Skip to content

Commit 369dce6

Browse files
JoanneOFlynn2018leifmadsenmickogeary
authored
162 2118749 proxy disconnected (#391)
* Network considerations module + note insertion/clarification * Updated support message in multiple locations re disconnected proxy * Update doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc * Update doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc Co-authored-by: mickogeary <[email protected]> * Update doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc * Update doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc * Update doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: mickogeary <[email protected]>
1 parent e96c8cc commit 369dce6

4 files changed

+14
-31
lines changed

‎doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can use Operators to load the {Project} ({ProjectShort}) components and obje
1818

1919
* An {OpenShift} version inclusive of {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion} is running.
2020
* 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, see https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling].
21-
21+
* Your environment is fully connected. {ProjectShort} does not work in a {OpenShift}-disconnected environments or network proxy environments.
2222

2323
ifeval::["{build}" == "downstream"]
2424
[IMPORTANT]

‎doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc

+5-4
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@ ifdef::context[:parent-context: {context}]
66
:context: assembly-preparing-your-ocp-environment-for-stf
77

88
[role="_abstract"]
9-
To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must plan for persistent storage, adequate resources, and event storage:
9+
To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must plan for persistent storage, adequate resources, event storage, and network considerations:
1010

11-
* Ensure that persistent storage is available in your {OpenShift} cluster for a production grade deployment. For more information, see <<persistent-volumes_assembly-preparing-your-ocp-environment-for-stf>>.
11+
* 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>>.
1212
* 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>>.
13-
13+
* 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[].
1414
ifeval::["{build}" == "upstream"]
15-
* {ProjectShort} uses ElasticSearch to store events, which requires a larger than normal `vm.max_map_count`. The `vm.max_map_count` value is set by default in {OpenShift}. For more information about how to edit the value of `vm.max_map_count`, see <<node-tuning-operator_assembly-preparing-your-ocp-environment-for-stf>>.
15+
* {ProjectShort} uses Elasticsearch to store events, which requires a larger than normal `vm.max_map_count` value. The `vm.max_map_count` value is set by default in {OpenShift}. For more information about how to edit the value of `vm.max_map_count`, see <<node-tuning-operator_assembly-preparing-your-ocp-environment-for-stf>>.
1616
endif::[]
1717

1818
include::../modules/con_observability-strategy.adoc[leveloffset=+1]
1919
include::../modules/con_persistent-volumes.adoc[leveloffset=+1]
2020
include::../modules/con_ephemeral-storage.adoc[leveloffset=+2]
2121
include::../modules/con_resource-allocation.adoc[leveloffset=+1]
22+
include::../modules/con_network-considerations-for-service-telemetry-framework.adoc[leveloffset=+1]
2223

2324
ifeval::["{build}" == "upstream"]
2425
include::../modules/con_node-tuning-operator.adoc[leveloffset=+1]

‎doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
:_content-type: CONCEPT
2+
3+
[id="con-network-considerations-for-service-telemetry-framework_{context}"]
4+
= Network considerations for Service Telemetry Framework
5+
6+
You can only deploy {Project}({ProjectShort}) in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments.

‎doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc

+2-26
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
1-
// Module included in the following assemblies:
2-
//
3-
// <List assemblies here, each on a new line>
4-
5-
// This module can be included from assemblies using the following include statement:
6-
// include::<path>/con_support-for-project.adoc[leveloffset=+1]
7-
8-
// The file name and the ID are based on the module title. For example:
9-
// * file name: con_my-concept-module-a.adoc
10-
// * ID: [id='con_my-concept-module-a_{context}']
11-
// * Title: = My concept module A
12-
//
13-
// The ID is used as an anchor for linking to the module. Avoid changing
14-
// it after the module has been published to ensure existing links are not
15-
// broken.
16-
//
17-
// The `context` attribute enables module reuse. Every module's ID includes
18-
// {context}, which ensures that the module has a unique ID even if it is
19-
// reused multiple times in a guide.
20-
//
21-
// In the title, include nouns that are used in the body text. This helps
22-
// readers and search engines find information quickly.
23-
// Do not start the title with a verb. See also _Wording of headings_
24-
// in _The IBM Style Guide_.
251
[id="support-for-project_{context}"]
262
= Support for {Project}
273

284
[role="_abstract"]
295
Red Hat supports the two most recent versions of {Project} ({ProjectShort}). Earlier versions are not supported. For more information, see the https://access.redhat.com/articles/5662081[{Project} Supported Version Matrix].
306

31-
Red Hat supports the core Operators and workloads, including {MessageBus}, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of ElasticSearch, Prometheus, Alertmanager, Grafana, and their Operators.
7+
Red Hat supports the core Operators and workloads, including {MessageBus}, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, such as Elasticsearch, Prometheus, Alertmanager, Grafana, and their Operators.
328

33-
{ProjectShort} does not work in {OpenShift} disconnected environments due to dependencies on components that are not yet available for installation in a disconnected environment.
9+
You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments.

0 commit comments

Comments
 (0)