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/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..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,13 +10,12 @@ 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_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 e22f0275..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 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/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 new file mode 100644 index 00000000..846d80a0 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -0,0 +1,86 @@ + + +[id="deploying-stf-on-openshift-disconnected-environments_{context}"] += 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} 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` 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 + +. 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 +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 +---- + + +. (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"] +---- +$ oc get catalogsources +---- + +* You have deployed {ProjectShort} in a disconnected {OpenShift} cluster and therefore cannot access external networks.