From 058ad3eba107cc633e3f2988c90e9b22ce34081f Mon Sep 17 00:00:00 2001 From: mickogeary Date: Fri, 5 May 2023 15:51:27 +0100 Subject: [PATCH 01/15] mg master 1195 add OSPdO content incl 3 new modules --- ...configuration-using-director-operator.adoc | 9 +- ...cloud-for-stf-using-director-operator.adoc | 16 ++- ...r-director-operator-for-the-overcloud.adoc | 66 +++++++++++ ...uration-for-director-operator-for-stf.adoc | 107 ++++++++++++++++++ ...g-the-overcloud-for-director-operator.adoc | 46 ++++++++ 5 files changed, 236 insertions(+), 8 deletions(-) create mode 100644 doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc create mode 100644 doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc create mode 100644 doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc index 101bee59..88239a40 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc @@ -18,9 +18,12 @@ 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] + +//The following modules differ between director and director Operator procedures +include::../modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc[leveloffset=+2] +include::../modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc[leveloffset=+2] +include::../modules/proc_deploying-the-overcloud-for-director-operator.adoc[leveloffset=+2] + //include::../modules/proc_validating-clientside-installation.adoc[leveloffset=+2] //include::../modules/proc_disabling-openstack-services-used-with-stf.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc index 0c5938ad..fdeabd38 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc @@ -2,7 +2,10 @@ = 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}). +When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using director Operator, you must configure the data collectors and the data transport to {Project} ({ProjectShort}). + +.Prerequisites +* You are familiar with deploying {OpenStackShort} with the {OpenStackShort} director Operator. .Procedure @@ -10,12 +13,15 @@ As part of the {OpenStack} ({OpenStackShort}) overcloud deployment using directo //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:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} route address] +. xref:proc_creating-the-base-configuration-for-director-operator-for-stf[Creating the base configuration for director Operator for {ProjectShort}] +. xref:proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud[Configuring the {ProjectShort} connection for the overcloud] +. xref:dproc_deploying-the-overcloud-for-director-operator[Deploying the overcloud for director operator] + //. 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[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc new file mode 100644 index 00000000..53982bd3 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -0,0 +1,66 @@ +:_content-type: PROCEDURE + +[id="configuring-the-stf-connection-for-director-operator-for-the-overcloud_{context}"] += Configuring the STF connection for director Operator for the overcloud + +Edit the `heat-env-config-deploy` ConfigMap to create a connection from {OpenStack} ({OpenStackShort}) to {Project}. + +.Procedure + +. Login to {OpenShift} environment and change to the project that hosts your {OpenStack} deployment. + +. Open the `heat-env-config-deploy` ConfigMap for editing: ++ +[source,bash,options="nowrap",subs="verbatim"] +---- +$ oc edit heat-env-config-deploy +---- + +. Add your `stf-connectors.yaml` configuration to the `heat-env-config-deploy ConfigMap`, appropriate to your environment, save your edits and close the file: ++ +.stf-connectors.yaml +[source,yaml,options="nowrap"] +---- +apiVersion: v1 +data: + [...] + stf-connectors.yaml: | + resource_registry: + OS::TripleO::Services::Collectd: /usr/share/openstack-tripleo-heat-templates/deployment/metrics/collectd-container-puppet.yaml + + parameter_defaults: + MetricsQdrConnectors: + - host: default-interconnect-5671-service-telemetry.apps.ostest.test.metalkube.org + port: 443 + role: edge + verifyHostname: false + sslProfile: sslProfile + + MetricsQdrSSLProfiles: + - name: sslProfile + + CeilometerQdrEventsConfig: + driver: amqp + topic: cloud1-event + + CeilometerQdrMetricsConfig: + driver: amqp + topic: cloud1-metering + + CollectdAmqpInstances: + cloud1-notify: + notify: true + format: JSON + presettle: false + cloud1-telemetry: + format: JSON + presettle: false + + CollectdSensubilityResultsChannel: sensubility/cloud1-telemetry +---- + +[role="_additional-resources"] +.Additional resources +* For more information about the `stf-connectors.yaml` environment file, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-completing-the-stf-configuration_assembly#configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[Configuring the STF connection for the overcloud] + +* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc new file mode 100644 index 00000000..8a72d1e4 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc @@ -0,0 +1,107 @@ +:_content-type: PROCEDURE + +[id="creating-the-base-configuration-for-director-operator-for-stf_{context}"] += Creating the base configuration for director Operator for {ProjectShort} + +Edit the `heat-env-config-deploy` ConfigMap to add the base {Project} ({ProjectShort}) configuration to the overcloud nodes. + +.Procedure + +. Login to your {OpenShift} environment and change to the project that hosts your {OpenStack} ({OpenStackShort}) deployment. + +. Open the `heat-env-config-deploy` ConfigMap for editing: ++ +[source,bash,options="nowrap",subs="verbatim"] +---- +$ oc edit heat-env-config-deploy +---- + +. Add the `enable-stf.yaml` configuration to the `heat-env-config-deploy` ConfigMap, save your edits and close the file: ++ +.enable-stf.yaml +[source,yaml,options="nowrap"] +---- +apiVersion: v1 +data: + [...] + enable-stf.yaml: | + parameter_defaults: + # only send to STF, not other publishers + EventPipelinePublishers: [] + PipelinePublishers: [] + + # manage the polling and pipeline configuration files for Ceilometer agents + ManagePolling: true + ManagePipeline: true + + # enable Ceilometer metrics and events + CeilometerQdrPublishMetrics: true + CeilometerQdrPublishEvents: true + + # enable collection of API status + CollectdEnableSensubility: true + CollectdSensubilityTransport: amqp1 + + # enable collection of containerized service metrics + CollectdEnableLibpodstats: true + + # set collectd overrides for higher telemetry resolution and extra plugins + # to load + CollectdConnectionType: amqp1 + CollectdAmqpInterval: 5 + CollectdDefaultPollingInterval: 5 + CollectdExtraPlugins: + - vmem + + # set standard prefixes for where metrics and events are published to QDR + MetricsQdrAddresses: + - prefix: 'collectd' + distribution: multicast + - prefix: 'anycast/ceilometer' + distribution: multicast + + ExtraConfig: + ceilometer::agent::polling::polling_interval: 30 + ceilometer::agent::polling::polling_meters: + - cpu + - disk.* + - ip.* + - image.* + - memory + - memory.* + - network.* + - perf.* + - port + - port.* + - switch + - switch.* + - storage.* + - volume.* + + # to avoid filling the memory buffers if disconnected from the message bus + # note: this may need an adjustment if there are many metrics to be sent. + collectd::plugin::amqp1::send_queue_limit: 5000 + + # receive extra information about virtual memory + collectd::plugin::vmem::verbose: true + + # provide name and uuid in addition to hostname for better correlation + # to ceilometer data + collectd::plugin::virt::hostname_format: "name uuid hostname" + + # provide the human-friendly name of the virtual instance + collectd::plugin:ConfigMap :virt::plugin_instance_format: metadata + + # set memcached collectd plugin to report its metrics by hostname + # rather than host IP, ensuring metrics in the dashboard remain uniform + collectd::plugin::memcached::instances: + local: + host: "%{hiera('fqdn_canonical')}" + port: 11211 +---- + +[role="_additional-resources"] +.Additional resources +* For more information about configuring the `enable-stf.yaml` environment file, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-completing-the-stf-configuration_assembly#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[Creating the base configuration for STF] + +* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc new file mode 100644 index 00000000..c0ee4f3b --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc @@ -0,0 +1,46 @@ +:_content-type: PROCEDURE + +[id="deploying-the-overcloud-for-director-operator_{context}"] += Deploying the overcloud for director Operator + +Deploy or update the overcloud with the required environment files so that data is collected and transmitted to {Project} ({ProjectShort}) . + +.Procedure + +. Login to your {OpenShift} environment and change to the project that hosts your {OpenStack} ({OpenStackShort}) deployment. + +. Open the `OpenStackConfigGenerator` custom resource for editing: ++ +[source,bash,options="nowrap",subs="verbatim"] +---- +$ oc edit OpenStackConfigGenerator +---- + +. Add the `metrics/ceilometer-write-qdr.yaml` and `metrics/qdr-edge-only.yaml` environment files as values for the `heatEnvs` parameter, save your edits and close the `OpenStackConfigGenerator` custom resource. +[NOTE] +If you already deployed a {OpenStack} environment using director Operator, you must delete the existing `OpenStackConfigGenerator` and create a new object with the full configuration in order to re-generate the `OpenStackConfigVersion`. + ++ +.OpenStackConfigGenerator +[source,yaml,options="nowrap"] +---- +apiVersion: osp-director.openstack.org/v1beta1 +kind: OpenStackConfigGenerator +metadata: + name: default + namespace: openstack +spec: + heatEnvConfigMap: heat-env-config-deploy + heatEnvs: + - + - metrics/ceilometer-write-qdr.yaml + - metrics/qdr-edge-only.yaml +---- + +. If you already deployed a {OpenStack} environment using director Operator and generated a new `OpenStackConfigVersion`, edit the `OpenStackDeploy` object of your deployment, and set the value of `spec.configVersion` to the new `OpenStackConfigVersion` in order to update the overcloud deployment. + +[role="_additional-resources"] +.Additional resources +* For more information about getting the latest `OpenStackConfigVersion`, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_obtain-the-latest-openstackconfigversion.adoc_assembly_configuring-overcloud-software-with-the-director-operator[Obtain the latest OpenStackConfigVersion] + +* For more information about applying the overcloud configuration with director Operator, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_applying-overcloud-configuration-with-the-director-operator_assembly_configuring-overcloud-software-with-the-director-operator[Applying overcloud configuration with the director Operator] From b4ece9430e7d79aa1d3c03a742c0b273e466977b Mon Sep 17 00:00:00 2001 From: mickogeary Date: Fri, 5 May 2023 16:30:57 +0100 Subject: [PATCH 02/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc Co-authored-by: Roger Heslop --- ...-stf-connection-for-director-operator-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc index 53982bd3..4ca2b3d4 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -7,7 +7,7 @@ Edit the `heat-env-config-deploy` ConfigMap to create a connection from {OpenSta .Procedure -. Login to {OpenShift} environment and change to the project that hosts your {OpenStack} deployment. +. Login to the {OpenShift} environment and change to the project that hosts your {OpenStack} deployment. . Open the `heat-env-config-deploy` ConfigMap for editing: + From b6a0fb48dc95453abd8f44046c040e212ae0d22b Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:44:01 -0400 Subject: [PATCH 03/15] Update doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc Co-authored-by: Roger Heslop --- .../proc_deploying-the-overcloud-for-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc index c0ee4f3b..ccef23d9 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc @@ -16,7 +16,7 @@ Deploy or update the overcloud with the required environment files so that data $ oc edit OpenStackConfigGenerator ---- -. Add the `metrics/ceilometer-write-qdr.yaml` and `metrics/qdr-edge-only.yaml` environment files as values for the `heatEnvs` parameter, save your edits and close the `OpenStackConfigGenerator` custom resource. +. Add the `metrics/ceilometer-write-qdr.yaml` and `metrics/qdr-edge-only.yaml` environment files as values for the `heatEnvs` parameter. Save your edits, and close the `OpenStackConfigGenerator` custom resource: [NOTE] If you already deployed a {OpenStack} environment using director Operator, you must delete the existing `OpenStackConfigGenerator` and create a new object with the full configuration in order to re-generate the `OpenStackConfigVersion`. From 34c564fe9d1f47621f2e1ef4795d530b5385c8bd Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:45:11 -0400 Subject: [PATCH 04/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc --- ...tack-platform-overcloud-for-stf-using-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc index fdeabd38..2526c1ec 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc @@ -5,7 +5,7 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using director Operator, you must configure the data collectors and the data transport to {Project} ({ProjectShort}). .Prerequisites -* You are familiar with deploying {OpenStackShort} with the {OpenStackShort} director Operator. +* You are familiar with deploying and managing {OpenStackShort} with the {OpenStackShort} director Operator. .Procedure From 750c227219477ff7479ad5c9ec1cee00c9d08438 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:45:30 -0400 Subject: [PATCH 05/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc --- ...-stf-connection-for-director-operator-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc index 4ca2b3d4..56d15eb1 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -16,7 +16,7 @@ Edit the `heat-env-config-deploy` ConfigMap to create a connection from {OpenSta $ oc edit heat-env-config-deploy ---- -. Add your `stf-connectors.yaml` configuration to the `heat-env-config-deploy ConfigMap`, appropriate to your environment, save your edits and close the file: +. Add your `stf-connectors.yaml` configuration to the `heat-env-config-deploy` ConfigMap, appropriate to your environment, save your edits and close the file: + .stf-connectors.yaml [source,yaml,options="nowrap"] From 681db83bebbff6796c739cdef324a95fc91018a7 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:45:54 -0400 Subject: [PATCH 06/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc --- ...-stf-connection-for-director-operator-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc index 56d15eb1..2ed7ea42 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -61,6 +61,6 @@ data: [role="_additional-resources"] .Additional resources -* For more information about the `stf-connectors.yaml` environment file, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-completing-the-stf-configuration_assembly#configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[Configuring the STF connection for the overcloud] +* For more information about the `stf-connectors.yaml` environment file, see xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[]. * For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] From e0eec1ce5dc32c9ed7e00fb42fdea3125fb9b69d Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:46:22 -0400 Subject: [PATCH 07/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc --- ...tack-platform-overcloud-for-stf-using-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc index 2526c1ec..4d1a6fd0 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc @@ -2,7 +2,7 @@ = Deploying {OpenStack} overcloud for {Project} using director Operator [role="_abstract"] -When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using director Operator, you must configure the data collectors and the data transport to {Project} ({ProjectShort}). +When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using director Operator, you must configure the data collectors and the data transport for {Project} ({ProjectShort}). .Prerequisites * You are familiar with deploying and managing {OpenStackShort} with the {OpenStackShort} director Operator. From 308a43febed27dc8c46f4714768198d804c1f587 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:47:10 -0400 Subject: [PATCH 08/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc --- ...tack-platform-overcloud-for-stf-using-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc index 4d1a6fd0..d41bc47a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc @@ -17,7 +17,7 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using di . xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} route address] . xref:proc_creating-the-base-configuration-for-director-operator-for-stf[Creating the base configuration for director Operator for {ProjectShort}] . xref:proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud[Configuring the {ProjectShort} connection for the overcloud] -. xref:dproc_deploying-the-overcloud-for-director-operator[Deploying the overcloud for director operator] +. xref:proc_deploying-the-overcloud-for-director-operator[Deploying the overcloud for director operator] //. xref:validating-clientside-installation_assembly-completing-the-stf-configuration[Validating client-side installation] From 7c33e597ad8cbf6da235ed08cf467d48ea73e403 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:47:29 -0400 Subject: [PATCH 09/15] Update doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc --- ...-stf-connection-for-director-operator-for-the-overcloud.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc index 2ed7ea42..2d59c26a 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -63,4 +63,4 @@ data: .Additional resources * For more information about the `stf-connectors.yaml` environment file, see xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[]. -* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] +* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:{defaultURL}/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] From a9a509ce0fbdd853daed85f5d5279b9c2e1eecd1 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:47:41 -0400 Subject: [PATCH 10/15] Update doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc --- ...ng-the-base-configuration-for-director-operator-for-stf.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc index 8a72d1e4..ea33854c 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc @@ -102,6 +102,6 @@ data: [role="_additional-resources"] .Additional resources -* For more information about configuring the `enable-stf.yaml` environment file, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-completing-the-stf-configuration_assembly#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[Creating the base configuration for STF] +* For more information about configuring the `enable-stf.yaml` environment file, see xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[] * For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] From 7a2ed2ef29da154e3c1e6db2b55ada76b6db6b92 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:47:48 -0400 Subject: [PATCH 11/15] Update doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc --- ...ng-the-base-configuration-for-director-operator-for-stf.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc index ea33854c..add32966 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-director-operator-for-stf.adoc @@ -104,4 +104,4 @@ data: .Additional resources * For more information about configuring the `enable-stf.yaml` environment file, see xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[] -* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] +* For more information about adding heat templates to a {OpenStack} director Operator deployment, see link:{defaultURL}/rhosp_director_operator_for_openshift_container_platform/assembly_adding-heat-templates-and-environment-files-with-the-director-operator_rhosp-director-operator#doc-wrapper[Adding heat templates and environment files with the director Operator] From 075ecd0abef009d6972ad1000491b7ed660eb29f Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:47:56 -0400 Subject: [PATCH 12/15] Update doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc --- .../proc_deploying-the-overcloud-for-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc index ccef23d9..4e2017e0 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc @@ -3,7 +3,7 @@ [id="deploying-the-overcloud-for-director-operator_{context}"] = Deploying the overcloud for director Operator -Deploy or update the overcloud with the required environment files so that data is collected and transmitted to {Project} ({ProjectShort}) . +Deploy or update the overcloud with the required environment files so that data is collected and transmitted to {Project} ({ProjectShort}). .Procedure From 451c881e407735308e808e2efcec9f2bd6fb7569 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:48:04 -0400 Subject: [PATCH 13/15] Update doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc --- .../proc_deploying-the-overcloud-for-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc index 4e2017e0..6feef8c8 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc @@ -41,6 +41,6 @@ spec: [role="_additional-resources"] .Additional resources -* For more information about getting the latest `OpenStackConfigVersion`, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_obtain-the-latest-openstackconfigversion.adoc_assembly_configuring-overcloud-software-with-the-director-operator[Obtain the latest OpenStackConfigVersion] +* For more information about getting the latest `OpenStackConfigVersion`, see link:{defaultURL}/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_obtain-the-latest-openstackconfigversion.adoc_assembly_configuring-overcloud-software-with-the-director-operator[Obtain the latest OpenStackConfigVersion] * For more information about applying the overcloud configuration with director Operator, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_applying-overcloud-configuration-with-the-director-operator_assembly_configuring-overcloud-software-with-the-director-operator[Applying overcloud configuration with the director Operator] From 015ede216838ea2dda249c732d1b416262d8fa55 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 08:48:10 -0400 Subject: [PATCH 14/15] Update doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc --- .../proc_deploying-the-overcloud-for-director-operator.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc index 6feef8c8..48426695 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud-for-director-operator.adoc @@ -43,4 +43,4 @@ spec: .Additional resources * For more information about getting the latest `OpenStackConfigVersion`, see link:{defaultURL}/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_obtain-the-latest-openstackconfigversion.adoc_assembly_configuring-overcloud-software-with-the-director-operator[Obtain the latest OpenStackConfigVersion] -* For more information about applying the overcloud configuration with director Operator, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_applying-overcloud-configuration-with-the-director-operator_assembly_configuring-overcloud-software-with-the-director-operator[Applying overcloud configuration with the director Operator] +* For more information about applying the overcloud configuration with director Operator, see link:{defaultURL}/rhosp_director_operator_for_openshift_container_platform/assembly_configuring-overcloud-software-with-the-director-operator_rhosp-director-operator#proc_applying-overcloud-configuration-with-the-director-operator_assembly_configuring-overcloud-software-with-the-director-operator[Applying overcloud configuration with the director Operator] From cf178f63097357913830f45e0b0bc031c3b65a78 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 11 May 2023 09:08:24 -0400 Subject: [PATCH 15/15] Include rhosp_attributes again and use defaultURL Include the rhosp_attributes file again when building for downstream. Update the Makefile so that it overrides the osp_curr_ver (which is statically set to 17.0 currently). This allows for proper URL resolution. Only build the OSPdO documentation when compiling for downstream. --- doc-Service-Telemetry-Framework/Makefile | 4 ++-- doc-Service-Telemetry-Framework/master.adoc | 5 ++++- ...iguring-red-hat-openstack-platform-overcloud-for-stf.adoc | 4 ++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/doc-Service-Telemetry-Framework/Makefile b/doc-Service-Telemetry-Framework/Makefile index 961db74b..1c7c8acf 100644 --- a/doc-Service-Telemetry-Framework/Makefile +++ b/doc-Service-Telemetry-Framework/Makefile @@ -59,10 +59,10 @@ $(DEST_HTML_170): $(SOURCES) asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.0 -b xhtml5 -d book -o $@ $< $(DEST_HTML_162): $(SOURCES) - asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=16.2 -b xhtml5 -d book -o $@ $< + asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=16.2 -a osp_curr_ver=16.2 -b xhtml5 -d book -o $@ $< $(DEST_HTML_13): $(SOURCES) - asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=13 -b xhtml5 -d book -o $@ $< + asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=13 -a osp_curr_ver=13 -b xhtml5 -d book -o $@ $< $(DEST_PDF): $(SOURCES) $(IMAGES) asciidoctor-pdf -a build=$(BUILD) -d book -o $@ $< diff --git a/doc-Service-Telemetry-Framework/master.adoc b/doc-Service-Telemetry-Framework/master.adoc index 4995f38c..d4d7c6dc 100644 --- a/doc-Service-Telemetry-Framework/master.adoc +++ b/doc-Service-Telemetry-Framework/master.adoc @@ -14,7 +14,7 @@ OpenStack Documentation Team include::common/global/stf-attributes.adoc[] ifeval::["{build}" == "downstream"] -//include::common/global/rhosp_attributes.adoc[] +include::common/global/rhosp_attributes.adoc[] include::common/global/making-open-source-more-inclusive.adoc[] include::common/global/proc_providing-feedback-on-red-hat-documentation.adoc[] endif::[] @@ -30,9 +30,12 @@ include::assemblies/assembly_installing-the-core-components-of-stf.adoc[leveloff //completing include::assemblies/assembly_completing-the-stf-configuration.adoc[leveloffset=+1] + +ifeval::["{build}" == "downstream"] ifdef::include_when_16_2[] include::assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc[leveloffset=+1] endif::include_when_16_2[] +endif::[] //advanced features include::assemblies/assembly_advanced-features.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc index 87049a28..0fd4cb17 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc @@ -16,7 +16,7 @@ endif::include_when_13,include_when_17[] . 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, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/director_installation_and_usage/index +* For more information about deploying an OpenStack cloud using director, see link:{defaultURL}/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]. +* To collect data through {MessageBus}, see link:{defaultURL}/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. endif::include_when_16_1[]