Deployed data service dashboard


This topic explains all features available in the deployment dashboard.

Prerequisites

  • A deployed data service

To view the dashboard:

  1. Select a data service under Deployments.

  2. From the Deployments list page, select the specific data service for which you want to view the dashboard.

The deployment dashboard helps you view:

  • the deployment status of your data service

  • additional details regarding the connection, configuration, and resources used in your deployment

  • deployment health: status and events occurred during the deployment process

  • json files for status and deployment details

  • the list of your backup jobs

From the dashboard, you can also:

  • update a data service

  • manage or edit the data service

  • backup a data service (ad-hoc or scheduled)

  • view metrics

View deployment status

PDS displays one of the following statuses for each deployment:

  • Deploying: data service deployment is started

  • Partially Available: one or more pods are yet to come up

  • Available: data service deployed successfully

  • Unavailable: pods are down, and the data service is unavilable

  • Unknown: when PDS is unable to compute the pods state

view deployment status

View node(s) status

You can hover over the node hexagons to view the status of pod(s). PDS displays the pod(s) in the following colors to let you know the status:

  • Green: pod is running

  • Yellow: pod is coming up

  • Gray: pod is yet to come up

View additional details

The Additional Details window provides the Connection, Configuration, and Resources details used by a deployment.

To view the Additional Details window:

  1. Select the vertical ellipsis button next to Edit.

  2. From the options, select View Additional Details.

view additional details option

Connection

By default, the Connection tab is selected in the Additional Details window:

connection tab in the additional details option

The Connection tab displays:

  • Ports: the open ports used for a specific deployment.

  • Authentication: the credentials (username and password) for a deployment.

  • Nodes: all the running nodes in a deployment.

You can also select the connection button, below the node hexagons, to directly access the Connection tab.

Configuration

The Configuration tab displays more information about the deployment, DNS zone, and load balancer ranges for the deployed data service.

To view the configuration details, perform one of the following tasks:

  • Select the Configurations tab in the Additional Details window:

    configuration tab

  • Select the button in the configuration details section.

Resources

The Resources tab displays the:

  • sum of CPU utilization, memory, and storage used by all nodes

  • maximum available CPU and memory limits for a specific deployment

To view the resources details, perform one of the following tasks:

  • Select the Resources tab in the Additional Details window:

    resources tab

  • Select the resources button in the resources details section.

View deployment health

The Deployment Health window provides more information about the status of your deployment and the real-time events that occurred during the deployment.

To view the Deployment Health window:

  1. In the Deployments page, select a deployed data service.

  2. In the deployment dashboard, select the vertical ellipsis button next to Edit.

  3. From the options, select View Deployment Health.

TIP: You can also select the deployment status and the nodes status to view the Deployment Health window:

View Deployment Health button

By default, the Status tab is selected in the Deployment Health window.
Select the Events tab to view the real-time events that occurred during the deployment:

Deployment Health window

Backup jobs

In PDS, you can backup Cassandra, Consul, Couchbase, Elasticsearch, MongoDB Enterprise, MySQL, PostgreSQL, and Redis data services.

The following labels in the deployment details page help you know the backup job details:

  • LAST BACKUP JOB: time when the last backup was performed

  • BACKUP: frequency of a specific backup

You can also view all scheduled and ad-hoc backups that belong to a deployment in the dashboard.
Each backup displays the backup name, start and end time, backup target location, and the backup type:

view backup jobs

Metrics

PDS provides built-in dashboards for monitoring the common usage scenarios for your data services. To view the built-in dashboards, select Metrics:

metrics button

In the metrics dashboard → Timeframe dropdown, you can select a timeline to view the time-based metrics for a deployment.

TIP: You can also query the metrics manually.
For more information, refer to the Configure manual metrics collection topic.

Update a data service

In the deployment dashboard, the update available label and the Update button appears when the latest data service version is available for update:

update button in deployment dashboard

For more information about updating a data service, refer to the Update a data service topic.

Backup a data service

From the deployment dashboard, you can perform an ad-hoc backup of the current data service that you selected.
For more information, refer to the Ad-hoc backup section.

Edit a deployed data service

For more information about managing or editing a deployed data service configuration, refer to the Manage or edit a data service topic.

Delete a deployed data service

For more information about deleting a deployed data service, refer to the Delete a data service topic.



Last edited: Thursday, Jan 26, 2023