From 6f4137b2da29b110100cdc96f23054e6f9c3d2d4 Mon Sep 17 00:00:00 2001 From: JoanneOFlynn2018 <45287002+JoanneOFlynn2018@users.noreply.github.com> Date: Thu, 3 Jun 2021 17:41:52 +0100 Subject: [PATCH] Jof 1967679 doc sweep (#197) * https://bugzilla.redhat.com/show_bug.cgi?id=1967679 Sweep for edits pre 1.3 * Minor edits to Gnocchi file * Update doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc * Update doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc Co-authored-by: Leif Madsen --- common/stf-attributes.adoc | 2 + .../assembly_advanced-features.adoc | 10 +++-- ...installing-the-core-components-of-stf.adoc | 4 +- .../modules/con_high-availability.adoc | 7 +--- ...erview-of-the-servicetelemetry-object.adoc | 5 +-- .../modules/con_stf-architecture.adoc | 2 +- .../proc_configuring-gnocchi-metrics.adoc | 4 +- ...-servicetelemetry-object-in-openshift.adoc | 40 +++++++++---------- .../proc_deploying-smart-gateways.adoc | 2 +- ...eratorhub-io-community-catalog-source.adoc | 5 ++- ...ting-up-grafana-to-host-the-dashboard.adoc | 14 +++---- ...-the-amq-certificate-manager-operator.adoc | 31 ++------------ 12 files changed, 51 insertions(+), 75 deletions(-) diff --git a/common/stf-attributes.adoc b/common/stf-attributes.adoc index 27a76eaf..d8b1eb97 100644 --- a/common/stf-attributes.adoc +++ b/common/stf-attributes.adoc @@ -33,6 +33,7 @@ ifeval::["{build}" == "upstream"] :ProjectShort: STF :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router :SupportedOpenShiftVersion: 4.6 +:NextSupportedOpenShiftVersion: 4.7 endif::[] ifeval::["{build}" == "downstream"] @@ -48,4 +49,5 @@ ifeval::["{build}" == "downstream"] :ProjectShort: STF :MessageBus: AMQ{nbsp}Interconnect :SupportedOpenShiftVersion: 4.6 +:NextSupportedOpenShiftVersion: 4.7 endif::[] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index e4325b1c..0cf2eaa3 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -55,6 +55,12 @@ include::../modules/con_dashboards.adoc[leveloffset=+1] include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2] include::../modules/ref_the-grafana-infrastructure-dashboard.adoc[leveloffset=+2] +//Monitoring the resource usage of Openstack services +include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1] + +//Monitoring container health +include::../modules/proc_monitoring-container-health-and-api-status.adoc[leveloffset=+1] + //Connecting multiple clouds include::../modules/con_configuring-multiple-clouds.adoc[leveloffset=+1] include::../modules/proc_planning-amqp-address-prefixes.adoc[leveloffset=+2] @@ -68,11 +74,7 @@ include::../modules/proc_querying-metrics-data-from-multiple-clouds.adoc[levelof include::../modules/con_ephemeral-storage.adoc[leveloffset=+1] include::../modules/proc_configuring-ephemeral-storage.adoc[leveloffset=+2] -//Monitoring the resource usage of Openstack services -include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1] -//Monitoring container health -include::../modules/proc_monitoring-container-health-and-api-status.adoc[leveloffset=+1] //Exposing services as routes include::../modules/proc_creating-a-route-in-ocp.adoc[leveloffset=+1] 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 65b8a4c4..0ed5bc04 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 @@ -25,13 +25,13 @@ You can use Operators to load the various application components and objects. Ea .Prerequisites -* {OpenShift} ({OpenShiftShort}) version 4.5 or 4.6 is running. +* {OpenShift} ({OpenShiftShort}) version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} is running. * You have prepared your {OpenShift} ({OpenShiftShort}) environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShiftShort} environment. ifeval::["{build}" == "downstream"] [IMPORTANT] -{Project} ({ProjectShort}) is compatible with {OpenShift} versions 4.5 and 4.6. +{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}. //For more information about migrating, see https://access.redhat.com/articles/5477371[Migrating Service Telemetry Framework v1.0 from OperatorSource to CatalogSource]. endif::[] diff --git a/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc b/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc index 95edf4f6..19144481 100644 --- a/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc @@ -28,7 +28,7 @@ [role="_abstract"] High availability is the ability of {Project} ({ProjectShort}) to rapidly recover from failures in its component services. Although {OpenShift} ({OpenShiftShort}) restarts a failed pod if nodes are available to schedule the workload, this recovery process might take more than one minute, during which time events and metrics are lost. A high availability configuration includes multiple copies of {ProjectShort} components, reducing recovery time to approximately 2 seconds. To protect against failure of an {OpenShiftShort} node, deploy {ProjectShort} to an {OpenShiftShort} cluster with three or more nodes. -[NOTE] +[WARNING] {ProjectShort} is not yet a fully fault tolerant system. Delivery of metrics and events during the recovery period is not guaranteed. Enabling high availability has the following effects: @@ -39,8 +39,5 @@ Enabling high availability has the following effects: ** Alertmanager ** Prometheus ** Events Smart Gateway -** Collectd Metrics Smart Gateway +** Metrics Smart Gateway * Recovery time from a lost pod in any of these services reduces to approximately 2 seconds. - -[NOTE] -The Ceilometer Metrics Smart Gateway is not yet HA. diff --git a/doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc b/doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc index 7d4cf10d..08c8bc88 100644 --- a/doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc @@ -39,10 +39,7 @@ Each of these top-level configuration parameters provides various controls for a [IMPORTANT] ==== -Versions of Service Telemetry Operator prior to v1.1.0 used a flat API (`servicetelemetry.infra.watch/v1alpha1`) interface for creating the `ServiceTelemetry` object. -In Service Telemetry Operator v1.1.0, there is a dictionary-based API interface (`servicetelemetry.infra.watch/v1beta1`) to allow for better control of {ProjectShort} deployments, including managing multi-cluster deployments natively, and allowing the management of additional storage backends in the future. Ensure that any previously created `ServiceTelemetry` objects are updated to the new interface. - -Support for `servicetelemetry.infra.watch/v1alpha1` will be removed in {ProjectShort} 1.3. +Support for `servicetelemetry.infra.watch/v1alpha1` was removed from {ProjectShort} 1.3. ==== diff --git a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc index cf643d10..e26b1e60 100644 --- a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc @@ -62,7 +62,7 @@ If you plan to collect and store events, collectd or Ceilometer delivers event d Server-side {ProjectShort} monitoring infrastructure consists of the following layers: * {Project} {ProductVersion} ({ProjectShort}) -* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort}) or 4.6 +* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort}) or {NextSupportedOpenShiftVersion} * Infrastructure platform [[osp-stf-server-side-monitoring]] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc index 5a8a9d20..7bfc44f7 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc @@ -2,7 +2,7 @@ [role="_abstract"] -To send metrics to {Project} ({ProjectShort}} and gnocchi simultaneously, you must include an environment file to your deployment to enable an additional publisher. +To send metrics to {Project} ({ProjectShort}} and Gnocchi simultaneously, you must include an environment file in your deployment to enable an additional publisher. .Prerequisites @@ -68,4 +68,4 @@ sinks: - notifier://172.17.1.35:5666/?driver=amqp&topic=metering ---- + -Ensure that the `publishers` section of the file contains information for both notifier and gnocchi. +Ensure that the `publishers` section of the file contains information for both notifier and Gnocchi. 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 dfae9fcd..85c81e5c 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 @@ -30,7 +30,7 @@ Create a `ServiceTelemetry` object in {OpenShiftShort} to result in the creation .Procedure -. To create a `ServiceTelemetry` object that results in a default {ProjectShort} deployment, create a `ServiceTelemetry` object with an empty `spec` object: +. 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. + [source,bash] ---- @@ -44,7 +44,25 @@ spec: {} EOF ---- + -Creating a default `ServiceTelemetry` object results in a {ProjectShort} deployment with the following defaults: +To override a default value, you need to define only the parameter that you want to override. In this example, you enable ElasticSearch by setting `enabled` to `true`: ++ +[source,yaml] +---- +$ oc apply -f - <