Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mg-master_RHOSPDOC-1200_STF-disconnected #531

Merged
merged 12 commits into from
Mar 5, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -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>>.
////
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
* 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[].
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
////
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
leifmadsen marked this conversation as resolved.
Show resolved Hide resolved

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:]
Original file line number Diff line number Diff line change
Expand Up @@ -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.
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@


[id="deploying-stf-on-openshift-disconnected-environments_{context}"]
= Deploying STF on OpenShift-disconnected environments
leifmadsen marked this conversation as resolved.
Show resolved Hide resolved

[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.
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
* All the {ProjectShort} dependencies are available in the {OpenShift} cluster mirror registry.

.Adding {ProjectShort} dependencies to the mirror registry
mickogeary marked this conversation as resolved.
Show resolved Hide resolved

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.
mickogeary marked this conversation as resolved.
Show resolved Hide resolved


.Procedure

. Create an `ImageSetConfiguration` resource to retrieve the {ProjectShort} dependencies:

mickogeary marked this conversation as resolved.
Show resolved Hide resolved
+
[source,yaml,options="nowrap",role="white-space-pre"]
----
apiVersion: mirror.openshift.io/v1alpha2
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
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
----

vkmc marked this conversation as resolved.
Show resolved Hide resolved
+
NOTE: This example is for {OpenShift} version 4.14.

vkmc marked this conversation as resolved.
Show resolved Hide resolved

vkmc marked this conversation as resolved.
Show resolved Hide resolved
. 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.

vkmc marked this conversation as resolved.
Show resolved Hide resolved
+
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].
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
mickogeary marked this conversation as resolved.
Show resolved Hide resolved



mickogeary marked this conversation as resolved.
Show resolved Hide resolved
////

mickogeary marked this conversation as resolved.
Show resolved Hide resolved
.Verification

mickogeary marked this conversation as resolved.
Show resolved Hide resolved
* TBD
mickogeary marked this conversation as resolved.
Show resolved Hide resolved

////

[role="_additional-resources"]
.Next steps

* Continue to install {ProjectShort} as in a non-restricted network environment.
mickogeary marked this conversation as resolved.
Show resolved Hide resolved

////

[role="_additional-resources"]
.Additional resources

* TBD
////
mickogeary marked this conversation as resolved.
Show resolved Hide resolved
Loading