diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-3.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-3.adoc index a91da0ce..f2454894 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-3.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-3.adoc @@ -41,7 +41,7 @@ When the new Operators start, they reconcile the existing `ServiceTelemetry` and * To check the state of the Smart Gateway containers, use the `oc get pods` command: + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- oc get pods diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc index cdd6399f..e5b3732a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc @@ -46,7 +46,7 @@ ifdef::include_when_13[] * Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13[] + -[source,yaml,options="nowrap",subs="+quotes"] +[source,yaml,options="nowrap"] ---- parameter_defaults: MetricsQdrConnectors: diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-route-in-ocp.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-route-in-ocp.adoc index 2ff98671..662efcae 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-a-route-in-ocp.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-a-route-in-ocp.adoc @@ -47,7 +47,7 @@ $ oc project service-telemetry $ oc get services ---- + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE alertmanager-operated ClusterIP None 9093/TCP,9094/TCP,9094/UDP 93m @@ -64,7 +64,7 @@ smart-gateway-operator-metrics ClusterIP 172.30.145.199 . Expose the `prometheus-operated` service as an edge route and redirect insecure traffic to the secure endpoint of port `9090`: + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ oc create route edge metrics-store --service=prometheus-operated --insecure-policy="Redirect" --port=9090 ---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc index 89a3040d..6868790b 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc @@ -143,7 +143,7 @@ spec: $ oc logs --selector name=service-telemetry-operator ---- + -[options="nowrap", subs="+quotes"] +[options="nowrap"] ---- --------------------------- Ansible Task Status Event StdOut ----------------- @@ -156,7 +156,7 @@ localhost : ok=54 changed=0 unreachable=0 failed=0 s NOTE: If you set `backends.events.elasticsearch.enabled: true`, the notification Smart Gateways reports `Error` and `CrashLoopBackOff` error messages for a period of time before ElasticSearch starts. + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ oc get pods diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc index f9048e5e..32ecf495 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc @@ -123,6 +123,8 @@ endif::include_when_16[] [WARNING] If you use the `collectd-write-qdr.yaml` file with a custom `CollectdAmqpInstances` parameter, data publishes to the custom and default topics. In a multiple cloud environment, the configuration of the `resource_registry` parameter in the `stf-connectors.yaml` file loads the collectd service. + +// valid use of +quotes subs for rendering emphasis ++ [source,bash,options="nowrap",subs="+quotes"] ---- (undercloud) [stack@undercloud-0 ~]$ openstack overcloud deploy __ diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc index d9512261..4afba5ce 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc @@ -41,7 +41,7 @@ To enable collection of telemetry with {ProjectShort} and Gnocchi, see xref:send ==== + ifdef::include_when_13[] -[source,yaml,options="nowrap",subs="+quotes"] +[source,yaml,options="nowrap"] ---- parameter_defaults: # only send to STF, not other publishers @@ -117,7 +117,7 @@ parameter_defaults: ---- endif::include_when_13[] ifdef::include_when_16[] -[source,yaml,options="nowrap",subs="+quotes"] +[source,yaml,options="nowrap"] ---- parameter_defaults: # only send to STF, not other publishers diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc index cddcef33..bf8fd097 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc @@ -48,6 +48,8 @@ Deploy or update the overcloud with the required environment files to result in * the `enable-stf.yaml` environment file to ensure defaults are set up correctly * the `stf-connectors.yaml` environment file to define the connection to {ProjectShort} + +// this one is actually a valid use of subs +quotes. We want the underbars to result in emphasis when generated. ++ [source,bash,options="nowrap",subs="+quotes"] ---- (undercloud) [stack@undercloud-0 ~]$ openstack overcloud deploy __ diff --git a/doc-Service-Telemetry-Framework/modules/proc_enabling-infrawatch-catalog-source.adoc b/doc-Service-Telemetry-Framework/modules/proc_enabling-infrawatch-catalog-source.adoc index 058fc8f6..16f03c28 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_enabling-infrawatch-catalog-source.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_enabling-infrawatch-catalog-source.adoc @@ -54,7 +54,7 @@ EOF . Validate the creation of your CatalogSource: + -[source,options="nowrap",subs="+quotes"] +[source,options="nowrap"] ---- $ oc get -nopenshift-marketplace catalogsource infrawatch-operators @@ -67,7 +67,7 @@ infrawatch-operators InfraWatch Operators grpc InfraWatch 2m16s . Validate that the Operators are available from the catalog: + -[source,options="nowrap",subs="+quotes"] +[source,options="nowrap"] ---- $ oc get packagemanifests | grep InfraWatch diff --git a/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc index babbdcfc..387c8f0b 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc @@ -37,7 +37,7 @@ parameter_defaults: . Add the environment file `gnocchi-connectors.yaml` to the deployment command. Replace __ with files that are applicable to your environment. + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ openstack overcloud deploy __ --templates /usr/share/openstack-tripleo-heat-templates \ @@ -52,7 +52,7 @@ $ openstack overcloud deploy __ . To verify that the configuration was successful, verify the content of the file `/var/lib/config-data/puppet-generated/ceilometer/etc/ceilometer/pipeline.yaml` on a Controller node. Ensure that the `publishers` section of the file contains information for both notifier and Gnocchi. + -[source,yaml,options="nowrap",subs="+quotes"] +[source,yaml,options="nowrap"] ---- sources: - name: meter_source diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc index 10cdb521..bf1adb0a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc @@ -61,7 +61,7 @@ EOF . To verify that the operator launched successfully, run the `oc get csv` command. If the value of the PHASE column is `Succeeded`, the operator launched successfully: + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ oc get csv diff --git a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc index 41d1ff8c..f094a0db 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc @@ -75,7 +75,7 @@ EOF . Validate your `ClusterServiceVersion`: + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ oc get --namespace openshift-operators csv diff --git a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-elastic-cloud-on-kubernetes-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-elastic-cloud-on-kubernetes-operator.adoc index 8c3e18aa..d50dbbe6 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-elastic-cloud-on-kubernetes-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-elastic-cloud-on-kubernetes-operator.adoc @@ -49,7 +49,7 @@ EOF . Verify that the `ClusterServiceVersion` for ElasticSearch Cloud on Kubernetes `Succeeded`: + -[source,options="nowrap",subs="+quotes"] +[source,options="nowrap"] ---- $ oc get csv diff --git a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-service-telemetry-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-service-telemetry-operator.adoc index d0cf888e..229d639b 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-service-telemetry-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_subscribing-to-the-service-telemetry-operator.adoc @@ -70,7 +70,7 @@ endif::[] . To validate the Service Telemetry Operator and the dependent operators, enter the following command: + -[source,bash,options="nowrap",subs="+quotes"] +[source,bash,options="nowrap"] ---- $ oc get csv --namespace service-telemetry