Skip to content

Commit c011d59

Browse files
mbaldessarimbaldessari
authored
Merge pull request #552 from kquinn1204/TELCODOCS-2223
Telcodocs 2223
2 parents 5b3e6ed + 392f593 commit c011d59

File tree

3 files changed

+137
-2
lines changed

3 files changed

+137
-2
lines changed

‎content/contribute/creating-a-pattern.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ There are 4 values files that make up any Validated Pattern. The values files a
5151

5252
== Operators into framework
5353

54-
We begin our journey by identifying what application services are needed to run the workload. The Cloud Native Operator framework provides a way of managing the lifecycle of application services that are needed by the application workload. The validated pattern framework gives you a way to describe these Operators in a values file that is specific to your pattern and the site type.
54+
We begin our journey by identifying what application services are needed to run the workload. The Cloud Native Operator framework provides a way of managing the lifecycle of application services that are needed by the application workload. The validated pattern framework gives you a way to describe these Operators in a values file that is specific to your pattern and the site type.
5555

56-
So for example if we wish deploy Advanced Cluster Management, AMQ (messaging) and AMQ Streams (Kafka) in our datacenter, we would make the following subscription entries in our `values-datacenter.yaml` file:
56+
So for example if we want deploy Advanced Cluster Management, AMQ (messaging) and AMQ Streams (Kafka) in our datacenter, we would make the following subscription entries in our `values-datacenter.yaml` file:
5757

5858
[source,yaml]
5959
----

‎content/learn/vp_add_ops_to_pattern.adoc‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
menu:
3+
learn:
4+
parent: Validated patterns frameworks
5+
title: Adding Operators to the framework
6+
weight: 23
7+
aliases: /ocp-framework/adding-operator-to-framework/
8+
---
9+
10+
:toc:
11+
:imagesdir: /images
12+
:_content-type: PROCEDURE
13+
include::modules/comm-attributes.adoc[]
14+
15+
Subscriptions are defined in the values files and they are OpenShift Operator subscriptions from the Operator Hub. Subscriptions contribute to the creation of a software bill of materials (SBOM), detailing all intended installations within the ClusterGroup. For example in `values-hub.yaml`, the subscriptions defined in the subscriptions section specify Operators that are installed in the hub cluster when you deploy the validated pattern.
16+
17+
This procedure describes how subscriptions to Operators are added to the validated pattern framework.
18+
19+
.Procedure
20+
21+
=== 1. Identify required application services
22+
* Decide the application services necessary to support the workload.
23+
* These services are managed through Operators, which handle their lifecycle within OpenShift.
24+
25+
=== 2. Define Operators in the values file
26+
* Use the validated pattern framework to specify required Operators in a values file (`values-<site>.yaml`).
27+
* This file should reflect the specific pattern and site type where the Operators will be deployed.
28+
29+
=== 3. Add subscription entries
30+
* Define the required Operators by adding subscription entries in the `values-<site>.yaml` file.
31+
* Each entry should specify:
32+
** The Operator name
33+
** The namespace where it should be deployed
34+
** The subscription channel
35+
** The ClusterServiceVersion (CSV)
36+
37+
.Example: Deploying Advanced Cluster Management, AMQ, and AMQ Streams
38+
39+
For example, if you want to deploy Advanced Cluster Management, AMQ (messaging) and AMQ Streams (Kafka) in your factory cluster, you would follow the guidance here:
40+
41+
The assumption is there is a `values-factory.yaml` file that is used to deploy the factory cluster. The file should include the following entries:
42+
+
43+
[source,yaml]
44+
----
45+
namespaces:
46+
- open-cluster-management
47+
- my-application
48+
- backend-storage
49+
50+
subscriptions:
51+
- name: advanced-cluster-management
52+
namespace: open-cluster-management
53+
channel: release-2.3
54+
csv: advanced-cluster-management.v2.3.2
55+
56+
- name: amq-streams
57+
namespace: my-application
58+
channel: amq-streams-1.7.x
59+
csv: amqstreams.v1.7.1
60+
61+
- name: amq-broker
62+
namespace: my-application
63+
channel: 7.8.x
64+
csv: amq-broker-operator.v7.8.1-opr-3
65+
----
66+
67+
The validated pattern framework provisions the required Operators and deploys them to the specified namespaces, ensuring they are available for workload deployment.

‎content/learn/vp_add_specific_ops_to_pattern.adoc‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
menu:
3+
learn:
4+
parent: Validated patterns frameworks
5+
title: Adding a specific operator to hub values file
6+
weight: 24
7+
aliases: /ocp-framework/adding-specific-operator-to-hub/
8+
---
9+
10+
:toc:
11+
:imagesdir: /images
12+
:_content-type: PROCEDURE
13+
include::modules/comm-attributes.adoc[]
14+
15+
== Procedure: Changing Subscription to Use a specific Operator Version
16+
17+
This procedure outlines the steps to change an Operator subscription to use a specific version by updating the `csv` field and configuring the installation approval process.
18+
19+
[NOTE]
20+
====
21+
This is required if an issue prevents the Operator from being successfully installed.
22+
====
23+
24+
.Procedure
25+
26+
. Change the `values-hub.yaml` file to include the following fields under `subscriptions`:
27+
28+
* `csv` - Specifies the exact Operator version to install.
29+
* `installPlanApproval` - Set to `Manual` to prevent automatic installation.
30+
+
31+
Update `values-hub.yaml` as follows:
32+
+
33+
[source,yaml]
34+
----
35+
clusterGroup:
36+
...
37+
subscriptions:
38+
acm:
39+
name: advanced-cluster-management
40+
namespace: open-cluster-management
41+
channel: release-2.11
42+
csv: advanced-cluster-management.v2.11.1
43+
installPlanApproval: Manual
44+
----
45+
+
46+
This change ensures that the specified version is not installed until manually approved.
47+
48+
. With the `installPlanApproval` set to `Manual`, follow these steps to manually approve the installation:
49+
50+
. Navigate to *Operators* -> *Installed Operators* in the OpenShift Web Console.
51+
. Locate the *InstallPlans* section.
52+
. Find the pending install plan for the Operator.
53+
. Click *Review manual InstallPlan*.
54+
. Click *Approve* to proceed with the installation.
55+
56+
. Optional: Automate approval and deploy the specified Operator version without manual intervention:
57+
58+
.. Edit the `values-global.yaml` file.
59+
.. Add the `autoApproveManualInstallPlans` variable and set it to `true` as shown below:
60+
+
61+
[source,yaml]
62+
----
63+
global:
64+
options:
65+
autoApproveManualInstallPlans: true
66+
----
67+
68+
This configuration generates a cronJob that runs every 5 minutes, automatically approving install plans that match the specified `csv` version.

0 commit comments

Comments
 (0)