Red Hat Summit7.9. mirror
7.9.1. syncCancel
指定したリポジトリーのミラーリング設定の sync_status を更新します。
POST /api/v1/repository/{repository}/mirror/sync-cancel
認可: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-cancel" \
7.9.2. syncNow
指定したリポジトリーのミラーリング設定の sync_status を更新します。
POST /api/v1/repository/{repository}/mirror/sync-now
認可: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror/sync-now" \
-H "Authorization: Bearer <access_token>"7.9.3. getRepoMirrorConfig
指定したリポジトリーのミラーリング設定を返します。
GET /api/v1/repository/{repository}/mirror
認可: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>"7.9.4. changeRepoMirrorConfig
ユーザーがリポジトリーのミラーリング設定を変更できるようにします。
PUT /api/v1/repository/{repository}/mirror
認可: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求の body スキーマ (application/json)
リポジトリーミラーリング設定を更新します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
is_enabled | 同期を有効または無効にするために使用されます。 | boolean |
|
external_reference | 外部リポジトリーの場所。 | string |
|
external_registry_username | 外部レジストリーでの認証に使用されるユーザー名。 | |
|
external_registry_password | 外部レジストリーでの認証に使用されるパスワード。 | |
|
sync_start_date | このリポジトリーの次の同期時間を決定します。 | string |
|
sync_interval | next_start_date が同期を開始するまでの秒数。 | integer |
|
robot_username | イメージのプッシュに使用されるロボットのユーザー名。 | string |
|
root_rule | 同期する必要のあるタグの判別に使用する glob パターンのリスト。 | object |
|
external_registry_config | object |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 正常な呼び出し | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X PUT "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"is_enabled": <false>, 1
"external_reference": "<external_reference>",
"external_registry_username": "<external_registry_username>",
"external_registry_password": "<external_registry_password>",
"sync_start_date": "<sync_start_date>",
"sync_interval": <sync_interval>,
"robot_username": "<robot_username>",
"root_rule": {
"rule": "<rule>",
"rule_type": "<rule_type>"
}
}'- 1
- 自動同期を無効にします。
7.9.5. createRepoMirrorConfig
特定のリポジトリーの RepoMirrorConfig を作成します。
POST /api/v1/repository/{repository}/mirror
認可: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求の body スキーマ (application/json)
リポジトリーのミラーリング設定を作成します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
is_enabled | 同期を有効または無効にするために使用されます。 | boolean |
|
external_reference | 外部リポジトリーの場所。 | string |
|
external_registry_username | 外部レジストリーでの認証に使用されるユーザー名。 | |
|
external_registry_password | 外部レジストリーでの認証に使用されるパスワード。 | |
|
sync_start_date | このリポジトリーの次の同期時間を決定します。 | string |
|
sync_interval | next_start_date が同期を開始するまでの秒数。 | integer |
|
robot_username | イメージのプッシュに使用されるロボットのユーザー名。 | string |
|
root_rule | 同期する必要のあるタグの判別に使用する glob パターンのリスト。 | object |
|
external_registry_config | object |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成に成功 | |
| 400 | Bad Request (不適切な要求) | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
コマンドの例
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/mirror" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"is_enabled": <is_enabled>,
"external_reference": "<external_reference>",
"external_registry_username": "<external_registry_username>",
"external_registry_password": "<external_registry_password>",
"sync_start_date": "<sync_start_date>",
"sync_interval": <sync_interval>,
"robot_username": "<robot_username>",
"root_rule": {
"rule": "<rule>",
"rule_type": "<rule_type>"
}
}'