第 16 章 Red Hat Quay 配置的 schema
大多数 Red Hat Quay 配置信息保存在 config.yaml
文件中,该文件是首先部署 Red Hat Quay 时基于浏览器的配置工具创建的。本章论述了在'config.yaml 文件中使用的这些设置的模式。
以下字段必填(所有其他字段都是可选的):
ACTION_LOG_ARCHIVE_LOCATION [string]:如果启用了操作日志归档,则存储引擎会放置存档数据。
-
示例 :
s3_us_east
-
示例 :
ACTION_LOG_ARCHIVE_PATH [string]:如果启用了操作日志归档,则存储中的路径会放置归档数据。
-
示例 :
存档/操作日志
-
示例 :
ACTION_LOG_ROTATION_THRESHOLD [string]:如果启用了操作日志归档,则时间间隔用于轮转日志。
-
示例
:30d
-
示例
ALLOW_PULLS_WITHOUT_STRICT_LOGGING [boolean]: 如果为 true,拉取无法写入拉取审计日志条目仍将成功。如果数据库可以回退到只读状态,并且需要在该时间内继续,则很有用。默认值为 False。
-
示例 :
True
-
示例 :
APP_SPECIFIC_TOKEN_EXPIRATION [string,
null
]:外部应用程序令牌的过期。默认值为 None。-
Pattern:
^[0-9]+(w|m|d|h|s)$
-
Pattern:
AUTHENTICATION_TYPE [string] required: 用于凭证身份验证的身份验证引擎。
- Enum :Database、LDAP、JWT、Keystone、OIDC。
-
示例 :
数据库
AVATAR_KIND [string]:要显示的 avatars 的类型,可以生成内联(本地)或 Gravatar (gravatar)
- Enum: local, gravatar
BITBUCKET_TRIGGER_CONFIG ['object', 'null']: 使用 BitBucket 进行构建触发器的配置。
consumer_key [string] required: 此 Red Hat Quay 实例的注册使用者密钥(客户端 ID)。
-
示例:
0e8dbe15c4c7630b6780
-
示例:
BLACKLISTED_EMAIL_DOMAINS [array]:如果 FEATURE_BLACKLISTED_EMAILS 设置为 true,则使用电子邮件地址域的数组。
-
示例 :"
example.com", "example.org"
-
示例 :"
BLACKLIST_V2_SPEC [string]:Red Hat Quay 将响应的 Docker CLI 版本将不支持 V2。默认为 &
lt;1.6.0
。BRANDING [object]:在 Red Hat Quay UI 中为徽标和 URL 自定义品牌。
- 必需 :徽标
属性 :
徽标 [字符串]:主徽标图像 URL.
-
示例 :
/static/img/quay-horizontal-color.svg
-
示例 :
footer_img [string]:UI footer 的徽标。
-
示例 :
/static/img/RedHat.svg
-
示例 :
footer_url [string]:页脚镜像的 Link。
BROWSER_API_CALLS_XHR_ONLY [boolean]:如果启用,则只有 XHR 发出的 API 调用才能被浏览器允许。默认值为 True。
- 示例: False
BUILDLOGS_REDIS [object] required: Redis 为构建日志缓存的连接信息。
HOST [string] 必需:Redis 可以访问的主机名。
-
示例 :
my.redis.cluster
-
示例 :
PASSWORD [string]:用于连接 Redis 实例的密码。
-
示例 :
mypassword
-
示例 :
PORT [number]:Redis 可访问的端口。
-
示例:
1234
-
示例:
CONTACT_INFO [array]:如果指定,则要在联系页面上显示联系信息。如果只指定一个单独的联系信息,则联系页脚将直接链接。
- Min Items: 1
唯一项目 :True
- 数组项 0 [string]:添加一个链接来发送电子邮件
-
Pattern:
^mailto: (.)+$
-
示例 :
mailto:support@quay.io
数组项目 1 [string]:添加一个链接来访问 IRC 聊天空间
-
Pattern:
^irc://(.)+$
-
示例:
irc://chat.freenode.net:6665/quay
-
Pattern:
数组项目 2 [string]:添加链接以调用电话号码
-
Pattern:
^tel: (.)+$
-
示例 :
tel:+1-888-930-3475
-
Pattern:
数组项 3 [string]:添加指向定义的 URL 的链接
-
Pattern:
^http (s)?://(.)+$
-
示例:
https://twitter.com/quayio
-
Pattern:
DB_CONNECTION_ARGS [object]:如果指定,则为数据库(如超时和 SSL)连接参数。
-
threadlocals [boolean] 必需:是否使用线程本地连接。应该为
true
。 -
Autorollback [boolean] 必需:是否使用自动滚动连接。应该为
true
。 SSL [object]: SSL 连接配置
- CA [string] 必需:用于 SSL 连接的 CA 证书的绝对路径。
-
示例 :
conf/stack/ssl-ca-cert.pem
-
threadlocals [boolean] 必需:是否使用线程本地连接。应该为
DATABASE_SECRET_KEY [string] 必需:用来加密数据库中敏感字段的密钥。一旦设置,这个值永远不会改变。更改此操作的结果是无效的所有依赖字段(例如,镜像用户名和密码配置)。
-
示例 :
40157269433064266822674401740626984898972632465622168464725100311621640999470
-
示例 :
DB_URI [string] 必需:用于访问数据库的 URI,包括任何凭证。
- 参考:https://www.postgresql.org/docs/9.3/static/libpq-connect.html#AEN39495
-
示例 :
mysql+pymysql://username:password@dns.of.database/quay
DEFAULT_NAMESPACE_MAXIMUM_BUILD_COUNT [number,
null
]:如果不是 None,则可以在命名空间中默认的最大构建数。-
示例
:20
-
示例
DEFAULT_TAG_EXPIRATION [string] required: default, configurable tag expiration time for time machine.默认为
2w
。-
Pattern:
^[0-9]+(w|m|d|h|s)$
-
Pattern:
DIRECT_OAUTH_CLIENTID_WHITELIST [array]:允许在用户批准的情况下执行直接 OAuth 批准的 Red Hat Quay 管理的 应用程序的列表。
- Min Items: None
- 唯一项目 :True
参考:https://coreos.com/quay-enterprise/docs/latest/direct-oauth.html
- 数组 item [string]
需要 DISTRIBUTED_STORAGE_CONFIG [object]:在 Red Hat Quay 中使用存储引擎的配置。每个键代表存储引擎的唯一标识符。该值由一个元组(键,值)组成,组成一个描述存储引擎参数的对象。
OCS/Noobaa :
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Ceph / RadosGW Storage / Hitachi HCP:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow AWS S3 Storage:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Azure Storage :
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Google Cloud Storage :
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Swift 存储 :
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS [array]:存储引擎列表(按 ID in DISTRIBUTED_STORAGE_CONFIG)默认复制到所有其他存储引擎。
- Min Items: None
示例 :
s3_us_east, s3_us_west
- 数组 item [string]
DISTRIBUTED_STORAGE_PREFERENCE [array] 必需:首选的存储引擎(使用 DISTRIBUTED_STORAGE_CONFIG)使用。首选引擎表示首先检查拉取(pull)和镜像被推送(push)和镜像(push)。
Min Items: None
-
示例:
[u's3_us_east', u's3_us_west']
- 数组 item [string]
-
示例:
preferred_url_scheme [string] 必需:点击 Red Hat Quay 时使用的 URL 方案。如果 Red Hat Quay 全部位于 SSL 之后,则必须为
https
。-
Enum:
http, https
-
示例 :
https
-
Enum:
- DOCUMENTATION_ROOT [string]: Root URL for documentation 链接。
ENABLE_HEALTH_DEBUG_SECRET [string,
null
]:如果指定,则可提供给健康端点的 secret,以便在未验证超级用户时查看完整的调试信息。-
示例 :
somesecrethere
-
示例 :
EXPIRED_APP_SPECIFIC_TOKEN_GC [string,
null
]: duration of time expired external app token will will will are be collected。默认为 1d。-
Pattern:
^[0-9]+(w|m|d|h|s)$
-
Pattern:
EXTERNAL_TLS_TERMINATION [boolean]:如果支持 TLS,但在 Red Hat Quay 前在层终止,则必须为 true。
-
示例 :
True
-
示例 :
FEATURE_ACI_CONVERSION [boolean]:是否启用转换到 ACI。默认值为 False。
-
示例:
False
-
示例:
FEATURE_ACTION_LOG_ROTATION [boolean]:是否使旧操作日志轮转到存储。默认值为 False。
-
示例:
False
-
示例:
FEATURE_ADVERTISE_V2 [boolean]:是否看到 v2/ 端点。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_AGGREGATED_LOG_COUNT_RETRIEVAL [boolean]:是否允许检索聚合的日志计数。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_ANONYMOUS_ACCESS [boolean]:是否允许匿名用户浏览和拉取公共存储库。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_APP_REGISTRY [boolean]:是否启用对 App 存储库的支持。默认值为 False。
-
示例:
False
-
示例:
FEATURE_APP_SPECIFIC_TOKENS [boolean]:如果启用,用户可以创建供 Docker CLI 使用的令牌。默认值为 True。
- 示例: False
FEATURE_BITBUCKET_BUILD [boolean]:是否支持 Bitbucket 构建触发器。默认值为 False。
-
示例:
False
-
示例:
- FEATURE_BLACKLISTED_EMAIL
FEATURE_BUILD_SUPPORT [boolean]:是否支持 Dockerfile 构建。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_CHANGE_TAG_EXPIRATION [boolean]:是否允许用户和组织更改其命名空间中的标签到期时间。默认值为 True。
-
示例:
False
-
示例:
FEATURE_DIRECT_LOGIN [boolean]:用户是否可以直接登录到 UI。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_GARBAGE_COLLECTION [boolean]:是否启用存储库垃圾回收。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_GITHUB_BUILD [boolean]:是否支持 GitHub 构建触发器。默认值为 False。
-
示例:
False
-
示例:
FEATURE_GITHUB_LOGIN [boolean]:是否支持 GitHub 登录。默认值为 False。
-
示例:
False
-
示例:
FEATURE_GITLAB_BUILD[boolean]:是否支持 GitLab 构建触发器。默认值为 False。
-
示例:
False
-
示例:
FEATURE_GOOGLE_LOGIN [boolean]:是否支持 Google 登录。默认值为 False。
-
示例:
False
-
示例:
FEATURE_INVITE_ONLY_USER_CREATION [boolean]:是否必须被另一个用户邀请创建的用户。默认值为 False。
-
示例:
False
-
示例:
FEATURE_LIBRARY_SUPPORT [boolean]:在从 Docker 拉取和推送时是否允许"无命名空间"存储库。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_LOG_EXPORT [boolean]:是否允许导出操作日志。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_MAILING [boolean]:是否启用电子邮件。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_NONSUPERUSER_TEAM_SYNCING_SETUP [boolean]:如果启用,则非超级用户可以在团队上设置同步,从而支持 LDAP 或 Keystone。默认为 False。
-
示例 :
True
-
示例 :
FEATURE_PARTIAL_USER_AUTOCOMPLETE [boolean]:如果设为 true,则自动完成将应用到部分用户名。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_PERMANENT_SESSIONS [boolean]:会话是永久的。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_PROXY_STORAGE [boolean]:是否通过 registry nginx 在存储中代理所有直接下载 URL。默认值为 False。
-
示例:
False
-
示例:
FEATURE_PUBLIC_CATALOG [boolean]:如果设为 true,
_catalog
端点会返回公共存储库。否则,只能返回私有存储库。默认值为 False。-
示例:
False
-
示例:
FEATURE_RATE_LIMITS [boolean]:是否启用 API 和 registry 端点的速率限值。默认值为 False。
-
示例:
False
-
示例:
FEATURE_READER_BUILD_LOGS [boolean]:如果设为 true,则构建日志可以被那些对仓库具有读取访问权限的用户读取,而不仅仅是写访问权限或管理员访问权限。默认值为 False。
- 示例: False
FEATURE_READONLY_APP_REGISTRY [boolean]: 是否只读。默认值为 False。
-
示例 :
True
-
示例 :
FEATURE_RECAPTCHA [boolean]:用户登录和恢复需要 Recaptcha。默认值为 False。
-
示例:
False
- 参考:https://www.google.com/recaptcha/intro/
-
示例:
FEATURE_REPO_MIRROR [boolean]:如果设为 true,则启用存储库镜像。默认值为 False。
-
示例:
False
-
示例:
FEATURE_REQUIRE_ENCRYPTED_BASIC_AUTH [boolean]:非加密密码(与加密令牌相反)都可用于基本身份验证。默认值为 False。
-
示例:
False
-
示例:
FEATURE_REQUIRE_TEAM_INVITE [boolean]:在将用户添加到团队时是否需要邀请。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_RESTRICTED_V1_PUSH [boolean]:如果设为 true,则只有 V1_PUSH_WHITELIST 支持 V1 push 中列出的命名空间。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_SECURITY_NOTIFICATIONS [boolean]:如果启用安全扫描程序,是否启用/关闭安全通知。默认值为 False。
-
示例:
False
-
示例:
FEATURE_SECURITY_SCANNER [boolean]:是否打开/关闭安全扫描程序。默认值为 False。
FEATURE_STORAGE_REPLICATION [boolean]:是否在存储引擎之间自动复制。默认值为 False。
-
示例:
False
-
示例:
FEATURE_SUPER_USERS [boolean]:是否支持超级用户。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_TEAM_SYNCING [boolean]:是否允许团队成员资格从身份验证引擎(LDAP 或 Keystone)中的后备组同步。
-
示例 :
True
-
示例 :
FEATURE_USER_CREATION [boolean]:是否可创建用户(通过非超级用户)。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_USER_LAST_ACCESSED [boolean]:是否记录最后一次访问用户的时间。默认值为 True。
-
示例 :
True
-
示例 :
FEATURE_USER_LOG_ACCESS [boolean]:如果设为 true,用户有权访问其命名空间的审计日志。默认值为 False。
-
示例 :
True
-
示例 :
FEATURE_USER_METADATA [boolean]:是否收集和支持用户元数据。默认值为 False。
-
示例:
False
-
示例:
FEATURE_USERNAME_CONFIRMATION [boolean]:如果设为 true,用户可以确认其生成的用户名。默认值为 True。
-
示例:
False
-
示例:
FEATURE_USER_RENAME [boolean]:如果设为 true,用户可以重命名自己的命名空间。默认值为 False。
-
示例 :
True
-
示例 :
FRESH_LOGIN_TIMEOUT [string]:新登录需要用户重新输入密码的时间
-
示例 :
5m
-
示例 :
GITOPSHUB_LOGIN_CONFIG [object, 'null']: Configuration for using GitHub (Enterprise)作为外部登录提供程序。
- 参考:https://coreos.com/quay-enterprise/docs/latest/github-auth.html
allowed_organizations [array]:将 GitHub (Enterprise)组织的名称列入白名单,与 ORG_RESTRICT 选项配合使用。
- Min Items: None
唯一项目 :True
- 数组 item [string]
api_ENDPOINT [string]:要使用的 GitHub (Enterprise) API 的端点。必须为 github.com 覆盖。
CLIENT_ID [string] required: 此 Red Hat Quay 实例的注册客户端 ID ; 无法与 GITHUB_TRIGGER_CONFIG 共享。
- 参考:https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
示例:
0e8dbe15c4c7630b6780
CLIENT_SECRET [string] required: 此 Red Hat Quay 实例的注册客户端 secret。
- 参考:https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
示例 :
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITOPSHUB_ENDPOINT [string] required: 被命中 GitHub (Enterprise)的端点。
- ORG_RESTRICT [boolean]: 如果为 true,则只有机构白名单中的用户可以使用这个提供程序进行登录。
-
示例 :
True
GITOPSHUB_TRIGGER_CONFIG [object,
null
]: 使用 GitHub (Enterprise)进行构建触发器的配置。- 参考:https://coreos.com/quay-enterprise/docs/latest/github-build.html
api_ENDPOINT [string]:要使用的 GitHub (Enterprise) API 的端点。必须为 github.com 覆盖。
CLIENT_ID [string] 必需:此 Red Hat Quay 实例的注册客户端 ID 无法与 GITHUB_LOGIN_CONFIG 共享。
- 参考:https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
示例:
0e8dbe15c4c7630b6780
CLIENT_SECRET [string] required: 此 Red Hat Quay 实例的注册客户端 secret。
- 参考:https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
示例 :
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITOPSHUB_ENDPOINT [string] required: 被命中 GitHub (Enterprise)的端点。
GITOPSLAB_TRIGGER_CONFIG [object]:使用 Gitlab (Enterprise)进行外部身份验证的配置。
CLIENT_ID [string] required: 此 Red Hat Quay 实例的注册客户端 ID。
-
示例:
0e8dbe15c4c7630b6780
-
示例:
CLIENT_SECRET [string] required: 此 Red Hat Quay 实例的注册客户端 secret。
-
示例 :
e4a58ddd3d7408b7aec109e85564a0d153d3e846
gitlab_endpoint [string] required :Gitlab (Enterprise)运行的端点。
-
示例 :
GOOGLE_LOGIN_CONFIG [object,
null
]:使用 Google 进行外部身份验证的配置CLIENT_ID [string] required: 此 Red Hat Quay 实例的注册客户端 ID。
-
示例:
0e8dbe15c4c7630b6780
-
示例:
CLIENT_SECRET [string] required: 此 Red Hat Quay 实例的注册客户端 secret。
- 示例 :e4a58ddd3d7408b7aec109e85564a0d153d3e846
gpg2_PRIVATE_KEY_FILENAME [string]:用于解密 ACI 的私钥的文件名。
-
示例 :
/path/to/file
-
示例 :
gpg2_PRIVATE_KEY_NAME [string]:用于签署 ACI 的私钥的名称。
-
示例 :
gpg2key
-
示例 :
gpg2_PUBLIC_KEY_FILENAME [string]:用于加密 ACI 的公钥的文件名。
-
示例 :
/path/to/file
-
示例 :
HEALTH_CHECKER [string]:配置的健康检查。
-
示例 :
('RDSAwareHealthCheck', {'access_key': 'foo', 'secret_key': 'bar'})
-
示例 :
JWT_AUTH_ISSUER [string]: JWT 用户的端点。
-
示例:
http://192.168.99.101:6060
-
Pattern:
^http (s)?://(.)+$
-
示例:
JWT_GETUSER_ENDPOINT [string]: JWT 用户的端点。
-
示例:
http://192.168.99.101:6060
-
Pattern:
^http (s)?://(.)+$
-
示例:
JWT_QUERY_ENDPOINT [string]: JWT 查询的端点。
-
示例:
http://192.168.99.101:6060
-
Pattern:
^http (s)?://(.)+$
-
示例:
JWT_VERIFY_ENDPOINT [string]: JWT 验证的端点。
-
示例:
http://192.168.99.101:6060
-
Pattern:
^http (s)?://(.)+$
-
示例:
- LDAP_ADMIN_DN [string]:用于 LDAP 验证的 admin DN。
- LDAP_ADMIN_PASSWD [string]:LDAP 身份验证的 admin 密码。
- LDAP_ALLOW_INSECURE_FALLBACK [boolean]:是否允许 SSL insecure fallback 进行 LDAP 身份验证。
- LDAP_BASE_DN [string]:用于 LDAP 身份验证的基本 DN。
- LDAP_EMAIL_ATTR [string]:LDAP 身份验证的电子邮件属性。
- LDAP_UID_ATTR [string]:LDAP 身份验证的 uid 属性。
- LDAP_URI [string]:LDAP URI。
- LDAP_USER_FILTER [string]:用于 LDAP 身份验证的用户过滤器。
- LDAP_USER_RDN [array]:用于 LDAP 身份验证的用户 RDN。
LOGS_MODEL [string]:操作日志的日志模型。
- Enum: database, transition_reads_both_writes_es, elasticsearch
-
示例 :
数据库
LOGS_MODEL_CONFIG [object]: Logs model config for action logs
elasticsearch_config [object]: Elasticsearch 集群配置
access_key [string]: Elasticsearch 用户(或 AWS ES 的 IAM 密钥)
-
示例 :
some_string
-
示例 :
Host [string]: Elasticsearch 集群端点
-
示例:
host.elasticsearch.example
-
示例:
index_prefix [string]: Elasticsearch 的索引前缀
-
示例 :
logentry_
-
示例 :
- index_settings [object]: Elasticsearch 的索引设置
use_ssl [boolean]:对于 Elasticsearch 使用 ssl。默认值为 True
-
示例 :
True
-
示例 :
SECRET_KEY [string]: Elasticsearch 密码(或 AWS ES 的 IAM secret)
-
示例 :
some_secret_string
-
示例 :
AWS_REGION [string]: Amazon web service region
-
示例 :
us-east-1
-
示例 :
端口 [number]:Elasticsearch 集群端点端口
-
示例:
1234
-
示例:
kinesis_stream_config [object]: AWS Kinesis Stream configuration
aws_secret_key [string]: AWS secret key
-
示例 :
some_secret_key
-
示例 :
stream_name [string]: Kinesis stream 来向发送操作日志
-
示例 :
logentry-kinesis-stream
-
示例 :
aws_access_key [string]: AWS access key
-
示例 :
some_access_key
-
示例 :
retries [number]:单个请求上进行的最大尝试次数
-
示例 :
5
-
示例 :
read_timeout [number]:从连接读取超时前的秒数
-
示例 :
5
-
示例 :
max_pool_connections [number] :连接池中要保留的最大连接数
-
示例
:10
-
示例
AWS_REGION [string]: AWS region
-
示例 :
us-east-1
-
示例 :
connect_timeout [number]:尝试进行连接时超时前的秒数
-
示例 :
5
-
示例 :
producer [string]: logs producer if logging to Elasticsearch
- enum: kafka, elasticsearch, kinesis_stream
-
示例:
kafka
kafka_config [object]: Kafka cluster configuration
topic [string]: Kafka 主题将日志条目发布到
-
示例 :
logentry
-
示例 :
- bootstrap_servers [array]:要从中引导客户端的 Kafka 代理列表
max_block_seconds [number]:
send ()
期间要阻止的最大秒数,这可能是因为缓冲区已满或元数据不可用-
示例
:10
-
示例
LOG_ARCHIVE_LOCATION [string]:如果启用了构建,则会在其中放置存档构建日志的存储引擎。
-
示例 :
s3_us_east
-
示例 :
LOG_ARCHIVE_PATH [string]:如果启用了构建,则存储中的路径会放置归档的构建日志。
-
示例 :
archive/buildlogs
-
示例 :
- LOGS_MODEL [string]:操作日志的日志模型。
-
Enum:
database
,transition_reads_both_writes_es
,elasticsearch
-
示例 :
数据库
MAIL_DEFAULT_SENDER [string,
null
]:如果指定,在 Red Hat Quay 发送电子邮件时用作来自
的电子邮件地址。如果没有,则默认为support@quay.io
。-
示例:
support@myco.com
-
示例:
MAIL_PASSWORD [string,
null
]:发送电子邮件时要使用的 SMTP 密码。-
示例 :
mypassword
-
示例 :
MAIL_PORT [number]:要使用的 SMTP 端口。如果没有指定,则默认为 587。
-
示例 :
588
-
示例 :
MAIL_SERVER [string]:用于发送电子邮件的 SMTP 服务器。只有在将 FEATURE_MAILING 设为 true 时才需要。
-
示例 :
smtp.somedomain.com
-
示例 :
MAIL_USERNAME [string, 'null'] :发送电子邮件时要使用的 SMTP 用户名。
-
示例 :
myuser
-
示例 :
MAIL_USE_TLS [boolean]:如果指定,是否使用 TLS 发送电子邮件。
-
示例 :
True
-
示例 :
MAXIMUM_LAYER_SIZE [string]:最大允许镜像层的大小。默认值为 20G。
-
Pattern:
^[0-9]+(G|M)$
-
示例
:100G
-
Pattern:
PREFERRED_URL_SCHEME [string]:点击 Red Hat Quay 时使用的 URL 方案。如果 Red Hat Quay 全部位于 SSL 之后,则必须 是
https
-
Enum:
http
或https
-
示例 :
https
-
Enum:
PROMETHEUS_NAMESPACE [string]:应用到所有公开的 Prometheus 指标的前缀。默认为
quay
。-
示例 :
myregistry
-
示例 :
PUBLIC_NAMESPACES [array]:如果在公共命名空间列表中定义命名空间,它将出现在所有用户的存储库列表页中,无论该用户是否为命名空间的成员。通常,这供企业客户用来配置一组"well-known"命名空间。
- Min Items: None
唯一项目 :True
- 数组 item [string]
- RECAPTCHA_SECRET_KEY [string]: if recaptcha is enabled, the secret key for the Recaptcha service.
- RECAPTCHA_SITE_KEY [string]:如果启用了 recaptcha,则启用 Recaptcha 服务的 site 键。
registry_STATE [string]:registry 的状态。
-
Enum:
normal
或read-only
-
示例 :
只读
-
Enum:
registry _TITLE [string]:如果指定,则 registry 的长格式标题。默认为
Quay Enterprise
。-
示例:
Corp Container Service
-
示例:
registry _TITLE_SHORT [string]:如果指定,则为 registry 的短格式标题。默认为
Quay Enterprise
。-
示例 :
CCS
-
示例 :
REPO_MIRROR_INTERVAL [number]:检查存储库镜像候选者的秒数。默认值为 30。
-
示例:
30
-
示例:
REPO_MIRROR_SERVER_HOSTNAME [string]: 替换 SERVER_HOSTNAME 作为镜像的目的地。默认为未设置。
-
示例:
openshift-quay-service
-
示例:
REPO_MIRROR_TLS_VERIFY [boolean]: Require HTTPS,并在镜像过程中验证 Quay registry 的证书。默认值为 True。
-
示例 :
True
-
示例 :
SEARCH_MAX_RESULT_PAGE_COUNT [number]:用户在搜索前,用户可以分页的最大页面数量。默认值为 10。
-
示例
:10
-
示例
SEARCH_RESULTS_PER_PAGE [number]: 按搜索页面返回的结果数。默认值为 10。
-
示例
:10
-
示例
SECRET_KEY [string] 必需:用来加密数据库中敏感字段的密钥以及运行时。一旦设置,这个值永远不会改变。更改此操作的结果是无效的所有依赖字段(例如,加密的密码凭证)。
-
示例 :
40157269433064266822674401740626984898972632465622168464725100311621640999470
-
示例 :
SECURITY_SCANNER_ENDPOINT [string]:安全扫描程序的端点。
-
Pattern:
^http (s)?://(.)+$
-
示例:
http://192.168.99.101:6060
-
Pattern:
SECURITY_SCANNER_INDEXING_INTERVAL [number]:安全扫描程序中索引间隔间隔的秒数。默认值为 30。
-
示例:
30
-
示例:
SECURITY_SCANNER_NOTIFICATIONS [boolean]:是否被安全扫描程序通知功能
-
示例:
false
-
示例:
SECURITY_SCANNER_V4_ENDPOINT [string]:V4 安全扫描程序的端点。
-
Pattern:
^http (s)?://(.)+$
-
示例:
http://192.168.99.101:6060
-
Pattern:
- SECURITY_SCANNER_V4_PSK [string]:为 Clair 生成的预共享密钥(PSK)。
SERVER_HOSTNAME [string] 必需:可以访问 Red Hat Quay 的 URL,没有方案。
-
示例:
quay.io
-
示例:
SESSION_COOKIE_SECURE [boolean]:是否应在会话 Cookie 上设置
secure
属性。默认值为 False。对于所有使用 SSL 的安装,建议为 True。- 示例 :True
- 参考:https://en.wikipedia.org/wiki/Secure_cookies
SSL_CIPHERS [array]:如果指定,则 nginx 定义的 SSL 密码列表用于启用和禁用。
-
示例 :
CAMELLIA
,!3DES
-
示例 :
SSL_PROTOCOLS [array]:如果指定,nginx 配置为启用列表中定义的 SSL 协议列表。从列表中删除 SSL 协议将禁用 Red Hat Quay 启动期间的协议。
- SSL_PROTOCOLS: ['TLSv1','TLSv1.1','TLSv1.2']
SUCCESSIVE_TRIGGER_FAILURE_DISABLE_THRESHOLD [number]:如果没有 None,则在构建触发器自动禁用前可能会发生的连续失败数量。默认值为 100。
-
示例 :
50
-
示例 :
- SUCCESSIVE_TRIGGER_INTERNAL_ERROR_DISABLE_THRESHOLD [number]:如果没有 None,则在自动禁用构建触发器前可能会发生的连续内部错误数量。默认值为 5。
SUPER_USERS [array]:要授予超级用户权限的 Red Hat Quay 用户名。
- Min Items: None
唯一项目 :True
- 数组 item [string]
TAG_EXPIRATION_OPTIONS [array] 必需:用户可以在其命名空间中选择标签到期的选项(如果已启用)。
- Min Items: None
- 数组 item [string]
-
Pattern:
^[0-9]+(w|m|d|h|s)$
TEAM_RESYNC_STALE_TIME [string]:如果团队启用了团队同步,则检查其成员资格和重新同步的频率(默认:30m)。
-
Pattern:
^[0-9]+(w|m|d|h|s)$
-
示例 :
2h
-
Pattern:
USERFILES_LOCATION [string]:要放置用户上传的文件的存储引擎 ID
-
示例 :
s3_us_east
-
示例 :
USERFILES_PATH [string]: Path 下的存储下放置用户上传的文件
-
示例 :
userfile
-
示例 :
USER_EVENTS_REDIS [object] required: Redis 为用户事件处理的连接信息。
HOST [string] 必需:Redis 可以访问的主机名。
-
示例 :
my.redis.cluster
-
示例 :
PASSWORD [string]:用于连接 Redis 实例的密码。
-
示例 :
mypassword
-
示例 :
PORT [number]:Redis 可访问的端口。
-
示例:
1234
-
示例:
CONSUMER_SECRET [string] required: 此 Red Hat Quay 实例的注册使用者 secret (客户端 secret)
- 示例 :e4a58ddd3d7408b7aec109e85564a0d153d3e846
USERFILES_LOCATION [string]:用于存储引擎的 ID,以放置用户上传的文件。
-
示例 :
s3_us_east
-
示例 :
USERFILES_PATH [string]: Path 下的存储下放置用户上传的文件。
-
示例 :
userfile
-
示例 :
USER_RECOVERY_TOKEN_LIFETIME [string]:恢复用户帐户的有效时间长度。默认值为 30m。
-
示例
:10m
-
Pattern:
^[0-9]+(w|m|d|h|s)$
-
示例
V1_PUSH_WHITELIST [array]:如果 FEATURE_RESTRICTED_V1_PUSH 设置为 true,则支持 V1 push 的命名空间名称的数组。
-
示例 :
一些
,命名空间
-
示例 :
V2_PAGINATION_SIZE [number]:V2 registry API 中每个页面返回的结果数。
-
示例
:100
-
示例
WEBHOOK_HOSTNAME_BLACKLIST [array]:验证外的 webhook 时,禁止使用主机名集合。
-
示例 :
someexternaldomain.com
-
示例 :