From 97c985a7f47d25df338b0b44a9cfe5a2d8d28765 Mon Sep 17 00:00:00 2001
From: Fabian Kammel <fabian@kammel.dev>
Date: Mon, 15 Aug 2022 11:09:10 +0200
Subject: [PATCH] provide commands for all new image schemas (#363)

* provide commands for all new image schemas
Signed-off-by: Fabian Kammel <fk@edgeless.systems>
---
 .github/docs/README.md | 20 ++++++++++----------
 debugd/README.md       | 29 ++---------------------------
 2 files changed, 12 insertions(+), 37 deletions(-)

diff --git a/.github/docs/README.md b/.github/docs/README.md
index 09e7f60a8..00ec422e3 100644
--- a/.github/docs/README.md
+++ b/.github/docs/README.md
@@ -112,11 +112,11 @@ Debug | constellation-debug-v\<major\>-\<minor\>-\<patch\> | constellation-\<com
 Branch | constellation-\<branch-name\> | constellation-\<commit-timestamp\>
 
 Example:
-Type | Image Family | Image Name
--|-|-
-Release | constellation | constellation-v1-5-0
-Debug | constellation-v1-5-0 | constellation-20220912123456
-Branch | constellation-ref-cli | constellation-20220912123456
+Type | Image Family | Image Name | List command
+-|-|-|-
+Release | constellation | constellation-v1-5-0 | `gcloud compute images list --filter="family~'^constellation$'" --sort-by=creationTimestamp --project constellation-images`
+Debug | constellation-debug-v1-5-0 | constellation-20220912123456 | `gcloud compute images list --filter="family~'constellation-debug-v.+'" --sort-by=creationTimestamp --project constellation-images`
+Branch | constellation-ref-cli | constellation-20220912123456 | `gcloud compute images list --filter="family~'constellation-$(go run $(git rev-parse --show-toplevel)/hack/pseudo-version/pseudo-version.go -print-branch)'" --sort-by=creationTimestamp --project constellation-images`
 
 ### Azure
 
@@ -128,8 +128,8 @@ Branch | Constellation_Testing | \<branch-name\> | \<commit-timestamp\>
 
 Example:
 
-Type | Image Definition | Image Version
--|-|-
-Release | constellation | 1.5.0
-Debug | v1.5.0 | 2022.0912.123456
-Branch | ref-cli | 2022.0912.123456
+Type | Gallery | Image Definition | Image Version | List command
+-|-|-|-|-
+Release | Constellation | constellation | 1.5.0 | `az sig image-version list --resource-group constellation-images --gallery-name Constellation --gallery-image-definition constellation --query "sort_by([], &publishingProfile.publishedDate)[].id" -o table`
+Debug | Constellation_Debug | v1.5.0 | 2022.0912.123456 | `az sig image-version list --resource-group constellation-images --gallery-name Constellation_Debug --gallery-image-definition v1.5.0 --query "sort_by([], &publishingProfile.publishedDate)[].id" -o table`
+Branch | Constellation_Testing | ref-cli | 2022.0912.123456 | `az sig image-version list --resource-group constellation-images --gallery-name Constellation_Testing --gallery-image-definition $(go run $(git rev-parse --show-toplevel)/hack/pseudo-version/pseudo-version.go -print-branch) --query "sort_by([], &publishingProfile.publishedDate)[].id" -o table`
diff --git a/debugd/README.md b/debugd/README.md
index a5d7b891c..f5bc68551 100644
--- a/debugd/README.md
+++ b/debugd/README.md
@@ -64,31 +64,6 @@ With `cdbg` and `yq` installed in your path:
 
 6. Run `constellation init […]` as usual
 
-### debugd GCP image
+### debugd images
 
-For GCP, run the following command to get a list of all constellation debug images, sorted by their creation date:
-
-```shell
-gcloud compute images list --filter="family~'constellation-debug-v.+'" --sort-by=creationTimestamp --project constellation-images --uri | sed 's#https://www.googleapis.com/compute/v1/##'
-```
-
-The images are grouped by the Constellation release they were built for.
-Choose the newest debugd image for your release and copy the full URI.
-
-### debugd Azure Image
-
-Azure debug images are grouped by the Constellation release they were built for.
-To get a list of available releases, run the following:
-
-```shell
-az sig image-definition list --resource-group constellation-images --gallery-name Constellation_Debug --query "[].name"  -o table
-```
-
-Run the following command to get a list of all constellation debugd images for release v1.5.0, sorted by their creation date:
-
-```shell
-RELEASE=v1.5.0
-az sig image-version list --resource-group constellation-images --gallery-name Constellation_Debug --gallery-image-definition ${RELEASE} --query "sort_by([], &publishingProfile.publishedDate)[].id" -o table
-```
-
-Choose the newest debugd image and copy the full URI.
+For a full list of image naming conventions and how to retreive them check [image version documentation](/.github/docs/README.md#image-versions)