From 0d6e40674c7c114f20ce32f22d7b858398c367b9 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 22 Nov 2023 16:24:40 -0500 Subject: [PATCH] Update install guide for dependent operators Update the installation guide for dependent operators. Adds installation instructions for Cluster Observability Operator and cert-manager for Red Hat OpenShift using the latest channels available for those Operators. The result is that deployment of observabilityStrategy: use_redhat is now possible as the default installation method. Related: STF-1636 --- ...installing-the-core-components-of-stf.adoc | 14 +++---- ...-servicetelemetry-object-in-openshift.adoc | 7 ++-- ...ficate-manager-for-openshift-operator.adoc | 41 ++++++++++++++----- ...proc_deploying-observability-operator.adoc | 25 +++++------ 4 files changed, 49 insertions(+), 38 deletions(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index 24c55708..7d8660a5 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -8,10 +8,12 @@ ifdef::context[:parent-context: {context}] [role="_abstract"] You can use Operators to load the {Project} ({ProjectShort}) components and objects. Operators manage each of the following {ProjectShort} core components: -* cert-manager +* Certificate Management * {MessageBus} -* Smart Gateway -* Prometheus and AlertManager +* Smart Gateways +* Prometheus and Alertmanager + +{Project} ({ProjectShort}) uses other supporting Operators as part of the deployment. {ProjectShort} can resolve most dependencies automatically, but you need to pre-install some Operators, such as {ObservabilityOperator}, which provides an instance of Prometheus and Alertmanager, and cert-manager for Red Hat OpenShift, which provides management of certificates. .Prerequisites @@ -43,14 +45,10 @@ endif::[] include::../modules/con_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] include::../modules/proc_deploying-observability-operator.adoc[leveloffset=+2] - -ifeval::[{SupportedOpenShiftVersion} < 4.12] include::../modules/proc_deploying-certificate-manager-for-openshift-operator.adoc[leveloffset=+2] -endif::[] include::../modules/proc_deploying-service-telemetry-operator.adoc[leveloffset=+2] - - include::../modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc[leveloffset=+1] + include::../modules/con_primary-parameters-of-the-servicetelemetry-object.adoc[leveloffset=+2] include::../modules/proc_accessing-uis-for-stf-components.adoc[leveloffset=+1] include::../modules/proc_configuring-observability-strategy.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc index 232ae45d..6b374997 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc @@ -6,7 +6,9 @@ Create a `ServiceTelemetry` object in {OpenShift} to result in the Service Telem .Procedure -. To create a `ServiceTelemetry` object that results in an {ProjectShort} using the core components for metrics delivery, create a `ServiceTelemetry` object: +. Log in to your {OpenShift} environment where {ProjectShort} is hosted. + +. To deploy {ProjectShort} that results in the core components for metrics delivery being configured, create a `ServiceTelemetry` object: + [source,yaml,options="nowrap",role="white-space-pre"] ---- @@ -97,12 +99,9 @@ $ oc get pods NAME READY STATUS RESTARTS AGE alertmanager-default-0 3/3 Running 0 123m -cert-manager-operator-controller-manager-54f7679467-46pjj 2/2 Running 0 139m default-cloud1-ceil-meter-smartgateway-7dfb95fcb6-bs6jl 3/3 Running 0 122m default-cloud1-coll-meter-smartgateway-674d88d8fc-858jk 3/3 Running 0 122m -ifndef::include_when_13[] default-cloud1-sens-meter-smartgateway-9b869695d-xcssf 3/3 Running 0 122m -endif::[] default-interconnect-6cbf65d797-hk7l6 1/1 Running 0 123m interconnect-operator-7bb99c5ff4-l6xc2 1/1 Running 0 138m prometheus-default-0 3/3 Running 0 122m diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc index 8fda61f9..1f55b747 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-certificate-manager-for-openshift-operator.adoc @@ -1,13 +1,27 @@ :_content-type: PROCEDURE [id="deploying-certificate-manager-for-openshift-operator_{context}"] -= Deploying Certificate Manager for OpenShift Operator += Deploying cert-manager for Red Hat OpenShift [role="_abstract"] -The Certificate Manager for OpenShift is pre-installed from the `stable-v1` channel with Service Telemetry Framework ({ProjectShort}) on {OpenShift} 4.12 or later. When installing {ProjectShort} on {OpenShift} 4.10 pre-installation is required due to only the `tech-preview` channel being available. Pre-installation is only required on versions of {OpenShift} prior to 4.12. +The cert-manager for Red Hat OpenShift (cert-manager) Operator must be pre-installed before creating an instance of {Project} ({ProjectShort}). For more information about cert-manager, see link:https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/security/cert_manager_operator/index.html[cert-manager for Red Hat OpenShift overview]. + +In previous versions of {ProjectShort}, the only available cert-manager channel was `tech-preview` which continues to work and is available until OpenShift v4.12. Installations of {ProjectShort} on versions of {OpenShift} v4.14 and later must be installed from the `stable-v1` channel. For new installations of {ProjectShort} it is recommended to install cert-manager from the `stable-v1` channel. + +[WARNING] +Only one deployment of cert-manager can be installed per {OpenShift} cluster. Subscribing to cert-manager in more than one project causes the deployments to conflict with each other. .Procedure +. Log in to your {OpenShift} environment where {ProjectShort} is hosted. + +. Verify cert-manager is not already installed on the OpenShift cluster. If any results are returned, do not install another instance of cert-manager: ++ +[source,bash,options="nowrap"] +---- +$ oc get sub --all-namespaces -o json | jq '.items[] | select(.metadata.name | match("cert-manager")) | .metadata.name' +---- + . Create a namespace for the cert-manager Operator: + [source,yaml,options="nowrap",role="white-space-pre"] @@ -16,7 +30,7 @@ $ oc create -f - <