Skip to content

Commit 83c17fc

Browse files
csibbittleifmadsenJoanneOFlynn2018
authored
Install docs updates for STF 1.5 (#396)
* Install docs updates for STF 1.5 * Additional 1.5 changes for removing cert manager * Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc Co-authored-by: Leif Madsen <[email protected]> * explicit namespace option and better order in removal proc * Update doc-Service-Telemetry-Framework/modules/proc_removing-the-cert-manager-operator.adoc Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: JoanneOFlynn2018 <[email protected]>
1 parent 1c8b75a commit 83c17fc

11 files changed

+219
-152
lines changed

‎common/global/stf-attributes.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:TargetVersion: 1.4
21
:ProductVersion: 1.5
32
:context: assembly
43
:containerbin: podman
@@ -34,8 +33,8 @@ ifeval::["{build}" == "upstream"]
3433
:Project: Service{nbsp}Telemetry{nbsp}Framework
3534
:ProjectShort: STF
3635
:MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router
37-
:SupportedOpenShiftVersion: 4.7
38-
:NextSupportedOpenShiftVersion: 4.8
36+
:SupportedOpenShiftVersion: 4.10
37+
:NextSupportedOpenShiftVersion: 4.10
3938
endif::[]
4039

4140
ifeval::["{build}" == "downstream"]
@@ -51,6 +50,6 @@ ifeval::["{build}" == "downstream"]
5150
:Project: Service{nbsp}Telemetry{nbsp}Framework
5251
:ProjectShort: STF
5352
:MessageBus: AMQ{nbsp}Interconnect
54-
:SupportedOpenShiftVersion: 4.7
55-
:NextSupportedOpenShiftVersion: 4.8
53+
:SupportedOpenShiftVersion: 4.10
54+
:NextSupportedOpenShiftVersion: 4.10
5655
endif::[]

‎doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ ifdef::context[:parent-context: {context}]
88
[role="_abstract"]
99
You can use Operators to load the {Project} ({ProjectShort}) components and objects. Operators manage each of the following {ProjectShort} core and community components:
1010

11+
* cert-manager
1112
* {MessageBus}
1213
* Smart Gateway
1314
* Prometheus and AlertManager
@@ -16,18 +17,28 @@ You can use Operators to load the {Project} ({ProjectShort}) components and obje
1617

1718
.Prerequisites
1819

20+
ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"]
21+
* {OpenShift} version {SupportedOpenShiftVersion} is running.
22+
endif::[]
23+
ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"]
1924
* An {OpenShift} version inclusive of {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion} is running.
25+
endif::[]
2026
* You have prepared your {OpenShift} environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShift} environment. For more information, see https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling].
2127
* Your environment is fully connected. {ProjectShort} does not work in a {OpenShift}-disconnected environments or network proxy environments.
2228

2329
ifeval::["{build}" == "downstream"]
2430
[IMPORTANT]
31+
ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"]
32+
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion}
33+
endif::[]
34+
ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"]
2535
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}.
2636
endif::[]
37+
endif::[]
2738

2839
.Additional resources
2940

30-
* For more information about Operators, see the https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/olm-what-operators-are.html[_Understanding Operators_] guide.
41+
* For more information about Operators, see the https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-what-operators-are.html[_Understanding Operators_] guide.
3142
* For more information about how to remove {ProjectShort} from the {OpenShift} environment, see xref:assembly-removing-stf-from-the-openshift-environment_assembly[].
3243

3344
include::../modules/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1]

‎doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ifdef::context[:parent-context: {context}]
22

33
[id="assembly-introduction-to-stf_{context}"]
4-
= Introduction to {Project} {TargetVersion}
4+
= Introduction to {Project} {ProductVersion}
55

66
// The `context` attribute enables module reuse. Every module's ID
77
// includes {context}, which ensures that the module has a unique ID even if
@@ -27,7 +27,12 @@ The components of {ProjectShort} use a message bus for data transport. Other mod
2727

2828
ifeval::["{build}" == "downstream"]
2929
[IMPORTANT]
30-
{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}.
30+
ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"]
31+
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion}
32+
endif::[]
33+
ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"]
34+
{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}.
35+
endif::[]
3136
endif::[]
3237

3338
.Additional resources

‎doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ To remove {ProjectShort} from the {OpenShift} environment, you must perform the
1212

1313
. Delete the namespace.
1414
. Remove the catalog source.
15-
. Remove the AMQ Cert Manager Operator.
15+
. Remove the cert-manager Operator.
1616

1717
include::../modules/proc_deleting-the-namespace.adoc[leveloffset=+1]
1818
include::../modules/proc_removing-the-catalogsource.adoc[leveloffset=+1]
19-
include::../modules/proc_removing-the-amq-cert-manager-operator.adoc[leveloffset=+1]
19+
include::../modules/proc_removing-the-cert-manager-operator.adoc[leveloffset=+1]
2020

2121
//reset the context
2222
ifdef::parent-context[:context: {parent-context}]

‎doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,12 @@ If you plan to collect and store events, collectd and Ceilometer deliver event d
7575
Server-side {ProjectShort} monitoring infrastructure consists of the following layers:
7676

7777
* {Project} {ProductVersion}
78+
ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"]
79+
* {OpenShift} {SupportedOpenShiftVersion}
80+
endif::[]
81+
ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"]
7882
* {OpenShift} {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}
83+
endif::[]
7984
* Infrastructure platform
8085

8186
[[osp-stf-server-side-monitoring]]

‎doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
[role="_abstract"]
55
Red Hat supports the two most recent versions of {Project} ({ProjectShort}). Earlier versions are not supported. For more information, see the https://access.redhat.com/articles/5662081[{Project} Supported Version Matrix].
66

7-
Red Hat supports the core Operators and workloads, including {MessageBus}, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, such as Elasticsearch, Prometheus, Alertmanager, Grafana, and their Operators.
7+
Red Hat supports the core Operators and workloads, including {MessageBus}, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, such as Elasticsearch, Prometheus, Alertmanager, Grafana, and their Operators.
88

99
You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments.

‎doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ $ oc logs --selector name=service-telemetry-operator
136136
--------------------------- Ansible Task Status Event StdOut -----------------
137137
138138
PLAY RECAP *********************************************************************
139-
localhost : ok=57 changed=0 unreachable=0 failed=0 skipped=20 rescued=0 ignored=0
139+
localhost : ok=90 changed=0 unreachable=0 failed=0 skipped=26 rescued=0 ignored=0
140140
----
141141

142142
.Verification

‎doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc

Lines changed: 58 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -76,57 +76,62 @@ smart-gateway-operator InfraWatch Operators 7m20s
7676
----
7777
endif::[]
7878

79-
. Enable the OperatorHub.io Community Catalog Source to install data storage and visualization Operators:
80-
+
81-
[WARNING]
82-
Red Hat supports the core Operators and workloads, including {MessageBus}, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of ElasticSearch, Prometheus, Alertmanager, Grafana, and their Operators.
79+
. Create a namespace for the cert-manager Operator:
8380
+
8481
[source,yaml,options="nowrap",role="white-space-pre"]
8582
----
8683
$ oc create -f - <<EOF
87-
apiVersion: operators.coreos.com/v1alpha1
88-
kind: CatalogSource
84+
apiVersion: project.openshift.io/v1
85+
kind: Project
8986
metadata:
90-
name: operatorhubio-operators
91-
namespace: openshift-marketplace
87+
name: openshift-cert-manager-operator
9288
spec:
93-
sourceType: grpc
94-
image: quay.io/operatorhubio/catalog:latest
95-
displayName: OperatorHub.io Operators
96-
publisher: OperatorHub.io
89+
finalizers:
90+
- kubernetes
9791
EOF
9892
----
9993

100-
. Subscribe to the AMQ Certificate Manager Operator by using the redhat-operators CatalogSource:
94+
. Create an OperatorGroup for the cert-manager Operator:
10195
+
102-
[NOTE]
103-
The AMQ Certificate Manager deploys to the `openshift-operators` namespace and is then available to all namespaces across the cluster. As a result, on clusters with a large number of namespaces, it can take several minutes for the Operator to be available in the `service-telemetry` namespace. The AMQ Certificate Manager Operator is not compatible with the dependency management of Operator Lifecycle Manager when you use it with other namespace-scoped operators.
96+
[source,yaml,options="nowrap",role="white-space-pre"]
97+
----
98+
$ oc create -f - <<EOF
99+
apiVersion: operators.coreos.com/v1
100+
kind: OperatorGroup
101+
metadata:
102+
name: openshift-cert-manager-operator
103+
namespace: openshift-cert-manager-operator
104+
spec: {}
105+
EOF
106+
----
107+
108+
. Subscribe to the cert-manager Operator by using the redhat-operators CatalogSource:
104109
+
105110
[source,yaml,options="nowrap",role="white-space-pre"]
106111
----
107112
$ oc create -f - <<EOF
108113
apiVersion: operators.coreos.com/v1alpha1
109114
kind: Subscription
110115
metadata:
111-
name: amq7-cert-manager-operator
112-
namespace: openshift-operators
116+
name: openshift-cert-manager-operator
117+
namespace: openshift-cert-manager-operator
113118
spec:
114-
channel: 1.x
119+
channel: tech-preview
115120
installPlanApproval: Automatic
116-
name: amq7-cert-manager-operator
121+
name: openshift-cert-manager-operator
117122
source: redhat-operators
118123
sourceNamespace: openshift-marketplace
119124
EOF
120125
----
121126

122-
. Validate your ClusterServiceVersion. Ensure that amq7-cert-manager.v1.0.3 displays a phase of `Succeeded`:
127+
. Validate your ClusterServiceVersion. Ensure that cert-manager Operator displays a phase of `Succeeded`:
123128
+
124129
[source,bash,options="nowrap",role="white-space-pre"]
125130
----
126-
$ oc get csv --namespace openshift-operators --selector operators.coreos.com/amq7-cert-manager-operator.openshift-operators
131+
$ oc get csv --namespace openshift-cert-manager-operator --selector=operators.coreos.com/openshift-cert-manager-operator.openshift-cert-manager-operator
127132
128-
NAME DISPLAY VERSION REPLACES PHASE
129-
amq7-cert-manager.v1.0.3 Red Hat Integration - AMQ Certificate Manager 1.0.3 amq7-cert-manager.v1.0.2 Succeeded
133+
NAME DISPLAY VERSION REPLACES PHASE
134+
openshift-cert-manager.v1.7.1 cert-manager Operator for Red Hat OpenShift 1.7.1-1 Succeeded
130135
----
131136

132137
. Subscribe to the AMQ Interconnect Operator by using the redhat-operators CatalogSource:
@@ -148,14 +153,35 @@ spec:
148153
EOF
149154
----
150155

151-
. Validate your ClusterServiceVersion. Ensure that amq7-interconnect-operator.v1.10.4 displays a phase of `Succeeded`:
156+
. Validate your ClusterServiceVersion. Ensure that amq7-interconnect-operator.v1.10.10 displays a phase of `Succeeded`:
152157
+
153158
[source,bash,options="nowrap",role="white-space-pre"]
154159
----
155160
$ oc get csv --selector=operators.coreos.com/amq7-interconnect-operator.service-telemetry
156161
157162
NAME DISPLAY VERSION REPLACES PHASE
158-
amq7-interconnect-operator.v1.10.4 Red Hat Integration - AMQ Interconnect 1.10.4 amq7-interconnect-operator.v1.10.3 Succeeded
163+
amq7-interconnect-operator.v1.10.10 Red Hat Integration - AMQ Interconnect 1.10.10 amq7-interconnect-operator.v1.10.4 Succeeded
164+
----
165+
166+
. Enable the OperatorHub.io Community Catalog Source to install data storage and visualization Operators:
167+
+
168+
[WARNING]
169+
Red Hat supports the core Operators and workloads, including {MessageBus}, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of Elasticsearch, Prometheus, Alertmanager, Grafana, and their Operators.
170+
+
171+
[source,yaml,options="nowrap",role="white-space-pre"]
172+
----
173+
$ oc create -f - <<EOF
174+
apiVersion: operators.coreos.com/v1alpha1
175+
kind: CatalogSource
176+
metadata:
177+
name: operatorhubio-operators
178+
namespace: openshift-marketplace
179+
spec:
180+
sourceType: grpc
181+
image: quay.io/operatorhubio/catalog:latest
182+
displayName: OperatorHub.io Operators
183+
publisher: OperatorHub.io
184+
EOF
159185
----
160186

161187
. If you plan to store metrics in Prometheus, you must enable the Prometheus Operator. To enable the Prometheus Operator, create the following manifest in your {OpenShift} environment:
@@ -213,7 +239,7 @@ EOF
213239
$ oc get csv --selector=operators.coreos.com/elasticsearch-eck-operator-certified.service-telemetry
214240
215241
NAME DISPLAY VERSION REPLACES PHASE
216-
elasticsearch-eck-operator-certified.1.9.1 Elasticsearch (ECK) Operator 1.9.1 Succeeded
242+
elasticsearch-eck-operator-certified.v2.4.0 Elasticsearch (ECK) Operator 2.4.0 elasticsearch-eck-operator-certified.v2.3.0 Succeeded
217243
----
218244

219245
. Create the Service Telemetry Operator subscription to manage the {ProjectShort} instances:
@@ -227,7 +253,7 @@ metadata:
227253
name: service-telemetry-operator
228254
namespace: service-telemetry
229255
spec:
230-
channel: stable-1.4
256+
channel: stable-1.5
231257
installPlanApproval: Automatic
232258
name: service-telemetry-operator
233259
source: redhat-operators
@@ -242,10 +268,10 @@ EOF
242268
$ oc get csv --namespace service-telemetry
243269
244270
NAME DISPLAY VERSION REPLACES PHASE
245-
amq7-cert-manager.v1.0.3 Red Hat Integration - AMQ Certificate Manager 1.0.3 amq7-cert-manager.v1.0.2 Succeeded
246-
amq7-interconnect-operator.v1.10.4 Red Hat Integration - AMQ Interconnect 1.10.4 amq7-interconnect-operator.v1.10.3 Succeeded
247-
elasticsearch-eck-operator-certified.1.9.1 Elasticsearch (ECK) Operator 1.9.1 Succeeded
271+
amq7-interconnect-operator.v1.10.10 Red Hat Integration - AMQ Interconnect 1.10.10 amq7-interconnect-operator.v1.10.4 Succeeded
272+
elasticsearch-eck-operator-certified.v2.4.0 Elasticsearch (ECK) Operator 2.4.0 elasticsearch-eck-operator-certified.v2.3.0 Succeeded
273+
openshift-cert-manager.v1.7.1 cert-manager Operator for Red Hat OpenShift 1.7.1-1 Succeeded
248274
prometheusoperator.0.47.0 Prometheus Operator 0.47.0 prometheusoperator.0.37.0 Succeeded
249-
service-telemetry-operator.v1.4.1641489191 Service Telemetry Operator 1.4.1641489191 Succeeded
250-
smart-gateway-operator.v4.0.1641489202 Smart Gateway Operator 4.0.1641489202 Succeeded
275+
service-telemetry-operator.v1.5.1664298822 Service Telemetry Operator 1.5.1664298822 Succeeded
276+
smart-gateway-operator.v5.0.1664298817 Smart Gateway Operator 5.0.1664298817 Succeeded
251277
----

‎doc-Service-Telemetry-Framework/modules/proc_removing-the-amq-cert-manager-operator.adoc

Lines changed: 0 additions & 106 deletions
This file was deleted.

0 commit comments

Comments
 (0)