此内容没有您所选择的语言版本。

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.

Expand
Table 2.1. Debug configuration variables
VariableTypeDescription

DEBUGLOG

Boolean

Whether to enable or disable debug logs. Must be True or False.

USERS_DEBUG

Integer. Either 0 or 1.

Used to debug LDAP operations in clear text, including passwords. Must be used with DEBUGLOG=TRUE.

Important

Setting 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.

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

  1. 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}
    Copy to Clipboard Toggle word wrap
  2. To view the debug logs, enter the following command:

    $ podman logs <quay_container_name>
    Copy to Clipboard Toggle word wrap

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

  1. 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}
    Copy to Clipboard Toggle word wrap
  2. To view the debug logs, enter the following command:

    $ podman logs <quay_container_name>
    Copy to Clipboard Toggle word wrap
    Important

    Setting 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

  1. Enter the following command to edit the QuayRegistry custom resource definition:

    $ oc edit quayregistry <quay_registry_name> -n <quay_namespace>
    Copy to Clipboard Toggle word wrap
  2. Update the QuayRegistry to add the following parameters:

    spec:
      - kind: quay
        managed: true
        overrides:
          env:
          - name: DEBUGLOG
            value: "true"
    Copy to Clipboard Toggle word wrap
  3. 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.
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat