Chapter 2. Running Red Hat Quay in debug mode
To gather debugging information for support cases and troubleshoot issues, you can run {product-title} in debug mode. Debug mode provides verbose logging that speeds up reproducing errors and supports root cause analysis for geo-replication, Operator, standalone deployments, and object storage.
2.1. Red Hat Quay debug variables Copy linkLink copied to clipboard!
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 Copy linkLink copied to clipboard!
To run a standalone Red Hat Quay deployment in debug mode and get verbose logging for troubleshooting, you can use podman run with DEBUGLOG=true. View debug output with the podman logs command.
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}$ podman run -p 443:8443 -p 80:8080 -e DEBUGLOG=true -v /config:/conf/stack -v /storage:/datastorage -d {productrepo}/{quayimage}:{productminv}Copy to Clipboard Copied! Toggle word wrap Toggle overflow To view the debug logs, enter the following command:
podman logs <quay_container_name>
$ podman logs <quay_container_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.3. Running an LDAP Red Hat Quay deployment in debug mode Copy linkLink copied to clipboard!
To run an LDAP Red Hat Quay deployment in debug mode and debug LDAP operations, you can use podman run with DEBUGLOG=true and USERS_DEBUG=1. View debug output with the podman logs command.
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}$ 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}Copy to Clipboard Copied! Toggle word wrap Toggle overflow To view the debug logs, enter the following command:
podman logs <quay_container_name>
$ podman logs <quay_container_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantSetting
USERS_DEBUG=1exposes 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 Copy linkLink copied to clipboard!
To run the {product-title} Operator in debug mode and get verbose logging for troubleshooting, you can edit the QuayRegistry custom resource and add DEBUGLOG=true to the env overrides. After the Operator restarts, try pulling an image or dump logs from Quay pods for more information.
Procedure
Enter the following command to edit the
QuayRegistrycustom resource definition:oc edit quayregistry <quay_registry_name> -n <quay_namespace>
$ oc edit quayregistry <quay_registry_name> -n <quay_namespace>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the
QuayRegistryto add the following parameters:Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
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
Quaypods to a file, and check the files for more information.