Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion cli_reference/tkn_cli/installing-tkn.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,25 @@ include::_attributes/common-attributes.adoc[]

toc::[]

Use the `tkn` CLI tool to manage {pipelines-title} from a terminal. The following section describes how to install `tkn` on different platforms.
Use the CLI tool to manage {pipelines-title} from a terminal. The following section describes how to install the CLI tool on different platforms.

You can also find the URL to the latest binaries from the {product-title} web console by clicking the *?* icon in the upper-right corner and selecting *Command Line Tools*.

:FeatureName: Running {pipelines-title} on ARM hardware
include::snippets/technology-preview.adoc[]

[NOTE]
====
Both the archives and the RPMs contain the following executables:

* tkn
* tkn-pac
* opc
====

:FeatureName: Running {pipelines-title} with the `opc` CLI tool
include::snippets/technology-preview.adoc[]

// Install tkn on Linux
include::modules/op-installing-tkn-on-linux.adoc[leveloffset=+1]

Expand Down
23 changes: 9 additions & 14 deletions modules/op-installing-pipelines-as-code-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,24 @@

:_content-type: PROCEDURE
[id="installing-pipelines-as-code-cli_{context}"]
= Installing {pac} CLI
= Installing {pac} CLI

[role="_abstract"]
Cluster administrators can use the `tkn-pac` CLI tool on local machines or as containers for testing. The `tkn-pac` CLI tool is installed automatically when you install the `tkn` CLI for {pipelines-title}.
Cluster administrators can use the `tkn-pac` and `opc` CLI tools on local machines or as containers for testing. The `tkn-pac` and `opc` CLI tools are installed automatically when you install the `tkn` CLI for {pipelines-title}.

You can also install the `tkn-pac` `tkn-pac` version `0.23.1` binaries for the supported platforms:
You can install the `tkn-pac` and `opc` version `1.9.0` binaries for the supported platforms:

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.23.1/tkn-pac-linux-amd64-0.23.1.tar.gz[Linux (x86_64, amd64)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.23.1/tkn-pac-linux-s390x-0.23.1.tar.gz[Linux on IBM Z and LinuxONE (s390x)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.23.1/tkn-pac-linux-ppc64le-0.23.1.tar.gz[Linux on IBM Power Systems (ppc64le)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.23.1/tkn-pac-macos-amd64-0.23.1.tar.gz[Mac]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.23.1/tkn-pac-windows-amd64-0.23.1.zip[Windows]
+
[NOTE]
====
The binaries are compatible with `tkn` version `0.23.1`.
====
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-amd64.tar.gz[Linux (x86_64, amd64)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-s390x.tar.gz[Linux on IBM Z and LinuxONE (s390x)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-ppc64le.tar.gz[Linux on IBM Power (ppc64le)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-macos-amd64.tar.gz[macOS]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-windows-amd64.zip[Windows]

// In addition, you can install `tkn-pac` using the following methods:

// [CAUTION]
// ====
// The `tkn-pac` CLI tool available using these methods is _not updated regularly_.
// The `tkn-pac` CLI tool available using these methods is _not updated regularly_.
// ====

// * Install on Linux or Mac OS using the `brew` package manager:
Expand Down
12 changes: 6 additions & 6 deletions modules/op-installing-tkn-on-linux-using-rpm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
:_content-type: PROCEDURE
[id="installing-tkn-on-linux-using-rpm"]

= Installing {pipelines-title} CLI (tkn) on Linux using an RPM
= Installing the {pipelines-title} CLI on Linux using an RPM

[role="_abstract"]
For {op-system-base-full} version 8, you can install the {pipelines-title} CLI (`tkn`) as an RPM.
For {op-system-base-full} version 8, you can install the {pipelines-title} CLI as an RPM.

.Prerequisites

Expand Down Expand Up @@ -51,28 +51,28 @@ For {op-system-base-full} version 8, you can install the {pipelines-title} CLI (
+
[source,terminal]
----
# subscription-manager repos --enable="pipelines-1.8-for-rhel-8-x86_64-rpms"
# subscription-manager repos --enable="pipelines-1.9-for-rhel-8-x86_64-rpms"
----
+
* Linux on IBM Z and LinuxONE (s390x)
+
[source,terminal]
----
# subscription-manager repos --enable="pipelines-1.8-for-rhel-8-s390x-rpms"
# subscription-manager repos --enable="pipelines-1.9-for-rhel-8-s390x-rpms"
----
+
* Linux on IBM Power (ppc64le)
+
[source,terminal]
----
# subscription-manager repos --enable="pipelines-1.8-for-rhel-8-ppc64le-rpms"
# subscription-manager repos --enable="pipelines-1.9-for-rhel-8-ppc64le-rpms"
----
+
* Linux on ARM (arm64)
+
[source,terminal]
----
# subscription-manager repos --enable="pipelines-1.8-for-rhel-8-arm64-rpms"
# subscription-manager repos --enable="pipelines-1.9-for-rhel-8-arm64-rpms"
----
. Install the `openshift-pipelines-client` package:
+
Expand Down
21 changes: 13 additions & 8 deletions modules/op-installing-tkn-on-linux.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@
:_content-type: PROCEDURE
[id="installing-tkn-on-linux"]

= Installing {pipelines-title} CLI (tkn) on Linux
= Installing the {pipelines-title} CLI on Linux

[role="_abstract"]
For Linux distributions, you can download the CLI directly as a `tar.gz` archive.
For Linux distributions, you can download the CLI as a `tar.gz` archive.

.Procedure

. Download the relevant CLI tool.

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-linux-amd64.tar.gz[Linux (x86_64, amd64)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-amd64.tar.gz[Linux (x86_64, amd64)]

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-linux-s390x.tar.gz[Linux on IBM Z and LinuxONE (s390x)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-s390x.tar.gz[Linux on IBM Z and LinuxONE (s390x)]

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-linux-ppc64le.tar.gz[Linux on IBM Power (ppc64le)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-ppc64le.tar.gz[Linux on IBM Power (ppc64le)]

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-linux-arm64.tar.gz[Linux on ARM (arm64)]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-linux-arm64.tar.gz[Linux on ARM (arm64)]

// Binaries also need to be updated in the following modules:
// op-installing-pipelines-as-code-cli.adoc
// op-installing-tkn-on-windows.adoc
// op-installing-tkn-on-macos.adoc

. Unpack the archive:
+
Expand All @@ -29,9 +34,9 @@ For Linux distributions, you can download the CLI directly as a `tar.gz` archive
$ tar xvzf <file>
----

. Place the `tkn` and `tkn-pac` binaries in a directory that is on your `PATH`.
. Add the location of your `tkn`, `tkn-pac`, and `opc` files to your `PATH` environment variable.

. To check your `PATH`, run:
. To check your `PATH`, run the following command:
+
[source,terminal]
----
Expand Down
14 changes: 7 additions & 7 deletions modules/op-installing-tkn-on-macos.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@
:_content-type: PROCEDURE
[id="installing-tkn-on-macos"]

= Installing {pipelines-title} CLI (tkn) on macOS
= Installing the {pipelines-title} CLI on macOS

[role="_abstract"]
For macOS, the `tkn` CLI is provided as a `tar.gz` archive.
For macOS, you can download the CLI as a `tar.gz` archive.

.Procedure

. Download the relevant CLI tool.

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-macos-amd64.tar.gz[macOS]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-macos-amd64.tar.gz[macOS]

* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-macos-arm64.tar.gz[macOS on ARM]
* link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-macos-arm64.tar.gz[macOS on ARM]

. Unpack and unzip the archive.
. Unpack and extract the archive.

. Move the `tkn` and `tkn-pac` binaries to a directory on your `PATH`.
. Add the location of your `tkn`, `tkn-pac`, and `opc` files to your `PATH` environment variable.

. To check your `PATH`, open a terminal window and run:
. To check your `PATH`, run the following command:
+
[source,terminal]
----
Expand Down
12 changes: 6 additions & 6 deletions modules/op-installing-tkn-on-windows.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
:_content-type: PROCEDURE
[id="installing-tkn-on-windows"]

= Installing {pipelines-title} CLI (tkn) on Windows
= Installing the {pipelines-title} CLI on Windows

[role="_abstract"]
For Windows, the `tkn` CLI is provided as a `zip` archive.
For Windows, you can download the CLI as a `zip` archive.

.Procedure

. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/0.24.1/tkn-windows-amd64.zip[CLI tool].
. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/pipeline/1.9.0/tkn-windows-amd64.zip[CLI tool].

. Unzip the archive with a ZIP program.
. Extract the archive with a ZIP program.

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

. To check your `PATH`, open the command prompt and run the command:
. To check your `PATH`, run the following command:
+
[source,terminal]
----
Expand Down