Access your clusters at any time by clicking Clusters on the left hand
demo cluster is included by default.
Creating and managing clusters is an essential task for a platform administrator in Starburst Galaxy. A cluster with the desired catalogs is required for a data consumer to use SQL statements in client tools to analyze the available data. The following concepts are important to perform this work efficiently.
Cloud provider region and catalogs #
Catalogs define the details to access a data source.
Any data source is located in a specific cloud region of a specific cloud
provider. For example, your Cloud SQL for MySQL database is hosted in the
us-east1 region of Google Cloud.
A cluster can include one or more catalogs. If multiple catalogs are configured, you can query them with SQL using the same client connection. You can also query the data in multiple catalogs within one SQL statement.
A cluster and all its configured catalogs must be located in the same cloud provider and region. This allows for maximum performance and avoids data transfer costs for access across regions or even cloud providers.
The size of a cluster is determined by the number of server nodes used to process queries, as well as the size of the individual nodes. A larger cluster, consisting of more and larger nodes, is capable of processing more complex queries, handle more concurrent users, and provide higher performance, by using more resources.
The available sizes include
x-large, and ``2x-large`. You can create a cluster with any size, and change
size based on the current needs.
Status and transitions #
Any cluster can be in one of the following three states:
- A stopped cluster consists of a small configuration set only. No significant resources are used, and no costs are incurred.
- A running cluster consists of a number of server nodes. It continues to be in the running state, while users are submitting queries for processing.
- A suspended cluster consists of a small configuration set, and a mechanism to listen to incoming user request. It does not include any actively running server nodes, and no costs are incurred.
A newly created cluster begins in the stopped state, and can be started in the list of cluster.
A running cluster can be manually stopped in the list of cluster.
A running cluster transitions to the suspended status when no user queries are processed, and the configured time for Auto suspend elapsed. When a user submits a query to a suspended cluster, the cluster is started, and the query is processed. The user has to wait for the cluster to start, which typically takes between one and five minutes.
List of clusters #
The list of clusters is accessible by clicking Clusters on the left hand menu. It displays the following information about each cluster:
- to access a drop down of more actions:
- Query to navigate to the Query editor using the current cluster as context.
- Get connection shows details to use to connect clients to the cluster.
- Stop to stop the cluster.
- Edit cluster to edit the cluster.
- Change owner to change the owner of the cluster to a different role.
- Open to navigate to the Trino Web UI to analyze the cluster.
- Delete cluster to delete the cluster.
- Name of the cluster, used to identify a cluster in the user interface as well as in the connection string for clients.
- Status includes the current status as well as buttons to change the status including Stop and Start.
- Quick actions show buttons for varying operations, depending on the cluster status.
- Catalogs lists the configured catalogs used in the cluster.
- Size displays the configured cluster size.
- Auto suspend displays the configured time for an inactive cluster to transition to suspended status.
- to edit the cluster.
Create a cluster #
Make sure that you have configured the desired catalogs to avoid restarts before creating a cluster. Use the Create cluster button above the list of clusters and proceed with the following steps:
- Set the Cluster name to a meaningful name for users.
- Configure the Cluster size from the available sizes.
- Add one or more Catalogs to provide access to the configured data sources to users in this cluster. The catalogs all needs to be using the same cloud provider and region as the cluster itself.
- Choose the Cloud provider region to use for deploying and running the cluster.
- Decide on the roles to grant access to the cluster and configure access with Allowed roles.
- Click Create cluster to save the configuration to the list of clusters as a stopped cluster.
If desired, proceed to start the cluster.
Start a cluster #
Use the Start button in the list of clusters.
Stop a cluster #
Edit a cluster #
Use the Edit cluster option available with the button, or the button in the list of clusters to access the edit view.
You can change the configuration of a cluster without affecting your users and any running queries. Many changes, such as adding catalogs, changing size, or changing cloud region, require a new cluster.
Use the Update button in the list of clusters to apply the configuration changes. The new cluster is created transparently and new queries are transferred to it as soon as it is ready. At the same time running queries continue to operate and complete on the existing cluster.
Delete a cluster #
You need to stop the cluster in the list of clusters to be able to delete a cluster. Once stopped, you can delete the cluster with the Delete cluster option in the drop down from the list. Alternatively, you can access the edit view for the cluster and use the Delete cluster button at the bottom of the view.
Is the information on this page helpful?