Chapter 3. OpenShift CLI Manager

Procedure

1. Log in to the OpenShift Container Platform web console.

2. Create the required namespace for the CLI Manager Operator:

   1. Navigate to Administration Namespaces and click Create Namespace.
   2. In the Name field, enter openshift-cli-manager-operator and click Create.

3. Install the CLI Manager Operator:

   1. Navigate to Operators OperatorHub.
   2. In the filter box, enter CLI Manager Operator.
   3. Select the CLI Manager Operator and click Install.

   4. On the Install Operator page, complete the following steps:

      1. Ensure that the Update channel is set to tech preview, which installs the latest Technology Preview release of the CLI Manager Operator.
      2. From the drop-down menu, select A specific namespace on the cluster and select openshift-cli-manager-operator.
      3. Click Install.

4. Create the CliManager resource by completing the following steps:

   1. Navigate to Installed Operators.
   2. Select CLI Manager Operator.
   3. Select the CLI Manager tab.
   4. Click Create CliManager.
   5. Use the default Name.

   6. Click Create.

      1. The new CliManager resource is listed in the CLI Manager tab.

Verification

1. Navigate to Operators Installed Operators.
2. Verify that CLI Manager Operator is listed with a Status of Succeeded.

Procedure

1. To establish the ROUTE variable, enter the following command:

   $ ROUTE=$(oc get route/openshift-cli-manager -n openshift-cli-manager-operator -o=jsonpath='{.spec.host}')

2. To add the custom index to Krew, enter the following command:

   $ oc krew index add <custom_index_name> https://$ROUTE/cli-manager

3. To update Krew, enter the following command and check for any errors:

   $ oc krew update

Procedure

1. Log in to the OpenShift Container Platform web console.
2. Navigate to Operators Installed Operators.
3. From the list, select CLI Manager Operator.
4. Select the CLI Plugin tab.
5. Click Create Plugin.

6. In the text box, enter the information for the plugin you are installing. See the following example YAML file.

   Example YAML file to add a plugin

   apiVersion: config.openshift.io/v1alpha1
   kind: Plugin
   metadata:
     name: <plugin_name> 1
   spec:
     description: <description_of_plugin>
     homepage: <plugin_homepage>
     platforms:
     - bin: 2
       files:
       - from: <plugin_file_path>
         to: .
       image: <plugin_image>
       imagePullSecret: 3
       platform: <platform> 4
     shortDescription: <short_description_of_plugin>
     version: <version> 5

   1

   The name of the plugin you plan to use in commands.

   2

   Bin specifies the path to the plugin executable.

   3

   Optional: If the registry is not public, add a pull secret to access your plugin image.

   4

   Add the architecture for your system; for example, linux/amd64, darwin/arm64, windows/amd64, or another architecture.

   5

   Version must be in v0.0.0 format.

7. Click Save.

Procedure

1. To list all available plugins, run the following command:

   $ oc krew search

2. To get information about a plugin, run the following command:

   $ oc krew info <plugin_name>

3. To install a plugin, run the following command:

   $ oc krew install <plugin_name>

4. To list all plugins that were installed by Krew, run the following command:

   $ oc krew list

Procedure

1. Using the CLI, enter the following command:

1. Edit the YAML file to include the new specifications for your plugin.

Procedure

1. Log in to the OpenShift Container Platform web console.

2. Uninstall the CLI Manager Operator by completing the following steps:

   1. Navigate to Operators Installed Operators.
   2. Click the Options menu next to the CLI Manager Operator entry and click Uninstall Operator.
   3. In the confirmation dialog, click Uninstall.

Procedure

1. Log in to the OpenShift Container Platform web console.

2. Remove the openshift-cli-manager-operator namespace:

   1. Navigate to Administration Namespaces.
   2. Click the Options menu next to the openshift-cli-manager-operator entry and select Delete Namespace.
   3. In the confirmation dialog, enter openshift-cli-manager-operator in the field and click Delete.