1. Documentation
    2. history bug_report picture_as_pdf
×

Installing tkn

Use the CLI tool to manage Red Hat OpenShift Pipelines from a terminal. You can install the CLI tool on different platforms.

Both the archives and the RPMs contain the following executables:

  • tkn

  • tkn-pac

  • opc

Running Red Hat OpenShift Pipelines with the opc CLI tool 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 Red Hat OpenShift Pipelines CLI on Linux

For Linux distributions, you can download the CLI as a tar.gz archive.

Procedure

  1. Download the relevant CLI tool.

  1. Unpack the archive:

    $ tar xvzf <file>

  2. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  3. To check your PATH, run the following command:

    $ echo $PATH

Installing the Red Hat OpenShift Pipelines CLI on Linux using an RPM

For Red Hat Enterprise Linux (RHEL) version 8, you can install the Red Hat OpenShift Pipelines CLI as an RPM.

Prerequisites

  • You have an active OpenShift Container Platform subscription on your Red Hat account.

  • You have root or sudo privileges on your local system.

Procedure

  1. Register with Red Hat Subscription Manager:

    # subscription-manager register

  2. Pull the latest subscription data:

    # subscription-manager refresh

  3. List the available subscriptions:

    # subscription-manager list --available --matches '*pipelines*'

  4. In the output for the previous command, find the pool ID for your OpenShift Container Platform subscription and attach the subscription to the registered system:

    # subscription-manager attach --pool=<pool_id>

  5. Enable the repositories required by Red Hat OpenShift Pipelines:

    • Linux (x86_64, amd64)

      # subscription-manager repos --enable="pipelines-1.16-for-rhel-8-x86_64-rpms"

    • Linux on IBM zSystems and IBM® LinuxONE (s390x)

      # subscription-manager repos --enable="pipelines-1.16-for-rhel-8-s390x-rpms"

    • Linux on IBM Power (ppc64le)

      # subscription-manager repos --enable="pipelines-1.16-for-rhel-8-ppc64le-rpms"

    • Linux on ARM (aarch64, arm64)

      # subscription-manager repos --enable="pipelines-1.16-for-rhel-8-aarch64-rpms"

  6. Install the openshift-pipelines-client package:

    # yum install openshift-pipelines-client

After you install the CLI, it is available using the tkn command:

$ tkn version

Installing the Red Hat OpenShift Pipelines CLI on Windows

For Windows, you can download the CLI as a zip archive.

Procedure

  1. Download the CLI tool.

  2. Extract the archive with a ZIP program.

  3. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  4. To check your PATH, run the following command:

    C:\> path

Installing the Red Hat OpenShift Pipelines CLI on macOS

For macOS, you can download the CLI as a tar.gz archive.

Procedure

  1. Download the relevant CLI tool.

  2. Unpack and extract the archive.

  3. Add the location of your tkn, tkn-pac, and opc files to your PATH environment variable.

  4. To check your PATH, run the following command:

    $ echo $PATH