第15章 Red Hat Quay のスキーマ
とくにマークされていない限り、すべてのフィールドはオプションになります。
AUTHENTICATION_TYPE [string] 必須: 認証情報の認証に使用する認証エンジン。
- enum: Database、LDAP、JWT、Keystone、OIDC。
-
例:
Database
BUILDLOGS_REDIS [object] 必須: ビルドログキャッシュの Redis の接続情報。
HOST [string] 必須: Redis にアクセス可能なホスト名。
-
例:
my.redis.cluster
-
例:
PASSWORD [string]: Redis インスタンスに接続するためのパスワード。
-
例:
mypassword
-
例:
PORT [number]: Redis にアクセスできるポート。
-
例:
1234
-
例:
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_TAG_EXPIRATION [string] 必須: タイムマシンのデフォルトの設定可能なタグの有効期限。デフォルトは
2w
に設定されます。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
DISTRIBUTED_STORAGE_CONFIG [object] 必須: Red Hat Quay で使用するストレージエンジンの設定。それぞれのキーはストレージエンジンに一意の ID で、値はそのエンジンのタイプと設定のタプルになります。
-
例:
{"local_storage": ["LocalStorage", {"storage_path": "some/path/"}]}
-
例:
DISTRIBUTED_STORAGE_PREFERENCE [array] 必須: 使用する優先されるストレージ (DISTRIBUTED_STORAGE_CONFIG の ID 別)。エンジンを優先するとは、優先されるエンジンがプルの実行時に最初にプルされ、イメージがこれにプッシュされるという意味です。
Min Items: None
-
例:
[u's3_us_east', u's3_us_west']
- array item [string]
-
例:
preferred_url_scheme [string] 必須: Red Hat Quay をヒットする際に使用する URL スキーム。Red Hat Quay が たしかに SSL の背後にある場合、これは
https
である はずです。-
enum:
http, https
-
例:
https
-
enum:
SERVER_HOSTNAME [string] 必須: スキームなしに Red Hat Quay にアクセスできる URL。
-
例:
quay.io
-
例:
TAG_EXPIRATION_OPTIONS [array] 必須: ユーザーが namespace でタグの有効期限について選択できるオプション (有効にされている場合)。
- Min Items: None
- array item [string]
-
パターン:
^[0-9]+(w|m|d|h|s)$
USER_EVENTS_REDIS [object] 必須: ユーザーイベント処理についての Redis の接続情報。
HOST [string] 必須: Redis にアクセス可能なホスト名。
-
例:
my.redis.cluster
-
例:
PASSWORD [string]: Redis インスタンスに接続するためのパスワード。
-
例:
mypassword
-
例:
PORT [number]: Redis にアクセスできるポート。
-
例:
1234
-
例:
ACTION_LOG_ARCHIVE_LOCATION [string]: アクションログのアーカイブが有効にされている場合の、アーカイブされたデータを配置するストレージエンジン。
-
例:
s3_us_east
-
例:
ACTION_LOG_ARCHIVE_PATH' [string]: アクションログのアーカイブが有効にされている場合の、アーカイブされたデータを配置するストレージのパス。
-
例:
archives/actionlogs
-
例:
APP_SPECIFIC_TOKEN_EXPIRATION [string,
null
]: 外部アプリケーショントークンの有効期限。デフォルトは None になります。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
ALLOW_PULLS_WITHOUT_STRICT_LOGGING [boolean]: true の場合、プル監査ログエントリーを書き込めないプルは正常に実行されます。データベースが読み取り専用の状態にフォールバックし、その間プルを続行する必要がある場合に便利です。デフォルトは false に設定されます。
-
例:
True
-
例:
AVATAR_KIND [string]: 表示する avatar のタイプ。インライン (ローカル) または Gravatar (gravatar)。
- enum: local, gravatar
BITBUCKET_TRIGGER_CONFIG ['object', 'null']: ビルドトリガーに BitBucket を使用するための設定。
consumer_key [string] 必須: この Red Hat Quay インスタンスの登録されたコンシューマーキー (クライアント ID)。
-
例:
0e8dbe15c4c7630b6780
-
例:
CONSUMER_SECRET [string] 必須: この Red Hat Quay インスタンスの登録されたコンシューマーシークレット (クライアントシークレット)
- 例: e4a58ddd3d7408b7aec109e85564a0d153d3e846
BROWSER_API_CALLS_XHR_ONLY [boolean]: 有効にされている場合、XHR による呼び出しとしてマークが付けられた API のみがブラウザーから許可されます。デフォルトは True に設定されます。
- 例: False
CONTACT_INFO [array]: 指定されている場合は、連絡先ページに表示される連絡先情報。連絡先情報が 1 つだけ指定される場合、連絡先フッターが直接リンクされます。
- Min Items: 1
Unique Items: True
- array item 0 [string]: メールを送信するためのリンクを追加します。
-
パターン:
^mailto:(.)+$
-
例:
mailto:support@quay.io
array item 1 [string]: IRC チャットルームにアクセスするためのリンクを追加します。
-
パターン:
^irc://(.)+$
-
例:
irc://chat.freenode.net:6665/quay
-
パターン:
array item 2 [string]: 電話番号に電話するためのリンクを追加します。
-
パターン:
^tel:(.)+$
-
例:
tel:+1-888-930-3475
-
パターン:
array item 3 [string]: 定義された URL へのリンクを追加します。
-
パターン:
^http(s)?://(.)+$
-
例:
https://twitter.com/quayio
-
パターン:
BLACKLIST_V2_SPEC [string]: Red Hat Quay が V2 は サポート対象外 であることを示す応答を返す Docker CLI バージョン。デフォルトは
<1.6.0
に設定されます。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] 必須: スレッドローカル接続を使用するかどうか。常に
DEFAULT_NAMESPACE_MAXIMUM_BUILD_COUNT [number,
null
]: None では無い場合、namespace でキューに入れることができるビルドのデフォルトの最大数。-
例:
20
-
例:
DIRECT_OAUTH_CLIENTID_WHITELIST [array]: ユーザーの承認なしに直接 OAuth 承認を実行できる Red Hat Quay 管理 アプリケーションのクライアント ID の一覧。
- Min Items: None
- Unique Items: True
参照: https://coreos.com/quay-enterprise/docs/latest/direct-oauth.html
- array item [string]
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS [array]: イメージをデフォルトで他のすべてのストレージエンジンに対して完全にレプリケートする必要のあるストレージエンジンの一覧 (DISTRIBUTED_STORAGE_CONFIG の ID 別)。
- Min Items: None
例:
s3_us_east, s3_us_west
- array item [string]
EXTERNAL_TLS_TERMINATION [boolean]: TLS がサポートされているが、Red Hat Quay の前の層で終了する場合は true になります。
-
例:
True
-
例:
ENABLE_HEALTH_DEBUG_SECRET [string,
null
]: 指定されている場合は、スーパーユーザーとして認証されていない場合に詳細なデバッグ情報を表示するために正常性エンドポイントに指定できるシークレット。-
例:
somesecrethere
-
例:
EXPIRED_APP_SPECIFIC_TOKEN_GC [string,
null
]: 期限切れとなった外部アプリケーションがガべージコレクションが行われるまでに留まる期間。デフォルトは 1d に設定されます。-
パターン:
^[0-9]+(w|m|d|h|s)$
-
パターン:
FEATURE_ACI_CONVERSION [boolean]: ACI への変換を有効にするかどうか。デフォルトは false に設定されます。
-
例:
False
-
例:
FEATURE_ACTION_LOG_ROTATION [boolean]: ストレージに対する古いアクションログのローテーションを行うかどうか。デフォルトは false に設定されます。
-
例:
False
-
例:
FEATURE_ADVERTISE_V2 [boolean]: v2/ エンドポイントが表示されるかどうか。デフォルトは True に設定されます。
-
例:
True
-
例:
FEATURE_ANONYMOUS_ACCESS [boolean]: 匿名ユーザーがパブリックリポジトリーを参照し、プルすることを許可するかどうか。デフォルトは True に設定されます。
-
例:
True
-
例:
FEATURE_APP_REGISTRY [boolean]: アプリケーションリポジトリーのサポートを有効にするかどうか。デフォルトは false に設定されます。
-
例:
False
-
例:
FEATURE_APP_SPECIFIC_TOKENS [boolean]: 有効にされる場合、ユーザーは Docker CLI で使用するトークンを作成できます。デフォルトは True に設定されます。
- 例: False
FEATURE_BITBUCKET_BUILD [boolean]: Bitbucket ビルドトリガーをサポートするかどうか。デフォルトは false に設定されます。
-
例:
False
-
例:
FEATURE_BUILD_SUPPORT [boolean]: Dockerfile ビルドをサポートするかどうか。デフォルトは True に設定されます。
-
例:
True
-
例:
FEATURE_CHANGE_TAG_EXPIRARTION [boolean]: ユーザーおよび組織が namespace でタグのタグ有効期限を変更することを許可するかどうか。デフォルトは True に設定されます。
-
例:
False
-
例:
FEATURE_DIRECT_LOGIN [boolean]: ユーザーが UI に直接ログインできるかどうか。デフォルトは 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 への/からのプルおよびプッシュの実行時に namespace のないリポジトリーを許可するかどうか。デフォルトは 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]: レジストリー nginx を使用してストレージ内のすべての直接ダウンロード URL をプロキシーするかどうか。デフォルトは false に設定されます。
-
例:
False
-
例:
FEATURE_PUBLIC_CATALOG [boolean]: true に設定される場合、
_catalog
エンドポイントはパブリックリポジトリーを返します。それ以外の場合は、プライベートリポジトリーのみが返されます。デフォルトは false に設定されます。-
例:
False
-
例:
FEATURE_READER_BUILD_LOGS [boolean]: true に設定されている場合、書き込みアクセスや管理アクセスがある場合だけでなく、リポジトリーへの読み取りアクセスを持つユーザーがビルドログを読み取ることができます。デフォルトは False に設定されます。
- 例: False
FEATURE_RECAPTCHA [boolean]: Recaptcha がユーザーログインおよびリカバリーに必要かどうか。デフォルトは False に設定されます。
-
例:
False
- 参照: https://www.google.com/recaptcha/intro/
-
例:
FEATURE_REQUIRE_ENCRYPTED_BASIC_AUTH [boolean]: (暗号化されたトークンに対して) 暗号化されていないパスワードが基本認証に使用できるかどうか。デフォルトは False に設定されます。
-
例:
False
-
例:
FEATURE_REQUIRE_TEAM_INVITE [boolean]: ユーザーをチームに追加する際に招待を必要とするかどうか。デフォルトは 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_LOG_ACCESS [boolean]: true に設定される場合、ユーザーは namespace の監査ログにアクセスできます。デフォルトは False に設定されます。
-
例:
True
-
例:
FEATURE_USER_METADATA [boolean]: ユーザーメタデータを収集し、サポートするかどうか。デフォルトは False に設定されます。
-
例:
False
-
例:
FEATURE_USER_RENAME [boolean]: true に設定される場合、ユーザーは独自の namespace の名前を変更できます。デフォルトは False に設定されます。
-
例:
True
-
例:
GITHUB_LOGIN_CONFIG [object, 'null']: 外部ログインプロバイダーとして GitHub (Enterprise) を使用するための設定。
- 参照: https://coreos.com/quay-enterprise/docs/latest/github-auth.html
allowed_organizations [array]: ORG_RESTRICT オプションを使用するためにホワイトリスト化された GitHub (Enterprise) 組織の名前。
- Min Items: None
Unique Items: True
- array item [string]
API_ENDPOINT [string]: 使用する GitHub (Enterprise) API のエンドポイント。github.com について上書きする必要があります。
CLIENT_ID [string] 必須: この Red Hat Quay インスタンスの登録されたクライアント ID。GITHUB_TRIGGER_CONFIG と共有にすることはできません。
- 参照: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
0e8dbe15c4c7630b6780
CLIENT_SECRET [string] 必須: この Red Hat Quay インスタンスの登録されたクライアントシークレット。
- 参照: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITHUB_ENDPOINT [string] 必須: ヒットする GitHub (Enterprise) のエンドポイント。
- ORG_RESTRICT [boolean]: true の場合、このプロバイダーを使用してログインできるのは組織のホワイトリスト内のユーザーのみです。
-
例:
True
GITHUB_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] 必須: この Red Hat Quay インスタンスの登録されたクライアントシークレット。
- 参照: https://coreos.com/quay-enterprise/docs/latest/github-app.html
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846
GITHUB_ENDPOINT [string] 必須: ヒットする GitHub (Enterprise) のエンドポイント。
GITLAB_TRIGGER_CONFIG [object]: 外部認証に Gitlab (Enterprise) を使用するための設定。
CLIENT_ID [string] 必須: この Red Hat Quay インスタンスの登録されたクライアント ID。
-
例:
0e8dbe15c4c7630b6780
-
例:
CLIENT_SECRET [string] 必須: この Red Hat Quay インスタンスの登録されたクライアントシークレット。
-
例:
e4a58ddd3d7408b7aec109e85564a0d153d3e846
gitlab_endpoint [string] 必須: Gitlab(Enterprise) が実行されているエンドポイント
-
例:
GOOGLE_LOGIN_CONFIG [object,
null
]: 外部認証に Google を使用するための設定。CLIENT_ID [string] 必須: この Red Hat Quay インスタンスの登録されたクライアント ID。
-
例:
0e8dbe15c4c7630b6780
-
例:
CLIENT_SECRET [string] 必須: この Red Hat Quay インスタンスの登録されたクライアントシークレット。
- 例: e4a58ddd3d7408b7aec109e85564a0d153d3e846
HEALTH_CHECKER [string]: 設定済みのヘルスチェック。
-
例:
('RDSAwareHealthCheck', {'access_key': 'foo', 'secret_key': 'bar'})
-
例:
LOG_ARCHIVE_LOCATION [string]: ビルドが有効にされている場合の、アーカイブされたビルドログを配置するストレージエンジン。
-
例:
s3_us_east
-
例:
LOG_ARCHIVE_PATH [string]: ビルドが有効にされている場合、アーカイブされたビルドログを配置するストレージのパス。
-
例:
archives/buildlogs
-
例:
MAIL_DEFAULT_SENDER [string,
null
]: 指定されている場合、Red Hat Quay がメールを送信する際のfrom
として使用されるメールアドレス。指定されていない場合は、デフォルトで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 に設定されます。
-
パターン:
^[0-9]+(G|M)$
-
例:
100G
-
パターン:
PUBLIC_NAMESPACES [array]: namespace がパブリック namespace 一覧に定義されている場合、それはユーザーが namespace のメンバーであるかどうかに関係なく、 すべての ユーザーのリポジトリー一覧ページに表示されます。通常、これは企業顧客がよく知られている namespace のセットを設定する際に使用します。
- Min Items: None
Unique Items: True
- array item [string]
PROMETHEUS_NAMESPACE [string]: 公開されているすべての Prometheus メトリクスの適用される接頭辞。デフォルトは
quay
に設定されます。-
例:
myregistry
-
例:
- RECAPTCHA_SITE_KEY [string]: recaptcha が有効にされている場合は、Recaptcha サービスのサイトキー。
- RECAPTCHA_SECRET_KEY [string]: 'recaptcha が有効にされている場合は、 Recaptcha サービスのシークレットキー。
REGISTRY_TITLE [string]: 指定される場合はレジストリーの長いタイト。デフォルトは
Quay Enterprise
に設定されます。-
例:
Corp Container Service
-
例:
REGISTRY_TITLE_SHORT [string]: 指定されている場合はレジストリーの短いタイトル。デフォルトは
Quay Enterprise
に設定されます。-
例:
CCS
-
例:
SECURITY_SCANNER_ENDPOINT [string]: セキュリティースキャナーのエンドポイント。
-
パターン:
^http(s)?://(.)+$
-
例:
http://192.168.99.101:6060
-
パターン:
SECURITY_SCANNER_INDEXING_INTERVAL [number]: セキュリティースキャナーのインデックス作成の間隔 (秒単位)。デフォルトは 30 に設定されます。
-
例:
30
-
例:
SESSION_COOKIE_SECURE [boolean]:
secure
なプロパティーをセッション cookie に設定するかどうか。デフォルトは False に設定されます。SSL を使用するすべてのインストールでは、True にすることが推奨されます。- 例: True
- 参考: https://en.wikipedia.org/wiki/Secure_cookies
SSL_PROTOCOLS [array]: 指定されている場合、nginx は、一覧で定義される SSL プロトコルの一覧を有効にするように設定されます。一覧から SSL プロトコルを削除すると、Red Hat Quay の起動中にプロトコルが無効になります。
- SSL_PROTOCOLS: ['TLSv1','TLSv1.1','TLSv1.2']
SUPER_USERS [array]: スーパーユーザー権限が付与されるユーザーの Red Hat Quay ユーザー名。
- Min Items: None
Unique Items: True
- array item [string]
TEAM_RESYNC_STALE_TIME [string]: チームの同期が有効になっている場合、必要に応じてメンバーシップを確認し、再同期する頻度 (デフォルト: 30m)。
-
パターン:
^[0-9]+(w|m|d|h|s)$
-
例:
2h
-
パターン:
USERFILES_LOCATION [string]: ユーザーがアップロードしたファイルを配置するストレージエンジンの ID。
-
例:
s3_us_east
-
例:
USERFILES_PATH [string]: ユーザーがアップロードしたファイルを配置するストレージの下のパス。
-
例:
userfiles
-
例:
USER_RECOVERY_TOKEN_LIFETIME [string]: ユーザーアカウントを回復するためのトークンが有効な時間の長さ。デフォルトは 30m に設定されます。
-
例:
10m
-
パターン:
^[0-9]+(w|m|d|h|s)$
-
例:
V2_PAGINATION_SIZE [number]: V2 レジストリー API のページごとに返される結果の数。
-
例:
100
-
例: