mg-master_RHOSPDOC-1200_STF-disconnected

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 <<persistent-volumes_assembly-preparing-your-ocp-environment-for-stf>>.
 * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <<resource-allocation_assembly-preparing-your-ocp-environment-for-stf>>.
+////
 * 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:]

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.

doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc

@@ -0,0 +1,109 @@
+
+
+[id="deploying-stf-on-openshift-disconnected-environments_{context}"]
+= 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}({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 {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
+
+. 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
+----
+
+
+. (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:
+
+* 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/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 <Mirror_Registry_Location><1>
+----
+
++
+* Replace <Mirror_Registry_Location> 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]
+
++
+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} in a disconnected {OpenShiftShort} cluster and therefore cannot access external networks.
+
+
+////
+
+[role="_additional-resources"]
+.Additional resources
+
+* TBD
+////