Compose Database-as-a-Service Help and Documentation

Everything you need to know about Compose, Hosted or Enterprise, is here in our help system. Whether you run one database for your businesses' sole application or six different databases to support an entire corporation, we've got the information you need.

The Cluster View

Each Enterprise cluster has its own console which gives an overview of the hosts and databases deployed on that cluster. You get to it through the Enterprise Console and its Clusters view. There are four sub-views within the Cluster view - Hosts, Deployments, Access and Settings.

The Hosts View

On entering the Cluster Console, the Hosts view is displayed. Other views available are listed in the left-hand menu.

List of hosts on a cluster.

List of hosts on a cluster.

This shows each independent host in the cluster, its name, version of Compose Enterprise software it is running and a usage meter.

The usage meter shows, from left to right, the percentage of RAM used on the host, the number of gigabytes of RAM used on the host, the total available RAM on the host and a graphical representation of those values.

In full, this example shows three hosts, each with 7.8GB of RAM available, using between 5.35 and 5.41GB of RAM on each, a 69% occupancy.

Clicking on the name of a host will give you a new view zoomed in on that host.

Breakdown of cluster resources by deployment and capsule.

Breakdown of cluster resources by deployment and capsule.

At the top of the page is a graphical representation of what type of databases are occupying this host. Each square represents a capsule that works for a particular type of database and hovering over the squares will reveal which database is being represented by that color. This is a simple capsule count.

Capsules and deployments

Compose database deployments are made up of a number of capsules: data capsules which run the database itself, utility capsules which perform essential administrative tasks and portal capsules which connect the database to the outside world. These are spread over the three (or more) hosts to ensure high availability of the deployment.

Below the capsule type usage, there is a listing of every capsule on the host, grouped by database type being served. As well as the databases, the listing is headed by databrowser which is a special class of capsule installed to allow the Compose Data Browsers to function.

For each group, capsules are listed with

  • the allocated (by Compose) name
  • the deployment that the capsule belongs to
  • the hostname that can be used to refer to the capsule
  • the role of the capsule in the deployment
  • the memory that the capsule is allocated (and may or may not be using)

Capsule roles include:

  • member - runs an active database node
  • proxy - runs a portal for access
  • lightweight - runs a utility/administrative process
  • backup - runs a backup database node
  • readonly - runs a synchronized read-only database node

Clicking on the deployment name will take you to the database's Deployment Overview.

The Deployments View

Deployments is the next option on the left-hand menu of the Cluster Console. When selected, it displays all the database deployments within the cluster. Clicking on the deployment name will take you to the database's Deployment Overview.

Listing of deployments by type and name.

Listing of deployments by type and name.

In the top right-hand corner is a Create Deployment button. Clicking this button takes the user to the New Deployment screen where they can select a database to deploy. When they select, the database options are displayed:

Creating a new deployment dialogue.

Creating a new deployment dialogue.

The cluster is automatically selected in the Create Deployment On field and so should not require changing. With Enterprise, the scale slider, which sets the initial scale of the deployment, is set to ten times the minimum size for a deployment of the database type. Adjust this if you require a small database which will autoscale over time. Other options available map to the standard Compose deployment options for the database type. Clicking Create Deployment will start the deployment provisioning process.

The Access View

Compose allows an account to create multiple users in that account and give them different privileges. This access control scheme extends into Compose Enterprise where those users may be given the ability to just deploy databases within a cluster, just manage the cluster's existing deployments or administer the cluster with full permissions. The permissions for a cluster are set in the Access View.

Access controls for the current cluster.

Access controls for the current cluster.

Further details on the Access view and Enterprise access control are in the Enterprise Access Control section.

The Settings View

The Settings view currently displays the setting for where backups are stored. Changes to this or to destroy the cluster require a support ticket to manage and track those changes. That ticket can be created by clicking Contact Support.

The Settings panel.

The Settings panel.


Still Need Help?

If this article didn't solve things, summon a human and get some help!

The Cluster View