Skip to content

Commit bc38396

Browse files
author
Kalyani Desai
committed
SRVLOGIC-369-kn-workflow: Added a new procedure for binary download
1 parent 859a991 commit bc38396

4 files changed

+191
-2
lines changed

‎install/serverless-logic-install-kn-workflow-plugin-cli.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
:_content-type: ASSEMBLY
2-
include::_attributes/common-attributes.adoc[]
32
[id="serverless-logic-install-kn-workflow-plugin-cli"]
43
= Installing the OpenShift Serverless Logic Knative Workflow plugin
5-
:context: serverless-logic-install-kn-workflow-artifact-images
4+
include::_attributes/common-attributes.adoc[]
5+
:context: serverless-logic-install-kn-workflow-plugin-cli
66

77
toc::[]
88

99
OpenShift Serverless Logic provides a plugin named `kn-workflow` for the Knative CLI, enabling you to set up a local workflow project using the command line.
1010

1111
//install doc
12+
include::modules/serverless-logic-install-kn-workflow-binary-file-linux.adoc[leveloffset=+1]
13+
include::modules/serverless-logic-install-kn-workflow-binary-file-macos.adoc[leveloffset=+1]
14+
include::modules/serverless-logic-install-kn-workflow-binary-file-windows.adoc[leveloffset=+1]
1215
include::modules/serverless-logic-install-kn-workflow-artifact-images.adoc[leveloffset=+1]

‎modules/serverless-logic-install-kn-workflow-binary-file-linux.adoc

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/install/serverless-logic-install-kn-workflow-plugin-cli.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="serverless-logic-install-kn-workflow-binary-file-linux_{context}"]
7+
= Installing the {ServerlessLogicProductName} Knative Workflow plugin for Linux
8+
9+
If you are using a Linux distribution that does not have RPM or another package manager installed, you can install the Knative Workflow plugin.
10+
11+
.Prerequisites
12+
13+
* You have installed the Knative (`kn`) command-line interface (CLI).
14+
15+
* If you are not using {op-system-base} or Fedora, ensure that the *libc* library is installed in a directory on your path.
16+
+
17+
[IMPORTANT]
18+
====
19+
If the *libc* library is not available, you might see the following error when you run commands:
20+
21+
[source,terminal]
22+
----
23+
$ kn: No such file or directory
24+
----
25+
====
26+
27+
.Procedure
28+
29+
. Download the latest `tar` archive suitable for your environment, from the link:https://mirror.openshift.com/pub/cgw/serverless-logic/latest/[Serverless Logic download mirror] page.
30+
31+
. Extract the Knative Workflow plugin binary file by running the following command:
32+
+
33+
[source,terminal]
34+
----
35+
$ tar xvzf <tar_archive>
36+
----
37+
38+
. Rename the extracted Knative Workflow plugin binary file to `kn-workflow` by running the following command:
39+
+
40+
[source,terminal]
41+
----
42+
$ mv <filename> kn-workflow
43+
----
44+
45+
. Install the `kn-workflow` command as the Knative CLI plugin:
46+
47+
.. Make the binary file executable by running the following command:
48+
+
49+
[source,terminal]
50+
----
51+
$ chmod +x /usr/local/bin/kn-workflow
52+
----
53+
54+
.. Copy the `kn-workflow` binary file to a directory in the `/usr/local/bin` path by running the following command:
55+
+
56+
[source,terminal]
57+
----
58+
$ cp <path/to/downloaded/kn-workflow> /usr/local/bin/kn-workflow
59+
----
60+
61+
.Verification
62+
63+
* Run the following command to verify that the `kn-workflow` plugin is installed successfully:
64+
+
65+
[source,terminal]
66+
----
67+
$ kn plugin list
68+
----

‎modules/serverless-logic-install-kn-workflow-binary-file-macos.adoc

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/install/serverless-logic-install-kn-workflow-plugin-cli.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="serverless-logic-install-kn-workflow-binary-file-macos_{context}"]
7+
= Installing the {ServerlessLogicProductName} Knative Workflow plugin for macOS
8+
9+
If you are using macOS, you can install the Knative Workflow plugin as a binary file.
10+
11+
[IMPORTANT]
12+
====
13+
On macOS, some systems might block the application from running due to security policies. To fix this issue, click *System Preferences* -> *Security & Privacy* -> *General* to approve the application to run. For more information, see the link:https://support.apple.com/en-in/guide/mac-help/mh40616/mac[Open a Mac app from an unidentified developer] Apple support article.
14+
====
15+
16+
.Prerequisites
17+
18+
* You have installed the Knative (`kn`) command-line interface (CLI).
19+
20+
.Procedure
21+
22+
. Download the latest `tar` archive suitable for your environment, from the link:https://mirror.openshift.com/pub/cgw/serverless-logic/latest/[Serverless Logic download mirror] page.
23+
24+
. Extract the Knative Workflow plugin binary file by running the following command:
25+
+
26+
[source,terminal]
27+
----
28+
$ tar xvzf <tar_archive>
29+
----
30+
31+
. Rename the extracted Knative Workflow plugin binary file to `kn-workflow` by running the following command:
32+
+
33+
[source,terminal]
34+
----
35+
$ mv <filename> kn-workflow
36+
----
37+
38+
. Install the `kn-workflow` command as the Knative CLI plugin:
39+
40+
.. Make the binary file executable by running the following command:
41+
+
42+
[source,terminal]
43+
----
44+
$ chmod +x /usr/local/bin/kn-workflow
45+
----
46+
47+
.. Copy the `kn-workflow` binary file to a directory in the `/usr/local/bin` path by running the following command:
48+
+
49+
[source,terminal]
50+
----
51+
$ cp <path/to/downloaded/kn-workflow> /usr/local/bin/kn-workflow
52+
----
53+
54+
.Verification
55+
56+
* Run the following command to verify that the `kn-workflow` plugin is installed successfully:
57+
+
58+
[source,terminal]
59+
----
60+
$ kn plugin list
61+
----

‎modules/serverless-logic-install-kn-workflow-binary-file-windows.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/install/serverless-logic-install-kn-workflow-plugin-cli.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="serverless-logic-install-kn-workflow-binary-file-windows_{context}"]
7+
= Installing the {ServerlessLogicProductName} Knative Workflow plugin for Windows
8+
9+
If you are using Windows, you can install the Knative Workflow plugin.
10+
11+
.Prerequisites
12+
13+
* You have installed the Knative (`kn`) command-line interface (CLI).
14+
15+
.Procedure
16+
17+
. Download the latest `zip` archive suitable for your environment, from the link:https://mirror.openshift.com/pub/cgw/serverless-logic/latest/[Serverless Logic download mirror] page.
18+
19+
. Extract the Knative Workflow plugin binary file using PowerShell by running the following command:
20+
+
21+
[source,terminal]
22+
----
23+
$ Expand-Archive -Path <filename>.zip -DestinationPath <destination>
24+
----
25+
26+
. Rename the extracted Knative Workflow plugin binary file to `kn-workflow` by running the following command:
27+
+
28+
[source,terminal]
29+
----
30+
$ Rename-Item -Path <destination>\<filename>.exe -NewName kn-workflow.exe
31+
----
32+
33+
. Install the `kn-workflow` command as the Knative CLI plugin:
34+
+
35+
On Windows, files with a `.exe` extension are treated as executable by default, so you do not need to change permissions.
36+
37+
.. Move the `kn-workflow.exe` file to a directory in your `PATH` by running the following command:
38+
+
39+
[source,terminal]
40+
----
41+
$ move C:\path\to\kn-workflow.exe "C:\Program Files"
42+
----
43+
44+
.. Copy the `kn-workflow` binary file to a directory in your `PATH` by running the following command:
45+
+
46+
[source,terminal]
47+
----
48+
$ Copy-Item -Path <destination>\kn-workflow.exe -Destination "C:\Program Files\kn-workflow.exe"
49+
----
50+
51+
.Verification
52+
* Run the following command to verify that the `kn-workflow` plugin is installed successfully:
53+
+
54+
[source,terminal]
55+
----
56+
$ kn plugin list
57+
----

0 commit comments

Comments
 (0)