From 31ad58a1d52a8e57345519d5fe0912d4848c27e0 Mon Sep 17 00:00:00 2001 From: mickogeary Date: Fri, 16 Feb 2024 17:21:16 +0000 Subject: [PATCH 01/11] mg-master_RHOSPDOC-1200_STF-disconnected --- ...reparing-your-ocp-environment-for-stf.adoc | 4 +- ...tions-for-service-telemetry-framework.adoc | 2 +- ...n-openshift-disconnected-environments.adoc | 83 +++++++++++++++++++ 3 files changed, 87 insertions(+), 2 deletions(-) create mode 100644 doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc index ea2ef706..b61bbf02 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc @@ -10,13 +10,15 @@ To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must * Ensure that you have persistent storage available in your {OpenShift} cluster for a production-grade deployment. For more information, see <>. * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <>. +//// * Ensure that you have a fully connected network environment. For more information, see xref:con-network-considerations-for-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[]. +//// include::../modules/con_observability-strategy.adoc[leveloffset=+1] include::../modules/con_persistent-volumes.adoc[leveloffset=+1] include::../modules/con_resource-allocation.adoc[leveloffset=+1] include::../modules/con_network-considerations-for-service-telemetry-framework.adoc[leveloffset=+1] - +include::../modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc[leveloffset=+1] //reset the context ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] diff --git a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc index e22f0275..b1d79eab 100644 --- a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc @@ -3,4 +3,4 @@ [id="con-network-considerations-for-service-telemetry-framework_{context}"] = Network considerations for Service Telemetry Framework -You can only deploy {Project} ({ProjectShort}) in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. +You can deploy {Project} ({ProjectShort}) in fully-connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. \ No newline at end of file diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc new file mode 100644 index 00000000..9e8b4793 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -0,0 +1,83 @@ + + +[id="deploying-stf-on-openshift-disconnected-environments_{context}"] += Deploying STF on OpenShift-disconnected environments + +[role="_abstract"] +Since {Project} ({ProjectShort}) version 1.5.4, you can deploy {ProjectShort} in {OpenShift}-disconnected environments. + +.Prerequisites + +* {OpenShift} Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. +* A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registry for {OpenShift}, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ Guide. +* All the {ProjectShort} dependencies are available in the {OpenShift} cluster mirror registry. + +.Adding {ProjectShort} dependencies to the mirror registry + +You can use the `oc-mirror` tool to fetch the {ProjectShort} dependencies and add them to the {OpenShift} cluster mirror registry. For more information about installing the `oc-mirror` tool, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/installing/index#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin] in the {OpenShift} _Installing_ Guide. + + +.Procedure + +. Create an `ImageSetConfiguration` resource to retrieve the {ProjectShort} dependencies: + ++ +[source,yaml,options="nowrap",role="white-space-pre"] +---- +apiVersion: mirror.openshift.io/v1alpha2 +kind: ImageSetConfiguration +storageConfig: + local: + path: ./ +mirror: + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.14 + packages: + - name: service-telemetry-operator + channels: + - name: stable-1.5 + - name: openshift-cert-manager-operator + channels: + - name: stable-v1 + - name: amq7-interconnect-operator + channels: + - name: 1.10.x + - name: smart-gateway-operator + channels: + - name: stable-1.5 + - name: cluster-observability-operator + channels: + - name: development +---- + ++ +NOTE: This example is for {OpenShift} version 4.14. + + +. If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShift} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. + ++ +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html-single/service_telemetry_framework_1.5/index#assembly-installing-the-core-components-of-stf_assembly[Installing the core components of Service Telemetry Framework]. + + + +//// + +.Verification + +* TBD + +//// + +[role="_additional-resources"] +.Next steps + +* Continue to install {ProjectShort} as in a non-restricted network environment. + +//// + +[role="_additional-resources"] +.Additional resources + +* TBD +//// From a12b05c47601b82e224a1b3a38bcec3524951998 Mon Sep 17 00:00:00 2001 From: mickogeary Date: Mon, 26 Feb 2024 17:28:19 +0000 Subject: [PATCH 02/11] added more info about mirror types and verificiation --- ...n-openshift-disconnected-environments.adoc | 52 ++++++++++++++----- 1 file changed, 39 insertions(+), 13 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 9e8b4793..072dfe26 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -1,20 +1,20 @@ [id="deploying-stf-on-openshift-disconnected-environments_{context}"] -= Deploying STF on OpenShift-disconnected environments += Deploying {ProjectShort} on {OpenShiftShort}-disconnected environments [role="_abstract"] Since {Project} ({ProjectShort}) version 1.5.4, you can deploy {ProjectShort} in {OpenShift}-disconnected environments. .Prerequisites -* {OpenShift} Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. -* A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registry for {OpenShift}, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ Guide. -* All the {ProjectShort} dependencies are available in the {OpenShift} cluster mirror registry. +* {OpenShift}({OpenShiftShort}) Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. +* A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registry for {OpenShiftShort}, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ Guide. +* All the {ProjectShort} dependencies are available in the {OpenShiftShort} cluster mirror registry. .Adding {ProjectShort} dependencies to the mirror registry -You can use the `oc-mirror` tool to fetch the {ProjectShort} dependencies and add them to the {OpenShift} cluster mirror registry. For more information about installing the `oc-mirror` tool, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html-single/installing/index#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin] in the {OpenShift} _Installing_ Guide. +You can use the `oc-mirror` tool to fetch the {ProjectShort} dependencies and add them to the {OpenShiftShort} cluster mirror registry. For more information about installing the `oc-mirror` tool, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html-single/installing/index#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin] in the {OpenShiftShort} _Installing_ Guide. .Procedure @@ -50,30 +50,56 @@ mirror: - name: development ---- -+ -NOTE: This example is for {OpenShift} version 4.14. +. (Optional) If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShiftShort} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. + ++ +You can use the oc-mirror plugin differently, depending on your environment, such as: -. If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShift} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. +* mirroring between mirrors. +* mirror from mirror to disk +* mirror from disk to mirror. + -NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html-single/service_telemetry_framework_1.5/index#assembly-installing-the-core-components-of-stf_assembly[Installing the core components of Service Telemetry Framework]. +For more information about different oc-mirror scenarios, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] +. Push the {ProjectShort} operators and their dependencies from the mirror registry and generate the manifest for the OCP cluster. -//// ++ +[source,bash,options="nowrap",role="white-space-pre"] +---- +$ oc-mirror --config imagesetconfig.yaml <1> +---- -.Verification ++ +* Replace with the filepath to the mirror registry that you want to use -* TBD ++ +. Locate the generated manifests and apply them to the target OCP cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] + ++ +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{osp_curr_ver}/html-single/service_telemetry_framework_1.5/index#assembly-installing-the-core-components-of-stf_assembly[Installing the core components of Service Telemetry Framework]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] -//// [role="_additional-resources"] .Next steps * Continue to install {ProjectShort} as in a non-restricted network environment. +.Verification + +* Check that the catalog sources are applied. You can return the entries for new catalogs that reference the {ProjectShort} operators and their dependencies: + ++ +[source,bash,options="nowrap",role="white-space-pre"] +---- +$ oc get catalogsources +---- + +* You have deployed {ProjectShort} and cannot access external networks. + + //// [role="_additional-resources"] From 423dd9922720d74f6b5c81b1fcfd1243309c590e Mon Sep 17 00:00:00 2001 From: mickogeary Date: Mon, 26 Feb 2024 17:57:57 +0000 Subject: [PATCH 03/11] 3rd commit --- ...oc_deploying-stf-on-openshift-disconnected-environments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 072dfe26..3951e3c9 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -97,7 +97,7 @@ NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the $ oc get catalogsources ---- -* You have deployed {ProjectShort} and cannot access external networks. +* You have deployed {ProjectShort} in a disconnected {OpenShiftShort} cluster and therefore cannot access external networks. //// From a633a618816ebe856250c6c979296e116e2a6925 Mon Sep 17 00:00:00 2001 From: mickogeary Date: Thu, 29 Feb 2024 16:29:37 +0000 Subject: [PATCH 04/11] another commit from feedback. Added xref and removed openshiftshort as well as a few other changes --- common/global/stf-attributes.adoc | 2 - ...installing-the-core-components-of-stf.adoc | 2 +- .../modules/con_manifest-overrides.adoc | 2 +- ...tions-for-service-telemetry-framework.adoc | 2 +- .../modules/con_support-for-stf.adoc | 2 +- ...n-openshift-disconnected-environments.adoc | 41 +++++++++---------- .../proc_overriding-a-managed-manifest.adoc | 2 +- 7 files changed, 24 insertions(+), 29 deletions(-) diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 8627eb74..4060da23 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -39,7 +39,6 @@ endif::[] ifeval::["{build}" == "upstream"] :ObservabilityOperator: Observability{nbsp}Operator :OpenShift: OpenShift -:OpenShiftShort: OKD :OpenStack: OpenStack :OpenStackShort: OSP :OpenStackVersion: Wallaby @@ -58,7 +57,6 @@ endif::[] ifeval::["{build}" == "downstream"] :ObservabilityOperator: Cluster{nbsp}Observability{nbsp}Operator :OpenShift: Red{nbsp}Hat{nbsp}OpenShift{nbsp}Container{nbsp}Platform -:OpenShiftShort: OCP :OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform :OpenStackShort: RHOSP :OpenStackVersion: 17.1 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 10bdb89a..bbbbd7f9 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 @@ -24,7 +24,7 @@ ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] * An {OpenShift} Extended Update Support (EUS) release version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} is running. endif::[] * 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 about {ProjectShort} performance, see the Red Hat Knowledge Base article https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. -* Your environment is fully connected. {ProjectShort} does not work in a {OpenShift}-disconnected environments or network proxy environments. +* You have deployed {ProjectShort} in a fully connected or {OpenShift}-disconnected environments. {ProjectShort} is unavailable in network proxy environments. ifeval::["{build}" == "downstream"] [IMPORTANT] diff --git a/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc b/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc index 1b1159ba..1478ecb2 100644 --- a/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc @@ -26,7 +26,7 @@ = Customizing the deployment [role="_abstract"] -The Service Telemetry Operator watches for a `ServiceTelemetry` manifest to load into {OpenShift} ({OpenShiftShort}). The Operator then creates other objects in memory, which results in the dependent Operators creating the workloads they are responsible for managing. +The Service Telemetry Operator watches for a `ServiceTelemetry` manifest to load into {OpenShift}. The Operator then creates other objects in memory, which results in the dependent Operators creating the workloads they are responsible for managing. [WARNING] ==== diff --git a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc index b1d79eab..58706cc5 100644 --- a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc @@ -3,4 +3,4 @@ [id="con-network-considerations-for-service-telemetry-framework_{context}"] = Network considerations for Service Telemetry Framework -You can deploy {Project} ({ProjectShort}) in fully-connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. \ No newline at end of file +You can deploy {Project} ({ProjectShort}) in fully connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. \ No newline at end of file diff --git a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc index f9bc7c19..dff80c81 100644 --- a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc @@ -4,6 +4,6 @@ [role="_abstract"] Red Hat supports the core Operators and workloads, including {MessageBus}, {ObservabilityOperator} (Prometheus, Alertmanager), Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of Elasticsearch, Grafana, and their Operators. -You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. +You can deploy {Project} ({ProjectShort}) in fully connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. For more information about {ProjectShort} life cycle and support status, see the https://access.redhat.com/node/6225361[{Project} Supported Version Matrix]. diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 3951e3c9..cc26ee86 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -1,20 +1,20 @@ [id="deploying-stf-on-openshift-disconnected-environments_{context}"] -= Deploying {ProjectShort} on {OpenShiftShort}-disconnected environments += Deploying {ProjectShort} on {OpenShift}-disconnected environments [role="_abstract"] Since {Project} ({ProjectShort}) version 1.5.4, you can deploy {ProjectShort} in {OpenShift}-disconnected environments. .Prerequisites -* {OpenShift}({OpenShiftShort}) Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. -* A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registry for {OpenShiftShort}, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ Guide. -* All the {ProjectShort} dependencies are available in the {OpenShiftShort} cluster mirror registry. +* {OpenShift} Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. +* A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registries, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ guide. +* All the {ProjectShort} dependencies are available in the {OpenShift} cluster mirror registry. .Adding {ProjectShort} dependencies to the mirror registry -You can use the `oc-mirror` tool to fetch the {ProjectShort} dependencies and add them to the {OpenShiftShort} cluster mirror registry. For more information about installing the `oc-mirror` tool, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html-single/installing/index#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin] in the {OpenShiftShort} _Installing_ Guide. +You can use the `oc-mirror` plugin to fetch the {ProjectShort} dependencies and add them to the {OpenShift} cluster mirror registry. For more information about installing the `oc-mirror` plugin, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html-single/installing/index#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin] in the {OpenShift} _Installing_ guide. .Procedure @@ -51,17 +51,17 @@ mirror: ---- -. (Optional) If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShiftShort} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. +. (Optional) If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShift} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. + -You can use the oc-mirror plugin differently, depending on your environment, such as: +You can use the `oc-mirror` plugin differently, depending on your environment, such as: * mirroring between mirrors. -* mirror from mirror to disk +* mirror from mirror to disk. * mirror from disk to mirror. + -For more information about different oc-mirror scenarios, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] +For more information about different `oc-mirror` scenarios, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] in the {OpenShift} _Installing_ guide. . Push the {ProjectShort} operators and their dependencies from the mirror registry and generate the manifest for the OCP cluster. @@ -69,23 +69,28 @@ For more information about different oc-mirror scenarios, see: link:https://acce + [source,bash,options="nowrap",role="white-space-pre"] ---- -$ oc-mirror --config imagesetconfig.yaml <1> +$ oc-mirror --config imagesetconfig.yaml ---- + -* Replace with the filepath to the mirror registry that you want to use +* Replace with the filepath to the mirror registry that you want to use. + -. Locate the generated manifests and apply them to the target OCP cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.14/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] +. Locate the generated manifests and apply them to the target OCP cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. + -NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{osp_curr_ver}/html-single/service_telemetry_framework_1.5/index#assembly-installing-the-core-components-of-stf_assembly[Installing the core components of Service Telemetry Framework]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: xref:assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] + + + +//// [role="_additional-resources"] .Next steps * Continue to install {ProjectShort} as in a non-restricted network environment. +//// .Verification @@ -97,13 +102,5 @@ NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the $ oc get catalogsources ---- -* You have deployed {ProjectShort} in a disconnected {OpenShiftShort} cluster and therefore cannot access external networks. - +* You have deployed {ProjectShort} in a disconnected {OpenShift} cluster and therefore cannot access external networks. -//// - -[role="_additional-resources"] -.Additional resources - -* TBD -//// diff --git a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc index 0a7c8ec6..34d1972e 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc @@ -32,7 +32,7 @@ $ oc project service-telemetry $ oc edit servicetelemetry default ---- -. To modify the `ServiceTelemetry` object, provide a manifest override parameter and the contents of the manifest to write to {OpenShiftShort} instead of the defaults provided by {ProjectShort}. +. To modify the `ServiceTelemetry` object, provide a manifest override parameter and the contents of the manifest to write to {OpenShift} instead of the defaults provided by {ProjectShort}. + [NOTE] ==== From 288d5c50ec004fa2beaa2c6f7a2f673af791c2dd Mon Sep 17 00:00:00 2001 From: mickogeary Date: Fri, 1 Mar 2024 14:25:27 +0000 Subject: [PATCH 05/11] another push to fix broken xref --- ...c_deploying-stf-on-openshift-disconnected-environments.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index cc26ee86..0cf85583 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -79,7 +79,8 @@ $ oc-mirror --config imagesetconfig.yaml . Locate the generated manifests and apply them to the target OCP cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. + -NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: xref:assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions.For more information, see: xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] + From 12df3599076961c23deef791dd08e784e34a212d Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 5 Mar 2024 12:08:53 -0500 Subject: [PATCH 06/11] Update doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc --- ...oc_deploying-stf-on-openshift-disconnected-environments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 0cf85583..b0fcce55 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -64,7 +64,7 @@ You can use the `oc-mirror` plugin differently, depending on your environment, s For more information about different `oc-mirror` scenarios, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] in the {OpenShift} _Installing_ guide. -. Push the {ProjectShort} operators and their dependencies from the mirror registry and generate the manifest for the OCP cluster. +. Push the {ProjectShort} operators and their dependencies from the mirror registry and generate the manifest for the {OpenShift} cluster. + [source,bash,options="nowrap",role="white-space-pre"] From ac288c259ff222cb22da8bd3eca0ec0a7b275929 Mon Sep 17 00:00:00 2001 From: mickogeary Date: Tue, 5 Mar 2024 17:04:16 +0000 Subject: [PATCH 07/11] fix mentions of OCP --- ...oc_deploying-stf-on-openshift-disconnected-environments.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index b0fcce55..f5153b9d 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -76,7 +76,7 @@ $ oc-mirror --config imagesetconfig.yaml * Replace with the filepath to the mirror registry that you want to use. + -. Locate the generated manifests and apply them to the target OCP cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. +. Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. + NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions.For more information, see: xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] From 347a5f466d5505156ba5a43fb92556ee90def2d5 Mon Sep 17 00:00:00 2001 From: mickogeary Date: Tue, 5 Mar 2024 18:07:58 +0000 Subject: [PATCH 08/11] edits based on SME feedback --- ..._deploying-stf-on-openshift-disconnected-environments.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index f5153b9d..8c1e947c 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -24,6 +24,7 @@ You can use the `oc-mirror` plugin to fetch the {ProjectShort} dependencies and + [source,yaml,options="nowrap",role="white-space-pre"] ---- +$ oc create -f - < . Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. + -NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions.For more information, see: xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] From 5fc1ae711862f82cd149eff37ea69a8797f1ad2b Mon Sep 17 00:00:00 2001 From: mickogeary Date: Tue, 5 Mar 2024 19:03:00 +0000 Subject: [PATCH 09/11] more edits based on SME feedback --- ...n-openshift-disconnected-environments.adoc | 22 ++++--------------- 1 file changed, 4 insertions(+), 18 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 8c1e947c..5db7bb26 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -19,12 +19,11 @@ You can use the `oc-mirror` plugin to fetch the {ProjectShort} dependencies and .Procedure -. Create an `ImageSetConfiguration` resource to retrieve the {ProjectShort} dependencies: +. Create an imagesetconfig.yaml file in your local working directory: + [source,yaml,options="nowrap",role="white-space-pre"] ---- -$ oc create -f - < * Replace with the filepath to the mirror registry that you want to use. + -. Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see: link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. +. Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. + -NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see: xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] - - - - - - -//// -[role="_additional-resources"] -.Next steps - -* Continue to install {ProjectShort} as in a non-restricted network environment. -//// +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] .Verification From 7cd8eec9e0892f2b0b22a7e7b8356cca39484076 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 5 Mar 2024 14:20:53 -0500 Subject: [PATCH 10/11] Minor syntax clean up --- ...tf-on-openshift-disconnected-environments.adoc | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 5db7bb26..846d80a0 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -19,9 +19,9 @@ You can use the `oc-mirror` plugin to fetch the {ProjectShort} dependencies and .Procedure -. Create an imagesetconfig.yaml file in your local working directory: - +. Create an `imagesetconfig.yaml` file in your local working directory: + +.imagesetconfig.yaml [source,yaml,options="nowrap",role="white-space-pre"] ---- apiVersion: mirror.openshift.io/v1alpha2 @@ -52,39 +52,31 @@ mirror: . (Optional) If your mirror registry is not reachable, you can save the manifests and images that you fetched with `oc-mirror` and physically transfer them to the mirror registry and {OpenShift} cluster. Otherwise you can run `oc-mirror` and point to the mirror registry. - + You can use the `oc-mirror` plugin differently, depending on your environment, such as: - ++ * mirroring between mirrors. * mirror from mirror to disk. * mirror from disk to mirror. - + For more information about different `oc-mirror` scenarios, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#mirroring-image-set-full[Mirroring an image set in a fully disconnected environment] in the {OpenShift} _Installing_ guide. - . Push the {ProjectShort} operators and their dependencies from the mirror registry and generate the manifest for the {OpenShift} cluster. - + [source,bash,options="nowrap",role="white-space-pre"] ---- $ oc-mirror --config imagesetconfig.yaml ---- - + * Replace with the filepath to the mirror registry that you want to use. -+ . Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. - + NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] .Verification * Check that the catalog sources are applied. You can return the entries for new catalogs that reference the {ProjectShort} operators and their dependencies: - + [source,bash,options="nowrap",role="white-space-pre"] ---- @@ -92,4 +84,3 @@ $ oc get catalogsources ---- * You have deployed {ProjectShort} in a disconnected {OpenShift} cluster and therefore cannot access external networks. - From 38fbf51b7bcb2e6c380e600e733c67006b0b1f38 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 5 Mar 2024 14:25:07 -0500 Subject: [PATCH 11/11] Update doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc --- .../assembly_preparing-your-ocp-environment-for-stf.adoc | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc index b61bbf02..609dadf2 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc @@ -10,9 +10,6 @@ To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must * Ensure that you have persistent storage available in your {OpenShift} cluster for a production-grade deployment. For more information, see <>. * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <>. -//// -* Ensure that you have a fully connected network environment. For more information, see xref:con-network-considerations-for-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[]. -//// include::../modules/con_observability-strategy.adoc[leveloffset=+1] include::../modules/con_persistent-volumes.adoc[leveloffset=+1]