$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
In OKD, you can enable monitoring for user-defined projects in addition to the default platform monitoring. You can monitor your own projects in OKD without the need for an additional monitoring solution. Using this feature centralizes monitoring for core platform components and user-defined projects.
Versions of Prometheus Operator installed using Operator Lifecycle Manager (OLM) are not compatible with user-defined monitoring. Therefore, custom Prometheus instances installed as a Prometheus custom resource (CR) managed by the OLM Prometheus Operator are not supported in OKD. |
Cluster administrators can enable monitoring for user-defined projects by setting the enableUserWorkload: true
field in the cluster monitoring ConfigMap
object.
You must remove any custom Prometheus instances before enabling monitoring for user-defined projects. |
You must have access to the cluster as a user with the |
You have access to the cluster as a user with the cluster-admin
cluster role.
You have installed the OpenShift CLI (oc
).
You have created the cluster-monitoring-config
ConfigMap
object.
You have optionally created and configured the user-workload-monitoring-config
ConfigMap
object in the openshift-user-workload-monitoring
project. You can add configuration options to this ConfigMap
object for the components that monitor user-defined projects.
Every time you save configuration changes to the |
Edit the cluster-monitoring-config
ConfigMap
object:
$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
Add enableUserWorkload: true
under data/config.yaml
:
apiVersion: v1
kind: ConfigMap
metadata:
name: cluster-monitoring-config
namespace: openshift-monitoring
data:
config.yaml: |
enableUserWorkload: true (1)
1 | When set to true , the enableUserWorkload parameter enables monitoring for user-defined projects in a cluster. |
Save the file to apply the changes. Monitoring for user-defined projects is then enabled automatically.
If you enable monitoring for user-defined projects, the |
Verify that the prometheus-operator
, prometheus-user-workload
, and thanos-ruler-user-workload
pods are running in the openshift-user-workload-monitoring
project. It might take a short while for the pods to start:
$ oc -n openshift-user-workload-monitoring get pod
NAME READY STATUS RESTARTS AGE
prometheus-operator-6f7b748d5b-t7nbg 2/2 Running 0 3h
prometheus-user-workload-0 4/4 Running 1 3h
prometheus-user-workload-1 4/4 Running 1 3h
thanos-ruler-user-workload-0 3/3 Running 0 3h
thanos-ruler-user-workload-1 3/3 Running 0 3h
As a cluster administrator, you can monitor all core OKD and user-defined projects.
You can also grant developers and other users different permissions:
Monitoring user-defined projects
Configuring the components that monitor user-defined projects
Configuring alert routing for user-defined projects
Managing alerts and silences for user-defined projects
You can grant the permissions by assigning one of the following monitoring roles or cluster roles:
Role name | Description | Project |
---|---|---|
|
Users with this role can edit the |
|
|
Users with this role have read access to the user-defined Alertmanager API for all projects, if the user-defined Alertmanager is enabled. |
|
|
Users with this role have read and write access to the user-defined Alertmanager API for all projects, if the user-defined Alertmanager is enabled. |
|
Cluster role name | Description | Project |
---|---|---|
|
Users with this cluster role have read access to |
Can be bound with |
|
Users with this cluster role can create, modify, and delete |
Can be bound with |
|
Users with this cluster role have the same privileges as users with the |
Can be bound with |
|
Users with this cluster role can create, update, and delete |
Can be bound with |
You can grant users permissions for the openshift-monitoring
project or their own projects, by using the OKD web console.
You have access to the cluster as a user with the cluster-admin
cluster role.
The user account that you are assigning the role to already exists.
In the Administrator perspective of the OKD web console, go to User Management → RoleBindings → Create binding.
In the Binding Type section, select the Namespace Role Binding type.
In the Name field, enter a name for the role binding.
In the Namespace field, select the project where you want to grant the access.
The monitoring role or cluster role permissions that you grant to a user by using this procedure apply only to the project that you select in the Namespace field. |
Select a monitoring role or cluster role from the Role Name list.
In the Subject section, select User.
In the Subject Name field, enter the name of the user.
Select Create to apply the role binding.
You can grant users permissions for the openshift-monitoring
project or their own projects, by using the OpenShift CLI (oc
).
Whichever role or cluster role you choose, you must bind it against a specific project as a cluster administrator. |
You have access to the cluster as a user with the cluster-admin
cluster role.
The user account that you are assigning the role to already exists.
You have installed the OpenShift CLI (oc
).
To assign a monitoring role to a user for a project, enter the following command:
$ oc adm policy add-role-to-user <role> <user> -n <namespace> --role-namespace <namespace> (1)
1 | Substitute <role> with the wanted monitoring role, <user> with the user to whom you want to assign the role, and <namespace> with the project where you want to grant the access. |
To assign a monitoring cluster role to a user for a project, enter the following command:
$ oc adm policy add-cluster-role-to-user <cluster-role> <user> -n <namespace> (1)
1 | Substitute <cluster-role> with the wanted monitoring cluster role, <user> with the user to whom you want to assign the cluster role, and <namespace> with the project where you want to grant the access. |
As a cluster administrator, you can assign the user-workload-monitoring-config-edit
role to a user. This grants permission to configure and manage monitoring for user-defined projects without giving them permission to configure and manage core OKD monitoring components.
You have access to the cluster as a user with the cluster-admin
cluster role.
The user account that you are assigning the role to already exists.
You have installed the OpenShift CLI (oc
).
Assign the user-workload-monitoring-config-edit
role to a user in the openshift-user-workload-monitoring
project:
$ oc -n openshift-user-workload-monitoring adm policy add-role-to-user \
user-workload-monitoring-config-edit <user> \
--role-namespace openshift-user-workload-monitoring
Verify that the user is correctly assigned to the user-workload-monitoring-config-edit
role by displaying the related role binding:
$ oc describe rolebinding <role_binding_name> -n openshift-user-workload-monitoring
$ oc describe rolebinding user-workload-monitoring-config-edit -n openshift-user-workload-monitoring
Name: user-workload-monitoring-config-edit
Labels: <none>
Annotations: <none>
Role:
Kind: Role
Name: user-workload-monitoring-config-edit
Subjects:
Kind Name Namespace
---- ---- ---------
User user1 (1)
1 | In this example, user1 is assigned to the user-workload-monitoring-config-edit role. |
You can query Prometheus metrics from outside the cluster when monitoring your own services with user-defined projects. Access this data from outside the cluster by using the thanos-querier
route.
This access only supports using a bearer token for authentication.
You have deployed your own service, following the "Enabling monitoring for user-defined projects" procedure.
You are logged in to an account with the cluster-monitoring-view
cluster role, which provides permission to access the Thanos Querier API.
You are logged in to an account that has permission to get the Thanos Querier API route.
If your account does not have permission to get the Thanos Querier API route, a cluster administrator can provide the URL for the route. |
Extract an authentication token to connect to Prometheus by running the following command:
$ TOKEN=$(oc whoami -t)
Extract the thanos-querier
API route URL by running the following command:
$ HOST=$(oc -n openshift-monitoring get route thanos-querier -ojsonpath={.status.ingress[].host})
Set the namespace to the namespace in which your service is running by using the following command:
$ NAMESPACE=ns1
Query the metrics of your own services in the command line by running the following command:
$ curl -H "Authorization: Bearer $TOKEN" -k "https://$HOST/api/v1/query?" --data-urlencode "query=up{namespace='$NAMESPACE'}"
The output shows the status for each application pod that Prometheus is scraping:
{
"status": "success",
"data": {
"resultType": "vector",
"result": [
{
"metric": {
"__name__": "up",
"endpoint": "web",
"instance": "10.129.0.46:8080",
"job": "prometheus-example-app",
"namespace": "ns1",
"pod": "prometheus-example-app-68d47c4fb6-jztp2",
"service": "prometheus-example-app"
},
"value": [
1591881154.748,
"1"
]
}
],
}
}
The formatted example output uses a filtering tool, such as |
Individual user-defined projects can be excluded from user workload monitoring. To do so, add the openshift.io/user-monitoring
label to the project’s namespace with a value of false
.
Add the label to the project namespace:
$ oc label namespace my-project 'openshift.io/user-monitoring=false'
To re-enable monitoring, remove the label from the namespace:
$ oc label namespace my-project 'openshift.io/user-monitoring-'
If there were any active monitoring targets for the project, it may take a few minutes for Prometheus to stop scraping them after adding the label. |
After enabling monitoring for user-defined projects, you can disable it again by setting enableUserWorkload: false
in the cluster monitoring ConfigMap
object.
Alternatively, you can remove |
Edit the cluster-monitoring-config
ConfigMap
object:
$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
Set enableUserWorkload:
to false
under data/config.yaml
:
apiVersion: v1
kind: ConfigMap
metadata:
name: cluster-monitoring-config
namespace: openshift-monitoring
data:
config.yaml: |
enableUserWorkload: false
Save the file to apply the changes. Monitoring for user-defined projects is then disabled automatically.
Check that the prometheus-operator
, prometheus-user-workload
and thanos-ruler-user-workload
pods are terminated in the openshift-user-workload-monitoring
project. This might take a short while:
$ oc -n openshift-user-workload-monitoring get pod
No resources found in openshift-user-workload-monitoring project.
The |