Merge pull request #94989 from tmalove/ms-osdocs-14992-tlove

ShaunaDiaz · web-flow · commit 3fdef436a049 · 2025-08-18T11:32:26.000-04:00
OSDOCS#14992: Update the config topics and deleted the start-service module
diff --git a/modules/microshift-otel-config-large.adoc b/modules/microshift-otel-config-large.adoc
@@ -8,6 +8,8 @@
 
 You can configure {microshift-short} Observability to collect the maximum amount of performance and resource information, from the maximum number of sources, by updating the YAML file.
 
+.Procedure
+
 . Select a large configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file. `Large` is the default configuration.
 +
 [source,yaml]
@@ -119,8 +121,14 @@ service:
             exporter:
               otlp:
                 protocol: http/protobuf
-                endpoint: http://${env:OTEL_BACKEND}:4318 <1>
+                endpoint: http://${env:OTEL_BACKEND}:4318 <2>
 ----
-<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the `microshift-observability` service logs.
+<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
+<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
 
-. Restart {microshift-short} Observability to complete the configuration selection.
+. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
++
+[source,terminal]
+----
+$ sudo systemctl restart microshift-observability
+----
diff --git a/modules/microshift-otel-config-medium.adoc b/modules/microshift-otel-config-medium.adoc
@@ -8,6 +8,8 @@
 
 You can configure {microshift-short} Observability to collect performance and resource information from various sources by updating the YAML file.
 
+.Procedure
+
 . Select a medium configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file:
 +
 [source,yaml]
@@ -68,8 +70,14 @@ service:
             exporter:
               otlp:
                 protocol: http/protobuf
-                endpoint: http://${env:OTEL_BACKEND}:4318 <1>
+                endpoint: http://${env:OTEL_BACKEND}:4318 <2>
 ----                
-<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the `microshift-observability` service logs.
+<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
+<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the `microshift-observability` service logs.
 
-. Restart {microshift-short} Observability to complete the configuration selection.
+. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
++
+[source,terminal]
+----
+$ sudo systemctl restart microshift-observability
+----
diff --git a/modules/microshift-otel-config-small.adoc b/modules/microshift-otel-config-small.adoc
@@ -8,6 +8,8 @@
 
 You can configure {microshift-short} Observability to collect the smallest amount of performance and resource information from various sources by updating the YAML file.
 
+.Procedure
+
 . Select a small configuration by adding the following information to the `/etc/microshift/observability/opentelemetry-collector.yaml` file:
 +
 [source,yaml]
@@ -60,8 +62,14 @@ service:
             exporter:
               otlp:
                 protocol: http/protobuf
-                endpoint: http://${env:OTEL_BACKEND}:4318 <1>
+                endpoint: http://${env:OTEL_BACKEND}:4318 <2>
 ----
-<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. Any unreachable endpoint is reported in the {microshift-short} service logs.
+<1> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the {microshift-short} service logs.
+<2> Replace the variable `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. Any unreachable endpoint is reported in the {microshift-short} service logs.
 
-. Restart {microshift-short} Observability to complete the configuration selection.
+. Restart {microshift-short} Observability to complete the configuration selection by entering the following command:
++
+[source,terminal]
+----
+$ sudo systemctl restart microshift-observability
+----
diff --git a/modules/microshift-otel-config.adoc b/modules/microshift-otel-config.adoc
@@ -35,10 +35,11 @@ service:
             exporter:
               otlp:
                 protocol: http/protobuf
-                endpoint: http://${env:OTEL_BACKEND}:4318 <1>
+                endpoint: http://${env:OTEL_BACKEND}:4318 <2>
 # ...                
 ----  
-<1> Replace `${env:OTEL_BACKEND}` with the IP address or host name of the remote back end. This IP address resolves to the local node's host name. An unreachable endpoint is reported in the {microshift-short} service logs.    
+<1> Replace `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. An unreachable endpoint is reported in the {microshift-short} service logs.
+<2> Replace `${env:OTEL_BACKEND}` with the IP address or hostname of the remote back end. This IP address resolves to the local node's hostname. An unreachable endpoint is reported in the {microshift-short} service logs.    
 
 . Each time that you update the `opentelemetry-collector.yaml` file, you must restart {microshift-short} Observability to apply the updates.
 +
