Skip to content

Commit

Permalink
Add deprecation note for Grafana authentication (#510)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
leifmadsen authored Oct 25, 2023
1 parent 0c88867 commit 0c5a236
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
----
Expand All @@ -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
----
----
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -33,4 +38,4 @@ $ oc edit stf default
[source,bash]
----
$ oc get po -l app=grafana -w
----
----

0 comments on commit 0c5a236

Please sign in to comment.