`manage apply-scheduler`

Install or upgrade the scheduling service.

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

Extended description

The scheduling service is a cluster-wide resource can be installed exactly once per cluster.

It is recommended that you install the scheduling service in its own project.

Do not install the scheduling service in the same project as the IBM Cloud Pak® for Data operators.

The apply-scheduler command installs or updates the following objects for the scheduling service in the specified project:

Catalog source
Subscription
Cluster service version (CSV)
Custom resource

Syntax

cpd-cli manage apply-scheduler \
--release=<version> \
--license_acceptance=true|false \
--scheduler_ns=<project-name> \
[--case_download=true|false] \
[--from_oci=true|false] \
[--oci_location=<registry-URL>] \
[--catsrc=true|false] \
[--sub=true|false] \
[--preview=true|false]

Arguments

The apply-scheduler command has no arguments.

Options

Option	Description
`--case_download`	Specify whether to download the CASE packages for the specified components if they are not detected in the work directory. Important: The command will fail if the CASE packages are not in the `work` directory. Default location If you made the `cpd-cli` executable from any directory, the path to the directory is: `<current-directory>/cpd-cli-workspace/olm-utils-workspace/work` If you did not make the `cpd-cli` executable from any directory, the path to the directory is: `<cli-install-directory>/cpd-cli-workspace/olm-utils-workspace/work` Custom location If you set the `CPD_CLI_MANAGE_WORKSPACE` environment variable, path to the directory is: `${CPD_CLI_MANAGE_WORKSPACE}/work` Status Optional. Syntax `--case_download=true\|false` Default value `true` If you omit this option, the default value is used. Valid values `false` Specify `false` if you are running the commands in a restricted network where the download will fail. If you specify `false` and the CASE packages are not in the `work` directory, the command will fail. `true` Specify `true` to download the CASE packages. If you are not allowed to download the CASE packages from GitHub, ensure that you set `--from_oci=true`.
`--catsrc`	Specify whether to create the catalog source objects for the specified component. You must create the catalog source for the scheduling service. However, you can create it separately from the subscription. Status Optional. Syntax `--catsrc=true\|false` Default value `true` If you omit this option, the default value is used. Valid values `false` Create the catalog source. `true` Skip creating the catalog source.
`--from_oci`	Download CASE packages from the IBM Cloud Pak Open Container Initiative (OCI) registry rather than from GitHub. This option is recommended for environments that are not allowed to access GitHub (github.com). Restriction: This setting applies only if you set `--case_download=true`. Status Optional. Syntax `--from_oci=true\|false` Default value `false` If you omit this option, the default value is used. Valid values `false` Download the CASE packages from GitHub. `true` Download the CASE packages from the IBM Cloud Pak Open Container Initiative.
`--license_acceptance`	Specify whether you accept the license terms. You must set this option to true to install the software. Status Required. Syntax `--license_acceptance=true\|false` Default value `false` If you omit this option, the default value is used. Valid values `false` This value indicates that you do not accept the license terms. If you specify `--license_acceptance=false`, the specified components will not be installed. `true` This value indicates that you accept the license terms. You must specify `--license_acceptance=true` to install the specified components.
`--oci_location`	The URL of the Open Container Initiative (OCI) registry from which you want to download CASE packages. For example, specify this option if you want to download the CASE packages from a private OCI registry. Restriction: This setting applies only if you set `--from_oci=true`. Status Optional. Syntax `--oci_location=<registry-URL>` Default value `cp.icr.io/cpopen` If you omit this option, the default value is used. Valid values The URL of the Open Container Initiative (OCI) registry from which you want to download CASE packages.
`--preview`	Preview the commands that run when you issue this CLI command. The command issues a series of `oc` commands. You can see the list of `oc` commands that are associated with the command. The `oc` commands are saved to the `preview.sh` file in the `work` directory. Status Optional. Syntax `--preview=true\|false` Default value false If you omit this option, the default value is used. Valid values false Run the commands to apply the changes to your cluster. true Preview the commands without running them. You can copy the `oc` commands from the output and run them yourself. However, this method is not recommended. When you run the commands manually, you do not have access to the additional helper scripts that are included in the underlying Ansible® playbook.
`--release`	The release that you want to install or upgrade to. If you have multiple versions of IBM Cloud Pak for Data installed on the cluster, it is recommended that you install the scheduling service at the same version as the latest version of IBM Cloud Pak for Data on the cluster. Status Required. Syntax `--release=<version>` Default value No default. You must specify the release. Valid values 4.8.0 4.8.1 4.8.2 4.8.3 4.8.4 4.8.5
`--scheduler_ns`	The project for the scheduling service. For install, specify the project where you want to install the scheduling service. For upgrade, specify the project where the scheduling service is installed. Do not install the scheduling service in the same project as the IBM Cloud Pak for Data operators. Status Required. Syntax `--scheduler_ns=<project-name>` Default value No default. Valid values For install, the project where you want to install the scheduling service. For upgrade, the project where the scheduling service is installed.
`--sub`	Specify whether to create the operator subscriptions for the specified component. You must create the subscription for the scheduling service. However, you can create it separately from the catalog source. Status Optional. Syntax `--sub=true\|false` Default value `true` If you omit this option, the default value is used. Valid values `false` Create the subscription. `true` Skip creating the subscription.

Table 1: Command options

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 Best practice: Setting up installation environment variables.

Install the scheduling service in the ${PROJECT_SCHEDULING_SERVICE} project

cpd-cli manage apply-scheduler \
--release=${VERSION} \
--license_acceptance=true \
--scheduler_ns=${PROJECT_SCHEDULING_SERVICE}

Preview the oc commands to install the scheduling service in the ${PROJECT_SCHEDULING_SERVICE} project

cpd-cli manage apply-scheduler \
--release=${VERSION} \
--license_acceptance=true \
--scheduler_ns=${PROJECT_SCHEDULING_SERVICE} \
--preview=true