Skip to main content

Operations and Management

CCX comes with tools for managing and operating your installation.

CCX Admin UI​

Your CCX_URL has the /auth/admin endpoint (https://ccxFQDN/auth/admin) that allows you (and your support team) to administer all datastores deployed

The account details for this are found in the kubernetes secret admin-users. (The format is <email>:<password> and additional admin users can be specified using the ; as a separator).

You need to logout from CCX web-app first or clear the cookies for your CCX_URL in a browser.

CCX Admin API​

The Admin UI offers basic administration of datastores (View and Delete), and also users (view).

Database configuration parameters, instance types, volunes, etc are configured in values.yaml.

Basic Auth​

The following Admin API endpoints requires Basic Auth authentication method to work:

  • Billing usage → GET /admin/datastores/billing/usage/{type}
  • Users count → GET /admin/users/count
  • Datastores count → GET /admin/datastores/count

The credentials can be found in the kubernetes secret admin-basic-auth. To create a Basic Authentication Header we can use this command

BASIC_AUTH=$(kubectl get secret admin-basic-auth -o json | jq -r '(.data.ADMIN_AUTH_USERNAME | @base64d) + ":" + (.data.ADMIN_AUTH_PASSWORD | @base64d)' | tr -d '\n' | base64) printf "Authorization: Basic %s" $BASIC_AUTH

ClusterControl UI​

This is the admin panel for ClusterControl and exposes the functionality of CMON through a web interface (you can also use the s9s CLI tool to interact).

The account details for this are found in the kubernetes secret cmon-credentials.

danger

Never use the ClusterControl UI to delete resources (nodes or datastores). This may lead to stray data.

S9S CLI​

S9s CLI is a tool that provides access to CMON functionality and the tool can be run from the cmon-master service within Kubernetes.

danger

Never use the S9S CLI to delete resources (nodes or datastores). This may lead to stray data.