第16章 Red Hat Quay の設定用スキーマ
ほとんどの Red Hat Quay 設定情報は、Red Hat Quay が最初に展開されたときにブラウザーベースの config ツールを使用して作成される config.yaml
ファイルに保存されます。この章では、config.yaml ファイルで使用可能なそれらの設定のスキーマについて説明します。
以下の項目は必須です (その他はすべて任意)。
AUTHENTICATION_TYPE BUILDLOGS_REDIS DATABASE_SECRET_KEY DB_URI DEFAULT_TAG_EXPIRATION DISTRIBUTED_STORAGE_CONFIG DISTRIBUTED_STORAGE_PREFERENCE PREFERRED_URL_SCHEME SECRET_KEY SERVER_HOSTNAME TAG_EXPIRATION_OPTIONS USER_EVENTS_REDIS
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 [object] 必須: Red Hat Quay で使用するストレージエンジンの設定。各キーは、ストレージエンジンの一意の ID を表します。この値は、ストレージエンジンパラメーターを記述するオブジェクトのタプル (キー、値) で設定されます。
OCS / Noobaa:
rhocsStorage: - RHOCSStorage - access_key: access_key_here secret_key: secret_key_here bucket_name: quay-datastore-9b2108a3-29f5-43f2-a9d5-2872174f9a56 hostname: s3.openshift-storage.svc.cluster.local is_secure: 'true' port: '443' storage_path: /datastorage/registry
Ceph / RadosGW Storage / Hitachi HCP:
radosGWStorage: - RadosGWStorage - access_key: access_key_here secret_key: secret_key_here bucket_name: bucket_name_here hostname: hostname_here is_secure: 'true' port: '443' storage_path: /datastorage/registry
AWS S3 Storage:
s3Storage: - S3Storage - host: s3.ap-southeast-2.amazonaws.com s3_access_key: s3_access_key_here s3_secret_key: s3_secret_key_here s3_bucket: s3_bucket_here storage_path: /datastorage/registry
Azure Storage:
azureStorage: - AzureStorage - azure_account_name: azure_account_name_here azure_account_key: azure_account_key_here azure_container: azure_container_here sas_token: some/path/ storage_path: /datastorage/registry
Google Cloud Storage:
googleCloudStorage: - GoogleCloudStorage - access_key: access_key_here secret_key: secret_key_here bucket_name: bucket_name_here storage_path: /datastorage/registry
Swift Storage:
swiftStorage: - SwiftStorage - swift_user: swift_user_here swift_password: swift_password_here swift_container: swift_container_here auth_url: https://example.org/swift/v1/quay auth_version: 1 ca_cert_path: /conf/stack/swift.cert" storage_path: /datastorage/registry
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_EXPIRATION [ブール]: ユーザーや組織が、自分の名前空間にあるタグの有効期限を変更できるかどうか。デフォルトは 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 [boolean]: true に設定されている場合、リポジトリーのミラーリングを有効にします。デフォルトは false です。
-
例:
False
-
例:
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 [文字列]: Amazon Web サービスの地域
-
例:
us-east-1
-
例:
port [番号]: Elasticsearch クラスターのエンドポイントポート
-
例:
1234
-
例:
kinesis_stream_config [オブジェクト]: AWS Kinesis ストリームの設定
aws_secret_key [文字列]: AWS の秘密鍵
-
例:
some_secret_key
-
例:
stream_name [文字列]: アクションログの送信先となる Kinesis ストリーム
-
例:
logentry-kinesis-stream
-
例:
aws_access_key [文字列]: AWS アクセスキー
-
例:
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 トピック
-
例:
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
-
パターン:
- SECURITY_SCANNER_V4_PSK [string]: Clair に生成された PSK (pre-shared key)
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
-
例: