Monitoring your OpenShift cluster health with Insights Advisor

Procedure

1. Navigate to OpenShift > Advisor > Recommendations.
2. In the main, filter-type drop-down list, select the Category filter type.
3. Expand the filter-value drop-down list and select the checkbox next to each category of recommendation you want to view. Leave the checkboxes for unnecessary categories clear.
4. Optional: Apply additional filters to further refine the list.

Procedure

1. Go to OpenShift > Advisor > Workloads.

2. Click a namespace (identified by cluster and namespace) to display the namespace details page, which includes recommendations based on the Deployment Validation Operator (DVO) checks for this namespace.

   Note

   You can use the filtering function to search by cluster name or namespace name.

3. Click the arrow next to a recommendation to see the following information about the issue:

   • A description of the detected issue
   • Steps to resolve the issue on affected objects in the namespace
   • Identifiers for affected objects in the namespace
   • Additional resources and information
4. Click View all objects to view a list of all of the objects affected by the recommendation in this namespace.

Procedure

1. Navigate to OpenShift > Advisor > Workloads.

2. Click a namespace that relates to the recommendation that includes the object you want to exclude. A namespace is identified by cluster and namespace.

   Note

   You can use the filtering function to search by the following:

   • For self-managed clusters: cluster name and namespace name
   • For managed clusters: cluster name and namespace UUID

3. Expand Description on the details page to see all issues or click the arrow next to a recommendation to see the following information about the issue:

   • A description of the detected issue
   • Steps to resolve the issue on affected objects in the namespace
   • Identifiers for affected objects in the namespace
   • Additional resources and information
4. Note the name of the KubeLinter check, for example run-as-non-root or non-isolated-pod.
5. In the Steps to resolve section, click View all objects to display a list of all of the objects affected by the recommendation in this namespace.
6. Note the Name and Kind values for the workload object you want to exclude from the Deployment Validation Operator’s (DVO) KubeLinter checks. You will need this information to change the annotation for the object.

7. Use Ignoring specific resources in the Github resource for Deployment Validation Operator (DVO) to annotate the object based on your organization’s workflow. The following example shows a change to the annotation in the nginx deployment object in the project named test-dvo to exclude the nginx object from the KubeLinter check run-as-root. In this YAML example, you would add the annotation, ignore-check.kube-linter.io/run-as-non-root: "This image must be run as a privileged user for it to work..

   kind: Deployment
   apiVersion: apps/v1
   metadata:
     annotations:
       deployment.kubernetes.io/revision: '1'
       kubectl.kubernetes.io/last-applied-configuration: |
         {"apiVersion":"apps/v1","kind":"Deployment","metadata":{"annotations":{},"labels":{"app":"nginx"},"name":"nginx","namespace":"test-dvo"},"spec":{"replicas":3,"selector":{"matchLabels":{"app":"nginx"}},"template":{"metadata":{"labels":{"app":"nginx"}},"spec":{"containers":[{"image":"nginxinc/nginx-unprivileged:1.18","name":"nginx","ports":[{"containerPort":8080}]}]}}}}
       ignore-check.kube-linter.io/run-as-non-root: "This image must be run as a privileged user for it to work.”
     resourceVersion: '114842'
     name: nginx
     uid: bf934080-0e21-4ae3-a6d1-d6d077b8d6f3

   Copy to Clipboard Toggle word wrap
8. It takes approximately two hours for the Insights Operator to update the recommendations. After the update completes, the recommendation for the specific object is no longer shown in the annotation.

Procedure

1. Go to the Overview page for the cluster in the OpenShift web console.
2. Look for the Status block, an Insights link, and the number of detected issues.

3. If one or more issues exist, click the Insights link to open the advisor service in the Hybrid Cloud Console.

   The cluster information page displays. On the Recommendations tab, you can see the issues detected for the cluster.

4. Click the arrow to view complete information about the issue, including the necessary actions to resolve it.