Skip to content

Commit

Permalink
another commit from feedback. Added xref and removed openshiftshort a…
Browse files Browse the repository at this point in the history 
…s well as a few other changes
  • Loading branch information
@mickogeary
mickogeary committed Feb 29, 2024
1 parent 423dd99 commit a633a61
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 29 deletions.
2 changes: 0 additions & 2 deletions common/global/stf-attributes.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ endif::[]
ifeval::["{build}" == "upstream"]
:ObservabilityOperator: Observability{nbsp}Operator
:OpenShift: OpenShift
:OpenShiftShort: OKD
:OpenStack: OpenStack
:OpenStackShort: OSP
:OpenStackVersion: Wallaby
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...emetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down
2 changes: 1 addition & 1 deletion ...amework/modules/con_network-considerations-for-service-telemetry-framework.adoc
View file
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 deploy {Project} ({ProjectShort}) in fully-connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in 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.
2 changes: 1 addition & 1 deletion doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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].
41 changes: 19 additions & 22 deletions ...ramework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc
View file
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -51,41 +51,46 @@ 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.

+
[source,bash,options="nowrap",role="white-space-pre"]
----
$ oc-mirror --config imagesetconfig.yaml <Mirror_Registry_Location><1>
$ oc-mirror --config imagesetconfig.yaml <mirror_registry_location>
----

+
* Replace <Mirror_Registry_Location> with the filepath to the mirror registry that you want to use
* 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]
. 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

Expand All @@ -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
////
2 changes: 1 addition & 1 deletion doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down

0 comments on commit a633a61

Please sign in to comment.