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/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/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-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..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 @@ -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 for {Project} ({ProjectShort}). + +.Prerequisites +* You are familiar with deploying and managing {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: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] + .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-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[] 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..2d59c26a --- /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 the {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 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:{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] 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..add32966 --- /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 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:{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] 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..48426695 --- /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:{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:{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]