diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 8627eb74..4060da23 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -39,7 +39,6 @@ endif::[] ifeval::["{build}" == "upstream"] :ObservabilityOperator: Observability{nbsp}Operator :OpenShift: OpenShift -:OpenShiftShort: OKD :OpenStack: OpenStack :OpenStackShort: OSP :OpenStackVersion: Wallaby @@ -58,7 +57,6 @@ endif::[] ifeval::["{build}" == "downstream"] :ObservabilityOperator: Cluster{nbsp}Observability{nbsp}Operator :OpenShift: Red{nbsp}Hat{nbsp}OpenShift{nbsp}Container{nbsp}Platform -:OpenShiftShort: OCP :OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform :OpenStackShort: RHOSP :OpenStackVersion: 17.1 diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 28916ec4..c7a64342 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -18,17 +18,11 @@ ifdef::include_when_16[] * xref:container-health-and-api-status_assembly-advanced-features[Monitoring container health and API status] endif::include_when_16[] - //Dashboards include::../modules/con_dashboards.adoc[leveloffset=+1] include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2] -ifdef::include_when_16[] -// 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] - +include::../modules/proc_connecting-an-external-dashboard-system.adoc[leveloffset=+2] //Editing the metrics retention time period include::../modules/con_metrics-retention-time-period.adoc[leveloffset=+1] @@ -69,13 +63,10 @@ include::../modules/con_resource-usage-of-openstack.adoc[leveloffset=+1] include::../modules/proc_disabling-resource-usage-monitoring-of-openstack-services.adoc[leveloffset=+2] //Monitoring container health - include::../modules/con_container-health-and-api-status.adoc[leveloffset=+1] include::../modules/proc_disabling-container-health-and-api-status-monitoring.adoc[leveloffset=+2] endif::include_when_16[] - - //reset the context ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:] 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 7b084d58..bbbbd7f9 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 @@ -21,10 +21,10 @@ ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"] * {OpenShift} version {SupportedOpenShiftVersion} is running. endif::[] ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] -* An {OpenShift} version inclusive of {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion} is running. +* An {OpenShift} Extended Update Support (EUS) release version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} is running. endif::[] * You have prepared your {OpenShift} environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShift} environment. For more information about {ProjectShort} performance, see the Red Hat Knowledge Base article https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling]. -* Your environment is fully connected. {ProjectShort} does not work in a {OpenShift}-disconnected environments or network proxy environments. +* You have deployed {ProjectShort} in a fully connected or {OpenShift}-disconnected environments. {ProjectShort} is unavailable in network proxy environments. ifeval::["{build}" == "downstream"] [IMPORTANT] @@ -32,7 +32,7 @@ ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"] {ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} endif::[] ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] -{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}. +{ProjectShort} is compatible with {OpenShift} versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}. endif::[] endif::[] @@ -42,6 +42,7 @@ endif::[] * For more information about Operator catalogs, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-rh-catalogs.html[_Red Hat-provided Operator catalogs_]. * For more information about the cert-manager Operator for Red Hat, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/security/cert_manager_operator/index.html[_cert-manager Operator for Red Hat OpenShift overview_]. * For more information about {ObservabilityOperator}, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/monitoring/cluster_observability_operator/cluster-observability-operator-overview.html[_Cluster Observability Operator Overview_]. +* For more information about OpenShift life cycle policy and Extended Update Support (EUS), see https://access.redhat.com/support/policy/updates/openshift[_Red Hat OpenShift Container Platform Life Cycle Policy_]. include::../modules/con_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc index 2178e603..8221cb70 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_introduction-to-stf.adoc @@ -31,7 +31,7 @@ ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"] {ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} endif::[] ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] -{ProjectShort} is compatible with {OpenShift} version {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion}. +{ProjectShort} is compatible with {OpenShift} Extended Update Support (EUS) release versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}. endif::[] endif::[] @@ -40,6 +40,7 @@ endif::[] * https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/[{OpenShift} product documentation] * https://access.redhat.com/articles/4907241[Service Telemetry Framework Performance and Scaling] * https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/welcome/index.html#cluster-installer-activities[OpenShift Container Platform {NextSupportedOpenShiftVersion} Documentation] +* https://access.redhat.com/support/policy/updates/openshift[Red Hat OpenShift Container Platform Life Cycle Policy] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc index ea2ef706..5b4a3f7e 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc @@ -10,7 +10,6 @@ To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must * Ensure that you have persistent storage available in your {OpenShift} cluster for a production-grade deployment. For more information, see <>. * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <>. -* Ensure that you have a fully connected network environment. For more information, see xref:con-network-considerations-for-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[]. include::../modules/con_observability-strategy.adoc[leveloffset=+1] include::../modules/con_persistent-volumes.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc b/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc index 6e9cf0e9..07745dd9 100644 --- a/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_dashboards.adoc @@ -7,7 +7,6 @@ Use the third-party application, Grafana, to visualize system-level metrics that For more information about configuring data collectors, see xref:configuring-red-hat-openstack-platform-overcloud-for-stf_assembly-completing-the-stf-configuration[]. ifdef::include_when_16[] -//TODO: can re-work this once we have OSP13 dashboard(s) to show. Can't use container health checks or monitoring in OSP13. You can use dashboards to monitor a cloud: Infrastructure dashboard:: diff --git a/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc b/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc index 1b1159ba..1478ecb2 100644 --- a/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_manifest-overrides.adoc @@ -26,7 +26,7 @@ = Customizing the deployment [role="_abstract"] -The Service Telemetry Operator watches for a `ServiceTelemetry` manifest to load into {OpenShift} ({OpenShiftShort}). The Operator then creates other objects in memory, which results in the dependent Operators creating the workloads they are responsible for managing. +The Service Telemetry Operator watches for a `ServiceTelemetry` manifest to load into {OpenShift}. The Operator then creates other objects in memory, which results in the dependent Operators creating the workloads they are responsible for managing. [WARNING] ==== diff --git a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc index e22f0275..58706cc5 100644 --- a/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_network-considerations-for-service-telemetry-framework.adoc @@ -3,4 +3,4 @@ [id="con-network-considerations-for-service-telemetry-framework_{context}"] = Network considerations for Service Telemetry Framework -You can only deploy {Project} ({ProjectShort}) in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. +You can deploy {Project} ({ProjectShort}) in fully connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. \ No newline at end of file diff --git a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc index c81d282b..b14e8087 100644 --- a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc @@ -87,10 +87,12 @@ ifeval::["{SupportedOpenShiftVersion}" == "{NextSupportedOpenShiftVersion}"] * {OpenShift} {SupportedOpenShiftVersion} endif::[] ifeval::["{SupportedOpenShiftVersion}" != "{NextSupportedOpenShiftVersion}"] -* {OpenShift} {SupportedOpenShiftVersion} through {NextSupportedOpenShiftVersion} +* {OpenShift} Extended Update Support (EUS) releases {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion} endif::[] * Infrastructure platform +For more information about the {OpenShift} EUS releases, see link:https://access.redhat.com/support/policy/updates/openshift[Red Hat OpenShift Container Platform Life Cycle Policy]. + [[osp-stf-server-side-monitoring]] .Server-side STF monitoring infrastructure image::363_OpenStack_STF_updates_0923_deployment_prereq.png[Server-side STF monitoring infrastructure] diff --git a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc index f9bc7c19..dff80c81 100644 --- a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc @@ -4,6 +4,6 @@ [role="_abstract"] Red Hat supports the core Operators and workloads, including {MessageBus}, {ObservabilityOperator} (Prometheus, Alertmanager), Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of Elasticsearch, Grafana, and their Operators. -You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. +You can deploy {Project} ({ProjectShort}) in fully connected network environments or in {OpenShift}-disconnected environments. You cannot deploy {ProjectShort} in network proxy environments. For more information about {ProjectShort} life cycle and support status, see the https://access.redhat.com/node/6225361[{Project} Supported Version Matrix]. diff --git a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc index f75060ea..874f7c04 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_accessing-uis-for-stf-components.adoc @@ -4,7 +4,18 @@ [role="_abstract"] In {OpenShift}, applications are exposed to the external network through a route. For more information about routes, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/networking/configuring_ingress_cluster_traffic/overview-traffic.html[Configuring ingress cluster traffic]. -In {Project} ({ProjectShort}), HTTPS routes are exposed for each service that has a web-based interface. These routes are protected by {OpenShift} RBAC and any user that has a `ClusterRoleBinding` that enables them to view {OpenShift} Namespaces can log in. For more information about RBAC, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. +In {Project} ({ProjectShort}), HTTPS routes are exposed for each service that has a web-based interface and protected by {OpenShift} role-based access control (RBAC). + +You need the following permissions to access the corresponding component UI's: + +[source,json,options="nowrap"] +---- +{"namespace":"service-telemetry", "resource":"grafana", "group":"grafana.integreatly.org", "verb":"get"} +{"namespace":"service-telemetry", "resource":"prometheus", "group":"monitoring.rhobs", "verb":"get"} +{"namespace":"service-telemetry", "resource":"alertmanager", "group":"monitoring.rhobs", "verb":"get"} +---- + +For more information about RBAC, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/authentication/using-rbac.html[Using RBAC to define and apply permissions]. .Procedure diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc index e406ae5d..fa356b4f 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-observability-strategy.adoc @@ -24,7 +24,7 @@ EOF + [source,bash] ---- -$ for o in alertmanager/default prometheus/default elasticsearch/elasticsearch grafana/default; do oc delete $o; done +$ for o in alertmanagers.monitoring.rhobs/default prometheuses.monitoring.rhobs/default elasticsearch/elasticsearch grafana/default-grafana; do oc delete $o; done ---- + . To verify that all workloads are operating correctly, view the pods and the status of each pod: diff --git a/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc b/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc new file mode 100644 index 00000000..4cc39b7a --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_connecting-an-external-dashboard-system.adoc @@ -0,0 +1,77 @@ + +[id="connecting-an-external-dashboard-system_{context}"] += Connecting an external dashboard system + +It is possible to configure third-party visualization tools to connect to the {ProjectShort} Prometheus for metrics retrieval. Access is controlled via an OAuth token, and a ServiceAccount is already created that has (only) the required permissions. A new OAuth token can be generated against this account for the external system to use. + +To use the authentication token, the third-party tool must be configured to supply an HTTP Bearer Token Authorization header as described in RFC6750. Consult the documentation of the third-party tool for how to configure this header. For example link:https://grafana.com/docs/grafana/latest/datasources/prometheus/configure-prometheus-data-source/#custom-http-headers[Configure Prometheus - Custom HTTP Headers] in the _Grafana Documentation_. + +.Procedure + +. Log in to {OpenShift}. + +. Change to the `service-telemetry` namespace: ++ +[source,bash] +---- +$ oc project service-telemetry +---- + +. Create a new token secret for the stf-prometheus-reader service account ++ +[source,bash] +---- +$ oc create -f - < +---- ++ +* Replace with the filepath to the mirror registry that you want to use. + +. Locate the generated manifests and apply them to the target {OpenShift} cluster. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{NextSupportedOpenShiftVersion}/html/installing/disconnected-installation-mirroring#oc-mirror-updating-cluster-manifests_installing-mirroring-disconnected[Configuring your cluster to use the resources generated by oc-mirror] in the {OpenShift} _Installing_ guide. ++ +NOTE: The manifests that you generate with `oc-mirror` produce catalogs with the full index name, such as `redhat-operator-index` instead of `redhat-operators` for `CatalogSource`. Ensure that you use the correct index name for the {ProjectShort} subscriptions. For more information, see xref:deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf[]. For more information about customizing Operators with oc mirror, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7016714[How to customize the catalog name and tags of Operators mirrored to the mirror registry using the oc mirror plugin.] + +.Verification + +* Check that the catalog sources are applied. You can return the entries for new catalogs that reference the {ProjectShort} operators and their dependencies: ++ +[source,bash,options="nowrap",role="white-space-pre"] +---- +$ oc get catalogsources +---- + +* You have deployed {ProjectShort} in a disconnected {OpenShift} cluster and therefore cannot access external networks. diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc index bbea3297..91bc7fad 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-the-overcloud.adoc @@ -17,7 +17,7 @@ $ source ~/stackrc . Add your data collection and {MessageBus} environment files to the stack with your other environment files and deploy the overcloud: + -[source,bash] +[source,bash,options="nowrap"] ---- (undercloud)$ openstack overcloud deploy --templates \ -e [your environment files] \ diff --git a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc index 86602898..21c4d2d6 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc @@ -1,76 +1,67 @@ [id="importing-dashboards_{context}"] -= Importing dashboards += Enabling dashboards [role="_abstract"] -The Grafana Operator can import and manage dashboards by creating `GrafanaDashboard` objects. You can view example dashboards at https://github.com/infrawatch/dashboards. +The Grafana Operator can import and manage dashboards by creating `GrafanaDashboard` objects. Service Telemetry Operator can enable a set of default dashboards that create the `GrafanaDashboard` objects that load dashboards into the Grafana instance. -.Procedure +Set the value of `graphing.grafana.dashboards.enabled` to `true` to load the following dashboards into Grafana : -. Import the infrastructure dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-dashboard.yaml +* Infrastructure dashboard +* Cloud view dashboard +* Virtual machine view dashboard +* Memcached view dashboard -grafanadashboard.integreatly.org/rhos-dashboard-1 created ----- -. Import the cloud dashboard: -+ -[WARNING] -In the `enable-stf.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. -ifdef::include_before_17[] -For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. -endif::include_before_17[] -ifdef::include_when_17[] -For more information about the `virt` plugin, see link:{defaultURL}/managing_overcloud_observability/collectd-plugins_assembly[collectd plugins]. -endif::include_when_17[] -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/rhos-cloud-dashboard.yaml +You can use the `GrafanaDashboard` object to create and load additional dashboards into Grafana. For more information about managing dashboards with Grafana Operator, see link:https://grafana.github.io/grafana-operator/docs/dashboards/[Dashboards] in the _Grafana Operator project documentation_. -grafanadashboard.integreatly.org/rhos-cloud-dashboard-1 created ----- -. Import the virtual machine dashboard: -+ -[source,bash,options="nowrap"] ----- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/virtual-machine-view.yaml +.Prerequisites -grafanadashboard.integreatly.org/virtual-machine-view-1 configured ----- -. Import the memcached dashboard: +* You enabled graphing in the `ServiceTelemetry` object. For more information about graphing, see xref:setting-up-grafana-to-host-the-dashboard_assembly-advanced-features[]. + +.Procedure + +. To enable the managed dashboards, create or modify the `ServiceTelemetry` object. Set `graphing.grafana.dashboards.enabled` to `true`: + -[source,bash,options="nowrap"] +[source,bash] ---- -$ oc apply -f https://raw.githubusercontent.com/infrawatch/dashboards/master/deploy/stf-1/memcached-dashboard.yaml +$ oc edit stf default -grafanadashboard.integreatly.org/memcached-dashboard-1 created +apiVersion: infra.watch/v1beta1 +kind: ServiceTelemetry +... +spec: + ... + graphing: + enabled: true + grafana: + dashboards: + enabled: true ---- -. Verify that the dashboards are available: +. Verify that the Grafana dashboards are created. The process of Service Telemetry Operator creating the dashboards might take some time. + -[source,bash] +[source,bash,options="nowrap"] ---- -$ oc get grafanadashboards +$ oc get grafanadashboards.grafana.integreatly.org -NAME AGE -memcached-dashboard-1 7s -rhos-cloud-dashboard-1 23s -rhos-dashboard-1 29s -virtual-machine-view-1 13s +NAME NO MATCHING INSTANCES LAST RESYNC AGE +memcached-dashboard-1 38s 38s +rhos-cloud-dashboard-1 39s 39s +rhos-dashboard-1 39s 39s +virtual-machine-dashboard-1 37s 37s ---- . Retrieve the Grafana route address: + [source,bash,options="nowrap"] ---- -$ oc get route grafana-route -ojsonpath='{.spec.host}' +$ oc get route default-grafana-route -ojsonpath='{.spec.host}' -grafana-route-service-telemetry.apps.infra.watch +default-grafana-route-service-telemetry.apps.infra.watch ---- . In a web browser, navigate to https://__. Replace __ with the value that you retrieved in the previous step. -. To view the dashboard, click *Dashboards* and *Manage*. +. Log in with OpenShift credentials. For more information about logging in, see xref:accessing-uis-for-stf-components_assembly-installing-the-core-components-of-stf[]. + +. To view the dashboard, click *Dashboards* and *Browse*. The managed dashboards are available in the _service-telemetry_ folder. 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 deleted file mode 100644 index 0a7c8ec6..00000000 --- a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc +++ /dev/null @@ -1,76 +0,0 @@ -// Module included in the following assemblies: -// -// - -// This module can be included from assemblies using the following include statement: -// include::/proc_overriding-a-managed-manifest.adoc[leveloffset=+1] - - -[id="overriding-a-managed-manifest_{context}"] -= Overriding a managed manifest - -[role="_abstract"] -Edit the `ServiceTelemetry` object and provide a parameter and manifest. For a list of available manifest override parameters, see xref:manifest-overrides_assembly-advanced-features[]. The default `ServiceTelemetry` object is `default`. Use `oc get servicetelemetry` to list the available {ProjectShort} deployments. - -[TIP] -The `oc edit` command loads the default system editor. To override the default editor, pass or set the environment variable `EDITOR` to the preferred editor. For example, `EDITOR=nano oc edit servicetelemetry default`. - -.Procedure - -. Log in to {OpenShift}. -. Change to the `service-telemetry` namespace: -+ -[source,bash] ----- -$ oc project service-telemetry ----- - -. Load the `ServiceTelemetry` object into an editor: -+ -[source,bash] ----- -$ 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. -==== -+ -[source,yaml,options="nowrap"] ----- -$ oc edit stf default - -apiVersion: infra.watch/v1beta1 -kind: ServiceTelemetry -metadata: - ... -spec: - alertmanagerConfigManifest: | - apiVersion: v1 - kind: Secret - metadata: - name: 'alertmanager-default' - namespace: 'service-telemetry' - type: Opaque - stringData: - alertmanager.yaml: |- - global: - resolve_timeout: 10m - route: - group_by: ['job'] - group_wait: 30s - group_interval: 5m - repeat_interval: 12h - receiver: 'null' - receivers: - - name: 'null' -status: - ... ----- -+ -The `alertmanagerConfigManifest` manifest override parameter is defined in the `spec` of the `ServiceTelemetry` object. - -. Save and close. 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 deleted file mode 100644 index b158ee74..00000000 --- a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc +++ /dev/null @@ -1,41 +0,0 @@ -[id="proc-retrieving-and-setting-grafana-credentials_{context}"] -= 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. - -[WARNING] -==== -Ensure that you log in to access the dashboards with the _Log in with OpenShift_ button, because the default username and password set by the Grafana Operator is deprecated. -==== - -You can override the credentials in the `ServiceTelemetry` object to have {Project} ({ProjectShort}) set the username and password for Grafana instead. - -.Procedure - -. Log in to {OpenShift}. -. Change to the `service-telemetry` namespace: -+ -[source,bash] ----- -$ oc project service-telemetry ----- -. Retrieve the existing username and password from the {ProjectShort} object: -+ -[source,bash] ----- -$ oc get stf default -o jsonpath="{.spec.graphing.grafana['adminUser','adminPassword']}" ----- - -. To modify the default values of the Grafana administrator username and password through the ServiceTelemetry object, use the `graphing.grafana.adminUser` and `graphing.grafana.adminPassword` parameters. -+ -[source,bash] ----- -$ oc edit stf default ----- -. Wait for the grafana pod to restart with the new credentials in place -+ -[source,bash] ----- -$ oc get po -l app=grafana -w ----- diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc index d3de9443..5cdde97f 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc @@ -4,17 +4,9 @@ [role="_abstract"] Grafana is not included in the default {Project} ({ProjectShort}) deployment, so you must deploy the Grafana Operator from community-operators CatalogSource. If you use the Service Telemetry Operator to deploy Grafana, it results in a Grafana instance and the configuration of the default data sources for the local {ProjectShort} deployment. -ifdef::include_16[The dashboards in {ProjectShort} require features that are available only in Grafana version 8.1.0 and later. By default, the Service Telemetry Operator installs a compatible version. For more information about how to override the Grafana container image, see xref:overriding-the-default-grafana-container-image_assembly-advanced-features[].] - .Procedure -. Log in to {OpenShift}. -. Change to the `service-telemetry` namespace: -+ -[source,bash] ----- -$ oc project service-telemetry ----- +. Log in to your {OpenShift} environment where {ProjectShort} is hosted. . Subscribe to the Grafana Operator by using the community-operators CatalogSource: + @@ -31,10 +23,12 @@ $ oc apply -f - <