Red Hat Quay の使用

手順

1. Red Hat Quay リポジトリーにスーパーユーザーとしてログインします。
2. ナビゲーションウィンドウでアカウント名を選択し、Super User Admin Panel をクリックします。
3. 列の Users アイコンをクリックします。
4. Create User ボタンをクリックします。
5. 新しいユーザーのユーザー名とメールアドレスを入力し、Create User ボタンをクリックします。

6. Users ページにリダイレクトされ、別の Red Hat Quay ユーザーが表示されます。

   注記

   追加したユーザーを表示するには、Users ページを更新する必要がある場合があります。

7. Users ページで、新しいユーザーに関連する Options の歯車をクリックします。下図のようなドロップダウンメニューが表示されます。

   

8. Change Password をクリックします。

9. 新しいパスワードを追加し、Change User Password をクリックします。

   新しいユーザーが、そのユーザー名とパスワードを使用して、Web UI または Podman などの希望するコンテナークライアントを通じてログインできるようになります。

手順

1. 次のコマンドを入力し、POST /api/v1/superuser/users/ エンドポイントを使用して新しいユーザーを作成します。

   $ curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{
     "username": "newuser",
     "email": "newuser@example.com"
   }' "https://<quay-server.example.com>/api/v1/superuser/users/"

   出力例

   {"username": "newuser", "email": "newuser@example.com", "password": "IJWZ8TIY301KPFOW3WEUJEVZ3JR11CY1", "encrypted_password": "9Q36xF54YEOLjetayC0NBaIKgcFFmIHsS3xTZDLzZSrhTBkxUc9FDwUKfnxLWhco6oBJV1NDBjoBcDGmsZMYPt1dSA4yWpPe/JKY9pnDcsw="}

2. Red Hat Quay レジストリーエンドポイント (例: quay-server.example.com) に移動し、API 呼び出しから生成されたユーザー名とパスワードを使用してログインします。この場合、ユーザー名は newuser、パスワードは IJWZ8TIY301KPFOW3WEUJEVZ3JR11CY1 です。または、CLI を使用してレジストリーにログインすることもできます。以下に例を示します。

   $ podman login <quay-server.example.com>

   出力例

   username: newuser
   password: IJWZ8TIY301KPFOW3WEUJEVZ3JR11CY1

3. 任意。GET /api/v1/superuser/users/ エンドポイントを使用して、スーパーユーザーを含むすべてのユーザーのリストを取得できます。

   $ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"

   出力例

   {"users": [{"kind": "user", "name": "quayadmin", "username": "quayadmin", "email": "quay@quay.com", "verified": true, "avatar": {"name": "quayadmin", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}, "super_user": true, "enabled": true}, {"kind": "user", "name": "newuser", "username": "newuser", "email": "newuser@example.com", "verified": true, "avatar": {"name": "newuser", "hash": "f338a2c83bfdde84abe2d3348994d70c34185a234cfbf32f9e323e3578e7e771", "color": "#9edae5", "kind": "user"}, "super_user": false, "enabled": true}]}

手順

1. Red Hat Quay リポジトリーにスーパーユーザーとしてログインします。
2. ナビゲーションウィンドウでアカウント名を選択し、Super User Admin Panel をクリックします。
3. ナビゲーションペインの Users アイコンをクリックします。
4. 削除するユーザーの横にある Options の歯車をクリックします。
5. Delete User をクリックし、Delete User をクリックして削除を確定します。

手順

1. コマンドラインから次の DELETE /api/v1/superuser/users/{username} コマンドを入力し、ユーザーを削除します。

   $ curl -X DELETE -H "Authorization: Bearer <insert token here>" https://<quay-server.example.com>/api/v1/superuser/users/<username>

2. CLI からユーザーを削除する場合、CLI は情報を返しません。削除を確認するには、Superuser Admin Panel → Users に移動するか、次の GET /api/v1/superuser/users/ コマンドを入力して、Red Hat Quay UI を確認します。すると、ユーザーが存在するかどうかを確認できます。

   $ curl -X GET -H "Authorization: Bearer <bearer_token>" "https://<quay-server.example.com>/api/v1/superuser/users/"

手順

1. Red Hat Quay レジストリーにログインします。
2. ナビゲーションペインで Organization をクリックします。
3. Create Organization をクリックします。
4. Organization Name (testorg など) を入力します。
5. Organization Email を入力します。
6. Create をクリックします。

手順

1. 次のコマンドを入力し、POST /api/v1/organization/ エンドポイントを使用して新しい組織を作成します。

   $ curl -X POST   -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json"   -d '{
       "name": "<new_organization_name>"
     }'   "https://<quay-server.example.com>/api/v1/organization/"

   出力例

   "Created"

手順

1. v2 UI で、Organizations をクリックします。
2. ロボットアカウントを作成する組織の名前をクリックします (例: test-org)。
3. Settings タブをクリックします。
4. オプション: 組織に関連付けられたメールアドレスを入力します。

5. オプション: Time Machine 機能に割り当てる時間を次のいずれかに設定します。

   • A few seconds
   • A day
   • 7 days
   • 14 days
   • A month
6. Save をクリックします。

手順

1. Organizations ページで、削除する組織の名前 (testorg など) を選択します。
2. More Actions ドロップダウンメニューをクリックします。

3. Delete をクリックします。

   注記

   Delete ページには、Search 入力ボックスがあります。このボックスを使用すると、ユーザーは特定の組織を検索して、削除が適切にスケジュールされていることを確認できます。たとえば、ユーザーが 10 の組織を削除していて、特定の組織が削除されたことを確認したい場合、Search 入力ボックスを使用して、その組織が削除対象としてマークされていることを確認できます。

4. ボックスに confirm と入力して、組織を完全に削除することを確定します。

5. Delete をクリックします。

   削除後、Organizations ページに戻ります。

   注記

   複数の組織を選択してから、More Actions → Delete をクリックすると、一度に複数の組織を削除できます。

手順

1. 次のコマンドを入力し、DELETE /api/v1/organization/{orgname} エンドポイントを使用して組織を削除します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     "https://<quay-server.example.com>/api/v1/organization/<organization_name>"

2. CLI から組織を削除する場合、CLI は情報を返しません。削除を確認するには、Red Hat Quay UI を確認するか、GET /api/v1/organization/{orgname} コマンドを入力して、削除した組織の詳細が返されるかどうかを確認します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     "<quay-server.example.com>/api/v1/organization/<organization_name>"

   出力例

   {"detail": "Not Found", "error_message": "Not Found", "error_type": "not_found", "title": "not_found", "type": "http://<quay-server.example.com>/api/v1/error/not_found", "status": 404}

手順

1. ナビゲーションペインで Repositories をクリックします。
2. Create Repository をクリックします。

3. 名前空間 (例: quayadmin) を選択し、リポジトリー名 (例: testrepo) を入力します。

   重要

   リポジトリー名には単語 * build * trigger * tag を使用しないでください。

   これらの単語をリポジトリー名に使用すると、ユーザーがリポジトリーにアクセスできなくなり、リポジトリーを完全に削除できなくなります。このようなリポジトリーを削除しようとすると、Failed to delete repository <repository_name>, HTTP404 - Not Found. エラーが返されます。

4. Create をクリックします。

   これで、サンプルリポジトリーが Repositories ページの下に表示されるはずです。

5. オプション: リポジトリーを非公開に設定するには、Settings → Repository visibility → Make private をクリックします。

手順

1. サンプルレジストリーからサンプルページを取得します。以下に例を示します。

   $ sudo podman pull busybox

   出力例

   Trying to pull docker.io/library/busybox...
   Getting image source signatures
   Copying blob 4c892f00285e done
   Copying config 22667f5368 done
   Writing manifest to image destination
   Storing signatures
   22667f53682a2920948d19c7133ab1c9c3f745805c14125859d20cede07f11f9

2. ローカルシステム上のイメージに、新しいリポジトリーとイメージ名をタグ付けします。以下に例を示します。

   $ sudo podman tag docker.io/library/busybox quay-server.example.com/quayadmin/busybox:test

3. イメージをレジストリーにプッシュします。この手順の後に、ブラウザーを使用して、リポジトリーでタグ付けされたイメージを確認できます。

   $ sudo podman push --tls-verify=false quay-server.example.com/quayadmin/busybox:test

   出力例

   Getting image source signatures
   Copying blob 6b245f040973 done
   Copying config 22667f5368 done
   Writing manifest to image destination
   Storing signatures

手順

1. 次のコマンドを入力し、POST /api/v1/repository エンドポイントを使用してリポジトリーを作成します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "repository": "<new_repository_name>",
       "visibility": "<private>",
       "description": "<This is a description of the new repository>."
     }' \
     "https://quay-server.example.com/api/v1/repository"

   出力例

   {"namespace": "quayadmin", "name": "<new_repository_name>", "kind": "image"}

手順

1. v2 UI の Repositories ページで、削除するリポジトリーのボックスをチェックします (例: quayadmin/busybox)。
2. Actions ドロップダウンメニューをクリックします。
3. Delete をクリックします。

4. ボックスに confirm と入力してから、Delete をクリックします。

   削除後、Repositories ページに戻ります。

手順

1. 次のコマンドを入力し、DELETE /api/v1/repository/{repository} エンドポイントを使用してリポジトリーを削除します。

   $ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

2. CLI からリポジトリーを削除する場合、CLI は情報を返しません。削除を確認するには、Red Hat Quay UI を確認するか、次の GET /api/v1/repository/{repository} コマンドを入力して、削除したリポジトリーの詳細が返されるかどうかを確認します。

   $ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

   出力例

   {"detail": "Not Found", "error_message": "Not Found", "error_type": "not_found", "title": "not_found", "type": "http://quay-server.example.com/api/v1/error/not_found", "status": 404}

手順

1. v2 UI で、Organizations をクリックします。
2. ロボットアカウントを作成する組織の名前をクリックします (例: test-org)。
3. Robot accounts タブ → Create robot account をクリックします。
4. Provide a name for your robot account ボックスに、robot1 などの名前を入力します。ロボットアカウントの名前は、ユーザー名とロボットの名前を組み合わせたものになります (例: quayadmin+robot1)。

5. 任意。必要に応じて、以下のオプションを使用できます。

   1. ロボットアカウントをチームに追加します。
   2. ロボットアカウントをリポジトリーに追加します。
   3. ロボットアカウントの権限を調整します。

6. Review and finish ページで、入力した情報を確認してから、Review and finish をクリックします。Successfully created robot account with robot name: <organization_name> + <robot_name> というアラートが表示されます。

   また、別のロボットアカウントと同じ名前でロボットアカウントを作成しようとすると、Error creating robot account というエラーメッセージが表示される場合があります。

7. オプション: Expand または Collapse をクリックすると、ロボットアカウントの説明情報を表示できます。
8. オプション: 縦の省略記号メニュー → Set repository permissions をクリックして、ロボットアカウントのパーミッションを変更できます。Successfully updated repository permission というメッセージが表示されます。

9. 任意。ロボットアカウントの名前をクリックすると、次の情報を取得できます。

   • Robot Account: ロボットアカウントのトークンを取得するには、これを選択します。Regenerate token now をクリックすると、トークンを再生成できます。
   • Kubernetes Secret: Kubernetes プルシークレット YAML ファイルの形式で認証情報をダウンロードするには、これを選択します。
   • Podman: 認証情報を含む完全な podman login コマンドラインをコピーするには、これを選択します。
   • Docker Configuration: 認証情報を含む完全な docker login コマンドラインをコピーするには、これを選択します。

手順

1. Red Hat Quay v2 UI ランディングページで、ナビゲーションペインの Organizations をクリックします。
2. Organizations ページで、複数のリポジトリーを持つ組織の名前を選択します。単一組織内のリポジトリーの数は、Repo Count 列で確認できます。
3. 組織のページで、Robot accounts をクリックします。
4. 複数のリポジトリーにロボットアカウントを追加する場合は、縦の省略記号アイコン → Set repository permissions をクリックします。

5. Set repository permissions ページで、ロボットアカウントを追加するリポジトリーのチェックボックスをオンにします。以下に例を示します。

   

6. ロボットアカウントの権限を設定します (例: None、Read、Write、Admin)。
7. save をクリックします。Success alert: Successfully updated repository permission というアラートが Set repository permissions ページに表示され、変更が確認されます。
8. Organizations → Robot accounts ページに戻ります。これで、ロボットアカウントの Repositories 列に、ロボットアカウントが追加されたリポジトリーの数が表示されます。

手順

1. config.yaml フィールドを更新して ROBOTS_DISALLOW 変数を追加します。次に例を示します。

   ROBOTS_DISALLOW: true

2. Red Hat Quay デプロイメントを再起動します。

検証: 新しいロボットアカウントの作成

1. Red Hat Quay リポジトリーに移動します。
2. リポジトリーの名前をクリックします。
3. ナビゲーションウィンドウで、Robot Accounts をクリックします。
4. Create Robot Account をクリックします。
5. ロボットアカウントの名前を入力します (例: <organization-name/username>+<robot-name>)。
6. Create robot account をクリックして作成を確定します。次のメッセージが表示されます。Cannot create robot account.Robot accounts have been disabled.Please contact your administrator.

検証: ロボットアカウントへのログイン

1. コマンドラインインターフェイス (CLI) で、次のコマンドを入力してロボットアカウントの 1 つとしてログインを試みます。

   $ podman login -u="<organization-name/username>+<robot-name>" -p="KETJ6VN0WT8YLLNXUJJ4454ZI6TZJ98NV41OE02PC2IQXVXRFQ1EJ36V12345678" <quay-server.example.com>

   次のエラーメッセージが返されます。

   Error: logging into "<quay-server.example.com>": invalid username/password

2. log-level=debug フラグを渡すと、ロボットアカウントが無効化されたことを確認できます。

   $ podman login -u="<organization-name/username>+<robot-name>" -p="KETJ6VN0WT8YLLNXUJJ4454ZI6TZJ98NV41OE02PC2IQXVXRFQ1EJ36V12345678" --log-level=debug <quay-server.example.com>

   ...
   DEBU[0000] error logging into "quay-server.example.com": unable to retrieve auth token: invalid username/password: unauthorized: Robot accounts have been disabled. Please contact your administrator.

手順

1. Red Hat Quay レジストリーにログインします。
2. ロボットアカウントがある組織の名前をクリックします。
3. Robot accounts をクリックします。
4. 削除するロボットアカウントのボックスをチェックします。
5. 縦の省略記号メニューをクリックします。
6. Delete をクリックします。
7. テキストボックスに confirm と入力し、Delete をクリックします。

手順

1. 次のコマンドを入力し、DELETE /api/v1/organization/{orgname}/robots/{robot_shortname} エンドポイントを使用して組織のロボットアカウントを削除します。

   curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"

2. API を使用してロボットアカウントを削除する場合、CLI は情報を返しません。削除を確認するには、Red Hat Quay UI を確認するか、次の GET /api/v1/organization/{orgname}/robots コマンドを入力して、ロボットアカウントの詳細が返されるかどうかを確認します。

   $ curl -X GET   -H "Authorization: Bearer <bearer_token>"   "https://<quay-server.example.com>/api/v1/organization/<organization_name>/robots"

   出力例

   {"robots": []}

3. 次のコマンドを入力し、DELETE /api/v1/user/robots/{robot_shortname} エンドポイントを使用して現在のユーザーのロボットアカウントを削除します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

4. API を使用して現在のユーザーのロボットアカウントを削除する場合、CLI は情報を返しません。削除を確認するには、Red Hat Quay UI を確認するか、次の GET /api/v1/user/robots/{robot_shortname} コマンドを入力して、ロボットアカウントの詳細が返されるかどうかを確認します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"

   出力例

   {"message":"Could not find robot with specified username"}

手順

1. 組織名をクリックします。
2. Default permissions をクリックします。
3. Create default permissions をクリックします。切り替え式のドロワーが表示されます。

4. リポジトリーの作成時にデフォルトの権限を作成するには、Anyone または Specific user を選択します。

   1. Anyone を選択する場合は、次の情報を入力する必要があります。

      • Applied to。ユーザー/ロボット/チームを検索、招待、または追加します。
      • Permission。権限を Read、Write、または Admin のいずれかに設定します。

   2. Specific user を選択する場合は、次の情報を指定する必要があります。

      • Repository creator。ユーザーまたはロボットアカウントを指定します。
      • Applied to。ユーザー名、ロボットアカウント、またはチーム名を入力します。
      • Permission。権限を Read、Write、または Admin のいずれかに設定します。
5. Create default permission をクリックします。確認ボックスが表示され、Successfully created default permission for creator というアラートが返されます。

手順

1. 次のコマンドを入力し、POST /api/v1/organization/{orgname}/prototypes エンドポイントでデフォルトの権限を作成します。

   $ curl -X POST   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   --data '{
       "role": "<admin_read_or_write>",
       "delegate": {
         "name": "<username>",
         "kind": "user"
       },
       "activating_user": {
         "name": "<robot_name>"
       }
     }'   https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes

   出力例

   {"activating_user": {"name": "test-org+test", "is_robot": true, "kind": "user", "is_org_member": true, "avatar": {"name": "test-org+test", "hash": "aa85264436fe9839e7160bf349100a9b71403a5e9ec684d5b5e9571f6c821370", "color": "#8c564b", "kind": "robot"}}, "delegate": {"name": "testuser", "is_robot": false, "kind": "user", "is_org_member": false, "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}}, "role": "admin", "id": "977dc2bc-bc75-411d-82b3-604e5b79a493"}

2. 次のコマンドを入力し、PUT /api/v1/organization/{orgname}/prototypes/{prototypeid} エンドポイントを使用してデフォルトの権限を更新します。これは権限タイプを変更する場合の例です。ポリシーを作成したときに返された ID を含める必要があります。

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "role": "write"
     }' \
     https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototypeid>

   出力例

   {"activating_user": {"name": "test-org+test", "is_robot": true, "kind": "user", "is_org_member": true, "avatar": {"name": "test-org+test", "hash": "aa85264436fe9839e7160bf349100a9b71403a5e9ec684d5b5e9571f6c821370", "color": "#8c564b", "kind": "robot"}}, "delegate": {"name": "testuser", "is_robot": false, "kind": "user", "is_org_member": false, "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}}, "role": "write", "id": "977dc2bc-bc75-411d-82b3-604e5b79a493"}

3. DELETE /api/v1/organization/{orgname}/prototypes/{prototypeid} コマンドを入力すると、権限を削除できます。

   curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototype_id>

   このコマンドは出力を返しません。GET /api/v1/organization/{orgname}/prototypes コマンドを入力すると、すべての権限のリストを取得できます。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes

   出力例

   {"prototypes": []}

手順

1. Red Hat Quay にログインします。
2. v2 UI で、Repositories をクリックします。
3. リポジトリーの名前をクリックします (例: quayadmin/busybox)。
4. Settings タブをクリックします。

5. オプション: User and robot permissions をクリックします。Permissions のドロップダウンメニューオプションをクリックすると、ユーザーまたはロボットアカウントの設定を調整できます。設定を Read、Write、または Admin に変更できます。

   • Read。ユーザーまたはロボットアカウントが、リポジトリーを表示し、リポジトリーからプルできます。
   • Write。ユーザーまたはロボットアカウントが、リポジトリーからの読み取り (プル) とリポジトリーへの書き込み (プッシュ) を実行できます。
   • Admin。ユーザーアカウントまたはロボットアカウントに、リポジトリーからのプルとリポジトリーへのプッシュのアクセス権に加え、リポジトリーに関連する管理タスクを実行する権限を付与します。

手順

1. ユーザーの権限を変更するには、次の PUT /api/v1/repository/{repository}/permissions/user/{username} コマンドを入力します。

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{"role": "admin"}' \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

   出力例

   {"role": "admin", "name": "quayadmin+test", "is_robot": true, "avatar": {"name": "quayadmin+test", "hash": "ca9afae0a9d3ca322fc8a7a866e8476dd6c98de543decd186ae090e420a88feb", "color": "#8c564b", "kind": "robot"}}

2. 現在の権限を削除するには、DELETE /api/v1/repository/{repository}/permissions/user/{username} コマンドを入力します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>

   このコマンドは CLI に出力を返しません。GET /api/v1/repository/{repository}/permissions/user/ コマンドを入力すると、権限が削除されたことを確認できます。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/

   出力例

   {"message":"User does not have permission for repo."}

手順

1. v2 UI で、Repositories をクリックします。
2. リポジトリーの名前をクリックします。

3. タグの名前をクリックします。そのタグの Details ページに移動します。このページには、次の情報が表示されます。

   • 名前
   • リポジトリー
   • Digest
   • 脆弱性
   • 作成
   • 修正済み
   • Size
   • ラベル
   • イメージタグの取得方法
4. Security Report をクリックして、タグの脆弱性を表示します。アドバイザリーの列を拡張して、CVE データを開くことができます。
5. Packages をクリックして、タグのパッケージを表示します。
6. リポジトリーの名前をクリックし、Tags ページに戻ります。

手順

1. タグ情報を取得するために、GET /api/v1/repository/{repository} API エンドポイントを使用し、includeTags パラメーターを渡す必要があります。以下に例を示します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>?includeTags=true

   出力例

   {"namespace": "quayadmin", "name": "busybox", "kind": "image", "description": null, "is_public": false, "is_organization": false, "is_starred": false, "status_token": "d8f5e074-690a-46d7-83c8-8d4e3d3d0715", "trust_enabled": false, "tag_expiration_s": 1209600, "is_free_account": true, "state": "NORMAL", "tags": {"example": {"name": "example", "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000", "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d"}, "test": {"name": "test", "size": 2275314, "last_modified": "Tue, 14 May 2024 14:04:48 -0000", "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d"}}, "can_write": true, "can_admin": true}

2. または、GET /api/v1/repository/{repository}/tag/ エンドポイントを使用することもできます。以下に例を示します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/

   出力例

   {"tags": [{"name": "test-two", "reversion": true, "start_ts": 1718737153, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 18 Jun 2024 18:59:13 -0000"}, {"name": "test-two", "reversion": false, "start_ts": 1718737029, "end_ts": 1718737153, "manifest_digest": "sha256:0cd3dd6236e246b349e63f76ce5f150e7cd5dbf2f2f1f88dbd734430418dbaea", "is_manifest_list": false, "size": 2275317, "last_modified": "Tue, 18 Jun 2024 18:57:09 -0000", "expiration": "Tue, 18 Jun 2024 18:59:13 -0000"}, {"name": "test-two", "reversion": false, "start_ts": 1718737018, "end_ts": 1718737029, "manifest_digest": "sha256:0cd3dd6236e246b349e63f76ce5f150e7cd5dbf2f2f1f88dbd734430418dbaea", "is_manifest_list": false, "size": 2275317, "last_modified": "Tue, 18 Jun 2024 18:56:58 -0000", "expiration": "Tue, 18 Jun 2024 18:57:09 -0000"}, {"name": "sample_tag", "reversion": false, "start_ts": 1718736147, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 18 Jun 2024 18:42:27 -0000"}, {"name": "test-two", "reversion": false, "start_ts": 1717680780, "end_ts": 1718737018, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Thu, 06 Jun 2024 13:33:00 -0000", "expiration": "Tue, 18 Jun 2024 18:56:58 -0000"}, {"name": "tag-test", "reversion": false, "start_ts": 1717680378, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Thu, 06 Jun 2024 13:26:18 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000"}], "page": 1, "has_additional": false}

手順

1. Red Hat Quay v2 UI ダッシュボードのナビゲーションペインで Repositories をクリックします。
2. イメージタグのあるリポジトリーの名前をクリックします。
3. 縦の省略記号メニューをクリックし、Add new tag をクリックします。

4. タグの名前を入力し、Create tag をクリックします。

   新しいタグが Repository Tags ページにリストされます。

手順

1. PUT /api/v1/repository/{repository}/tag/{tag} コマンドを使用すると、タグが参照するイメージを変更するか、新しいタグを作成できます。

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "manifest_digest": "<manifest_digest>"
     }' \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/<tag>

   出力例

   "Updated"

2. POST /api/v1/repository/{repository}/tag/{tag}/restore コマンドを使用すると、リポジトリータグを以前のイメージに復元できます。以下に例を示します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "manifest_digest": <manifest_digest>
     }' \
     quay-server.example.com/api/v1/repository/quayadmin/busybox/tag/test/restore

   出力例

   {}

3. 新しいタグを作成した後にタグのリストを表示するには、GET /api/v1/repository/{repository}/tag/ コマンドを使用します。以下に例を示します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
      https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag

   出力例

   {"tags": [{"name": "test", "reversion": false, "start_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715697708, "end_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:41:48 -0000", "expiration": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715695488, "end_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:04:48 -0000", "expiration": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715631517, "end_ts": 1715695488, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Mon, 13 May 2024 20:18:37 -0000", "expiration": "Tue, 14 May 2024 14:04:48 -0000"}], "page": 1, "has_additional": false}

手順

1. v2 UI ダッシュボードのナビゲーションペインで Repositories をクリックします。
2. イメージタグのあるリポジトリーの名前をクリックします。
3. イメージの縦の省略記号メニューをクリックし、Edit labels を選択します。
4. Edit labels ウィンドウで、Add new label をクリックします。

5. key=value 形式を使用してイメージタグのラベルを入力します (例: com.example.release-date=2023-11-14)。

   注記

   key=value 形式の使用に失敗すると、Invalid label format, must be key value separated by = というエラーが返されます。

6. 空白のボックスをクリックしてラベルを追加します。
7. オプション: 2 番目のラベルを追加します。
8. Save labels をクリックして、ラベルをイメージタグに保存します。Created labels successfully という通知が返されます。
9. オプション: 同じイメージタグの縦の省略記号メニュー→ Edit labels → ラベルの X をクリックして削除します。または、テキストを編集することもできます。Save labels をクリックします。これでラベルが削除または編集されました。

手順

1. リポジトリー内にある特定のマニフェストの詳細を取得するには、GET /api/v1/repository/{repository}/manifest/{manifestref} コマンドを使用します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>

2. 特定のマニフェストのラベルのリストを取得するには、GET /api/v1/repository/{repository}/manifest/{manifestref}/labels コマンドを使用します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels

   出力例

   {"labels": [{"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}, {"id": "2d34ec64-4051-43ad-ae06-d5f81003576a", "key": "org.opencontainers.image.version", "value": "1.36.1-glibc", "source_type": "manifest", "media_type": "text/plain"}]}

3. 特定のマニフェストに関する情報を取得するには、GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid} コマンドを使用します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<label_id>

   出力例

   {"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}

4. 特定のリポジトリー内のマニフェストに追加のラベルを追加するには、POST /api/v1/repository/{repository}/manifest/{manifestref}/labels コマンドを使用します。以下に例を示します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "key": "<key>",
       "value": "<value>",
       "media_type": "<media_type>"
     }' \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels

   出力例

   {"label": {"id": "346593fd-18c8-49db-854f-4cb1fb76ff9c", "key": "example-key", "value": "example-value", "source_type": "api", "media_type": "text/plain"}}

5. DELETE/api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid} コマンドを使用してラベルを削除できます。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<labelid>

   このコマンドは CLI に出力を返しません。上記のコマンドのいずれかを使用して、正常に削除されたことを確認できます。

手順

1. リポジトリーの Tags ページに移動します。
2. Manifest で、Fetch Tag アイコンをクリックします。

3. ポップアップボックスが表示され、次のオプションが表示されます。

   • Podman Pull (by tag)
   • Docker Pull (by tag)
   • Podman Pull (by digest)

   • Docker Pull (by digest)

     4 つのオプションのいずれかを選択すると、イメージのプルに使用できる各クライアント用のコマンドが返されます。

4. Copy Command をクリックしてコマンドをコピーします。このコマンドはコマンドラインインターフェイス (CLI) で使用できます。以下に例を示します。

   $ podman pull quay-server.example.com/quayadmin/busybox:test2

手順

1. Red Hat Quay v2 UI ダッシュボードのナビゲーションペインで Repositories をクリックします。
2. イメージタグのあるリポジトリーの名前をクリックします。

3. Tag History をクリックします。このページでは、次の操作を実行できます。

   • タグ名での検索
   • 日付範囲の選択
   • タグの変更の表示
   • タグの変更日と変更時刻の表示

手順

1. 次のコマンドを入力し、GET /api/v1/repository/{repository}/tag/ コマンドを使用して次のいずれかのクエリーを渡して、タグ履歴を表示します。

   • onlyActiveTags=<true/false>: アクティブなタグだけに対象を絞り込みます。
   • page=<number>: 取得する結果のページ番号を指定します。
   • limit=<number>: ページあたりの結果数を制限します。

   • specificTag=<tag_name>: 対象とするタグを、指定した名前のタグだけに絞り込みます。

     $ curl -X GET \
       -H "Authorization: Bearer <bearer_token>" \
       -H "Accept: application/json" \
       "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/tag/?onlyActiveTags=true&page=1&limit=10"

     出力例

     {"tags": [{"name": "test-two", "reversion": false, "start_ts": 1717680780, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Thu, 06 Jun 2024 13:33:00 -0000"}, {"name": "tag-test", "reversion": false, "start_ts": 1717680378, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Thu, 06 Jun 2024 13:26:18 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000"}], "page": 1, "has_additional": false}

2. specificTag=<tag_name> クエリーを使用すると、特定のタグだけに結果を絞り込むことができます。以下に例を示します。

   $ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/repository/quayadmin/busybox/tag/?onlyActiveTags=true&page=1&limit=20&specificTag=test-two"

   出力例

   {"tags": [{"name": "test-two", "reversion": true, "start_ts": 1718737153, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 18 Jun 2024 18:59:13 -0000"}], "page": 1, "has_additional": false}

手順

1. v2 UI の Repositories ページで、削除するイメージの名前 (quay/admin/busybox など) をクリックします。
2. More Actions ドロップダウンメニューをクリックします。

3. Delete をクリックします。

   注記

   必要に応じて、Make Public または Make Private をクリックできます。

4. ボックスに confirm と入力してから、Delete をクリックします。

5. 削除後、Repositories ページに戻ります。

   注記

   イメージタグの削除は、タイムマシン 機能に割り当てられている時間に基づいて元に戻すことができます。詳細は、「タグの変更を元に戻す」を参照してください。

手順

1. DELETE /api/v1/repository/{repository}/tag/{tag} コマンドを使用すると、イメージタグを削除できます。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag/<tag>

   このコマンドは CLI に出力を返しません。タグのリストを返すには、次のステップに進みます。

2. タグを削除した後にタグのリストを表示するには、GET /api/v1/repository/{repository}/tag/ コマンドを使用します。以下に例を示します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
      https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag

   出力例

   {"tags": [{"name": "test", "reversion": false, "start_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715697708, "end_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:41:48 -0000", "expiration": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715695488, "end_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:04:48 -0000", "expiration": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715631517, "end_ts": 1715695488, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Mon, 13 May 2024 20:18:37 -0000", "expiration": "Tue, 14 May 2024 14:04:48 -0000"}], "page": 1, "has_additional": false}

手順

1. v2 UI の Repositories ページで、元に戻すイメージの名前をクリックします。
2. Tag History タブをクリックします。
3. タイムライン内でイメージタグが変更または削除された時点を見つけます。次に、Revert の下のオプションをクリックして、タグをイメージに戻します。

手順

1. POST /api/v1/repository/{repository}/tag/{tag}/restore コマンドを使用すると、リポジトリータグを以前のイメージに復元できます。以下に例を示します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "manifest_digest": <manifest_digest>
     }' \
     quay-server.example.com/api/v1/repository/quayadmin/busybox/tag/test/restore

   出力例

   {}

2. 古いタグを復元した後にタグのリストを表示するには、GET /api/v1/repository/{repository}/tag/ コマンドを使用します。以下に例を示します。

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
      https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/tag

   出力例

   {"tags": [{"name": "test", "reversion": false, "start_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "example", "reversion": false, "start_ts": 1715697708, "end_ts": 1715698131, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:41:48 -0000", "expiration": "Tue, 14 May 2024 14:48:51 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715695488, "end_ts": 1716324069, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Tue, 14 May 2024 14:04:48 -0000", "expiration": "Tue, 21 May 2024 20:41:09 -0000"}, {"name": "test", "reversion": false, "start_ts": 1715631517, "end_ts": 1715695488, "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d", "is_manifest_list": false, "size": 2275314, "last_modified": "Mon, 13 May 2024 20:18:37 -0000", "expiration": "Tue, 14 May 2024 14:04:48 -0000"}], "page": 1, "has_additional": false}

手順

1. Red Hat Quay レジストリーにログインします。
2. 自分が管理者である組織、リポジトリーまたは名前空間に移動します。

3. Logs をクリックします。

   

4. オプション: From ボックスと To ボックスに日付を追加して、ログエントリーを表示する日付範囲を設定します。
5. オプション: Export をクリックして、ログをエクスポートします。http:// またはhttps:// で始まるメールアドレスまたは有効なコールバック URL を入力する必要があります。このプロセスは、ログの数に応じて 1 時間かかる場合があります。

手順

1. 管理者権限のあるリポジトリーを選択します。
2. Logs タブをクリックします。
3. オプション: 特定の日付を指定する場合は、From ボックスと to ボックスに範囲を入力します。

4. Export Logs ボタンをクリックします。以下のような Export Usage Logs のポップアップが表示されます。

   

5. エクスポートされたログを受信するメールアドレスまたはコールバック URL を入力します。コールバック URL には、指定ドメインへの URL (例: <webhook.site>) を使用できます。
6. Confirm を選択して、選択したログエントリーを収集するプロセスを開始します。収集されるログデータの量に応じて、これが完了するまでに数分から数時間かかる場合があります。

7. ログのエクスポートが完了すると、次の 2 つのイベントのいずれかが発生します。

   • 要求したエクスポート済みログエントリーが利用可能であることを通知するメールが受信されます。
   • Webhook URL からのログエクスポート要求の成功ステータスが返されます。さらに、エクスポートされたデータへのリンクを使用して、ログをダウンロードできるようになります。

手順

1. 現在のユーザーのログをエクスポートするには、POST /api/v1/user/exportlogs エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "<MM/DD/YYYY>",
           "endtime": "<MM/DD/YYYY>",
           "callback_email": "your.email@example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/user/exportlogs"

   出力例

   {"export_id": "6a0b9ea9-444c-4a19-9db8-113201c38cd4"}

2. 組織のログをエクスポートするには、POST /api/v1/organization/{orgname}/exportlogs エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "<MM/DD/YYYY>",
           "endtime": "<MM/DD/YYYY>",
           "callback_email": "org.logs@example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/organization/{orgname}/exportlogs"

3. リポジトリーのログをエクスポートするには、POST /api/v1/repository/{repository}/exportlogs エンドポイントを使用します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "2024-01-01",
           "endtime": "2024-06-18",
           "callback_url": "http://your-callback-url.example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/repository/{repository}/exportlogs"

手順

1. リポジトリーに移動し、ナビゲーションペインで Tags をクリックします。このページに、セキュリティースキャンの結果が表示されます。
2. マルチアーキテクチャーイメージに関する詳細情報を表示するには、See Child Manifests をクリックして、展開されたビューでマニフェストのリストを確認します。
3. See Child Manifests の下の関連リンクをクリックします。たとえば、1 Unknown をクリックすると、Security Scanner ページにリダイレクトされます。
4. Security Scanner ページには、イメージがどの CVE の影響を受けるか、利用可能な修復オプションなど、タグに関する情報が表示されます。

手順

1. Red Hat Quay のリポジトリーに移動します。
2. ナビゲーションペインで、Settings をクリックします。
3. Events and Notifications カテゴリーで、Create Notification をクリックして、リポジトリーイベントの新しい通知を追加します。Create notification ポップアップボックスが表示されます。

4. Create repository ポップアップボックスで、When this event occurs ボックスをクリックしてイベントを選択します。次のタイプのイベントの通知を選択できます。

   • リポジトリーへのプッシュ
   • イメージビルドの失敗
   • イメージビルドのキューへの追加
   • イメージビルドの開始
   • イメージビルドの成功
   • イメージビルドのキャンセル
   • イメージの有効期限トリガー

5. イベントの種類を選択したら、通知方法を選択します。次の方法を使用できます。

   • Quay 通知
   • メール通知
   • Webhook POST
   • Flowdock チーム通知
   • HipChat ルーム通知

   • Slack 通知

     選択した方法に応じて、追加情報を入力する必要があります。たとえば、E-mail を選択した場合は、メールアドレスと通知タイトル (省略可能) を入力する必要があります。

6. イベントと通知方法を選択したら、Create Notification をクリックします。

手順

1. 次の POST /api/v1/repository/{repository}/notification コマンドを入力し、リポジトリーに関する通知を作成します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "event": "<event>",
       "method": "<method>",
       "config": {
         "<config_key>": "<config_value>"
       },
       "eventConfig": {
         "<eventConfig_key>": "<eventConfig_value>"
       }
     }' \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/

   このコマンドは CLI に出力を返しません。次の GET /api/v1/repository/{repository}/notification/{uuid} コマンドを入力すると、リポジトリー通知に関する情報を取得できます。

   {"uuid": "240662ea-597b-499d-98bb-2b57e73408d6", "title": null, "event": "repo_push", "method": "quay_notification", "config": {"target": {"name": "quayadmin", "kind": "user", "is_robot": false, "avatar": {"name": "quayadmin", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}}}, "event_config": {}, "number_of_failures": 0}

2. 次の POST /api/v1/repository/{repository}/notification/{uuid}/test コマンドを入力すると、リポジトリー通知をテストできます。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

   出力例

   {}

3. 次の POST /api/v1/repository/{repository}/notification/{uuid} コマンドを入力すると、リポジトリー通知の失敗を 0 にリセットできます。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

4. リポジトリー通知を削除するには、次の DELETE /api/v1/repository/{repository}/notification/{uuid} コマンドを入力します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/<uuid>

   このコマンドは CLI に出力を返しません。次の GET /api/v1/repository/{repository}/notification/ コマンドを入力すると、すべての通知のリストを取得できます。

   $ curl -X GET  -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification

   出力例

   {"notifications": []}

手順

1. UI の Quay 組織 (たとえば cache-quayio) で、左側のペインの Organization Settings をクリックします。

2. オプション: Add Storage Quota をクリックして、組織のクォータ管理を設定します。クォータ管理の詳細は、クォータ管理 を参照してください。

   注記

   場合によっては、Podman を使用してイメージをプルすると、プル中にクォータ制限に達したときに unable to pull image: Error parsing image configuration: Error fetching blob: invalid status code from registry 403 (Forbidden) エラーが返されることがあります。エラー 403 は不正確であり、Podman が正しい API エラー Quota has been exceeded on namespace を非表示にしているために発生します。この既知の問題は、将来の Podman 更新で修正される予定です。

3. Remote Registry に、キャッシュするリモートレジストリーの名前 (quay.io など) を入力し、Save をクリックします。

   注記

   Remote Registry に名前空間 (たとえば quay.io/<namespace>) を追加すると、組織内のユーザーはその名前空間からのみプロキシーできるようになります。

4. オプション: Remote Registry Username および Remote Registry Password を追加します。

   注記

   Remote Registry Username および Remote Registry Password を設定しない場合は、プロキシーキャッシュを削除して新しいレジストリーを作成しない限り、パスワードを追加できません。

5. オプション: Expiration フィールドに時間を設定します。

   注記
   • プロキシー組織でキャッシュされたイメージのデフォルトのタグ Expiration フィールドは 86400 秒に設定されています。プロキシー組織では、タグがプルされるたびに、タグの有効期限が UI の Expiration フィールドに設定された値に更新されます。この機能は、Quay のデフォルトの 個別タグ有効期限 機能とは異なります。プロキシー組織では、個々のタグ機能をオーバーライドできます。これが発生すると、プロキシー組織の Expiration フィールドに従って、個々のタグの有効期限がリセットされます。
   • 期限切れのイメージは、割り当てられた時間が経過すると消えますが、Quay に保存されます。イメージが完全に削除されるタイミング、またはコレクションされるタイミングは、組織の Time Machine の設定によって異なります。特に指定がない限り、ガベージコレクションのデフォルトの時間は 14 日です。
6. Save をクリックします。

7. CLI で、プロキシーキャッシュとして機能するパブリックイメージ (quay.io など) をレジストリーからプルします。

   $ podman pull <registry_url>/<organization_name>/<quayio_namespace>/<image_name>

   重要

   組織がリモートレジストリー内の単一の名前空間からプルするように設定されている場合は、リモートレジストリーの名前空間を URL から省略する必要があります。たとえば、podman pull <registry_url>/<organization_name>/<image_name> です。

手順

1. メインページで、Organization を選択します。
2. ナビゲーションペインで、Applications を選択します。
3. Create New Application をクリックし、新しいアプリケーション名を入力して、Enter を押します。
4. OAuth Applications ページで、アプリケーションの名前を選択します。

5. オプション: 以下の情報を入力します。

   1. Application Name
   2. Homepage URL
   3. Description
   4. Avatar E-mail
   5. Redirect/Callback URL prefix
6. ナビゲーションペインで、Generate Token を選択します。

7. 次のオプションのチェックボックスをオンにします。

   1. Administer Organization
   2. Administer Repositories
   3. Create Repositories
   4. View all visible repositories
   5. Read/Write to any accessible repositories
   6. Super User Access
   7. Administer User
   8. Read User Information
8. Generate Access Token をクリックします。新しいページにリダイレクトされます。
9. 許可する権限を確認し、Authorize Application をクリックします。Authorize Application をクリックして決定した内容を確定します。

10. Access Token ページにリダイレクトされます。アクセストークンをコピーして保存します。

    重要

    これは、アクセストークンをコピーして保存する唯一の機会です。このページを離れると再取得できません。

手順

1. config.yaml ファイルを更新して、FEATURE_REFERRERS_API: true フィールドを含めます。以下に例を示します。

   # ...
   FEATURE_REFERRERS_API: true
   # ...

2. 次のコマンドを入力し、認証情報を Base64 でエンコードします。

   $ echo -n '<username>:<password>' | base64

   出力例

   abcdeWFkbWluOjE5ODlraWROZXQxIQ==

3. 次のコマンドを入力して、base64 でエンコードされた文字列を使用し、URL エンドポイントを Red Hat Quay サーバーに変更します。

   $ curl --location '<quay-server.example.com>/v2/auth?service=<quay-server.example.com>&scope=repository:quay/listocireferrs:pull,push' --header 'Authorization: Basic <base64_username:password_encode_token>' -k | jq

   出力例

   {
     "token": "<example_secret>
   }

手順

1. オプション: まだ更新していない場合は、Red Hat Quay config.yaml ファイルを更新して、FEATURE_ASSIGN_OAUTH_TOKEN: true フィールドを含めます。

   # ...
   FEATURE_ASSIGN_OAUTH_TOKEN: true
   # ...

2. オプション: Red Hat Quay レジストリーを再起動します。
3. 組織管理者として Red Hat Quay レジストリーにログインします。
4. OAuth トークンを作成した組織の名前をクリックします。
5. ナビゲーションペインで、Applications をクリックします。
6. 適切なアプリケーション名をクリックします。
7. ナビゲーションペインで、Generate Token をクリックします。
8. Assign another user をクリックし、OAuth トークンを引き継ぐユーザーの名前を入力します。

9. 新しいユーザーに付与する必要な権限のボックスをオンにします。たとえば、新しいユーザーにリポジトリーの作成のみを許可する場合は、Create Repositories クリックします。

   重要

   権限の制御は、組織内のチームロールによって定義され、ここで選択したオプションに関係なく設定する必要があります。たとえば、OAuth トークンを割り当てるユーザーは、管理 API エンドポイントを使用するために Admin チームロールを持っている必要があります。

   Super User Access ボックスをオンにしただけでは、この権限がユーザーに実際に付与されるわけではありません。config.yaml ファイルでスーパーユーザーを設定する必要があり、かつ ここでボックスをオンにする必要があります。

10. Assign token をクリックします。ポップアップボックスに、認可を確認する次のメッセージと、承認される権限が表示されます。

    This will prompt user <username> to generate a token with the following permissions:
    repo:create

11. ポップアップボックスで Assign token をクリックします。新しいページにリダイレクトされ、次のメッセージが表示されます。

    Token assigned successfully

検証

1. OAuth トークンを再割り当てした後、割り当てられたユーザーがトークンを受け入れて、API エンドポイントの使用に必要なベアラートークンを受け取る必要があります。割り当てられたユーザーに、Red Hat Quay レジストリーにログインするよう依頼します。
2. ユーザーは、ログインしたら、Users and Organizations の下にある自分のユーザー名をクリックする必要があります。
3. ナビゲーションペインで、External Logins And Applications をクリックする必要があります。
4. Authorized Applications の下で、Authorize Application をクリックしてアプリケーションを確認する必要があります。新しいページに移動し、Authorize Application をクリックして再確認する必要があります。
5. ユーザーは、ベアラートークンが表示される新しいページにリダイレクトされます。このベアラートークンは再度表示することはできないため、保存する必要があります。

手順

1. 次のコマンドを入力して、チャートリポジトリーを追加します。

   $ helm repo add redhat-cop https://redhat-cop.github.io/helm-charts

2. 次のコマンドを入力して、チャートリポジトリーから、ローカルで使用可能なチャートの情報を更新します。

   $ helm repo update

3. 次のコマンドを入力して、リポジトリーからチャートを取得します。

   $ helm pull redhat-cop/etherpad --version=0.0.4 --untar

4. 次のコマンドを入力して、チャートをチャートアーカイブにパッケージ化します。

   $ helm package ./etherpad

   出力例

   Successfully packaged chart and saved it to: /home/user/linux-amd64/etherpad-0.0.4.tgz

5. helm registry login を使用して Red Hat Quay にログインします。

   $ helm registry login quay370.apps.quayperf370.perfscale.devcluster.openshift.com

6. helm push コマンドを使用して、チャートをリポジトリーにプッシュします。

   $ helm push etherpad-0.0.4.tgz oci://quay370.apps.quayperf370.perfscale.devcluster.openshift.com

   出力例:

   Pushed: quay370.apps.quayperf370.perfscale.devcluster.openshift.com/etherpad:0.0.4
   Digest: sha256:a6667ff2a0e2bd7aa4813db9ac854b5124ff1c458d170b70c2d2375325f2451b

7. ローカルコピーを削除してから、リポジトリーからチャートをプルして、プッシュが機能したことを確認します。

   $ rm -rf etherpad-0.0.4.tgz

   $ helm pull oci://quay370.apps.quayperf370.perfscale.devcluster.openshift.com/etherpad --version 0.0.4

   出力例:

   Pulled: quay370.apps.quayperf370.perfscale.devcluster.openshift.com/etherpad:0.0.4
   Digest: sha256:4f627399685880daf30cf77b6026dc129034d68c7676c7e07020b70cf7130902

検証

1. oras でイメージをプルします。以下に例を示します。

   $ oras pull quay.io/<organization_name>/<repository>/<image_name>:<tag>

2. oras を使用して変更を検査します。以下に例を示します。

   $ oras manifest fetch quay.io/<organization_name>/<repository>/<image_name>:<tag>

   出力例

   {"schemaVersion":2,"mediaType":"application/vnd.oci.image.manifest.v1+json","artifactType":"application/vnd.unknown.artifact.v1","config":{"mediaType":"application/vnd.oci.empty.v1+json","digest":"sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a","size":2,"data":"e30="},"layers":[{"mediaType":"application/vnd.oci.empty.v1+json","digest":"sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a","size":2,"data":"e30="}],"annotations":{"org.opencontainers.image.created":"2024-07-11T15:22:42Z","version ":" 8.11"}}

手順

1. 次のコマンドを入力して、OCI メディアアーティファクトにタグを付けます。

   $ podman tag <myartifact_image> <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag>

2. アーティファクトを Red Hat Quay レジストリーにプッシュします。以下に例を示します。

   $ podman push <myartifact_image> <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag>

3. oras で OCI 1.1 リファラーの API スキーマを使用してマニフェストを割り当てるには、次のコマンドを入力します。

   $ oras attach --artifact-type <MIME_type> --distribution-spec v1.1-referrers-api <myartifact_image> \
   <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag> \
   <example_file>.txt

   出力例

   -spec v1.1-referrers-api quay.io/testorg3/myartifact-image:v1.0 hi.txt
   ✓ Exists    hi.txt                                                               3/3  B 100.00%     0s
     └─ sha256:98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4
   ✓ Exists    application/vnd.oci.empty.v1+json                                    2/2  B 100.00%     0s
     └─ sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a
   ✓ Uploaded  application/vnd.oci.image.manifest.v1+json                       723/723  B 100.00%  677ms
     └─ sha256:31c38e6adcc59a3cfbd2ef971792aaf124cbde8118e25133e9f9c9c4cd1d00c6
   Attached to [registry] quay.io/testorg3/myartifact-image@sha256:db440c57edfad40c682f9186ab1c1075707ce7a6fdda24a89cb8c10eaad424da
   Digest: sha256:31c38e6adcc59a3cfbd2ef971792aaf124cbde8118e25133e9f9c9c4cd1d00c6

4. OCI 1.1 リファラーの tag スキーマを使用してマニフェストを割り当てるには、次のコマンドを入力します。

   $ oras attach --artifact-type <MIME_type> --distribution-spec v1.1-referrers-tag \
   <myartifact_image> <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag> \
   <example_file>.txt

   出力例

   ✓ Exists    hi.txt                                                             3/3  B 100.00%     0s
     └─ sha256:98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4
   ✓ Exists    application/vnd.oci.empty.v1+json                                  2/2  B 100.00%     0s
     └─ sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a
   ✓ Uploaded  application/vnd.oci.image.manifest.v1+json                     723/723  B 100.00%  465ms
     └─ sha256:2d4b54201c8b134711ab051389f5ba24c75c2e6b0f0ff157fce8ffdfe104f383
   Attached to [registry] quay.io/testorg3/myartifact-image@sha256:db440c57edfad40c682f9186ab1c1075707ce7a6fdda24a89cb8c10eaad424da
   Digest: sha256:2d4b54201c8b134711ab051389f5ba24c75c2e6b0f0ff157fce8ffdfe104f383

5. tag スキーマを使用してアーティファクトのリファラーを検出するには、次のコマンドを入力します。

   $ oras discover --insecure --distribution-spec v1.1-referrers-tag \
   <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag>

   出力例

   quay.io/testorg3/myartifact-image@sha256:db440c57edfad40c682f9186ab1c1075707ce7a6fdda24a89cb8c10eaad424da
   └── doc/example
       └── sha256:2d4b54201c8b134711ab051389f5ba24c75c2e6b0f0ff157fce8ffdfe104f383

6. API スキーマを使用してアーティファクトのリファラーを検出するには、次のコマンドを入力します。

   $ oras discover --distribution-spec v1.1-referrers-api \
   <quay-server.example.com>/<organization_name>/<repository>/<image_name>:<tag>

   出力例

   Discovered 3 artifacts referencing v1.0
   Digest: sha256:db440c57edfad40c682f9186ab1c1075707ce7a6fdda24a89cb8c10eaad424da
   
   Artifact Type   Digest
                   sha256:2d4b54201c8b134711ab051389f5ba24c75c2e6b0f0ff157fce8ffdfe104f383
                   sha256:22b7e167793808f83db66f7d35fbe0088b34560f34f8ead36019a4cc48fd346b
                   sha256:bb2b7e7c3a58fd9ba60349473b3a746f9fe78995a88cb329fc2fd1fd892ea4e4

7. 任意。/v2/<organization_name>/<repository_name>/referrers/<sha256_digest> エンドポイントを使用してリファラーを検出することもできます。これを機能させるには、v2 API トークンを生成し、config.yaml ファイルで FEATURE_REFERRERS_API: true を設定する必要があります。

   1. config.yaml ファイルを更新して、FEATURE_REFERRERS_API フィールドを含めます。以下に例を示します。

      # ...
      FEATURE_REFERRERS_API: true
      # ...

   2. 次のコマンドを入力し、認証情報を Base64 でエンコードします。

      $ echo -n '<username>:<password>' | base64

      出力例

      abcdeWFkbWluOjE5ODlraWROZXQxIQ==

   3. 次のコマンドを入力して、base64 でエンコードされたトークンを使用し、URL エンドポイントを Red Hat Quay サーバーに変更します。

      $ curl --location '<quay-server.example.com>/v2/auth?service=<quay-server.example.com>&scope=repository:quay/listocireferrs:pull,push' --header 'Authorization: Basic <base64_username:password_encode_token>' -k | jq

      出力例

      {
        "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ijl5RWNtWmdiZ0l6czBBZW16emhTMHM1R0g2RDJnV2JGUTdUNGZYand4MlUiLCJ0eXAiOiJKV1QifQ..."
      }

8. リポジトリー配下のマニフェストの OCI リファラーをリスト表示するには、v2 API トークンを使用して次のコマンドを入力します。

   $ GET https://<quay-server.example.com>/v2/<organization_name>/<repository_name>/referrers/sha256:0de63ba2d98ab328218a1b6373def69ec0d0e7535866f50589111285f2bf3fb8
   --header 'Authorization: Bearer <v2_bearer_token> -k | jq

   出力例

   {
     "schemaVersion": 2,
     "mediaType": "application/vnd.oci.image.index.v1+json",
     "manifests": [
       {
         "mediaType": "application/vnd.oci.image.manifest.v1+json",
         "digest": "sha256:2d4b54201c8b134711ab051389f5ba24c75c2e6b0f0ff157fce8ffdfe104f383",
         "size": 793
       },
     ]
   }