Initial refactoring for director Operator support

common/global/stf-attributes.adoc

@@ -7,6 +7,10 @@ ifeval::[{vernum} > 16.0]
 :include_when_16_1:
 endif::[]
 
+ifeval::[{vernum} == 16.2]
+:include_when_16_2:
+endif::[]
+
 ifeval::[{vernum} >= 16.0]
 :include_when_16:
 endif::[]

doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc

@@ -0,0 +1,35 @@
+ifdef::context[:parent-context: {context}]
+
+
+[id="assembly-completing-the-stf-configuration-using-director-operator_{context}"]
+= Configuring {OpenStack} director Operator for {Project}
+
+:context: assembly-completing-the-stf-configuration-using-director-operator
+
+[role="_abstract"]
+To collect metrics, events, or both, and to send them to the {Project} ({ProjectShort}) storage domain, you must configure the {OpenStack} ({OpenStackShort}) overcloud to enable data collection and transport.
+
+{ProjectShort} can support both single and multiple clouds. The default configuration in {OpenStackShort} and {ProjectShort} set up for a single cloud installation.
+
+* For a single {OpenStackShort} overcloud deployment using director Operator with default configuration, see xref:configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator_assembly-completing-the-stf-configuration-using-director-operator[].
+
+include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc[leveloffset=+1]
+ifdef::include_when_17_1[]
+include::../modules/proc_getting-ca-certificate-from-stf-for-overcloud-configuration.adoc[leveloffset=+2]
+endif::include_when_17_1[]
+include::../modules/proc_retrieving-the-qdr-route-address.adoc[leveloffset=+2]
+//include::../modules/proc_creating-the-base-configuration-for-stf.adoc[leveloffset=+2]
+//include::../modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc[leveloffset=+2]
+//include::../modules/proc_deploying-the-overcloud.adoc[leveloffset=+2]
+//include::../modules/proc_validating-clientside-installation.adoc[leveloffset=+2]
+//include::../modules/proc_disabling-openstack-services-used-with-stf.adoc[leveloffset=+1]
+
+// Gather information for deployment in non-standard network topologies in the OSP overcloud
+// NOTE: removing this for now because it's not clear that this is necessary, and that recommendations here may actually be harmful. See RHBZ#2023902.
+//include::../modules/proc_deploying-to-non-standard-network-topologies.adoc[leveloffset=+1]
+
+// TODO: Connecting multiple clouds
+
+//reset the context
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc

@@ -2,7 +2,7 @@ ifdef::context[:parent-context: {context}]
 
 
 [id="assembly-completing-the-stf-configuration_{context}"]
-= Configuring {OpenStack} for {Project}
+= Configuring {OpenStack} director for {Project}
 
 :context: assembly-completing-the-stf-configuration
 

doc-Service-Telemetry-Framework/master.adoc

@@ -30,6 +30,9 @@ include::assemblies/assembly_installing-the-core-components-of-stf.adoc[leveloff
 
 //completing
 include::assemblies/assembly_completing-the-stf-configuration.adoc[leveloffset=+1]
+ifdef::include_when_16_2[]
+include::assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc[leveloffset=+1]
+endif::include_when_16_2[]
 
 //advanced features
 include::assemblies/assembly_advanced-features.adoc[leveloffset=+1]

doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc

@@ -0,0 +1,23 @@
+[id="configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator_{context}"]
+= Deploying {OpenStack} overcloud for {Project} using director Operator
+
+[role="_abstract"]
+As part of the {OpenStack} ({OpenStackShort}) overcloud deployment using director Operator, you must configure the data collectors and the data transport to {Project} ({ProjectShort}).
+
+.Procedure
+
+// NOTE: not required until available for RHOSP 17.1
+//ifdef::include_when_13,include_when_17[]
+//. xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]
+//endif::include_when_13,include_when_17[]
+. xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration-using-director-operator[Retrieving the {MessageBus} route address]
+//. xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[Creating the base configuration for {ProjectShort}]
+//. xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[Configuring the {ProjectShort} connection for the overcloud]
+//. xref:deploying-the-overcloud_assembly-completing-the-stf-configuration[Deploying the overcloud]
+//. xref:validating-clientside-installation_assembly-completing-the-stf-configuration[Validating client-side installation]
+
+.Additional resources
+* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/rhosp_director_operator_for_openshift_container_platform/index
+ifdef::include_when_16_1[]
+* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in].
+endif::include_when_16_1[]

doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc

@@ -1,8 +1,8 @@
 [id="configuring-red-hat-openstack-platform-overcloud-for-stf_{context}"]
-= Deploying {OpenStack} overcloud for {Project}
+= Deploying {OpenStack} overcloud for {Project} using director
 
 [role="_abstract"]
-As part of the {OpenStack} ({OpenStackShort}) overcloud deployment, you must configure the data collectors and the data transport to {Project} ({ProjectShort}).
+As part of the {OpenStack} ({OpenStackShort}) overcloud deployment using director, you must configure the data collectors and the data transport to {Project} ({ProjectShort}).
 
 .Procedure
 
@@ -15,7 +15,8 @@ endif::include_when_13,include_when_17[]
 . xref:deploying-the-overcloud_assembly-completing-the-stf-configuration[Deploying the overcloud]
 . xref:validating-clientside-installation_assembly-completing-the-stf-configuration[Validating client-side installation]
 
-ifdef::include_when_16_1[]
 .Additional resources
+* For more information about deploying an OpenStack cloud using director, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/director_installation_and_usage/index
+ifdef::include_when_16_1[]
 * To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in].
 endif::include_when_16_1[]