diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 4060da23..b435eb4e 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -49,8 +49,8 @@ ifeval::["{build}" == "upstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router -:SupportedOpenShiftVersion: 4.12 -:NextSupportedOpenShiftVersion: 4.14 +:SupportedOpenShiftVersion: 4.14 +:NextSupportedOpenShiftVersion: 4.16 :CodeReadyContainersVersion: 2.19.0 endif::[] @@ -67,6 +67,6 @@ ifeval::["{build}" == "downstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: AMQ{nbsp}Interconnect -:SupportedOpenShiftVersion: 4.12 -:NextSupportedOpenShiftVersion: 4.14 +:SupportedOpenShiftVersion: 4.14 +:NextSupportedOpenShiftVersion: 4.16 endif::[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc index 874f7c04..7756cd73 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc @@ -10,9 +10,9 @@ You need the following permissions to access the corresponding component UI's: [source,json,options="nowrap"] ---- -{"namespace":"service-telemetry", "resource":"grafana", "group":"grafana.integreatly.org", "verb":"get"} -{"namespace":"service-telemetry", "resource":"prometheus", "group":"monitoring.rhobs", "verb":"get"} -{"namespace":"service-telemetry", "resource":"alertmanager", "group":"monitoring.rhobs", "verb":"get"} +{"namespace":"service-telemetry", "resource":"grafanas", "group":"grafana.integreatly.org", "verb":"get"} +{"namespace":"service-telemetry", "resource":"prometheuses", "group":"monitoring.rhobs", "verb":"get"} +{"namespace":"service-telemetry", "resource":"alertmanagers", "group":"monitoring.rhobs", "verb":"get"} ---- For more information about RBAC, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. 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 f5017fb1..324b0bab 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 @@ -41,7 +41,7 @@ data: verifyHostname: false sslProfile: sslProfile saslUsername: guest@default-interconnect - saslPassword: pass: + saslPassword: MetricsQdrSSLProfiles: - name: sslProfile @@ -58,6 +58,18 @@ data: CollectdSensubilityResultsChannel: sensubility/cloud1-telemetry ---- +* The `resource_registry` configuration directly loads the collectd service because you do not include the `collectd-write-qdr.yaml` environment file for multiple cloud deployments. +* Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. +* Replace the `` portion of the `saslPassword` sub-parameter of `MetricsQdrConnectors` with the value you retrieved in xref:retrieving-the-qdr-password_assembly-completing-the-stf-configuration[]. +ifdef::include_when_13,include_when_17[] +* Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. +endif::include_when_13,include_when_17[] +* Set `topic` value of `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. The value is a unique topic identifier for the cloud such as `cloud1-metering`. +* Set `CollectdAmqpInstances` sub-parameter to define the topic for collectd metrics. The section name is a unique topic identifier for the cloud such as `cloud1-telemetry`. +ifndef::include_when_13[] +* Set `CollectdSensubilityResultsChannel` to define the topic for collectd-sensubility events. The value is a unique topic identifier for the cloud such as `sensubility/cloud1-telemetry`. +endif::[] + [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[]. diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc index 769fb11c..e3238836 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc @@ -43,7 +43,7 @@ parameter_defaults: verifyHostname: false sslProfile: sslProfile saslUsername: guest@default-interconnect - saslPassword: pass: + saslPassword: MetricsQdrSSLProfiles: - name: sslProfile 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 32284470..b41a87f0 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 @@ -54,8 +54,9 @@ data: CollectdConnectionType: amqp1 CollectdAmqpInterval: 30 CollectdDefaultPollingInterval: 30 - CollectdExtraPlugins: - - vmem + # to collect information about the virtual memory subsystem of the kernel + # CollectdExtraPlugins: + # - vmem # set standard prefixes for where metrics are published to QDR MetricsQdrAddresses: @@ -74,13 +75,16 @@ data: # 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 + # to receive extra information about virtual memory, you must enable vmem plugin in CollectdExtraPlugins + # 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" + # to capture all extra_stats metrics, comment out below config + collectd::plugin::virt::extra_stats: cpu_util vcpu disk + # provide the human-friendly name of the virtual instance collectd::plugin:ConfigMap :virt::plugin_instance_format: metadata @@ -90,6 +94,9 @@ data: local: host: "%{hiera('fqdn_canonical')}" port: 11211 + + # report root filesystem storage metrics + collectd::plugin::df::ignoreselected: false ---- [role="_additional-resources"] diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc index 46a5299d..57d15360 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-the-base-configuration-for-stf.adoc @@ -35,9 +35,10 @@ parameter_defaults: CollectdConnectionType: amqp1 CollectdAmqpInterval: 30 CollectdDefaultPollingInterval: 30 - CollectdExtraPlugins: - - vmem - + # to collect information about the virtual memory subsystem of the kernel + # CollectdExtraPlugins: + # - vmem + # set standard prefixes for where metrics are published to QDR MetricsQdrAddresses: - prefix: 'collectd' @@ -55,8 +56,8 @@ parameter_defaults: # note: Adjust the value of the `send_queue_limit` to handle your required volume of metrics. collectd::plugin::amqp1::send_queue_limit: 5000 - # receive extra information about virtual memory - collectd::plugin::vmem::verbose: true + # to receive extra information about virtual memory, you must enable vmem plugin in CollectdExtraPlugins + # collectd::plugin::vmem::verbose: true # set memcached collectd plugin to report its metrics by hostname # rather than host IP, ensuring metrics in the dashboard remain uniform @@ -65,6 +66,9 @@ parameter_defaults: host: "%{hiera('fqdn_canonical')}" port: 11211 + # report root filesystem storage metrics + collectd::plugin::df::ignoreselected: false + # align defaults across OSP versions collectd::plugin::cpu::reportbycpu: true collectd::plugin::cpu::reportbystate: true @@ -105,8 +109,9 @@ parameter_defaults: CollectdConnectionType: amqp1 CollectdAmqpInterval: 30 CollectdDefaultPollingInterval: 30 - CollectdExtraPlugins: - - vmem + # to collect information about the virtual memory subsystem of the kernel + # CollectdExtraPlugins: + # - vmem # set standard prefixes for where metrics are published to QDR MetricsQdrAddresses: @@ -125,13 +130,16 @@ parameter_defaults: # 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 + # to receive extra information about virtual memory, you must enable vmem plugin in CollectdExtraPlugins + # 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" + # to capture all extra_stats metrics, comment out below config + collectd::plugin::virt::extra_stats: cpu_util vcpu disk + # provide the human-friendly name of the virtual instance collectd::plugin::virt::plugin_instance_format: metadata @@ -141,5 +149,9 @@ parameter_defaults: local: host: "%{hiera('fqdn_canonical')}" port: 11211 + + # report root filesystem storage metrics + collectd::plugin::df::ignoreselected: false + ---- endif::include_when_16[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc index 846d80a0..01d020da 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-on-openshift-disconnected-environments.adoc @@ -8,7 +8,7 @@ Since {Project} ({ProjectShort}) version 1.5.4, you can deploy {ProjectShort} in .Prerequisites -* {OpenShift} Extended Update Support (EUS) version 4.12 or 4.14 deployed in a restricted network. +* {OpenShift} Extended Update Support (EUS) version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} deployed in a restricted network. * A mirror registry so that the {OpenShift} cluster can access the required images. For more information about mirror registries, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring[Disconnected installation mirroring] in the {OpenShift} _Installing_ guide. * All the {ProjectShort} dependencies are available in the {OpenShift} cluster mirror registry.