diff --git a/common/saf-attributes.adoc b/common/stf-attributes.adoc similarity index 100% rename from common/saf-attributes.adoc rename to common/stf-attributes.adoc diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_completing-the-saf-configuration.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_completing-the-stf-configuration.adoc similarity index 86% rename from doc-Service-Assurance-Framework/assemblies/assembly_completing-the-saf-configuration.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_completing-the-stf-configuration.adoc index 137ac2ef..63c780e8 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_completing-the-saf-configuration.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_completing-the-stf-configuration.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_completing-the-saf-configuration.adoc[leveloffset=+1] +// include::/assembly_completing-the-stf-configuration.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-completing-the-saf-configuration: {context} +:parent-context-of-completing-the-stf-configuration: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='completing-the-saf-configuration_{context}'] +[id='completing-the-stf-configuration_{context}'] = Completing the {Project} configuration // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: completing-the-saf-configuration +:context: completing-the-stf-configuration // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -44,9 +44,9 @@ include::../modules/proc_setting-up-openstack-on-the-client-side.adoc[leveloffset=+1] -include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc[leveloffset=+1] -include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf-events.adoc[leveloffset=+1] -include::../modules/proc_updating-red-hat-openstack-platform-overcloud-for-saf.adoc[leveloffset=+1] +include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1] +include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-events.adoc[leveloffset=+1] +include::../modules/proc_updating-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1] include::../modules/proc_deploying-with-routed-l3-networks.adoc[leveloffset=+2] include::../modules/con_conclusion.adoc[leveloffset=+1] diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_configuring-saf-components.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_configuring-stf-components.adoc similarity index 91% rename from doc-Service-Assurance-Framework/assemblies/assembly_configuring-saf-components.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_configuring-stf-components.adoc index eb9207b2..bb4d4155 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_configuring-saf-components.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_configuring-stf-components.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_configuring-saf-components.adoc[leveloffset=+1] +// include::/assembly_configuring-stf-components.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-configuring-saf-components: {context} +:parent-context-of-configuring-stf-components: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='configuring-saf-components_{context}'] +[id='configuring-stf-components_{context}'] = Configuring {Project} data collection // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: configuring-saf-components +:context: configuring-stf-components // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -61,7 +61,7 @@ $ openstack overcloud deploy -e /home/templates/custom/collectd-environment.yaml ---- + -To view the collectd plug-ins and configurations, see <>. +To view the collectd plug-ins and configurations, see <>. //include::../common/collectd/con_data-collecting-agent.adoc[leveloffset=+1] diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-saf.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-stf.adoc similarity index 87% rename from doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-saf.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-stf.adoc index 43fb3567..da745368 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-saf.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_connecting-multiple-clouds-to-stf.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_connecting-multiple-clouds-to-saf.adoc[leveloffset=+1] +// include::/assembly_connecting-multiple-clouds-to-stf.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-connecting-multiple-clouds-to-saf: {context} +:parent-context-of-connecting-multiple-clouds-to-stf: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='connecting-multiple-clouds-to-saf_{context}'] +[id='connecting-multiple-clouds-to-stf_{context}'] = Connecting multiple clouds to {Project} // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: connecting-multiple-clouds-to-saf +:context: connecting-multiple-clouds-to-stf // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -48,4 +48,4 @@ include::../modules/proc_using-the-amq-interconnect-message-bus.adoc[leveloffset -:context: {parent-context-of-connecting-multiple-clouds-to-saf} +:context: {parent-context-of-connecting-multiple-clouds-to-stf} diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-saf.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc similarity index 79% rename from doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-saf.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index e145d00c..c8b52640 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-saf.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_installing-the-core-components-of-saf.adoc[leveloffset=+1] +// include::/assembly_installing-the-core-components-of-stf.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-installing-the-core-components-of-saf: {context} +:parent-context-of-installing-the-core-components-of-stf: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='installing-the-core-components-of-saf_{context}'] +[id='installing-the-core-components-of-stf_{context}'] = Installing the core components of {Project} // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: installing-the-core-components-of-saf +:context: installing-the-core-components-of-stf // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -45,9 +45,9 @@ This section describes the prerequisites required for a successful {Project} ({ProjectShort}) installation and describes the installation of the core {ProjectShort} components. -include::../modules/proc_prerequisites-for-saf-deployment.adoc[leveloffset=+1] -include::../modules/con_the-core-components-of-saf.adoc[leveloffset=+1] -include::../modules/proc_preparing-your-openshift-environment-for-saf.adoc[leveloffset=+1] +include::../modules/proc_prerequisites-for-stf-deployment.adoc[leveloffset=+1] +include::../modules/con_the-core-components-of-stf.adoc[leveloffset=+1] +include::../modules/proc_preparing-your-openshift-environment-for-stf.adoc[leveloffset=+1] ifeval::["{build}" == "upstream"] include::../modules/proc_quickstart-script-for-development-usage.adoc[leveloffset=+1] @@ -59,8 +59,8 @@ endif::[] include::../modules/proc_generating-a-tls-certificate-for-amq-interconnect.adoc[leveloffset=+1] include::../modules/proc_generating-tls-certificates-for-elasticsearch.adoc[leveloffset=+1] -include::../modules/proc_deploying-saf-to-the-openshift-environment.adoc[leveloffset=+1] +include::../modules/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] -include::../modules/proc_importing-the-container-images-for-saf.adoc[leveloffset=+2] -include::../modules/proc_generating-the-manifests-for-saf.adoc[leveloffset=+2] -include::../modules/proc_installing-saf-components-using-a-script.adoc[leveloffset=+2] +include::../modules/proc_importing-the-container-images-for-stf.adoc[leveloffset=+2] +include::../modules/proc_generating-the-manifests-for-stf.adoc[leveloffset=+2] +include::../modules/proc_installing-stf-components-using-a-script.adoc[leveloffset=+2] diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-service-assurance-framework.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-stf.adoc similarity index 80% rename from doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-service-assurance-framework.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-stf.adoc index 16fe69b4..b33a5937 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-service-assurance-framework.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_introduction-to-stf.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_introduction-to-service-assurance-framework.adoc[leveloffset=+1] +// include::/assembly_introduction-to-stf.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-introduction-to-service-assurance-framework: {context} +:parent-context-of-introduction-to-stf: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='introduction-to-service-assurance-framework_{context}'] +[id='introduction-to-stf_{context}'] = Introduction to {Project} // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: introduction-to-service-assurance-framework +:context: introduction-to-stf // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -39,7 +39,7 @@ This section describes {Project} and the framework architecture. -include::../modules/con_overview-of-service-assurance-framework.adoc[leveloffset=+1] +include::../modules/con_overview-of-stf.adoc[leveloffset=+1] include::../modules/con_architecture.adoc[leveloffset=+1] diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_saf-appendices.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_stf-appendices.adoc similarity index 89% rename from doc-Service-Assurance-Framework/assemblies/assembly_saf-appendices.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_stf-appendices.adoc index b5a71eea..3316ed8a 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_saf-appendices.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_stf-appendices.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_saf-appendices.adoc[leveloffset=+1] +// include::/assembly_stf-appendices.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-saf-appendices: {context} +:parent-context-of-stf-appendices: {context} // The file name and the ID are based on the assembly title. // For example: @@ -26,13 +26,13 @@ // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='saf-appendices_{context}'] +[id='stf-appendices_{context}'] // = SAF Appendices // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: saf-appendices +:context: stf-appendices // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. diff --git a/doc-Service-Assurance-Framework/assemblies/assembly_saf.adoc b/doc-Service-Assurance-Framework/assemblies/assembly_stf.adoc similarity index 95% rename from doc-Service-Assurance-Framework/assemblies/assembly_saf.adoc rename to doc-Service-Assurance-Framework/assemblies/assembly_stf.adoc index 493d8b2e..3ee96f99 100644 --- a/doc-Service-Assurance-Framework/assemblies/assembly_saf.adoc +++ b/doc-Service-Assurance-Framework/assemblies/assembly_stf.adoc @@ -4,11 +4,11 @@ // This assembly can be included from other assemblies using the following // include statement: -// include::/assembly_saf.adoc[leveloffset=+1] +// include::/assembly_stf.adoc[leveloffset=+1] // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:parent-context-of-saf: {context} +:parent-context-of-stf: {context} // The file name and the ID are based on the assembly title. // For example: @@ -25,13 +25,13 @@ // // If the assembly covers a task, start the title with a verb in the gerund // form, such as Creating or Configuring. -[id='saf_{context}'] +[id='stf_{context}'] = SAF // The `context` attribute enables module reuse. Every module's ID // includes {context}, which ensures that the module has a unique ID even if // it is reused multiple times in a guide. -:context: saf +:context: stf // The following block is rendered only if the `internal` variable is set. // The table shows various metadata useful when editing this file. @@ -86,5 +86,5 @@ Include modules here. // The following line is necessary to allow assemblies be included in other // assemblies. It restores the `context` variable to its previous state. -:context: {parent-context-of-saf} +:context: {parent-context-of-stf} diff --git a/doc-Service-Assurance-Framework/docinfo.xml b/doc-Service-Assurance-Framework/docinfo.xml index 3c5c3fc5..8c2bab7f 100644 --- a/doc-Service-Assurance-Framework/docinfo.xml +++ b/doc-Service-Assurance-Framework/docinfo.xml @@ -1,11 +1,11 @@ -Service Assurance Framework -Installing and deploying Service Assurance Framework +Service Telemetry Framework +Installing and deploying Service Telemetry Framework Red Hat OpenStack Platform 13 0 - This guide contains information about installing the core components and deploying Service Assurance Framework. + This guide contains information about installing the core components and deploying Service Telemetry Framework. diff --git a/doc-Service-Assurance-Framework/master.adoc b/doc-Service-Assurance-Framework/master.adoc index 0024b559..6584dfa1 100644 --- a/doc-Service-Assurance-Framework/master.adoc +++ b/doc-Service-Assurance-Framework/master.adoc @@ -8,17 +8,17 @@ OpenStack Documentation Team :director-guide: true :context: osp -include::common/saf-attributes.adoc[] +include::common/stf-attributes.adoc[] -include::assemblies/assembly_introduction-to-service-assurance-framework.adoc[leveloffset=+1] +include::assemblies/assembly_introduction-to-stf.adoc[leveloffset=+1] -include::assemblies/assembly_installing-the-core-components-of-saf.adoc[leveloffset=+1] +include::assemblies/assembly_installing-the-core-components-of-stf.adoc[leveloffset=+1] -include::assemblies/assembly_completing-the-saf-configuration.adoc[leveloffset=+1] +include::assemblies/assembly_completing-the-stf-configuration.adoc[leveloffset=+1] -include::assemblies/assembly_configuring-saf-components.adoc[leveloffset=+1] +include::assemblies/assembly_configuring-stf-components.adoc[leveloffset=+1] -include::assemblies/assembly_connecting-multiple-clouds-to-saf.adoc[leveloffset=+1] +include::assemblies/assembly_connecting-multiple-clouds-to-stf.adoc[leveloffset=+1] //appendix diff --git a/doc-Service-Assurance-Framework/modules/con_overview-of-service-assurance-framework.adoc b/doc-Service-Assurance-Framework/modules/con_overview-of-stf.adoc similarity index 91% rename from doc-Service-Assurance-Framework/modules/con_overview-of-service-assurance-framework.adoc rename to doc-Service-Assurance-Framework/modules/con_overview-of-stf.adoc index ddc91919..05a42dfb 100644 --- a/doc-Service-Assurance-Framework/modules/con_overview-of-service-assurance-framework.adoc +++ b/doc-Service-Assurance-Framework/modules/con_overview-of-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/con_overview-of-service-assurance-framework.adoc[leveloffset=+1] +// include::/con_overview-of-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: con_my-concept-module-a.adoc @@ -22,7 +22,7 @@ // readers and search engines find information quickly. // Do not start the title with a verb. See also _Wording of headings_ // in _The IBM Style Guide_. -[id='overview-of-service-assurance-framework_{context}'] +[id='overview-of-stf_{context}'] = Overview of {Project} ifeval::["{build}" == "downstream"] diff --git a/doc-Service-Assurance-Framework/modules/con_the-core-components-of-saf.adoc b/doc-Service-Assurance-Framework/modules/con_the-core-components-of-stf.adoc similarity index 87% rename from doc-Service-Assurance-Framework/modules/con_the-core-components-of-saf.adoc rename to doc-Service-Assurance-Framework/modules/con_the-core-components-of-stf.adoc index 5906229f..879690b0 100644 --- a/doc-Service-Assurance-Framework/modules/con_the-core-components-of-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/con_the-core-components-of-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_installing-the-core-components-of-saf.adoc[leveloffset=+1] +// include::/proc_installing-the-core-components-of-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='installing-the-core-components-of-saf_{context}'] +[id='installing-the-core-components-of-stf_{context}'] = The core components of {ProjectShort} When you install {ProjectShort}, use the `oc` tool or web interface to load Kubernetes @@ -50,16 +50,16 @@ application components and objects. To prepare your environment for {ProjectShort}, complete the following procedures: -. Prepare your {OpenShiftShort} environment for {ProjectShort}. For more information, see <>. +. Prepare your {OpenShiftShort} environment for {ProjectShort}. For more information, see <>. ifeval::["{build}" == "downstream"] -. Create an RHCC Secret. For more information, see <>. +. Create an RHCC Secret. For more information, see <>. endif::[] . Generate a TLS certificate for {MessageBus}. For more information, see -<>. +<>. . Generate TLS certificates for ElasticSearch. For more information, see -<>. +<>. -. Deploy {ProjectShort} to the {OpenShiftShort} environment. For more information, see <>. +. Deploy {ProjectShort} to the {OpenShiftShort} environment. For more information, see <>. diff --git a/doc-Service-Assurance-Framework/modules/proc_configuring-multiple-clouds.adoc b/doc-Service-Assurance-Framework/modules/proc_configuring-multiple-clouds.adoc index 7730b4ae..d1fd1456 100644 --- a/doc-Service-Assurance-Framework/modules/proc_configuring-multiple-clouds.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_configuring-multiple-clouds.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_configuring-saf-for-multi-cloud.adoc[leveloffset=+1] +// include::/proc_configuring-stf-for-multi-cloud.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -25,12 +25,12 @@ To configure multiple {OpenStack} clouds to target a single instance of {Project} ({ProjectShort}), complete the following tasks: -. Plan the AMQP address prefixes to use for each cloud. For more information, see <>. +. Plan the AMQP address prefixes to use for each cloud. For more information, see <>. . Deploy metrics and events consumer Smart Gateways for each cloud to listen on - the corresponding address prefixes. For more information, see <>. -. Optional: Delete the default Smart Gateways if they are no longer needed. For more information, see <>. + the corresponding address prefixes. For more information, see <>. +. Optional: Delete the default Smart Gateways if they are no longer needed. For more information, see <>. . Configure each cloud to send its metrics and events to {ProjectShort} on the - correct address. For more information, see <>. + correct address. For more information, see <>. This diagram demonstrates how two {OpenStack} clouds connect to {ProjectShort}. diff --git a/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf-events.adoc b/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-events.adoc similarity index 90% rename from doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf-events.adoc rename to doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-events.adoc index 66d5638e..e35f62db 100644 --- a/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf-events.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-events.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc[leveloffset=+1] +// include::/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,11 +20,11 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='configuring-red-hat-openstack-platform-overcloud-for-saf-events_{context}'] +[id='configuring-red-hat-openstack-platform-overcloud-for-stf-events_{context}'] = Configuring the {OpenStack} overcloud for {ProjectShort} events To enable the collection of events on the client side, follow the steps in -<> and use the following sample from `metrics-collectd-qdr-overrides.yaml` for this procedure. +<> and use the following sample from `metrics-collectd-qdr-overrides.yaml` for this procedure. You can pass the `metrics-collectd-qdr-overrides.yaml` environment file to a {OpenstackLong} {OpenStackInstaller} deployment to configure and setup collectd and {MessageBus}. .metrics-collectd-qdr-overrides.yaml diff --git a/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc b/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc similarity index 96% rename from doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc rename to doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc index a7b9e298..9d1eee15 100644 --- a/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_configuring-red-hat-openstack-platform-overcloud-for-saf.adoc[leveloffset=+1] +// include::/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='configuring-red-hat-openstack-platform-overcloud-for-saf_{context}'] +[id='configuring-red-hat-openstack-platform-overcloud-for-stf_{context}'] = Configuring {OpenStack} overcloud for {ProjectShort} diff --git a/doc-Service-Assurance-Framework/modules/proc_deleting-the-default-smart-gateways.adoc b/doc-Service-Assurance-Framework/modules/proc_deleting-the-default-smart-gateways.adoc index 65a2d301..8ed94c48 100644 --- a/doc-Service-Assurance-Framework/modules/proc_deleting-the-default-smart-gateways.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_deleting-the-default-smart-gateways.adoc @@ -40,4 +40,4 @@ rm deploy/service-assurance/smartgateway/{events,metrics}-smartgateway.yaml ---- [NOTE] -To regenerate the default manifests, re-run the <> step. +To regenerate the default manifests, re-run the <> step. diff --git a/doc-Service-Assurance-Framework/modules/proc_deploying-smart-gateways.adoc b/doc-Service-Assurance-Framework/modules/proc_deploying-smart-gateways.adoc index 410ba95a..2b727e3b 100644 --- a/doc-Service-Assurance-Framework/modules/proc_deploying-smart-gateways.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_deploying-smart-gateways.adoc @@ -29,7 +29,7 @@ When you deploy {ProjectShort} for the first time, two Smart Gateway manifests a To deploy multiple Smart Gateways, complete the following steps: -. Copy the following Smart Gateway manifests and edit them to define a Smart Gateway for each cloud: `deploy/service-assurance/smartgateway/metrics-smartgateway.yaml` and `deploy/service-assurance/smartgateway/events-smartgateway.yaml`. For more information, see <>. +. Copy the following Smart Gateway manifests and edit them to define a Smart Gateway for each cloud: `deploy/service-assurance/smartgateway/metrics-smartgateway.yaml` and `deploy/service-assurance/smartgateway/events-smartgateway.yaml`. For more information, see <>. + ---- pushd deploy/service-assurance/smartgateway/ diff --git a/doc-Service-Assurance-Framework/modules/proc_deploying-saf-to-the-openshift-environment.adoc b/doc-Service-Assurance-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc similarity index 79% rename from doc-Service-Assurance-Framework/modules/proc_deploying-saf-to-the-openshift-environment.adoc rename to doc-Service-Assurance-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc index 9588afb2..953cda2a 100644 --- a/doc-Service-Assurance-Framework/modules/proc_deploying-saf-to-the-openshift-environment.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_deploying-saf-to-the-openshift-environment.adoc[leveloffset=+1] +// include::/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='deploying-saf-to-the-openshift-environment_{context}'] +[id='deploying-stf-to-the-openshift-environment_{context}'] = Deploying {ProjectShort} to the {OpenShiftShort} environment To deploy {ProjectShort} to an {OpenShiftShort} environment, complete the @@ -28,12 +28,12 @@ following tasks: . Import the {build} container images into the `sa-telemetry` namespace by using the _import-{build}.sh_ script. For more information, see -<>. +<>. . Generate the custom manifests by using the Ansible playbook `deploy_builder.yaml` and using the `ansible-playbook` command. For more information, -see <>. +see <>. . Execute the `deploy.sh` script to create the Kubernetes objects in the {OpenShiftShort} environment. For more information, see -<>. +<>. diff --git a/doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-saf.adoc b/doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-stf.adoc similarity index 93% rename from doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-saf.adoc rename to doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-stf.adoc index d6adfb31..84d09445 100644 --- a/doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_generating-the-manifests-for-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_generating-the-manifests-for-saf.adoc[leveloffset=+1] +// include::/proc_generating-the-manifests-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id="generating-the-manifests-for-saf_{context}"] +[id="generating-the-manifests-for-stf_{context}"] = Generating the manifests for {ProjectShort} Several of the manifests that are required for deployment are dynamically generated by diff --git a/doc-Service-Assurance-Framework/modules/proc_generating-tls-certificates-for-elasticsearch.adoc b/doc-Service-Assurance-Framework/modules/proc_generating-tls-certificates-for-elasticsearch.adoc index 3433f282..71097302 100644 --- a/doc-Service-Assurance-Framework/modules/proc_generating-tls-certificates-for-elasticsearch.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_generating-tls-certificates-for-elasticsearch.adoc @@ -26,7 +26,7 @@ To connect the Smart Gateway to ElasticSearch for events storage, generate certificates and load them as a secret into {OpenShiftShort}. . Generate the unsigned certificates. If you have signed certificates to load -into {OpenShiftShort}, go to <>. +into {OpenShiftShort}, go to <>. + ---- WORKING_DIR=./es-certs \ # <1> diff --git a/doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-saf.adoc b/doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-stf.adoc similarity index 91% rename from doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-saf.adoc rename to doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-stf.adoc index 440c9b0c..2db54777 100644 --- a/doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_importing-the-container-images-for-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_importing-the-container-images-for-saf.adoc[leveloffset=+1] +// include::/proc_importing-the-container-images-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='importing-the-container-images-for-saf_{context}'] +[id='importing-the-container-images-for-stf_{context}'] = Importing the container images for {ProjectShort} To import the container images as image streams into {OpenShiftShort}, run the diff --git a/doc-Service-Assurance-Framework/modules/proc_installing-saf-components-using-a-script.adoc b/doc-Service-Assurance-Framework/modules/proc_installing-stf-components-using-a-script.adoc similarity index 90% rename from doc-Service-Assurance-Framework/modules/proc_installing-saf-components-using-a-script.adoc rename to doc-Service-Assurance-Framework/modules/proc_installing-stf-components-using-a-script.adoc index 038d2409..1080a5e8 100644 --- a/doc-Service-Assurance-Framework/modules/proc_installing-saf-components-using-a-script.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_installing-stf-components-using-a-script.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_installing-saf-components-using-a-script.adoc[leveloffset=+1] +// include::/proc_installing-stf-components-using-a-script.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id="installing-saf-components-using-a-script_{context}"] +[id="installing-stf-components-using-a-script_{context}"] = Installing {ProjectShort} components using a script image::STF_Overview_37_0819_deployment_manually.png[] @@ -37,7 +37,7 @@ to create the namespace. . Extract the contents of the telemetry-framework release archive and change to the extracted directory. For more information, see -<>. +<>. Use the `deploy.sh` script in the `deploy/` directory of the telemetry-framework release file that you previously extracted. Run the script to start the various components in your {OpenShiftShort} deployment. To remove the components, supply the `DELETE` argument to the script. diff --git a/doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-saf.adoc b/doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-stf.adoc similarity index 96% rename from doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-saf.adoc rename to doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-stf.adoc index 4baa4f45..2ac73642 100644 --- a/doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_preparing-your-openshift-environment-for-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_preparing-your-openshift-environment-for-saf.adoc[leveloffset=+1] +// include::/proc_preparing-your-openshift-environment-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='preparing-your-openshift-environment-for-saf_{context}'] +[id='preparing-your-openshift-environment-for-stf_{context}'] = Preparing your {OpenShiftShort} environment for {ProjectShort} Complete the following steps: diff --git a/doc-Service-Assurance-Framework/modules/proc_prerequisites-for-saf-deployment.adoc b/doc-Service-Assurance-Framework/modules/proc_prerequisites-for-stf-deployment.adoc similarity index 89% rename from doc-Service-Assurance-Framework/modules/proc_prerequisites-for-saf-deployment.adoc rename to doc-Service-Assurance-Framework/modules/proc_prerequisites-for-stf-deployment.adoc index 9c9fba6e..21e0b142 100644 --- a/doc-Service-Assurance-Framework/modules/proc_prerequisites-for-saf-deployment.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_prerequisites-for-stf-deployment.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_prerequisites-for-saf-deployment.adoc[leveloffset=+1] +// include::/proc_prerequisites-for-stf-deployment.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,7 +20,7 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='prerequisites-for-saf-deployment_{context}'] +[id='prerequisites-for-stf-deployment_{context}'] = Prerequisites for {ProjectShort} deployment Complete the following prerequisite tasks: @@ -30,7 +30,7 @@ example, link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/[Red Hat OpenStack Platform]. If you already have an {OpenShiftShort} 3.11 environment, see -<>. +<>. . Install {OpenShiftShort}. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/installing_clusters/index[OpenShift diff --git a/doc-Service-Assurance-Framework/modules/proc_updating-collectd-configuration.adoc b/doc-Service-Assurance-Framework/modules/proc_updating-collectd-configuration.adoc index 5ad12a76..11144eb0 100644 --- a/doc-Service-Assurance-Framework/modules/proc_updating-collectd-configuration.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_updating-collectd-configuration.adoc @@ -38,4 +38,4 @@ parameter_defaults: presettle: false ---- -For more information about how to edit and redeploy this configuration, see <> and <>. +For more information about how to edit and redeploy this configuration, see <> and <>. diff --git a/doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-saf.adoc b/doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-stf.adoc similarity index 93% rename from doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-saf.adoc rename to doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-stf.adoc index 641509ac..8dd018a6 100644 --- a/doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-saf.adoc +++ b/doc-Service-Assurance-Framework/modules/proc_updating-red-hat-openstack-platform-overcloud-for-stf.adoc @@ -3,7 +3,7 @@ // // This module can be included from assemblies using the following include statement: -// include::/proc_updating-red-hat-openstack-platform-overcloud-for-saf.adoc[leveloffset=+1] +// include::/proc_updating-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1] // The file name and the ID are based on the module title. For example: // * file name: proc_doing-procedure-a.adoc @@ -20,10 +20,10 @@ // // Start the title with a verb, such as Creating or Create. See also // _Wording of headings_ in _The IBM Style Guide_. -[id='updating-red-hat-openstack-platform-overcloud-for-saf_{context}'] +[id='updating-red-hat-openstack-platform-overcloud-for-stf_{context}'] = Updating {OpenStack} overcloud for {ProjectShort} -The procedure in section <> includes the instruction to create the `metrics-collectd-qdr-overrides.yaml` environment file. The following example uses the `metrics-collectd-qdr-overrides.yaml` file in the `openstack overcloud deploy` command with the environment files that you must add to the command. +The procedure in section <> includes the instruction to create the `metrics-collectd-qdr-overrides.yaml` environment file. The following example uses the `metrics-collectd-qdr-overrides.yaml` file in the `openstack overcloud deploy` command with the environment files that you must add to the command. ---- openstack overcloud deploy \ diff --git a/doc-Service-Assurance-Framework/modules/ref_example-manifests.adoc b/doc-Service-Assurance-Framework/modules/ref_example-manifests.adoc index 78c610ec..33660d8f 100644 --- a/doc-Service-Assurance-Framework/modules/ref_example-manifests.adoc +++ b/doc-Service-Assurance-Framework/modules/ref_example-manifests.adoc @@ -26,7 +26,7 @@ [IMPORTANT] The content in the following examples might be different to the file content in your deployment. Copy the manifests in your deployment. -Ensure that the `name` and `amqp_url` parameters of each Smart Gateway match the names you want to use for your clouds. For more information, see <>. +Ensure that the `name` and `amqp_url` parameters of each Smart Gateway match the names you want to use for your clouds. For more information, see <>. .metrics-smartgateway.yaml