How to use a Rancher debug image

This document (000021247) is provided subject to the disclaimer at the end of this document.

Environment

SUSE Rancher 2.7.x

Situation

SUSE Rancher support and engineering might propose a debug image for troubleshooting purposes.
Debug images usually follow the naming convention: "v<X.Y.Z>-debug-<ISSUE_ID>"
The Rancher version should be respected (for Rancher v2.7.6, the debug image should be v2.7.6-debug-12345).

Resolution

Setting up the debug image should be done using kubectl for the local cluster:

# for debug image v2.7.6-debug-42864-1
export TAG=v2.7.6-debug-42864-1
kubectl set image -n cattle-system deployment/rancher rancher=docker.io/rancher/rancher:$TAG

After a few minutes, the image should also reflect the cattle-cluster-agent on the downstream clusters.
Note: for airgap environments, one would need to import the Rancher debug image and the rancher-agent debug image. Eg: rancher v2.7.6-debug-42864-1 and rancher-agent v2.7.6-debug-42864-1.

To revert back to the original version, one should set the tag back:

# for Rancher v2.7.6
export TAG=v2.7.6
kubectl set image -n cattle-system deployment/rancher rancher=docker.io/rancher/rancher:$TAG

Note: Please, use a debug image only when instructed by the respective Support/Engineering resources. They are meant to help troubleshoot specific problems and should not be for general use.

Disclaimer

This Support Knowledgebase provides a valuable tool for SUSE customers and parties interested in our products and solutions to acquire information, ideas and learn from one another. Materials are provided for informational, personal or non-commercial use within your organization and are presented "AS IS" WITHOUT WARRANTY OF ANY KIND.