Cluster Control Manager core commands

Last Updated : Jul 17, 2022 |
Prolog information
Metadata
Keywords:
Some of the commands in the following table require the release name. You can obtain the release name from the Release column of the chart that is displayed when you run the ccm status command.
Command
Description
ccm
Provides command line syntax help for the ccm command level. The same as issuing the ccm help command.
ccm archive help
Displays ccm archive commands, including options for the ccm archive config command.
For more information about these command options, see ccm archive command options.
ccm backup
Performs a backup.
For information about the options available with this command, see ccm backup and ccm backup schedule command options.
ccm config
Provides command line syntax help for the ccm config command level. The same as issuing the ccm config help command.
ccm config help
Provides command line syntax help for the ccm config command level.
ccm config show <release-name>
Reads the configuration from the specified, running, helm release and displays it on the console in YAML format. Redirection of standard out can be used to capture the configuration data to a file.
. For example: ccm config show <example-helm-release > example-helm-release-config.yaml.
ccm config update <release-name> <config-file>
Updates the specified, running, helm release with the configuration provided by the specified YAML configuration file. Redirection of standard out can be used to capture the configuration data to a file.
For example: ccm config update example-helm-release example-helm-release-config.yaml.
ccm delete <release> [--yes]
Deletes the specified product chart after providing a confirmation prompt. If the optional argument --yes is used, the prompt is not provided.
Only run ccm delete <service name> to delete a failed service in case of an installation or upgrade failure. For more information, see Service failure during an installation or upgrade.
ccm help
Provides command line syntax help for the ccm command level.
ccm infra
Provides command line syntax help for the ccm infra command level. Same as issuing the command ccm infra help.
ccm infra help
Provides command line syntax help for the ccm infra command level.
ccm infra update-vcenter-creds
Updates the vCenter credentials used by Cluster Control Manager to manage a deployed cluster.
ccm install <cluster-config-xlsx-file> [--post-clean] [--force-download]
Installs the cluster infrastructure and services as defined in the provided Excel workbook. The file must end in the .xlsx or .xlsm extention. The user must accept, the Avaya EULA before proceeding. This variation of the install command auto-downloads all artifacts as part of the installation process. If a given artifact is already in the /var/avaya/artifactCache directory, its download is skipped. If --post-clean is specified, product chart docker images that are downloaded as part of the services staging process are deleted from the local CCM cache after they are staged on the system. If --force-download is specified the download of artifacts is forced (copies in /var/avaya/artifactCache are first deleted).
ccm install <resume | cancel> [--force-download]
Resumes or cancels the installation of the cluster infrastructure. If --force-download is specified, the download of artifacts if forced (copies in /var/avaya/artifactCache are first deleted).
ccm product
Shows a list of staged products to which product-specific commands can be directed.
Same as issuing the ccm product help command.
ccm product <staged-product-name>
Provides command line syntax help for the staged product identified in <staged-product-name>.
Same as issuing the ccm product <staged-product-name> help command.
ccm registry
Provides command line syntax help for the ccm registry command level.
Same as issuing the command ccm registry help.
ccm registry purge <image_name> <image_tag>
Deletes the docker container specified in <image_name> <image_tag> from the cluster's registry.
Note:
The ccm registry purge <image_name> <image_tag> command requires root access. Run su - root to access the root account.
ccm registry repopulate <--use-local-images>
Repopulates the docker image registry with docker images.
When running this command:
  • If you do not set --use-local-images, the command pulls all images, which are associated with the charts staged on Cluster Control Manager, from the external (harbor) docker registry. It then pushes these images to the docker registry running in the cluster.
  • If you set --use-local-images, the command only uploads the docker images that are relevant for the charts deployed in the cluster. This command obtains the images from Cluster Control Manager and uploads them to the docker registry running in the cluster.
ccm registry repos [--tags]
Lists the docker repositories (containers) in the cluster's registry. If --tags is specified, each <image_name>:<tag> is printed.
ccm registry tags <repository>
Lists all the <image>:<tag> entries for the specified docker repository (image name) at the cluster registry.
ccm release
Shows a list of running helm releases (and the staged products they were installed from) to which release-specific commands can be directed.
Same as issuing the ccm release help command.
ccm release <helm-release-name>
Provides command line syntax help for the help release identified by <helm-release-name>.
Same as issuing the ccm release <helm-release-name> help command.
ccm restore
Performs the restore operation.
For information about the options available with this command, see ccm restore command options.
ccm report
Enables the automatic collection of cluster and application-related information. The information collected is useful for troubleshooting purposes. For more information about this command, see ccm report command.
Note:
This command requires common-services chart version 1.1.0.0.x or later. On Cluster Control Manager, run ccm status to see which version of the chart is deployed.
ccm smoke-test
Runs a smoke test on the installed products. This command verifies that pods and contains are running as expected. It then pings the nodes and virtual IPs for proper operation.
The exit status of the command is not zero if the test fails.
ccm status [--health] [--pod-details] [--ps] [<product-name>]
Shows general status information about the services deployed in the cluster. If the cluster is not in the installed state, information about the state of the cluster (installing, uninstalling, services upgrading) is displayed. If --health is specified, the program checks to make sure that all pods have a status of Running or Completed.
Note:
The command does not verify the state of the containers within the pod.
If --pod-details is specified, the name, container count, restart count, and uptime for each pod is displayed. If the product name is specified, only pod details for that product are displayed.
If --ps is specified, the status of the following Kubernetes processes on each cluster node is displayed:
  • sdsetcd.service
  • etcd.service
  • kube-apiserver.service
  • kube-controller-manager.service
  • kube-scheduler.service
  • keepalived.service
  • flanneld.service
  • kubelet.service
  • kube-proxy.service
  • containerd.service
ccm system
Provides command line syntax help for the ccm system command level.
Same as issuing the ccm system help command.
ccm system config 
Displays information about the configuration of Cluster Control Manager.
ccm system log
Provides command line syntax help for the ccm system log command level.
Same as issuing the ccm system log help command.
ccm system log config 
Shows the current configuration of Cluster Control Manager logging. Each row represents a "logger" (a log type) that is embedded in the Cluster Control Manager software, along with the logging filter level used by the logger. The filter level filters the logs that are injected into the logging system by the logger. Each column represents a log handler that receives logs from the logging system and writes them to the output device that it manages. The configuration for each log handler includes:
  • The name of its output file, if applicable
  • Whether each log line is prefixed
  • The log rotation parameters (size-in-MB, max-count)
  • The logging filter level used to filter the logs that the handler writes to the output device it manages
  • 'X' indicates that the logs injected by a logger for the given row are routed by the logging system to the handler for the given column
The filter levels are NOTSET (no filtering), and in order of increasing priority, DEBUG3, DEBUG2, DEBUG1, INFO, WARNING, ERROR, and CRITICAL. Filtering is performed based on the priority of the generated log and the filter level.  For example, a filter level of INFO will allow logs at levels INFO, WARNING, ERROR, and CRITICAL, but not at DEBUG3, DEBUG2, or DEBUG1.
Use the command ccm system log preset default to set the log settings to the standard system default.
ccm system log getlogs 
Gathers the CCM log files into a zip file placing the zip file into the user's current working directory. The output file is named ccm-logs-<date>-<time>-<hostname>.zip. 
ccm system log help
Provides command line syntax help for the ccm system log command level.
ccm system log listpresets
Lists the available set of logging presets. A preset is a specific logging configuration. Available presets are:
  • Default: This preset refers to the factory default settings. This configuration is used on initial installation.
  • Debug: This preset is used to adjust settings to gather an additional level of detail.
  • Developer: This preset is useful for developers to analyze logs during software development.
ccm system log preset preset-name
Sets the logging configuration to the given preset.
ccm uninstall resume
Resumes the uninstallation of the cluster infrastructure (from a previous error exit).
ccm uninstall [--force]
Uninstalls the cluster infrastructure. Exits with an error if there are any helm releases running in the cluster, unless --force is specified, in which case the cluster uninstallation proceeds.
Tip:
Unless specified otherwise, always include --force when you run this command. The --force option deletes the deployed solution components along with the cluster virtual machines.
ccm upgrade
Provides command line syntax help for the ccm upgrade help command level.
Same as issuing the ccm upgrade help command.
ccm upgrade cancel [--no-prompt]
Cancels a paused upgrade of services (product helm charts). A confirmation prompt is first given unless --no-prompt is specified.
ccm upgrade hard-reset [--force]
Performs a hard reset of the Cluster Control Manager services (helm chart) upgrade state machine. This command is used if the state machine experiences an unrecoverable fault. It is used in exception conditions only. An attempt is first made to have the state machine process the reset. If the state machine fails to process the reset, state machine tracking data is cleared and the system returns to the Installed state. If --force is specified, state machine data is immediately cleared (the state machine is bypassed).
ccm upgrade system upgrade-config.yaml
Upgrades the Cluster Control Manager machine. The system reboots after the upgrade is applied.
ccm upgrade spec <complete path>/<solution spreadsheet name>.xlsx --infra
Upgrades the cluster. In <complete path>, provide the complete path to the solution configuration spreadsheet you are using for the upgrade.
ccm upgrade spec <complete path>/<solution spreadsheet name>.xlsx --products
Upgrades the services in the solution. In <complete path>, provide the complete path to the solution configuration spreadsheet you are using for the upgrade.
ccm version [-k] [-p <product_name>] [--runtime] [ --details] [-s] [-c]
Displays the version(s) of software that is staged or installed on Cluster Control Manager and the Kubernetes cluster. Optional arguments:
-k: Prints the version of Red Hat, Kubernetes, and dockers running on each of the Kubernetes nodes.
-p <product>: Prints all versions of software of a specific product installed on Cluster Control Manager.
-s: Shows the software versions of all the products deployed in the cluster. All other command options are ignored.
-c: Prints the software versions of individual components (for example, charts) of all or specific products installed/staged on Cluster Control Manager.
--details: Prints docker-image or binary versions associated with an individual component (charts/packages) of all or specific products.
--runtime: Prints the runtime status of the software that is staged/installed on Cluster Control Manager.