1. Documentation
×

Remote health reporting

Enabling remote health reporting

If you or your organization have disabled remote health reporting, you can enable this feature again. You can see that remote health reporting is disabled from the message Insights not available in the Status tile on the OKD web console Overview page.

To enable remote health reporting, you must change the global cluster pull secret with a new authorization token. Enabling remote health reporting enables both Insights Operator and Telemetry.

Changing your global cluster pull secret to enable remote health reporting

You can change your existing global cluster pull secret to enable remote health reporting. If you have disabled remote health monitoring, you must download a new pull secret with your console.openshift.com access token from Red Hat OpenShift Cluster Manager.

Prerequisites

  • Access to the cluster as a user with the cluster-admin role.

  • Access to OpenShift Cluster Manager.

Procedure

  1. Go to the Downloads page on the Red Hat Hybrid Cloud Console.

  2. From Tokens → Pull secret, click the Download button.

    The pull-secret file contains your cloud.openshift.com access token in JSON format:

    {
  "auths": {
    "cloud.openshift.com": {
      "auth": "<your_token>",
      "email": "<email_address>"
    }
  }
}

  3. Download the global cluster pull secret to your local file system.

    $ oc get secret/pull-secret -n openshift-config --template='{{index .data ".dockerconfigjson" | base64decode}}' > pull-secret

  4. Make a backup copy of your pull secret.

    $ cp pull-secret pull-secret-backup

  5. Open the pull-secret file in a text editor.

  6. Append the cloud.openshift.com JSON entry from the pull-secret file that you downloaded earlier into the auths file.

  7. Save the file.

  8. Update the secret in your cluster by running the following command:

    oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=pull-secret

    You might need to wait several minutes for the secret to update and your cluster to begin reporting.

Verification

  1. For a verification check from the OKD web console, complete the following steps:

    1. Go to the Overview page on the OKD web console.

    2. View the Insights section in the Status tile that reports the number of issues found.

  2. For a verification check from the OpenShift CLI (oc), enter the following command and then check that the value of the status parameter states false:

    $ oc get co insights -o jsonpath='{.status.conditions[?(@.type=="Disabled")]}'

Consequences of disabling remote health reporting

In OKD, customers can disable reporting usage information.

Before you disable remote health reporting, read the following benefits of a connected cluster:

  • Red Hat can react more quickly to problems and better support our customers.

  • Red Hat can better understand how product upgrades impact clusters.

  • Connected clusters help to simplify the subscription and entitlement process.

  • Connected clusters enable the OpenShift Cluster Manager service to offer an overview of your clusters and their subscription status.

Consider leaving health and usage reporting enabled for pre-production, test, and production clusters. This means that Red Hat can participate in qualifying OKD in your environments and react more rapidly to product issues.

The following lists some consequences of disabling remote health reporting on a connected cluster:

  • Red Hat cannot view the success of product upgrades or the health of your clusters without an open support case.

  • Red Hat cannot use configuration data to better triage customer support cases and identify which configurations our customers find important.

  • The OpenShift Cluster Manager cannot show data about your clusters, which includes health and usage information.

In restricted networks, Telemetry and Insights data still gets gathered through the appropriate configuration of your proxy.

Disabling remote health reporting

You can change your existing global cluster pull secret to disable remote health reporting. This configuration disables both Telemetry and the Insights Operator.

Prerequisites

  • You have access to the cluster as a user with the cluster-admin role.

Procedure

  1. Download the global cluster pull secret to your local file system:

    $ oc extract secret/pull-secret -n openshift-config --to=.

  2. In a text editor, edit the .dockerconfigjson file that you downloaded by removing the cloud.openshift.com JSON entry:

    "cloud.openshift.com":{"auth":"<hash>","email":"<email_address>"}

  3. Save the file.

  4. Update the secret in your cluster. For more information, see "Updating the global cluster pull secret".

    You might need to wait several minutes for the secret to update in your cluster.

Registering your disconnected cluster

Register your disconnected OKD cluster on the Red Hat Hybrid Cloud Console so that your cluster does not get impacted by disabling remote health reporting. For more information, see "Consequences of disabling remote health reporting".

By registering your disconnected cluster, you can continue to report your subscription usage to Red Hat. Red Hat can then return accurate usage and capacity trends associated with your subscription, so that you can use the returned information to better organize subscription allocations across all of your resources.
Prerequisites

  • You logged in to the OKD web console as the cluster-admin role.

  • You can log in to the Red Hat Hybrid Cloud Console.

Procedure

  1. Go to the Register disconnected cluster web page on the Red Hat Hybrid Cloud Console.

  2. Optional: To access the Register disconnected cluster web page from the home page of the Red Hat Hybrid Cloud Console, go to the Clusters navigation menu item and then select the Register cluster button.

  3. Enter your cluster’s details in the provided fields on the Register disconnected cluster page.

  4. From the Subscription settings section of the page, select the subscription settings that apply to your Red Hat subscription offering.

  5. To register your disconnected cluster, select the Register cluster button.

Updating the global cluster pull secret

You can update the global pull secret for your cluster by either replacing the current pull secret or appending a new pull secret.

Use the procedure when you need a separate registry to store images than the registry used during installation.

Prerequisites

  • You have access to the cluster as a user with the cluster-admin role.

Procedure

  1. Optional: To append a new pull secret to the existing pull secret, complete the following steps:

    1. Enter the following command to download the pull secret:

      $ oc get secret/pull-secret -n openshift-config \
  --template='{{index .data ".dockerconfigjson" | base64decode}}' \
  <pull_secret_location> (1)
      1 Include the path to the pull secret file.

    2. Enter the following command to add the new pull secret:

      $ oc registry login --registry="<registry>" \ (1)
--auth-basic="<username>:<password>" \ (2)
--to=<pull_secret_location> (3)
      1 Include the new registry. You can include many repositories within the same registry, for example: --registry="<registry/my-namespace/my-repository>".
      2 Include the credentials of the new registry.
      3 Include the path to the pull secret file.

      You can also perform a manual update to the pull secret file.

  2. Enter the following command to update the global pull secret for your cluster:

    $ oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=<pull_secret_location> (1)
    1 Include the path to the new pull secret file.

    This update rolls out to all nodes, which can take some time depending on the size of your cluster.

    As of OKD 4.7.4, changes to the global pull secret no longer trigger a node drain or reboot.
Additional resources