From e1cec58d08f61e4ffb77f3b6e89dc58c646ccfe5 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 31 Jul 2024 18:48:39 +0200 Subject: [PATCH] OBSDOCS-744: Document taint and toleration usage for Tempo/Jaeger/OTEL --- .../distr-tracing-jaeger-configuring.adoc | 13 ++++++--- .../distr-tracing-tempo-configuring.adoc | 29 ++++++++++--------- observability/otel/otel-installing.adoc | 7 ++++- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc index bfc4d7ea76..2146d81d5e 100644 --- a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc @@ -27,7 +27,7 @@ spec: ---- <1> Deployment strategy. -[id="supported-deployment-strategies"] +[id="supported-deployment-strategies_{context}"] == Supported deployment strategies The {JaegerName} Operator currently supports the following deployment strategies: @@ -58,12 +58,12 @@ include::modules/distr-tracing-deploy-production-es.adoc[leveloffset=+1] include::modules/distr-tracing-deploy-streaming.adoc[leveloffset=+1] -[id="validating-your-jaeger-deployment"] +[id="validating-your-jaeger-deployment_{context}"] == Validating your deployment include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+2] -[id="customizing-your-deployment"] +[id="customizing-your-deployment_{context}"] == Customizing your deployment include::modules/distr-tracing-deployment-best-practices.adoc[leveloffset=+2] @@ -74,6 +74,11 @@ endif::[] include::modules/distr-tracing-config-default.adoc[leveloffset=+2] +[id="taints-and-tolerations_{context}"] +=== Using taints and tolerations + +To schedule the Jaeger and Elasticsearch pods on dedicated nodes, see link:https://access.redhat.com/solutions/7040769[How to deploy the different Jaeger components on infra nodes using nodeSelector and tolerations in OpenShift 4]. + include::modules/distr-tracing-config-jaeger-collector.adoc[leveloffset=+2] include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2] @@ -84,7 +89,7 @@ include::modules/distr-tracing-config-query.adoc[leveloffset=+2] include::modules/distr-tracing-config-ingester.adoc[leveloffset=+2] -[id="injecting-sidecars"] +[id="injecting-sidecars_{context}"] == Injecting sidecars The {JaegerName} relies on a proxy sidecar within the application's pod to provide the Agent. The {JaegerName} Operator can inject Agent sidecars into deployment workloads. You can enable automatic sidecar injection or manage it manually. diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc index 0494d02de2..74c9e77f24 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc @@ -8,32 +8,36 @@ toc::[] The {TempoOperator} uses a custom resource definition (CRD) file that defines the architecture and configuration settings for creating and deploying the {TempoShortName} resources. You can install the default configuration or modify the file. -[id="customizing-your-tempo-deployment"] -== Customizing your deployment - ifdef::openshift-enterprise,openshift-dedicated[] -For information about configuring the back-end storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option. +[id="configuring-storages_{context}"] +== Configuring back-end storage + +For information about configuring the back-end storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the relevant configuration section for your chosen storage option. endif::[] -include::modules/distr-tracing-tempo-config-default.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-config-default.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#installing-a-tempostack-instance[Installing a TempoStack instance] * xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#installing-a-tempomonolithic-instance[Installing a TempoMonolithic instance] -include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_distr-tracing-tempo-configuring-query-frontend"] -==== Additional resources +.Additional resources * xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations] -include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+1] -include::modules/distr-tracing-tempo-config-multitenancy.adoc[leveloffset=+2] +include::modules/distr-tracing-tempo-config-multitenancy.adoc[leveloffset=+1] -[id="setting-up-monitoring-for-tempo"] +[id="taints-and-tolerations_{context}"] +== Using taints and tolerations + +To schedule the TempoStack pods on dedicated nodes, see link:https://access.redhat.com/solutions/7040685[How to deploy the different TempoStack components on infra nodes using nodeSelector and tolerations in OpenShift 4]. + +[id="setting-up-monitoring-for-tempo_{context}"] == Configuring monitoring and alerts The {TempoOperator} supports monitoring and alerts about each TempoStack component such as distributor, ingester, and so on, and exposes upgrade and operational metrics about the Operator itself. @@ -41,8 +45,7 @@ The {TempoOperator} supports monitoring and alerts about each TempoStack compone include::modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc[leveloffset=+2] [role="_additional-resources"] -[id="additional-resources_distr-tracing-tempo-configuring-tempostack-metrics-and-alerts"] -==== Additional resources +.Additional resources * xref:../../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] include::modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc[leveloffset=+2] diff --git a/observability/otel/otel-installing.adoc b/observability/otel/otel-installing.adoc index 851bcd16d0..62669e6021 100644 --- a/observability/otel/otel-installing.adoc +++ b/observability/otel/otel-installing.adoc @@ -16,8 +16,13 @@ include::modules/otel-install-web-console.adoc[leveloffset=+1] include::modules/otel-install-cli.adoc[leveloffset=+1] +[id="taints-and-tolerations_{context}"] +== Using taints and tolerations + +To schedule the OpenTelemetry pods on dedicated nodes, see link:https://access.redhat.com/solutions/7040771[How to deploy the different OpenTelemetry components on infra nodes using nodeSelector and tolerations in OpenShift 4] + [role="_additional-resources"] -[id="additional-resources_otel-installing"] +[id="additional-resources_otel-installing_{context}"] == Additional resources * xref:../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin] * link:https://operatorhub.io/[OperatorHub.io]