From 1fddfcb5ab97b4dbb99a17b308c64642c583e5b0 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 25 Oct 2023 10:59:20 -0400 Subject: [PATCH] Add deprecation note for Grfana authentication Deprecate the basic auth login parameters for Grafana login. Preference is to use the Log in for OpenShift button going forward. Fix syntax issues in asciidoc. --- .../modules/proc_configuring-snmp-traps.adoc | 2 +- .../proc_configuring-tls-certificates-duration.adoc | 8 ++++---- .../modules/proc_overriding-a-managed-manifest.adoc | 6 ++++-- ...retrieving-and-setting-grafana-login-credentials.adoc | 9 +++++++-- 4 files changed, 16 insertions(+), 9 deletions(-) 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-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_overriding-a-managed-manifest.adoc b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc index 28bc958c..0a7c8ec6 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc @@ -34,8 +34,10 @@ $ oc edit servicetelemetry default . To modify the `ServiceTelemetry` object, provide a manifest override parameter and the contents of the manifest to write to {OpenShiftShort} instead of the defaults provided by {ProjectShort}. + -NOTE: The trailing pipe (`|`) after entering the manifest override parameter indicates that the value provided is multi-line. - +[NOTE] +==== +The trailing pipe (`|`) after entering the manifest override parameter indicates that the value provided is multi-line. +==== + [source,yaml,options="nowrap"] ---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc index 7d986a74..91814037 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc @@ -2,7 +2,12 @@ = Retrieving and setting Grafana login credentials [role="_abstract"] -When Grafana is enabled, you can login using openshift authentication, or the default username and password set by the Grafana Operator. +When Grafana is enabled, you can login using OpenShift authentication, or the default username and password set by the Grafana Operator. + +[WARNING] +==== +Logging in using the default username and password set by the Grafana Operator is deprecated. Use the _Log in with OpenShift_ button to access the dashboards. +==== You can override the credentials in the `ServiceTelemetry` object to have {Project} ({ProjectShort}) set the username and password for Grafana instead. @@ -33,4 +38,4 @@ $ oc edit stf default [source,bash] ---- $ oc get po -l app=grafana -w ----- \ No newline at end of file +----