Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 2. Running Red Hat Quay in debug mode
Red Hat recommends gathering your debugging information when opening a support case. Running Red Hat Quay in debug mode provides verbose logging to help administrators find more information about various issues. Enabling debug mode can speed up the process to reproduce errors and validate a solution for things like geo-replication deployments, Operator deployments, standalone Red Hat Quay deployments, object storage issues, and so on. Additionally, it helps the Red Hat Support to perform a root cause analysis.
2.1. Red Hat Quay debug variables
Red Hat Quay offers two configuration fields that can be added to your config.yaml
file to help diagnose issues or help obtain log information.
Variable | Type | Description |
---|---|---|
DEBUGLOG | Boolean |
Whether to enable or disable debug logs. Must be |
USERS_DEBUG |
Integer. Either |
Used to debug LDAP operations in clear text, including passwords. Must be used with Important
Setting |
2.2. Running a standalone Red Hat Quay deployment in debug mode
Running Red Hat Quay in debug mode provides verbose logging to help administrators find more information about various issues. Enabling debug mode can speed up the process to reproduce errors and validate a solution.
Use the following procedure to run a standalone deployment of Red Hat Quay in debug mode.
Procedure
Enter the following command to run your standalone Red Hat Quay deployment in debug mode:
$ podman run -p 443:8443 -p 80:8080 -e DEBUGLOG=true -v /config:/conf/stack -v /storage:/datastorage -d {productrepo}/{quayimage}:{productminv}
To view the debug logs, enter the following command:
$ podman logs <quay_container_name>
2.3. Running an LDAP Red Hat Quay deployment in debug mode
Use the following procedure to run an LDAP deployment of Red Hat Quay in debug mode.
Procedure
Enter the following command to run your LDAP Red Hat Quay deployment in debug mode:
$ podman run -p 443:8443 -p 80:8080 -e DEBUGLOG=true -e USERS_DEBUG=1 -v /config:/conf/stack -v /storage:/datastorage -d {productrepo}/{quayimage}:{productminv}
To view the debug logs, enter the following command:
$ podman logs <quay_container_name>
ImportantSetting
USERS_DEBUG=1
exposes credentials in clear text. This variable should be removed from the Red Hat Quay deployment after debugging. The log file that is generated with this environment variable should be scrutinized, and passwords should be removed before sending to other users. Use with caution.
2.4. Running the Red Hat Quay Operator in debug mode
Use the following procedure to run the Red Hat Quay Operator in debug mode.
Procedure
Enter the following command to edit the
QuayRegistry
custom resource definition:$ oc edit quayregistry <quay_registry_name> -n <quay_namespace>
Update the
QuayRegistry
to add the following parameters:spec: - kind: quay managed: true overrides: env: - name: DEBUGLOG value: "true"
-
After the Red Hat Quay Operator has restarted with debugging enabled, try pulling an image from the registry. If it is still slow, dump all logs from all
Quay
pods to a file, and check the files for more information.