Red Hat Summit第14章 Red Hat Quay の設定用スキーマ
ほとんどの Red Hat Quay 構成情報は、Red Hat Quay が最初に展開されたときにブラウザベースの config ツールを使用して作成されるconfig.yamlファイルに保存されます。この章では、config.yaml ファイルで使用可能なそれらの設定のスキーマについて説明します。
以下の項目は必須です（その他はすべて任意）。
ACTION_LOG_ARCHIVE_LOCATION[文字列]:アクションログのアーカイブが有効な場合、アーカイブされたデータを配置するストレージエンジンです。
-
例:
s3_us_east
-
例:
ACTION_LOG_ARCHIVE_PATH[文字列]:アクションログのアーカイブが有効な場合、アーカイブされたデータを配置するストレージ内のパスです。
-
例:
archives/actionlogs
-
例:
ACTION_LOG_ROTATION_THRESHOLD[文字列]:ACTION_LOG_ROTATION_THRESHOLD [文字列] アクションログのアーカイブが有効な場合、ログを回転させる時間間隔を指定します。
-
例
30d
-
例
ALLOW_PULLS_WITHOUT_STRICT_LOGGING[ブール]:trueの場合、pull監査ログのエントリが書き込めないプルも成功します。データベースが読み取り専用の状態にフォールバックすることができ、その間もプルを継続したい場合に有効です。デフォルトは false です。
-
例:
True
-
例:
APP_SPECIFIC_TOKEN_EXPIRATION[文字列,
null]:外部アプリのトークンの有効期限です。デフォルトは None です。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
AUTHENTICATION_TYPE[文字列] 必須。クレデンシャル認証に使用する認証エンジンを指定します。
- enum: Database, LDAP, JWT, Keystone, OIDC.
-
例
Database
AVATAR_KIND[文字列]:表示するアバターの種類。インラインで生成されたもの（local）か、Gravatar（gravatar）か。
- enum: local, gravatar
BITBUCKET_TRIGGER_CONFIG['object', 'null']:ビルドトリガーにBitBucketを使用するための設定です。
consumer_key[文字列] 必須。この Red Hat Quay インスタンスに登録されているコンシューマーキー（クライアント ID）です。
-
例:
0e8dbe15c4c7630b6780
-
例:
BLACKLISTED_EMAIL_DOMAINS[array]:FEATURE_BLACKLISTED_EMAILSがtrueに設定されている場合に使用される電子メールアドレスドメインの配列です。
-
例:
"example.com", "example.org"
-
例:
BLACKLIST_V2_SPEC[文字列]:Red Hat Quay が V2 はunsupportedと応答する Docker CLI のバージョンです。デフォルトは
<1.6.0.です。BRANDING[オブジェクト]。Red Hat Quay UI でのロゴや URL のカスタムブランディング。
- Required: ロゴ
properties:
logo [文字列] : メインのロゴイメージURL
-
例:
/static/img/quay-horizontal-color.svg
-
例:
footer_img[文字列] :UIフッター用のロゴ。
-
例:
/static/img/RedHat.svg
-
例:
footer_url[文字列] :フッター画像のリンク。
BROWSER_API_CALLS_XHR_ONLY［ブール値］。有効にすると、XHRによって行われるとマークされたAPIコールのみがブラウザから許可されます。デフォルトは True です。
- 例: False
BUILDLOGS_REDIS[オブジェクト] 必須。ビルドログをキャッシュするためのRedisの接続情報です。
HOST[文字列] 必須。Redisにアクセスするためのホスト名。
-
例:
my.redis.cluster
-
例:
PASSWORD[文字列]: Redisインスタンスに接続するためのパスワードです。
-
例:
mypassword
-
例:
PORT［番号］。Redisにアクセスするためのポートです。
-
例:
1234
-
例:
CONTACT_INFO[配列]:指定された場合は、連絡先ページに表示する連絡先情報。連絡先が1つしか指定されていない場合は、連絡先のフッターが直接リンクされます。
- Min Items: 1
Unique Items: True
- array item 0[文字列] :メールを送信するためのリンクを追加する
-
パターン:
^mailto:(.)+$ -
例:
mailto:support@quay.io
array item 1[文字列] :IRCチャットルームを訪問するためのリンクを追加する
-
パターン:
^irc://(.)+$ -
例:
irc://chat.freenode.net:6665/quay
-
パターン:
array item 2 [文字列] : Adds a link to call a phone number
-
パターン:
^tel:(.)+$ -
例:
tel:+1-888-930-3475
-
パターン:
array item 3[文字列] :定義されたURLへのリンクを追加する
-
パターン:
^http(s)?://(.)+$ -
例:
https://twitter.com/quayio
-
パターン:
DB_CONNECTION_ARGS[オブジェクト]:指定された場合、タイムアウトやSSLなどのデータベースの接続引数。
-
threadlocals[ブール] 必須。スレッドローカルな接続を使用するかどうか。常に
trueである必要があります。 -
autorollback[ブール] 必須。自動ロールバック接続を使用するかどうか。常に
trueである必要があります。 ssl[オブジェクト]: SSL接続の設定
- ca[文字列] 必須。SSL接続に使用するCA証明書の絶対コンテナパス。
-
例:
conf/stack/ssl-ca-cert.pem
-
threadlocals[ブール] 必須。スレッドローカルな接続を使用するかどうか。常に
DATABASE_SECRET_KEY[文字列] 必須。データベース内の機密フィールドを暗号化するために使用するキー。一度設定した値は絶対に変更してはいけません。これを変更すると、関連するすべてのフィールド（例えば、リポジトリミラーのユーザー名とパスワードの設定など）が無効になります。
-
例:
40157269433064266822674401740626984898972632465622168464725100311621640999470
-
例:
DB_URI[文字列] 必須。データベースにアクセスするための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: [数値、
null]: Noneでない場合、ネームスペースでキューに入れることができるビルドのデフォルトの最大数です。-
例:
20
-
例:
DEFAULT_TAG_EXPIRATION[文字列] 必須。タイムマシンのデフォルトの、設定可能なタグの有効期限です。デフォルトは
2wです。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
DIRECT_OAUTH_CLIENTID_WHITELIST[配列]。ユーザーの承認なしに直接 OAuth 承認を実行することが許可されているRed Hat Quay 管理アプリケーションのクライアント ID のリスト。
- Min Items: None
- Unique Items: True
参考: https://coreos.com/quay-enterprise/docs/latest/direct-oauth.html
- array item[文字列] .
DISTRIBUTED_STORAGE_CONFIG[オブジェクト] 必須。Red Hat Quay で使用するストレージエンジンの構成。各キーはストレージエンジンのユニークなIDで、値はそのエンジンのタイプと構成のタプルです。
-
例:
{"local_storage": ["LocalStorage", {"storage_path": "some/path/"}]}
-
例:
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS[配列]:DISTRIBUTED_STORAGE_CONFIGのIDで指定されたストレージエンジンのリストで、そのイメージはデフォルトで他のすべてのストレージエンジンに完全に複製されます。
- Min Items: None
例:
s3_us_east, s3_us_west- array item[文字列] .
DISTRIBUTED_STORAGE_PREFERENCE[配列] 必須。使用する優先的なストレージエンジン（DISTRIBUTED_STORAGE_CONFIGのIDによる）。優先されるエンジンとは、プルのチェックが行われ、画像がプッシュされることを意味します。
Min Items: None
-
例:
[u’s3_us_east', u’s3_us_west'] - array item[文字列] .
-
例:
preferred_url_scheme[文字列] 必須。Red Hat Quayにアクセスする際に使用するURLスキームです。Red Hat Quay が SSL を一部的にでも使用している場合、これは
httpsでなければなりません。-
enum:
http, https -
例:
https
-
enum:
- DOCUMENTATION_ROOT[文字列]:ドキュメントへのリンクのルート URL。
ENABLE_HEALTH_DEBUG_SECRET[string,
null]:指定された場合、スーパーユーザとして認証されていないときに、完全なデバッグ情報を見るためにヘルスエンドポイントに与えることができるシークレットです。-
例:
somesecrethere
-
例:
EXPIRED_APP_SPECIFIC_TOKEN_GC[string,
null]:期限切れの外部アプリのトークンがガベージコレクションされるまでの期間です。デフォルトは 1dです。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
EXTERNAL_TLS_TERMINATION[ブール]。TLS がサポートされているが、Red Hat Quay より前のレイヤーで終了している場合、true にする必要があります。
-
例:
True
-
例:
FEATURE_ACI_CONVERSION[ブール]:ACIへの変換を有効にするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_ACTION_LOG_ROTATION[ブール]:古いアクションログをストレージに回転させるかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_ADVERTISE_V2[ブール]:v2/のエンドポイントを表示するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_AGGREGATED_LOG_COUNT_RETRIEVAL[ブール]:集約されたログカウントの検索を許可するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_ANONYMOUS_ACCESS[ブール]:匿名ユーザーによるパブリックリポジトリの閲覧やプルを許可するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_APP_REGISTRY[ブール]:Appのリポジトリへの対応を有効にするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_APP_SPECIFIC_TOKENS［ブール値］。有効にすると、ユーザーはDocker CLIで使用するトークンを作成できます。デフォルトは True です。
- 例: False
FEATURE_BITBUCKET_BUILD[ブール]:Bitbucketのビルドトリガーをサポートするかどうか。デフォルトは false です。
-
例:
False
-
例:
- FEATURE_BLACKLISTED_EMAIL
FEATURE_BUILD_SUPPORT[ブール]:Dockerfileのビルドをサポートするかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_CHANGE_TAG_EXPIRARTION[ブール]:ユーザーや組織が、自分の名前空間にあるタグの有効期限を変更できるかどうか。デフォルトは True です。
-
例:
False
-
例:
FEATURE_DIRECT_LOGIN[ブール]:ユーザーがUIに直接ログインできるかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_GARBAGE_COLLECTION[ブール]:リポジトリのガベージコレクションを有効にするかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_GITHUB_BUILD[ブール]:GitHubのビルドトリガーをサポートするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_GITHUB_LOGIN[ブール]:GitHubのログインに対応しているかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_GITLAB_BUILD[ブール]:GitLabのビルドトリガーをサポートするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_GOOGLE_LOGIN[ブール]:Googleログインがサポートされているかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_INVITE_ONLY_USER_CREATION[ブール]:作成されるユーザーが他のユーザーによって招待されなければならないかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_LIBRARY_SUPPORT[ブール]:Dockerからのプルプッシュ時に「名前空間のない」リポジトリを許可するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_LOG_EXPORT[ブール]:アクションログのエクスポートを許可するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_MAILING[ブール]:メールが有効であるかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_NONSUPERUSER_TEAM_SYNCING_SETUP［ブール値］。有効にすると、スーパーユーザーではない人でも、LDAPやKeystoneをバックにチームの同期を設定できます。デフォルトは False です。
-
例:
True
-
例:
FEATURE_PARTIAL_USER_AUTOCOMPLETE［ブール値］。trueに設定すると、オートコンプリートは部分的なユーザー名にも適用されます。デフォルトは True です。
-
例:
True
-
例:
FEATURE_PERMANENT_SESSIONS[ブール]:セッションが永続的であるかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_PROXY_STORAGE[ブール]:ストレージ内のすべての直接ダウンロードURLをレジストリのnginx経由でプロキシするかどうかを指定します。デフォルトは false です。
-
例:
False
-
例:
FEATURE_PUBLIC_CATALOG［ブール値］。trueに設定すると、
_catalogエンドポイントは公開リポジトリを返します。それ以外では、プライベートリポジトリのみが返されます。デフォルトは false です。-
例:
False
-
例:
FEATURE_RATE_LIMITS[ブール]:APIとレジストリのエンドポイントでレート制限を有効にするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_READER_BUILD_LOGS[ブール]:trueに設定すると、ビルドログは書き込みアクセスや管理者アクセスだけではなく、レポへの読み取りアクセスを持つ人が読むことができます。デフォルトは false です。
- 例: False
FEATURE_READONLY_APP_REGISTRY[ブール]:Appのリポジトリを読み取り専用にするかどうか。デフォルトは false です。
-
例:
True
-
例:
FEATURE_RECAPTCHA[ブール]:ユーザーのログインとリカバリーにRecaptchaが必要かどうか。デフォルトは false です。
-
例:
False - 参考: https://www.google.com/recaptcha/intro/
-
例:
FEATURE_REPO_MIRROR[ブール]:ミラーリング時にHTTPSを要求し、Quayレジストリの証明書を検証します。デフォルトは True です。
-
例:
True
-
例:
FEATURE_REQUIRE_ENCRYPTED_BASIC_AUTH[ブール]:基本認証に暗号化されていないパスワード（暗号化されたトークンではなく）を使用できるかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_REQUIRE_TEAM_INVITE[ブール]:ユーザーをチームに追加する際に招待状を要求するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_RESTRICTED_V1_PUSH[ブール]:trueに設定すると、V1_PUSH_WHITELISTに記載されている名前空間のみがV1プッシュをサポートします。デフォルトは True です。
-
例:
True
-
例:
FEATURE_SECURITY_NOTIFICATIONS[ブール]:セキュリティスキャナが有効な場合、セキュリティ通知をオン/オフするかどうかを指定します。デフォルトは false です。
-
例:
False
-
例:
FEATURE_SECURITY_SCANNER[ブール]:セキュリティスキャナをオン/オフするかどうか。デフォルトは false です。
FEATURE_STORAGE_REPLICATION[ブール]:ストレージエンジン間で自動的にレプリケーションを行うかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_SUPER_USERS[ブール]:スーパーユーザーをサポートするかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_TEAM_SYNCING[ブール]:認証エンジン（LDAPまたはKeystone）のバッキンググループからチームメンバーを同期させることを許可するかどうか。
-
例:
True
-
例:
FEATURE_USER_CREATION[ブール]:スーパーユーザーではない人が）ユーザーを作成できるかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_USER_LAST_ACCESSED[ブール]:ユーザーが最後にアクセスした時間を記録するかどうか。デフォルトは True です。
-
例:
True
-
例:
FEATURE_USER_LOG_ACCESS［ブール値］。trueに設定すると、ユーザーは自分のネームスペースの監査ログにアクセスできます。デフォルトは false です。
-
例:
True
-
例:
FEATURE_USER_METADATA[ブール]:ユーザのメタデータを収集してサポートするかどうか。デフォルトは false です。
-
例:
False
-
例:
FEATURE_USERNAME_CONFIRMATION［ブール値］。trueに設定すると、ユーザは生成されたユーザ名を確認できます。デフォルトは True です。
-
例:
False
-
例:
FEATURE_USER_RENAME［ブール値］。trueに設定すると、ユーザーは自分のネームスペースの名前を変更できます。デフォルトは false です。
-
例:
True
-
例:
FRESH_LOGIN_TIMEOUT[文字列]:フレッシュログインでユーザーがパスワードの再入力を要求される時間
-
例
5m
-
例
GITHUB_LOGIN_CONFIG[オブジェクト, 'null']:GitHub (Enterprise)を外部ログインプロバイダーとして使用するための設定です。
- 参考: https://coreos.com/quay-enterprise/docs/latest/github-auth.html
allowed_organizations[配列]:ORG_RESTRICTオプションで動作するようにホワイトリストされたGitHub (Enterprise)の組織の名前。
- Min Items: None
Unique Items: True
- array item[文字列] .
API_ENDPOINT[文字列]:使用するGitHub (Enterprise) APIのエンドポイントです。github.comにオーバーライドされる必要があります。
CLIENT_ID[文字列] 必須。GITHUB_TRIGGER_CONFIGとは共有できません。
- Reference: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
0e8dbe15c4c7630b6780
CLIENT_SECRET[文字列] 必須。この Red Hat Quay インスタンスに登録されているクライアントシークレットです。
- Reference: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITHUB_ENDPOINT[文字列] 必須。ヒットしているGitHub（Enterprise）のエンドポイントです。
- ORG_RESTRICT[ブール]。trueの場合、組織のホワイトリスト内のユーザのみがこのプロバイダを使用してログインできます。
-
例:
True
GITHUB_TRIGGER_CONFIGオブジェクト、
null:ビルドトリガーにGitHub (Enterprise)を使用するための設定です。- Reference: https://coreos.com/quay-enterprise/docs/latest/github-build.html
API_ENDPOINT[文字列]:使用するGitHub (Enterprise) APIのエンドポイントです。github.comにオーバーライドされる必要があります。
CLIENT_ID[文字列] 必須。GITHUB_LOGIN_CONFIGとは共有できません。
- Reference: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
0e8dbe15c4c7630b6780
CLIENT_SECRET[文字列] 必須。この Red Hat Quay インスタンスに登録されているクライアントシークレットです。
- Reference: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITHUB_ENDPOINT[文字列] 必須。ヒットしているGitHub（Enterprise）のエンドポイントです。
GITLAB_TRIGGER_CONFIG[オブジェクト]:Gitlab (Enterprise)を外部認証で使用するための設定。
CLIENT_ID[文字列] 必須。この Red Hat Quay インスタンスの登録済みクライアント ID です。
-
例:
0e8dbe15c4c7630b6780
-
例:
CLIENT_SECRET[文字列] 必須。この Red Hat Quay インスタンスに登録されているクライアントシークレットです。
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846 gitlab_endpoint[文字列] 必須。Gitlab(Enterprise)が動作しているエンドポイントです。
-
例:
GOOGLE_LOGIN_CONFIGオブジェクト,
null:外部認証にGoogleを利用するための設定CLIENT_ID[文字列] 必須。この Red Hat Quay インスタンスの登録済みクライアント ID です。
-
例:
0e8dbe15c4c7630b6780
-
例:
CLIENT_SECRET[文字列] 必須。この Red Hat Quay インスタンスに登録されているクライアントシークレットです。
- 例: e4a58ddd3d7408b7aec109e85564a0d153d3e846
GPG2_PRIVATE_KEY_FILENAME[文字列]。ACIの解読に使用する秘密鍵のファイル名です。
-
例:
/path/to/file
-
例:
GPG2_PRIVATE_KEY_NAME[文字列]。ACIの署名に使用する秘密鍵の名前です。
-
例:
gpg2key
-
例:
GPG2_PUBLIC_KEY_FILENAME[文字列]。ACIの暗号化に使用する公開鍵のファイル名です。
-
例:
/path/to/file
-
例:
HEALTH_CHECKER[文字列]:設定されたヘルスチェック。
-
例:
('RDSAwareHealthCheck', {'access_key': 'foo', 'secret_key': 'bar'})
-
例:
JWT_AUTH_ISSUER[文字列] :JWT ユーザーのエンドポイント。
-
例:
http://192.168.99.101:6060 -
パターン:
^http(s)?://(.)+$
-
例:
JWT_GETUSER_ENDPOINT [文字列] : The endpoint for JWT users.
-
例:
http://192.168.99.101:6060 -
パターン:
^http(s)?://(.)+$
-
例:
JWT_QUERY_ENDPOINT[文字列] :JWT クエリのエンドポイントです。
-
例:
http://192.168.99.101:6060 -
パターン:
^http(s)?://(.)+$
-
例:
JWT_VERIFY_ENDPOINT[文字列] :JWTの検証を行うエンドポイント。
-
例:
http://192.168.99.101:6060 -
パターン:
^http(s)?://(.)+$
-
例:
- LDAP_ADMIN_DN[文字列]:LDAP認証のアドミンDNです。
- LDAP_ADMIN_PASSWD[文字列]:LDAP認証の管理者パスワードです。
- LDAP_ALLOW_INSECURE_FALLBACK[ブール]:LDAP認証において、SSL insecure fallbackを許可するかどうかを指定します。
- LDAP_BASE_DN[文字列]:LDAP認証のベースDNです。
- LDAP_EMAIL_ATTR[文字列]:LDAP認証のメール属性です。
- LDAP_UID_ATTR[文字列]:LDAP認証のuid属性です。
- LDAP_URI[文字列]:LDAP URIです。
- LDAP_USER_FILTER[文字列]:LDAP認証のためのユーザーフィルターです。
- LDAP_USER_RDN[配列]:LDAP認証のユーザーRDNです。
LOGS_MODEL[文字列]:アクションログのログモデル。
- enum: database, transition_reads_both_writes_es, elasticsearch
-
例:
database
LOGS_MODEL_CONFIG[オブジェクト]:アクションログ用のログモデル設定
elasticsearch_config[オブジェクト]:Elasticsearchクラスタの設定
access_key[文字列] :Elasticsearch のユーザー（AWS ES の場合は IAM キー）。
-
例:
some_string
-
例:
ホスト[文字列]:Elasticsearch クラスタのエンドポイント
-
例:
host.elasticsearch.example
-
例:
index_prefix[文字列]。Elasticsearch のインデックスのプレフィックス
-
例:
logentry_
-
例:
- index_settings[オブジェクト]:Elasticsearchのインデックス設定
use_ssl[ブール]。Elasticsearchにsslを使用します。デフォルトは true です。
-
例:
True
-
例:
secret_key[文字列] :Elasticsearchのパスワード（またはAWS ESの場合はIAMシークレット
-
例:
some_secret_string
-
例:
aws_region[文字列]:アマゾンウェブサービスの地域
-
例:
us-east-1
-
例:
ポート[番号]:Elasticsearchクラスタのエンドポイントポート
-
例:
1234
-
例:
kinesis_stream_config[オブジェクト]:AWS Kinesis ストリームの設定
aws_secret_key[文字列] :AWSの秘密鍵
-
例:
some_secret_key
-
例:
stream_name [文字列] : [文字列]:アクションログの送信先となるKinesisストリーム
-
例:
logentry-kinesis-stream
-
例:
aws_access_key [文字列] : AWS access key
-
例:
some_access_key
-
例:
retries[番号] :一回のリクエストに対する最大試行回数
-
例:
5
-
例:
read_timeout[番号]:コネクションからの読み込み時にタイムアウトするまでの秒数
-
例:
5
-
例:
max_pool_connections[番号] :コネクションプールに保持するコネクションの最大数
-
例:
10
-
例:
aws_region [文字列] : AWS のリージョン
-
例:
us-east-1
-
例:
connect_timeout[番号]:接続を試みる際のタイムアウトまでの秒数
-
例:
5
-
例:
producer[文字列] :Elasticsearchにロギングする場合、producerを記録します。
- enum: kafka, elasticsearch, kinesis_stream
-
例:
kafka
kafka_config[オブジェクト]:Kafkaクラスターの設定
topic [文字列] : Kafka topic to publish log entries to
-
例:
logentry
-
例:
- bootstrap_servers[配列]:クライアントをブートストラップさせる Kafka ブローカーのリスト
max_block_seconds[番号]:
send()の実行中に、バッファがいっぱいになったり、メタデータが利用できないなどの理由でブロックする最大秒数-
例:
10
-
例:
LOG_ARCHIVE_LOCATION[文字列]。ビルドが有効な場合、アーカイブされたビルドログを配置するストレージエンジンです。
-
例:
s3_us_east
-
例:
LOG_ARCHIVE_PATH[文字列]:ビルドが有効な場合、アーカイブされたビルドログを保存するストレージ内のパス。
-
例:
archives/buildlogs
-
例:
- LOGS_MODEL[文字列]:アクションログのログモデル。
-
enum:
database,transition_reads_both_writes_es,elasticsearch -
例:
database MAIL_DEFAULT_SENDER[文字列、
null]。指定された場合、Red Hat Quay が電子メールを送信する際にfromとして使用される電子メールアドレスです。何もない場合、デフォルトはsupport@quay.ioです。-
例:
support@myco.com
-
例:
MAIL_PASSWORD[文字列,
null]:電子メールの送信時に使用するSMTPパスワード。-
例:
mypassword
-
例:
MAIL_PORT［番号］。使用するSMTPポートを指定します。指定されていない場合、デフォルトでは587になります。
-
例:
588
-
例:
MAIL_SERVER[文字列]:電子メールの送信に使用するSMTPサーバーです。FEATURE_MAILINGがtrueに設定されている場合のみ必要です。
-
例:
smtp.somedomain.com
-
例:
MAIL_USERNAME[文字列, 'null']:電子メールの送信時に使用するSMTPユーザー名。
-
例:
myuser
-
例:
MAIL_USE_TLS［ブール値］。指定された場合、電子メールの送信にTLSを使用するかどうか。
-
例:
True
-
例:
MAXIMUM_LAYER_SIZE[文字列]:画像レイヤーの最大許容サイズ。デフォルトは20Gです。
-
パターン:
^[0-9]+(G|M)$ -
例:
100G
-
パターン:
PREFERRED_URL_SCHEME[文字列]。Red Hat Quay にアクセスする際に使用する URL スキームです。Red Hat Quay が SSL を一部的にでも使用している場合、これは
httpsでなければなりません。-
enum:
httpまたはhttps -
例:
https
-
enum:
PROMETHEUS_NAMESPACE［文字列］。公開されているすべてのPrometheusメトリクスに適用されるプレフィックスです。デフォルトは
quayです。-
例:
myregistry
-
例:
PUBLIC_NAMESPACES[配列]:名前空間が公共の名前空間リストで定義されている場合、そのユーザーが名前空間のメンバーであるかどうかにかかわらず、すべてのユーザーのリポジトリリストページに表示されます。一般的には、企業のお客様が「よく知られた」名前空間のセットを構成する際に使用されます。
- Min Items: None
Unique Items: True
- array item[文字列] .
- RECAPTCHA_SECRET_KEY[文字列]:recaptcha が有効な場合、Recaptcha サービスの秘密鍵。
- RECAPTCHA_SITE_KEY[文字列]:recaptcha が有効な場合、Recaptcha サービスのサイトキー。
REGISTRY_STATE[文字列]:レジストリの状態です。
-
enum:
ノーマルまたはリードオンリー -
例:
read-only
-
enum:
REGISTRY_TITLE[文字列]:指定された場合は、レジストリの長い形式のタイトルです。デフォルトは
Quay Enterpriseです。-
例:
Corp Container Service
-
例:
REGISTRY_TITLE_SHORT[文字列]:指定された場合、レジストリの短い形式のタイトル。デフォルトは
Quay Enterpriseです。-
例:
CCS
-
例:
REPO_MIRROR_INTERVAL［数値］。リポジトリのミラー候補をチェックする間隔を秒単位で指定します。デフォルトは 30 です。
-
例:
30
-
例:
REPO_MIRROR_SERVER_HOSTNAME[文字列]を指定します。ミラーリング先の SERVER_HOSTNAME を置き換えます。デフォルトは unset です。
-
例:
openshift-quay-service
-
例:
REPO_MIRROR_TLS_VERIFY[ブール]:ミラーリング中にHTTPSを要求し、Quayレジストリの証明書を検証します。デフォルトは True です。
-
例:
True
-
例:
SEARCH_MAX_RESULT_PAGE_COUNT[番号]:ユーザーが検索でページングする際に、制限されるまでの最大ページ数。デフォルトは10です。
-
例:
10
-
例:
SEARCH_RESULTS_PER_PAGE[番号]:検索ページごとに返される結果の数。デフォルトは10です。
-
例:
10
-
例:
SECRET_KEY[文字列] 必須。データベースやランタイムで機密性の高いフィールドを暗号化するために使用されるキー。一度設定した値は絶対に変更してはいけません。これを変更すると、依存するすべてのフィールド（たとえば、暗号化されたパスワードの認証情報）が無効になります。
-
例:
40157269433064266822674401740626984898972632465622168464725100311621640999470
-
例:
SECURITY_SCANNER_ENDPOINT[文字列] :セキュリティスキャナのエンドポイントです。
-
パターン:
^http(s)?://(.)+$ -
例:
http://192.168.99.101:6060
-
パターン:
SECURITY_SCANNER_INDEXING_INTERVAL［番号］。セキュリティスキャナのインデキシング間隔の秒数です。デフォルトは 30 です。
-
例:
30
-
例:
SECURITY_SCANNER_NOTIFICATIONS[ブール]:セキュリティスキャナの通知機能を行うかどうか
-
例:
false
-
例:
SECURITY_SCANNER_V4_ENDPOINT[文字列]:V4セキュリティスキャナーのエンドポイントです。
-
パターン:
^http(s)?://(.)+$ -
例:
http://192.168.99.101:6060
-
パターン:
SERVER_HOSTNAME[文字列] 必須。Red Hat Quay にアクセスするための URL で、スキームは含まれません。
-
例:
quay.io
-
例:
SESSION_COOKIE_SECURE[ブール]:セッションクッキーに
secureプロパティを設定するかどうか。デフォルトは false です。SSLを使用するすべてのインストールでTrueにすることを推奨します。- 例: True
- Reference: https://en.wikipedia.org/wiki/Secure_cookies
SSL_CIPHERS[配列]:指定された場合、有効または無効にするSSL暗号のnginx定義のリストです。
-
例:
CAMELLIA,!3DES
-
例:
SSL_PROTOCOLS[配列]:指定された場合、nginxはリストで定義されたSSLプロトコルを有効にするように設定されます。リストから SSL プロトコルを削除すると、Red Hat Quay の起動時にそのプロトコルが無効になります。
- SSL_PROTOCOLS: ['TLSv1','TLSv1.1','TLSv1.2']
SUCCESSIVE_TRIGGER_FAILURE_DISABLE_THRESHOLD[番号]:Noneではない場合、ビルドトリガーが自動的に無効になるまでに発生する連続した失敗の回数を指定します。デフォルトは 100 です。
-
例:
50
-
例:
- SUCCESSIVE_TRIGGER_INTERNAL_ERROR_DISABLE_THRESHOLD[番号]:Noneでない場合、ビルドトリガーが自動的に無効になるまでに発生する連続した内部エラーの数を指定します。デフォルトは 5 です。
SUPER_USERS[配列]:スーパーユーザー権限を付与されるユーザーの Red Hat Quay ユーザー名。
- Min Items: None
Unique Items: True
- array item[文字列] .
TAG_EXPIRATION_OPTIONS[配列] 必須。ネームスペースのタグの有効期限について、ユーザーが選択できるオプション（有効な場合）。
- Min Items: None
- array item[文字列] .
-
パターン:
^[0-9]+(w|m|d|h|s)$
TEAM_RESYNC_STALE_TIME[文字列]:チームの同期が有効な場合、そのチームのメンバーシップをチェックし、必要に応じて再同期する頻度を指定します（デフォルト: 30m）。
-
パターン:
^[0-9]+(w|m|d|h|s)$ -
例:
2h
-
パターン:
USERFILES_LOCATION[文字列]:ユーザーがアップロードしたファイルを配置するストレージエンジンの ID。
-
例:
s3_us_east
-
例:
USERFILES_PATH[文字列]:ユーザーがアップロードしたファイルを配置するストレージ下のパス
-
例:
userfiles
-
例:
USER_EVENTS_REDIS[オブジェクト] 必須。ユーザーイベント処理用のRedisへの接続情報です。
HOST[文字列] 必須。Redisにアクセスするためのホスト名。
-
例:
my.redis.cluster
-
例:
PASSWORD[文字列]: Redisインスタンスに接続するためのパスワードです。
-
例:
mypassword
-
例:
PORT［番号］。Redisにアクセスするためのポートです。
-
例:
1234
-
例:
CONSUMER_SECRET[文字列] 必須。この Red Hat Quay インスタンスに登録されているコンシューマーシークレット（クライアントシークレット）です。
- 例: e4a58ddd3d7408b7aec109e85564a0d153d3e846
USERFILES_LOCATION[文字列]:ユーザーがアップロードしたファイルを配置するストレージ エンジンの ID。
-
例:
s3_us_east
-
例:
USERFILES_PATH[文字列]:ユーザーがアップロードしたファイルを配置するストレージ下のパス。
-
例:
userfiles
-
例:
USER_RECOVERY_TOKEN_LIFETIME[文字列]:ユーザーアカウントを回復するためのトークンが有効な期間です。デフォルトでは30mです。
-
例:
10m -
パターン:
^[0-9]+(w|m|d|h|s)$
-
例:
V1_PUSH_WHITELIST[配列]:FEATURE_RESTRICTED_V1_PUSHがtrueに設定されている場合、V1プッシュをサポートする名前空間名の配列です。
-
例:
some,namespaces
-
例:
V2_PAGINATION_SIZE［数値］。V2 レジストリ API で 1 ページあたりに返される結果の数を指定します。
-
例:
100
-
例:
WEBHOOK_HOSTNAME_BLACKLIST[配列]: ウェブフックの検証時に許可しないホスト名のセット（localhost以外）。
-
例:
someexternaldomain.com
-
例:
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}