This is a cache of https://docs.openshift.com/container-platform/4.17/cli_reference/cli_manager/cli-manager-install.html. It is a snapshot of the page at 2024-11-25T06:30:41.822+0000.
Installing the Openshift CLI Manager - OpenShift CLI Manager | CLI tools | OpenShift Container Platform 4.17
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

Installing the CLI Manager Operator

You can run the CLI Manager Operator in both connected and disconnected environments. In particular, it eases the installation and management of CLI plugins in disconnected environments. The CLI Manager Operator makes Krew compatible with the oc CLI. Cluster administrators can use the CLI Manager Operator to add CLI plugin custom resources that can then be accessed in both connected and disconnected environments. Cluster administrators install and configure the CLI Manager Operator, and users then add the custom index to Krew and add CLI plugins to the CLI Manager Operator.

Using the CLI Manager Operator to install and manage plugins for the OpenShift CLI is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

Installing the CLI Manager Operator

Install the CLI Manager Operator to facilitate adding CLI plugins in both connected and disconnected environments.

Prerequisites

  • Krew is installed.

  • You are logged in to OpenShift Container Platform as a user with the cluster-admin role.

  • You have access to the OpenShift Container Platform web console.

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.

Adding the CLI Manager Operator custom index to Krew

You can use the terminal to add the CLI manager custom index to Krew. This procedure is required for the CLI Manager Operator to function correctly and needs to be done only once.

The custom index connects Krew to the CLI Manager Operator binaries and enables the CLI Manager Operator to work in disconnected environments.

If you use self-signed certificates, mark the certificate as trusted on your local operating system to use Krew.
Prerequisites
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
Example output
Updated the local copy of plugin index.
Updated the local copy of plugin index <custom_index_name>.
New plugins available:
* ocp/<plugin_name>

Adding a plugin to the CLI Manager Operator

You can add a CLI plugin to the CLI Manager Operator by using the YAML View.

Prerequisites

  • You are logged in to OpenShift Container Platform as a user with the cluster-admin role.

  • The CLI Manager Operator is installed.

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.

Verification

  • Enter the following command to see if the plugin is listed and has been added successfully:

$ oc get plugin/<plugin_name> -o yaml
Example output
<plugin_name> ready to be served.