Skip to content

Commit 02ae8bd

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #76488 from kaldesai/SRVLOGIC-189-OSL
PR for SRVLOGIC-189: Added the installtion and uninstallation assemblies for Openshift Serverless Logic docs
2 parents ad01cda + 48f2265 commit 02ae8bd

7 files changed

+261
-0
lines changed

‎_attributes/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@
108108
:ServerlessProductName: OpenShift Serverless
109109
:ServerlessProductShortName: Serverless
110110
:ServerlessOperatorName: OpenShift Serverless Operator
111+
:ServerlessLogicOperatorName: OpenShift Serverless Logic Operator
111112
:FunctionsProductName: OpenShift Serverless Functions
112113
:ServerlessProductVersion: 1.31.0
113114
//service mesh v2

‎_topic_maps/_topic_map.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ Topics:
3737
File: kube-rbac-proxy-kafka
3838
- Name: Configuring OpenShift Serverless Functions
3939
File: configuring-serverless-functions
40+
- Name: Installing the OpenShift Serverless Logic Operator
41+
File: install-serverless-logic-operator
42+
- Name: Installing the OpenShift Serverless Logic Knative Workflow plugin
43+
File: serverless-logic-install-kn-workflow-plugin-cli
4044
- Name: OpenShift Serverless upgrades
4145
File: serverless-upgrades
4246
---
@@ -450,5 +454,7 @@ Topics:
450454
File: uninstalling-knative-serving
451455
- Name: Removing OpenShift Serverless Operator
452456
File: removing-serverless-operator
457+
- Name: Removing the OpenShift Serverless Logic Operator
458+
File: removing-openshift-serverless-logic-operator
453459
- Name: Deleting OpenShift Serverless CRDs
454460
File: deleting-serverless-crds

‎install/install-serverless-logic-operator.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="install-serverless-logic-operator"]
4+
= Installing the {ServerlessLogicOperatorName}
5+
:context: install-serverless-logic-operator
6+
7+
toc::[]
8+
9+
Installing the {ServerlessLogicOperatorName} enables you to install and use link:https://serverlessworkflow.io[Serverless Workflow] on a {ocp-product-title} cluster. The {ServerlessLogicOperatorName} manages Kubernetes custom resource definitions (CRDs) to configure and deploy the workflows.
10+
11+
//install doc
12+
include::modules/serverless-logic-install-web-console.adoc[leveloffset=+1]
13+
14+
[id="additional-resources_install-serverless-logic-operator"]
15+
[role="_additional-resources"]
16+
== Additional resources
17+
* link:https://docs.openshift.com/container-platform/latest/operators/understanding/crds/crd-managing-resources-from-crds.html[Managing resources from custom resource definitions]
18+
* link:https://docs.openshift.com/container-platform/latest/storage/understanding-persistent-storage.html#understanding-persistent-storage[Understanding persistent storage]
19+
* link:https://docs.openshift.com/container-platform/latest/networking/configuring-a-custom-pki.html[Configuring a custom PKI]
20+
21+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:_content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="serverless-logic-install-kn-workflow-plugin-cli"]
4+
= Installing the OpenShift Serverless Logic Knative Workflow plugin
5+
:context: serverless-logic-install-kn-workflow-artifact-images
6+
7+
toc::[]
8+
9+
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.
10+
11+
//install doc
12+
include::modules/serverless-logic-install-kn-workflow-artifact-images.adoc[leveloffset=+1]

‎modules/serverless-logic-install-kn-workflow-artifact-images.adoc

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
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-artifact-images_{context}"]
7+
= Installing the OpenShift Serverless Logic Knative Workflow plugin using the artifacts image
8+
9+
.Prerequisites
10+
11+
* You have installed the Knative (`kn`) CLI.
12+
* You have installed Podman on your local machine.
13+
14+
.Procedure
15+
16+
. Download the Knative Workflow plugin using the `logic-kn-workflow-cli-artifacts-rhel8` image by running the following commands:
17+
18+
.. Log in to the Red{nbsp}Hat Registry by running the following command:
19+
+
20+
[source,terminal]
21+
----
22+
$ podman login registry.redhat.io
23+
----
24+
+
25+
You can use your Red{nbsp}Hat Customer Portal account or a registry service account.
26+
27+
.. Set a variable for `KN_IMAGE` to start the `logic-kn-workflow-cli-artifacts-rhel8` image by running the following command:
28+
+
29+
[source,terminal]
30+
----
31+
$ export KN_IMAGE=registry.redhat.io/openshift-serverless-1/logic-kn-workflow-cli-artifacts-rhel8:1.33.0
32+
----
33+
34+
.. Set a variable for `KN_CONTAINER_ID` by running the following command:
35+
+
36+
[source,terminal]
37+
----
38+
$ export KN_CONTAINER_ID=$(podman run -di $KN_IMAGE)
39+
----
40+
41+
.. Copy the Knative Workflow plugin binary file by running the following command:
42+
+
43+
[source,terminal]
44+
----
45+
$ podman cp $KN_CONTAINER_ID:<path_to_binary> .
46+
----
47+
+
48+
where `<path_to_binary>` is the path to the file for your environment:
49+
+
50+
[cols=2,options=header]
51+
|===
52+
|Environment
53+
|Path to binary file
54+
55+
|Linux amd64 architecture
56+
|`/usr/share/kn/linux_amd64/kn-workflow-linux-amd64.tar.gz`
57+
58+
|Linux arm64 architecture
59+
|`/usr/share/kn/linux_arm64/kn-workflow-linux-arm64.tar.gz`
60+
61+
|macOS amd64 architecture
62+
|`/usr/share/kn/macos_amd64/kn-workflow-macos-amd64.tar.gz`
63+
64+
|macOS arm64 architecture
65+
|`/usr/share/kn/macos_arm64/kn-workflow-macos-arm64.tar.gz`
66+
67+
|Windows amd64 architecture
68+
|`/usr/share/kn/windows/kn-workflow-windows-amd64.zip`
69+
|===
70+
71+
.. Stop the container by running the following command:
72+
+
73+
[source,terminal]
74+
----
75+
$ podman stop $KN_CONTAINER_ID
76+
----
77+
78+
.. Delete the container by running the following command:
79+
+
80+
[source,terminal]
81+
----
82+
$ podman rm $KN_CONTAINER_ID
83+
----
84+
85+
.. Extract the selected Knative Workflow plugin binary file by running the following command:
86+
+
87+
[source,terminal]
88+
----
89+
$ tar xvzf kn-workflow-linux-amd64.tar.gz
90+
----
91+
92+
.. Rename the Knative Workflow plugin binary file to `kn-workflow` by running the following command:
93+
+
94+
[source,terminal]
95+
----
96+
$ mv kn kn-workflow
97+
----
98+
99+
. Install the `kn-workflow` command as a plugin of the Knative CLI by running the following commands:
100+
101+
.. Copy the `kn-workflow` binary file to a directory in your PATH, such as `/usr/local/bin`, and ensure the file name is `kn-workflow`:
102+
+
103+
[source,terminal]
104+
----
105+
$ cp path/to/downloaded/kn-workflow /usr/local/bin/kn-workflow
106+
----
107+
108+
.. Make the binary file executable:
109+
+
110+
[source,terminal]
111+
----
112+
$ chmod +x /usr/local/bin/kn-workflow
113+
----
114+
115+
.Verification
116+
. Run the following command to verify that the `kn-workflow` plugin is installed successfully:
117+
+
118+
[source,terminal]
119+
----
120+
$ kn plugin list
121+
----
122+
123+
. After installing the plugin, you can use `kn-workflow` to run the related subcommands.
124+
+
125+
.Aliases to use workflow subcommand
126+
[source,terminal]
127+
----
128+
kn-workflow
129+
----
130+
+
131+
.Example output of `kn-workflow help` command
132+
[source,terminal]
133+
----
134+
Manage OpenShift Serverless Logic Workflow projects
135+
136+
Usage:
137+
kn workflow [command]
138+
139+
Aliases:
140+
kn workflow, kn-workflow
141+
142+
Available Commands:
143+
completion Generate the autocompletion script for the specified shell
144+
create Creates a new OpenShift Serverless Logic Workflow project
145+
deploy Deploy an OpenShift Serverless Logic Workflow project on Kubernetes via SonataFlow Operator
146+
help Help about any command
147+
quarkus Manage OpenShift Serverless Logic Workflow projects built in Quarkus
148+
run Run an OpenShift Serverless Logic Workflow project in development mode
149+
undeploy Undeploy an OpenShift Serverless Logic Workflow project on Kubernetes via SonataFlow Operator
150+
version Show the version
151+
152+
Flags:
153+
-h, --help help for kn
154+
-v, --version version for kn
155+
156+
Use "kn [command] --help" for more information about a command.
157+
----

‎modules/serverless-logic-install-web-console.adoc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * /serverless/install/install-serverless-operator.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="serverless-logic-install-web-console_{context}"]
7+
= Installing the {ServerlessLogicOperatorName} from the web console
8+
9+
You can install the {ServerlessLogicOperatorName} from OperatorHub by using the {ocp-product-title} web console.
10+
11+
.Prerequisites
12+
13+
* You have cluster administrator permissions on {ocp-product-title}, or you have cluster or dedicated administrator permissions on {rosa-product-title} or {dedicated-product-title}.
14+
* For {ocp-product-title}, your cluster has the Marketplace capability enabled or the Red{nbsp}Hat-provided Operator catalogs source configured manually.
15+
* You have logged in to the web console.
16+
17+
.Procedure
18+
19+
. In the web console, navigate to the *Operators* -> *OperatorHub* page.
20+
21+
. Scroll, or type the keyword *Serverless Logic* into the *Filter by keyword* box to find the {ServerlessLogicOperatorName}.
22+
23+
. Review the information about the Operator and click *Install*.
24+
25+
. On the *Install Operator* page, ensure that the configuration uses the following settings:
26+
27+
.. The *Installation Mode* is *All namespaces on the cluster (default)*. This mode installs the Operator in the default `openshift-serverless-logic` namespace to watch and be made available to all namespaces in the cluster.
28+
29+
.. The *Installed Namespace* is `openshift-serverless-logic`.
30+
31+
.. Select the *stable* channel as the *Update Channel*. The *stable* channel will enable installation of the latest stable release of the {ServerlessLogicOperatorName}.
32+
33+
.. Select *Automatic* or *Manual* approval strategy.
34+
35+
. Click *Install* to make the Operator available to the selected namespaces on this {ocp-product-title} cluster.
36+
37+
. From the *Catalog* -> *Operator Management* page, you can monitor the {ServerlessLogicOperatorName} subscription's installation and upgrade progress.
38+
39+
** If you selected a *Manual* approval strategy, the subscription's upgrade status will remain *Upgrading* until you review and approve its install plan. After approving on the *Install Plan* page, the subscription upgrade status moves to *Up to date*.
40+
41+
** If you selected an *Automatic* approval strategy, the upgrade status should resolve to *Up to date* without intervention.
42+
43+
.Verification
44+
45+
* After the subscription's upgrade status is *Up to date*, select *Catalog* -> *Installed Operators* to verify that the {ServerlessLogicOperatorName} eventually shows up and its *Status* ultimately resolves to *InstallSucceeded* in the relevant namespace.
46+
+
47+
If it does not, check the following items:
48+
49+
.. Switch to the *Catalog* -> *Operator Management* page and inspect the *Operator Subscriptions* and *Install Plans* tabs for any failure or errors under *Status*.
50+
51+
.. Check the logs in any pods in the `openshift-serverless-logic` project on the *Workloads* -> *Pods* page that are reporting issues to troubleshoot further.

‎removing/removing-openshift-serverless-logic-operator.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="removing-openshift-serverless-logic-operator"]
4+
= Removing the OpenShift Serverless Logic Operator
5+
:context: uninstalling-openshift-serverless-logic-operator
6+
7+
If you need to remove OpenShift Serverless Logic from your cluster, you can do so by manually removing the {ServerlessLogicOperatorName} and other OpenShift Serverless Logic components.
8+
9+
You can delete the {ServerlessLogicOperatorName} by using the web console.
10+
11+
* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-deleting-operators-from-cluster.html#olm-deleting-operators-from-a-cluster-using-web-console_olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster using the web console]
12+
13+
* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-deleting-operators-from-cluster.html#olm-refresh-subs_olm-deleting-operators-from-a-cluster[Refreshing failing subscriptions]

0 commit comments

Comments
 (0)