Quickstart guide

Overview

In this Quickstart guide, we will find out how to start using TypeDB Cloud:

  • Get an account

  • Log In

  • Create a deployment

  • Connect to a TypeDB Enterprise cluster

Get an account

During alpha testing, access to the TypeDB Cloud is restricted by an invite-only policy.

To send a request to join the alpha test of TypeDB Cloud, use the following form.

Log in

Head to the main page of TypeDB Cloud and use the credentials provided by Vaticle to log in.

Create a deployment

To create a new deployment, use the following steps:

  1. Select an Organization to create a deployment in.

  2. Open the Deployments page from the navigation menu on the left.

  3. Click the Create button in the top toolbar.

  4. Use the Create new deployment form to provide the required information:

    • Deployment ID — enter the new deployment’s unique (in the project scope) name.

    • Select location — select the zone to deploy. Each zone named after the respective cloud provider and geographic location (E.g., AWS EU West 2).

    • Select project — select one of the projects available to you to deploy.

    • Select servers — select a number of servers in the TypeDB Enterprise cluster for this deployment.

  5. Click the Submit button.

Now that the deployment is being created all we need is to wait for the status of the deployment to become Fully available.

Connect to a deployment

To work with the deployment’s TypeDB servers, we need to set up a TypeDB Client and connect it to the deployment cluster.

At this stage of alpha testing, all TypeDB Cloud deployments are created with the listening port of 1729 and a default user with the following credentials:

Username: admin
Password: password

To connect to a TypeDB Cloud deployment we can use any TypeDB Client: see the Connect to a deployment page for more options.

For example, to connect via TypeDB Console:

typedb console --cluster=<address> --username=admin --password=password --tls-enabled=true --tls-root-ca=<path_to_ca>

where:

  • <address> — is the address of a server in the TypeDB Cloud installation we are connecting to, including the port number.
    For example, deployment-78678ca6-afda-4792-b5b8-0cb6b540d8ee-0.deployment-78678ca6-afda-4792-b5b8-0cb6b540d8ee.cloud.typedb.com:1729.

  • admin — is the default username for the default user.

  • password — is the default password for the default user.

  • true — is the TLS encryption setting. It’s true (enabled) by default.

  • <path_to_ca> — the path to the CA certificate.

See example 
typedb console --cluster=deployment-78678ca6-afda-4792-b5b8-0cb6b540d8ee-0.deployment-78678ca6-afda-4792-b5b8-0cb6b540d8ee.cloud.typedb.com:1729  --username=admin --password=password --tls-enabled=true --tls-root-ca=./typedb-cloud-root-ca.pem

As a result, we get a welcome message from TypeDB Console, and if the connection is successful, it’s followed by a command line prompt.

Welcome to TypeDB Console. You are now in TypeDB Wonderland!
Copyright (C) 2022 Vaticle

>

For more information on how to use TypeDB Console, see the TypeDB Console page.

For more information on how to connect with other TypeDB Clients, see the Connect to a deployment page.

Learn more

Check the current account details on the Account page.

Find out how to manage deployments in the Deployment management section:

Explore the user management options in the User management section:

  • Users — how to create, delete, and see details of a user.

  • Teams — how to group users in teams for easier management.

  • Organizations — how to manage an organization.