diff --git a/common/global/rhosp_attributes.adoc b/common/global/rhosp_attributes.adoc index a463d3df..8544c71f 100644 --- a/common/global/rhosp_attributes.adoc +++ b/common/global/rhosp_attributes.adoc @@ -15,7 +15,7 @@ :osp_long: Red Hat OpenStack Platform :osp_acro: RHOSP -:osp_curr_ver: 17.1-Beta +:osp_curr_ver: 17.1 :osp_curr_ver_no_beta: 17.1 :osp_z_stream: 0 @@ -29,5 +29,6 @@ :defaultURL: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{osp_curr_ver}/html :defaultCephURL: https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/{CephVernum}/html -:setup-tlse: {defaultURL}/hardening_red_hat_openstack_platform/assembly_securing-rhos-with-tls-and-pki_security_and_hardening#proc_implementing-tls-e-with-ansible_encryption-and-key-management[Implementing TLS-e with Ansible] +// Specific links +:setup-tlse: {defaultURL}/hardening_red_hat_openstack_platform/assembly_securing-rhos-with-tls-and-pki_security_and_hardening#proc_implementing-tls-e-with-ansible_encryption-and-key-management[Implementing TLS-e with Ansible] diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 18859528..5650ae75 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -28,6 +28,10 @@ ifeval::[{vernum} >= 17.0] :include_when_17: endif::[] +ifeval::[{vernum} == 17.1] +:include_when_17_1: +endif::[] + ifeval::[{ProductVersion} < 1.5] :include_before_stf15: endif::[] @@ -45,9 +49,9 @@ ifeval::["{build}" == "upstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router -:SupportedOpenShiftVersion: 4.10 -:NextSupportedOpenShiftVersion: 4.12 -:CodeReadyContainersVersion: 2.6.0 +:SupportedOpenShiftVersion: 4.12 +:NextSupportedOpenShiftVersion: 4.14 +:CodeReadyContainersVersion: 2.19.0 endif::[] ifeval::["{build}" == "downstream"] @@ -55,7 +59,7 @@ ifeval::["{build}" == "downstream"] :OpenShiftShort: OCP :OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform :OpenStackShort: RHOSP -:OpenStackVersion: 17.0 +:OpenStackVersion: 17.1 :OpenStackLong: {OpenStack}{nbsp}{OpenStackVersion} :OpenStackInstaller: director :OVirt: Red{nbsp}Hat{nbsp}Virtualization @@ -63,6 +67,6 @@ ifeval::["{build}" == "downstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: AMQ{nbsp}Interconnect -:SupportedOpenShiftVersion: 4.10 -:NextSupportedOpenShiftVersion: 4.12 +:SupportedOpenShiftVersion: 4.12 +:NextSupportedOpenShiftVersion: 4.14 endif::[] diff --git a/doc-Service-Telemetry-Framework/Makefile b/doc-Service-Telemetry-Framework/Makefile index 45501d12..e321f39f 100644 --- a/doc-Service-Telemetry-Framework/Makefile +++ b/doc-Service-Telemetry-Framework/Makefile @@ -24,7 +24,7 @@ endif all: html -html: html-latest html171 html170 html162 html13 +html: html-latest html171 html162 html-latest: prepare $(IMAGES_TS) $(DEST_HTML) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 13100ea2..28916ec4 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -23,8 +23,8 @@ endif::include_when_16[] include::../modules/con_dashboards.adoc[leveloffset=+1] include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2] ifdef::include_when_16[] -include::../modules/proc_overriding-the-default-grafana-container-image.adoc[leveloffset=+2] -//TODO: Add dashboards back when we have working code for OSP13 +// TODO: either rewrite or drop this procedure. We now provide the preferred downstream RHEL Grafana workload image in the deployment procedure. +//include::../modules/proc_overriding-the-default-grafana-container-image.adoc[leveloffset=+2] include::../modules/proc_importing-dashboards.adoc[leveloffset=+2] endif::include_when_16[] include::../modules/proc_retrieving-and-setting-grafana-login-credentials.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc index db479abe..fb6dd127 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc @@ -29,6 +29,7 @@ include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-st ifdef::include_when_13,include_when_17[] include::../modules/proc_getting-ca-certificate-from-stf-for-overcloud-configuration.adoc[leveloffset=+2] endif::include_when_13,include_when_17[] +include::../modules/proc_retrieving-the-qdr-password.adoc[leveloffset=+2] 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] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index 579480c0..24c55708 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -43,7 +43,10 @@ endif::[] include::../modules/con_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] include::../modules/proc_deploying-observability-operator.adoc[leveloffset=+2] + +ifeval::[{SupportedOpenShiftVersion} < 4.12] include::../modules/proc_deploying-certificate-manager-for-openshift-operator.adoc[leveloffset=+2] +endif::[] include::../modules/proc_deploying-service-telemetry-operator.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/master.adoc b/doc-Service-Telemetry-Framework/master.adoc index d4d7c6dc..b0d9d717 100644 --- a/doc-Service-Telemetry-Framework/master.adoc +++ b/doc-Service-Telemetry-Framework/master.adoc @@ -1,7 +1,7 @@ = Service Telemetry Framework 1.5 OpenStack Documentation Team :imagesdir: images -:vernum: 17.0 +:vernum: 17.1 :toc: left :toclevels: 3 :icons: font @@ -32,9 +32,9 @@ include::assemblies/assembly_installing-the-core-components-of-stf.adoc[leveloff include::assemblies/assembly_completing-the-stf-configuration.adoc[leveloffset=+1] ifeval::["{build}" == "downstream"] -ifdef::include_when_16_2[] +ifdef::include_when_16_2,include_when_17_1[] include::assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc[leveloffset=+1] -endif::include_when_16_2[] +endif::include_when_16_2,include_when_17_1[] endif::[] //advanced features @@ -46,7 +46,7 @@ include::assemblies/assembly_renewing-the-amq-interconnect-certificate.adoc[leve // removing include::assemblies/assembly_removing-stf-from-the-openshift-environment.adoc[leveloffset=+1] -//collectd plugins - // upgrading to 1.5 -include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc[leveloffset=+1] +// NOTE: this is no longer being rendered because the expectation is to move from STF 1.4 on OCP 4.8 to STF 1.5 on OCP 4.10, both of which are EOL now. +// if this affects you, please open a customer case to help manage the upgrade, or simply perform a greenfield deployment of STF 1.5 on OCP 4.14. +//include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.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 69d8ff10..63d52520 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 @@ -10,9 +10,9 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using di .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[] +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[Retrieving the {MessageBus} route address] . xref:creating-the-base-configuration-for-director-operator-for-stf_assembly-completing-the-stf-configuration-using-director-operator[Creating the base configuration for director Operator for {ProjectShort}] @@ -23,7 +23,11 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using di .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[] +ifdef::include_when_16_2[] +* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/index +* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] +ifdef::include_when_17_1[] +* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/deploying_an_overcloud_in_a_red_hat_openshift_container_platform_cluster_with_director_operator/index +* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/managing_overcloud_observability/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] 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 ceba9322..2b7617c3 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 @@ -9,6 +9,7 @@ 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-password_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} password] . xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[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] @@ -16,7 +17,11 @@ endif::include_when_13,include_when_17[] . xref:validating-clientside-installation_assembly-completing-the-stf-configuration[Validating client-side installation] .Additional resources +ifdef::include_when_16_2[] * For more information about deploying an OpenStack cloud using director, see link:{defaultURL}/director_installation_and_usage/index[Director Installation and Usage]. -ifdef::include_when_16_1[] * To collect data through {MessageBus}, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. -endif::include_when_16_1[] +endif::[] +ifdef::include_when_17_1[] +* For more information about deploying an OpenStack cloud using director, see link:{defaultURL}/installing_and_managing_red_hat_openstack_platform_with_director/index[Installing and managing Red Hat OpenStack Platform with director]. +* To collect data through {MessageBus}, see link:{defaultURL}/managing_overcloud_observability/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc index 221c16ed..e5d9e6dd 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc @@ -52,7 +52,7 @@ For more information about available parameters for `snmpTraps`, see xref:config You can create alerts that are configured for delivery by SNMP traps by adding labels that are parsed by the prometheus-webhook-snmp middleware to define the trap information and delivered object identifiers (OID). Adding the `oid` or `severity` labels is only required if you need to change the default values for a particular alert definition. -NOTE:: When you set the oid label, the top-level SNMP trap OID changes, but the sub-OIDs remain defined by the global `trapOidPrefix` value plus the child OID values `.1.1.1` through `.1.1.9`. For more information about the MIB definition, see xref:overview-of-the-mib-definition_{context}[]. +NOTE: When you set the oid label, the top-level SNMP trap OID changes, but the sub-OIDs remain defined by the global `trapOidPrefix` value plus the child OID values `.1.1.1` through `.1.1.9`. For more information about the MIB definition, see xref:overview-of-the-mib-definition_{context}[]. .Procedure 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 892d1317..f5017fb1 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 @@ -40,6 +40,8 @@ data: role: edge verifyHostname: false sslProfile: sslProfile + saslUsername: guest@default-interconnect + saslPassword: pass: MetricsQdrSSLProfiles: - name: sslProfile 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 60455cde..769fb11c 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 @@ -9,6 +9,7 @@ To configure the {Project} ({ProjectShort}) connection, you must create a file t ifdef::include_when_13,include_when_17[] * Retrieve the CA certificate from the {MessageBus} deployed by {ProjectShort}. For more information, see xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] +* Retrieve the {MessageBus} password. For more information, see xref:retrieving-the-qdr-password_assembly-completing-the-stf-configuration[]. * Retrieve the {MessageBus} route address. For more information, see xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. // The following configuration should match the contents in modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc. If you have changes to make, please make the same changes to both files. @@ -41,6 +42,8 @@ parameter_defaults: role: edge verifyHostname: false sslProfile: sslProfile + saslUsername: guest@default-interconnect + saslPassword: pass: MetricsQdrSSLProfiles: - name: sslProfile @@ -67,11 +70,11 @@ endif::[] * The `qdr::router_id` configuration is to override the default value which uses the fully-qualified domain name (FQDN) of the host. In some cases the FQDN can result in a router ID length of greater than 61 characters which results in failed QDR connections. For deployments with shorter FQDN values this is not necessary. * 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` parameter with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. +* 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[] -* 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[]. * 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[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc index ccb2fb01..14c6c2d9 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc @@ -8,13 +8,13 @@ To configure the duration of the TLS certificates to use with {Project} ({Projec * You didn't deploy an instance of Service Telemetry Operator already. -NOTE:: When you create the `ServiceTelemetry` object, the required certificates and their secrets for {ProjectShort} are also created. -For more information about how to modify the certificates and the secrets, see: xref:assembly-renewing-the-amq-interconnect-certificate_assembly[] +NOTE: When you create the `ServiceTelemetry` object, the required certificates and their secrets for {ProjectShort} are also created. +For more information about how to modify the certificates and the secrets, see: xref:assembly-renewing-the-amq-interconnect-certificate_assembly[]. The following procedure is valid for new {ProjectShort} deployments. .Procedure -To edit the duration of the TLS certificate, you can set the QDR `caCertDuration`, for example `87600h` for 10 years: +. To edit the duration of the TLS certificate, you can set the QDR `caCertDuration`, for example `87600h` for 10 years: + [source,yaml,options="nowrap",role="white-space-pre"] ---- @@ -41,4 +41,4 @@ EOF ---- $ oc get secret default-interconnect-selfsigned -o jsonpath='{.data.tls\.crt}' | base64 -d | openssl x509 -in - -text | grep "Not After" Not After : Mar 9 21:00:16 2033 GMT ----- \ No newline at end of file +---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc index 718c21c5..232ae45d 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc @@ -6,138 +6,70 @@ Create a `ServiceTelemetry` object in {OpenShift} to result in the Service Telem .Procedure -. To create a `ServiceTelemetry` object that results in an {ProjectShort} deployment that uses the default values, create a `ServiceTelemetry` object with an empty `spec` parameter: +. To create a `ServiceTelemetry` object that results in an {ProjectShort} using the core components for metrics delivery, create a `ServiceTelemetry` object: + [source,yaml,options="nowrap",role="white-space-pre"] ---- $ oc apply -f - <