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
×

Installing the Operator SDK CLI

The Operator SDK provides a command-line interface (CLI) tool that Operator developers can use to build, test, and deploy an Operator. You can install the Operator SDK CLI on your workstation so that you are prepared to start authoring your own Operators.

Operator authors with cluster administrator access to a Kubernetes-based cluster, such as OpenShift Container Platform, can use the Operator SDK CLI to develop their own Operators based on Go, Ansible, or Helm. Kubebuilder is embedded into the Operator SDK as the scaffolding solution for Go-based Operators, which means existing Kubebuilder projects can be used as is with the Operator SDK and continue to work.

See Developing Operators for full documentation on the Operator SDK.

OpenShift Container Platform 4.9 and later supports Operator SDK v1.10.1.

Installing the Operator SDK CLI

You can install the OpenShift SDK CLI tool on Linux.

Prerequisites

  • Go v1.16+

  • docker v17.03+, podman v1.9.3+, or buildah v1.7+

Procedure

  1. Navigate to the OpenShift mirror site.

  2. From the latest 4.9.0 directory, download the latest version of the tarball for Linux.

  3. Unpack the archive:

    $ tar xvf operator-sdk-v1.10.1-ocp-linux-x86_64.tar.gz

  4. Make the file executable:

    $ chmod +x operator-sdk

  5. Move the extracted operator-sdk binary to a directory that is on your PATH.

    To check your PATH:

    $ echo $PATH
    		 
    $ sudo mv ./operator-sdk /usr/local/bin/operator-sdk
Verification

  • After you install the Operator SDK CLI, verify that it is available:

    $ operator-sdk version
    Example output
    operator-sdk version: "v1.10.1-ocp", ...