manage apply-cluster-component-scale-config

Change the scaling configuration of a shared cluster component.

Required role
Cluster administrator You must be a cluster administrator to run this command.

Extended description

You can change the scaling configuration of the following cluster components:

  • Scheduling service

You can scale the scheduling service to one of the following levels:

  • level_1
  • level_2
  • level_3
  • level_4
  • level_5

For more information about the resources that are required for each level, see Downloading the component scaling PDF from the IBM Entitled Registry.

Syntax

cpd-cli manage apply-cluster-component-scale-config \
--cluster_component_ns=<project-name> \
--component=<component-name> \
--release=<version> \
--scale=<scaling-configuration-level> \
[--wait=true|false]

Arguments

The apply-cluster-component-scale-config command has no arguments.

Options

Table 1: Command options
Option Description
--cluster_component_ns The project where the cluster-wide component that you want to modify is installed.
Status
Required.
Syntax
--cluster_component_ns=<project-name>
Default value
No default. User defined.
Valid values
The project where the cluster-wide component that you want to modify is installed.
--component The component that identifies the custom resource that you want to update.
Status
Required.
Syntax
--component=<component-name>
Default value
No default.
Valid values
  • scheduler
--release The release of IBM Software Hub that corresponds to the version of the shared cluster component that is installed in the specified project.
Status
Required.
Syntax
--release=<version>
Default value
No default. You must specify the release.
Valid values
  • 5.1.0
  • 5.1.1
  • 5.1.2
  • 5.1.3
--scale The scaling configuration to apply to the specified component or components.
Status
Required.
Syntax
--scale=<scaling-configuration-level>
Default value
No default.
Valid values
  • level_1
  • level_2
  • level_3
  • level_4
  • level_5
--wait Specify whether to wait for the custom resource to be ready.
Status
Optional.
Syntax
--wait=true|false
Default value
true

If you omit this option, the default value is used.

Valid values
false
Return to the command prompt without waiting for the custom resource to be ready.
true
Wait for the custom resource to be ready.

Examples

Note: The following example uses the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Setting up installation environment variables.

Scale the scheduling service to level_3
cpd-cli manage apply-cluster-component-scale-config \
--cluster_component_ns=${PROJECT_SCHEDULING_SERVICE} \
--component=scheduler \
--release=${VERSION} \
--scale=level_3