Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_completing-the-saf-configuration.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand All @@ -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]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_configuring-saf-components.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand Down Expand Up @@ -61,7 +61,7 @@ $ openstack overcloud deploy
-e /home/templates/custom/collectd-environment.yaml
----
+
To view the collectd plug-ins and configurations, see <<appe-saf-collectd-plugins>>.
To view the collectd plug-ins and configurations, see <<appe-stf-collectd-plugins>>.


//include::../common/collectd/con_data-collecting-agent.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_connecting-multiple-clouds-to-saf.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand All @@ -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}
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_installing-the-core-components-of-saf.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand All @@ -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]
Expand All @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_introduction-to-service-assurance-framework.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -25,21 +25,21 @@
//
// 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.


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]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_saf-appendices.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

// This assembly can be included from other assemblies using the following
// include statement:
// include::<path>/assembly_saf.adoc[leveloffset=+1]
// include::<path>/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:
Expand All @@ -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.
Expand Down Expand Up @@ -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}

6 changes: 3 additions & 3 deletions doc-Service-Assurance-Framework/docinfo.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<title>Service Assurance Framework</title>
<subtitle>Installing and deploying Service Assurance Framework </subtitle>
<title>Service Telemetry Framework</title>
<subtitle>Installing and deploying Service Telemetry Framework </subtitle>
<productname>Red Hat OpenStack Platform</productname>
<productnumber>13</productnumber>
<pubsnumber>0</pubsnumber>
<abstract>
<para>
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.
</para>
</abstract>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
12 changes: 6 additions & 6 deletions doc-Service-Assurance-Framework/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ OpenStack Documentation Team <rhos-docs@redhat.com>
: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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// <List assemblies here, each on a new line>

// This module can be included from assemblies using the following include statement:
// include::<path>/con_overview-of-service-assurance-framework.adoc[leveloffset=+1]
// include::<path>/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
Expand All @@ -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"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// <List assemblies here, each on a new line>

// This module can be included from assemblies using the following include statement:
// include::<path>/proc_installing-the-core-components-of-saf.adoc[leveloffset=+1]
// include::<path>/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
Expand All @@ -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
Expand Down Expand Up @@ -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 <<preparing-your-openshift-environment-for-saf_installing-the-core-components-of-saf>>.
. Prepare your {OpenShiftShort} environment for {ProjectShort}. For more information, see <<preparing-your-openshift-environment-for-stf_installing-the-core-components-of-stf>>.

ifeval::["{build}" == "downstream"]
. Create an RHCC Secret. For more information, see <<creating-an-rhcc-secret_installing-the-core-components-of-saf>>.
. Create an RHCC Secret. For more information, see <<creating-an-rhcc-secret_installing-the-core-components-of-stf>>.
endif::[]

. Generate a TLS certificate for {MessageBus}. For more information, see
<<generating-a-tls-certificate-for-amq-interconnect_installing-the-core-components-of-saf>>.
<<generating-a-tls-certificate-for-amq-interconnect_installing-the-core-components-of-stf>>.

. Generate TLS certificates for ElasticSearch. For more information, see
<<generating-tls-certificates-for-elasticsearch_installing-the-core-components-of-saf>>.
<<generating-tls-certificates-for-elasticsearch_installing-the-core-components-of-stf>>.

. Deploy {ProjectShort} to the {OpenShiftShort} environment. For more information, see <<deploying-saf-to-the-openshift-environment_installing-the-core-components-of-saf>>.
. Deploy {ProjectShort} to the {OpenShiftShort} environment. For more information, see <<deploying-stf-to-the-openshift-environment_installing-the-core-components-of-stf>>.
Loading