CrateDB Cloud Console

The Cloud Console is a hosted web administration interface for interacting with CrateDB Cloud.

Note

This is a reference manual.

Check out Getting Started With CrateDB Cloud for a beginner tutorial.

See also

This is an open source documentation project. We host the source code and issue tracker on GitHub.

Table of contents

Basics

_images/start.png

You must access the Cloud Console by region.

Available regions:

Region URL
Azure East-US eastus2.azure.cratedb.cloud
Azure West-Europe westeurope.azure.cratedb.cloud
Bregenz bregenz.a1.cratedb.cloud

Azure East-US and Azure West-Europe are managed by Microsoft Azure. The Bregenz region is managed by Crate.io and is located in Austria, Europe.

Azure East-US is a good default region if you don’t know which one to pick.

From the Cloud Console homepage, you can sign in using your Cloud Console username and password or Microsoft Azure Active Directory (AD).

If you don’t have a Cloud Console account yet, select the sign-in option you wish to use. From there, you will be given the option to sign up.

Once signed in, you will be presented with your account overview.

Account overview

The account overview screen lists the organizations and projects you can access.

If you follow the getting started instructions and deploy a test cluster, your account overview will look something like this:

_images/account-overview.png

From the main panel, you can view organization details, view project details, or create a new project. You can collapse the individual organization widgets, so they take up less screen space.

From the left-hand navigation menu, you can log out. You can also collapse the menu.

Organizations

Organization overview

The organization overview screen lists all current organization projects for a specific region:

_images/organization-overview.png

From the main panel, you can switch regions, view project details, or create a new project. Switching regions refreshes the display to show you projects in that region.

From the left-hand navigation menu, you can now view organization users or the organization settings. Or, you can go back to your account overview.

Organization users

The organization users screen lists all current users along with their associated username, email, and role:

_images/org-users.png

From the main panel, you can edit user roles, remove users, or add users.

Organization settings

The organization settings screen lists the current settings for the organization:

_images/org-settings.png

From the main panel, you can edit settings or delete the organization.

If you set a notification email and turn on notifications, CrateDB Cloud will send relevant operational notifications via email.

Projects

Create a project

If you select Create project from the organization overview screen, you have the option to create a new project by name:

_images/create-project.png

Project overview

The project overview screen lists all currently deployed project services along with their associated service name, type, and billing:

_images/project-overview.png

From the main panel, you can select the individual services. For CrateDB clusters, this will bring up the cluster overview.

From the left-hand navigation menu, you can now view project users or the project settings. Notice also that deployed services appear as expandable menu items.

Project users

The project users screen lists all current users with access to the project, along with their associated username, email, and role:

_images/project-users.png

From the main panel, you can edit user roles, remove users, or add users.

Project settings

The project settings screen lists the current settings for the project:

_images/project-settings.png

From the main panel, you can delete the project.

Services

CrateDB clusters

Cluster overview

The cluster overview screen lists the current cluster information:

_images/cluster-overview.png

From the main panel, you can visit the cluster Admin UI at the Cluster URL.

CrateDB clients can also use the Cluster URL to connect on port 4200 for HTTP or port 5432 for the PostgreSQL wire protocol. Refer to your client documentation for more help.

Note

The Cluster URL points to a load-balancer that distributes traffic internally to the whole CrateDB cluster.

The load-balancer closes idle connections after four minutes, therefore client applications that require stateful connections (e.g., JDBC) must be be configured to send keep-alive heartbeat queries.

Cluster settings

The cluster settings screen lists the current cluster plan and unit.

_images/cluster_settings.png

With the Scale button, you are able to scale your cluster up or down, by selecting a scale unit.

_images/cluster_settings_scale.png

With the Delete button, you can delete the current cluster.

_images/cluster_settings_delete.png