ci: registry URLs Fixes (#4411)

* ci: fix release branch CI action * ci: typo * chore: fix CI job * chore: remove XML exclusion * ci: remove xml exclusion * save (cherry picked from commit 1372921)
spectrocloud · Oct 22, 2024 · 4b776a9 · 4b776a9
1 parent 8c70918
commit 4b776a9
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 40 deletions.
diff --git a/.github/workflows/release-preview.yaml b/.github/workflows/release-preview.yaml
@@ -44,14 +44,14 @@ jobs:
       - name: Make Robots.txt
         run: |
           touch static/robots.txt
-          echo "User-agent: *" >> robots.txt
-          echo "Disallow: /" >> robots.txt
-          excho "Sitemap: https://docs-latest.spectrocloud.com/sitemap.xml" >> robots.txt
+          echo "User-agent: *" >> static/robots.txt
+          echo "Disallow: /" >> static/robots.txt
+          echo "Sitemap: https://docs-latest.spectrocloud.com/sitemap.xml" >> static/robots.txt
         
 
       - name: Ensure noIndex is set
         id: check_noindex
-        run: node scripts/noindex_docusaurus_config.js $RUNNER_TEMP $PWD && mv $RUNNER_TEMP/temp.docusaurus.config.js $PWD/docusaurus.config.j
+        run: node scripts/noindex_docusaurus_config.js $PWD
 
 
       - name: Build
@@ -61,7 +61,7 @@ jobs:
 
       - name: Deploy Preview
         run: |
-          aws s3 sync --cache-control 'public, max-age=604800' --exclude '*.html' --exclude '*.xml' --exclude build/scripts/ build/ s3://docs-latest.spectrocloud.com --delete
+          aws s3 sync --cache-control 'public, max-age=604800' --exclude '*.html' --exclude build/scripts/ build/ s3://docs-latest.spectrocloud.com --delete
           aws s3 sync --cache-control 'public, max-age=0, s-maxage=604800' build/ s3://docs-latest.spectrocloud.com --delete
           aws cloudfront create-invalidation --distribution-id ${{ secrets.LATEST_DOCS_DISTRIBUTION_ID }} --paths "/*"
 
@@ -74,4 +74,4 @@ jobs:
           message-failure: |
               👎 Uh oh! The Netlify Preview failed to deploy for commit ${{ github.sha }}. Please check the Netlify logs for more information.
           refresh-message-position: true
-          update-only: true
+          update-only: false
diff --git a/...erprise-version/install-palette/install-on-kubernetes/airgap-install/install.md b/...erprise-version/install-palette/install-on-kubernetes/airgap-install/install.md
@@ -159,7 +159,7 @@ environment. Reach out to our support team if you need assistance.
     Use the following `mirrorRegistries`placeholder string to replace the respective values of your OCI registry.
 
     ```yaml
-    docker.io::OCI_URL/IMAGE_PROJECT,gcr.io::OCI_URL/IMAGE_PROJECT,ghcr.io::OCI_URL/IMAGE_PROJECT,k8s.gcr.io::OCI_URL/IMAGE_PROJECT,registry.k8s.io::OCI_URL/IMAGE_PROJECT,quay.io::OCI_URL/IMAGE_PROJECT"
+    docker.io::OCI_URL/IMAGE_PROJECT/docker.io,gcr.io::OCI_URL/IMAGE_PROJECT/gcr.io,ghcr.io::OCI_URL/IMAGE_PROJECT/ghcr.io,k8s.gcr.io::OCI_URL/IMAGE_PROJECT/k8s.gcr.io,registry.k8s.io::OCI_URL/IMAGE_PROJECT/registry.k8s.io,quay.io::OCI_URL/IMAGE_PROJECT/quay.io"
     ```
 
     :::
@@ -173,7 +173,7 @@ environment. Reach out to our support team if you need assistance.
       baseContentPath: "spectro-images" #
       insecureSkipVerify: true
       caCert: ""
-      mirrorRegistries: "docker.io::my-oci-registry.com/spectro-images,gcr.io::my-oci-registry.com/spectro-images,ghcr.io::my-oci-registry.com/spectro-images,k8s.gcr.io::my-oci-registry.com/spectro-images,registry.k8s.io::my-oci-registry.com/spectro-images,quay.io::my-oci-registry.com/spectro-images"
+      mirrorRegistries: "docker.io::my-oci-registry.com/spectro-images/docker.io,gcr.io::my-oci-registry.com/spectro-images,ghcr.io::my-oci-registry.com/spectro-images/ghcr.io,k8s.gcr.io::my-oci-registry.com/spectro-images/k8s.gcr.io,registry.k8s.io::my-oci-registry.com/spectro-images/registry.k8s.io,quay.io::my-oci-registry.com/spectro-images/quay.io"
     ```
 
 7.  Create an empty YAML file with the name **registry-secret.yaml**. Use the following command to create the file.
@@ -378,14 +378,14 @@ Install the image-swap chart using the following command. Point to the **values.
       #    insecureSkipVerify: false
       #    caCert: ""
 
-      #  ociPackRegistry:
-      #    endpoint: "" #<Contact Spectro Cloud Sales for More info>
-      #    name: "" #<Contact Spectro Cloud Sales for More info>
-      #    password: "" #<Contact Spectro Cloud Sales for More info>
-      #    username: "" #<Contact Spectro Cloud Sales for More info>
-      #    baseContentPath: "" #<Contact Spectro Cloud Sales for More info>
-      #    insecureSkipVerify: false
-      #    caCert: ""
+      ociPackRegistry:
+        endpoint: "my-oci-registry.com" #<Contact Spectro Cloud Sales for More info>
+        name: "Airgap Packs OCI" #<Contact Spectro Cloud Sales for More info>
+        password: "" #<Contact Spectro Cloud Sales for More info>
+        username: "" #<Contact Spectro Cloud Sales for More info>
+        baseContentPath: "spectro-packs" #<Contact Spectro Cloud Sales for More info>
+        insecureSkipVerify: false
+        caCert: ""
 
       # ociPackEcrRegistry:
       #   endpoint: "" #<Contact Spectro Cloud Sales for More info>
@@ -405,7 +405,7 @@ Install the image-swap chart using the following command. Point to the **values.
         baseContentPath: "spectro-images" #<Contact Spectro Cloud Sales for More info>
         insecureSkipVerify: true
         caCert: ""
-        mirrorRegistries: "docker.io::my-oci-registry.com/v2/spectro-images,gcr.io::my-oci-registry.com/v2/spectro-images,ghcr.io::my-oci-registry.com/v2/spectro-images,k8s.gcr.io::my-oci-registry.com/v2/spectro-images,registry.k8s.io::my-oci-registry.com/v2/spectro-images,quay.io::my-oci-registry.com/v2/spectro-images"
+        mirrorRegistries: "docker.io::my-oci-registry.com/v2/spectro-images/docker.io,gcr.io::my-oci-registry.com/v2/spectro-images/gcr.io,ghcr.io::my-oci-registry.com/v2/spectro-images/ghcr.io,k8s.gcr.io::my-oci-registry.com/v2/spectro-images/k8s.gcr.io,registry.k8s.io::my-oci-registry.com/v2/spectro-images/registry.k8s.io,quay.io::my-oci-registry.com/v2/spectro-images/quay.io"
 
       scar:
         endpoint: "http://10.15.20.15:2015"
@@ -632,7 +632,7 @@ Install the image-swap chart using the following command. Point to the **values.
         baseContentPath: "spectro-images" #<Contact Spectro Cloud Sales for More info>
         insecureSkipVerify: false
         caCert: ""
-        mirrorRegistries: "docker.io::public.ecr.aws/123456789/v2/spectr-images,gcr.io::public.ecr.aws/123456789/v2/spectro-images,ghcr.io::public.ecr.aws/123456789/v2/spectro-images,k8s.gcr.io::public.ecr.aws/123456789/v2/spectro-images,registry.k8s.io::public.ecr.aws/123456789/v2/spectro-images,quay.io::public.ecr.aws/123456789/v2/spectro-imagesßßß"
+        mirrorRegistries: "docker.io::public.ecr.aws/123456789/v2/spectro-images/docker.io,gcr.io::public.ecr.aws/123456789/v2/spectro-images/gcr.io,ghcr.io::public.ecr.aws/123456789/v2/spectro-images/ghcr.io,k8s.gcr.io::public.ecr.aws/123456789/v2/spectro-images/k8s.gcr.io,registry.k8s.io::public.ecr.aws/123456789/v2/spectro-images/registry.k8s.io,quay.io::public.ecr.aws/123456789/v2/spectro-images/quay.io"
       #
       # Instruction for mirrorRegistries.
       # ----------------------------------
@@ -780,7 +780,8 @@ Install the image-swap chart using the following command. Point to the **values.
     :::warning
 
     Ensure you have configured the **values.yaml** file with the required parameters before proceeding to the next
-    steps.
+    steps. For the parameter `ociImageRegistry.mirrorRegistries`, ensure a `/v2/` endpoint is used if your OCI registry
+    supports the Docker Registry protocol v2, otherwise container pull images will fail.
 
     :::
 

diff --git a/...t/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md b/...t/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md
@@ -159,7 +159,7 @@ environment. Reach out to our support team if you need assistance.
     Use the following `mirrorRegistries`placeholder string to replace the respective values of your OCI registry.
 
     ```yaml
-    docker.io::OCI_URL/IMAGE_PROJECT,gcr.io::OCI_URL/IMAGE_PROJECT,ghcr.io::OCI_URL/IMAGE_PROJECT,k8s.gcr.io::OCI_URL/IMAGE_PROJECT,registry.k8s.io::OCI_URL/IMAGE_PROJECT,quay.io::OCI_URL/IMAGE_PROJECT"
+    docker.io::OCI_URL/IMAGE_PROJECT/docker.io,gcr.io::OCI_URL/IMAGE_PROJECT/gcr.io,ghcr.io::OCI_URL/IMAGE_PROJECT/ghcr.io,k8s.gcr.io::OCI_URL/IMAGE_PROJECT/k8s.gcr.io,registry.k8s.io::OCI_URL/IMAGE_PROJECT/registry.k8s.io,quay.io::OCI_URL/IMAGE_PROJECT/quay.io"
     ```
 
     :::
@@ -173,7 +173,7 @@ environment. Reach out to our support team if you need assistance.
       baseContentPath: "spectro-images" #
       insecureSkipVerify: true
       caCert: ""
-      mirrorRegistries: "docker.io::my-oci-registry.com/spectro-images,gcr.io::my-oci-registry.com/spectro-images,ghcr.io::my-oci-registry.com/spectro-images,k8s.gcr.io::my-oci-registry.com/spectro-images,registry.k8s.io::my-oci-registry.com/spectro-images,quay.io::my-oci-registry.com/spectro-images"
+      mirrorRegistries: "docker.io::my-oci-registry.com/spectro-images/docker.io,gcr.io::my-oci-registry.com/spectro-images,ghcr.io::my-oci-registry.com/spectro-images/ghcr.io,k8s.gcr.io::my-oci-registry.com/spectro-images/k8s.gcr.io,registry.k8s.io::my-oci-registry.com/spectro-images/registry.k8s.io,quay.io::my-oci-registry.com/spectro-images/quay.io"
     ```
 
 7.  Create an empty YAML file with the name **registry-secret.yaml**. Use the following command to create the file.
@@ -380,22 +380,22 @@ environment. Reach out to our support team if you need assistance.
       cluster:
         stableEndpointAccess: false
 
-      #  registry:
-      #    endpoint: "" #<Contact Spectro Cloud Sales for More info>
-      #    name: "" #<Contact Spectro Cloud Sales for More info>
-      #    password: "" #<Contact Spectro Cloud Sales for More info>
-      #    username: "" #<Contact Spectro Cloud Sales for More info>
-      #    insecureSkipVerify: false
-      #    caCert: ""
-
-      #  ociPackRegistry:
-      #    endpoint: "" #<Contact Spectro Cloud Sales for More info>
-      #    name: "" #<Contact Spectro Cloud Sales for More info>
-      #    password: "" #<Contact Spectro Cloud Sales for More info>
-      #    username: "" #<Contact Spectro Cloud Sales for More info>
-      #    baseContentPath: "" #<Contact Spectro Cloud Sales for More info>
-      #    insecureSkipVerify: false
-      #    caCert: ""
+        #  registry:
+        #    endpoint: "" #<Contact Spectro Cloud Sales for More info>
+        #    name: "" #<Contact Spectro Cloud Sales for More info>
+        #    password: "" #<Contact Spectro Cloud Sales for More info>
+        #    username: "" #<Contact Spectro Cloud Sales for More info>
+        #    insecureSkipVerify: false
+        #    caCert: ""
+
+        ociPackRegistry:
+          endpoint: "my-oci-registry.com" #<Contact Spectro Cloud Sales for More info>
+          name: "Airgap Packs OCI" #<Contact Spectro Cloud Sales for More info>
+          password: "" #<Contact Spectro Cloud Sales for More info>
+          username: "" #<Contact Spectro Cloud Sales for More info>
+          baseContentPath: "spectro-packs" #<Contact Spectro Cloud Sales for More info>
+          insecureSkipVerify: false
+          caCert: ""
 
       # ociPackEcrRegistry:
       #   endpoint: "" #<Contact Spectro Cloud Sales for More info>
@@ -415,7 +415,7 @@ environment. Reach out to our support team if you need assistance.
         baseContentPath: "spectro-images" #<Contact Spectro Cloud Sales for More info>
         insecureSkipVerify: true
         caCert: ""
-        mirrorRegistries: "docker.io::my-oci-registry.com/v2/spectro-images,gcr.io::my-oci-registry.com/v2/spectro-images,ghcr.io::my-oci-registry.com/v2/spectro-images,k8s.gcr.io::my-oci-registry.com/v2/spectro-images,registry.k8s.io::my-oci-registry.com/v2/spectro-images,quay.io::my-oci-registry.com/v2/spectro-images"
+        mirrorRegistries: "docker.io::my-oci-registry.com/v2/spectro-images/docker.io,gcr.io::my-oci-registry.com/v2/spectro-images/gcr.io,ghcr.io::my-oci-registry.com/v2/spectro-images/ghcr.io,k8s.gcr.io::my-oci-registry.com/v2/spectro-images/k8s.gcr.io,registry.k8s.io::my-oci-registry.com/v2/spectro-images/registry.k8s.io,quay.io::my-oci-registry.com/v2/spectro-images/quay.io"
 
       scar:
         endpoint: "http://10.15.20.15:2015"
@@ -642,7 +642,7 @@ environment. Reach out to our support team if you need assistance.
         baseContentPath: "spectro-images" #<Contact Spectro Cloud Sales for More info>
         insecureSkipVerify: false
         caCert: ""
-        mirrorRegistries: "docker.io::public.ecr.aws/123456789/v2/spectr-images,gcr.io::public.ecr.aws/123456789/v2/spectro-images,ghcr.io::public.ecr.aws/123456789/v2/spectro-images,k8s.gcr.io::public.ecr.aws/123456789/v2/spectro-images,registry.k8s.io::public.ecr.aws/123456789/v2/spectro-images,quay.io::public.ecr.aws/123456789/v2/spectro-imagesßßß"
+        mirrorRegistries: "docker.io::public.ecr.aws/123456789/v2/spectro-images/docker.io,gcr.io::public.ecr.aws/123456789/v2/spectro-images/gcr.io,ghcr.io::public.ecr.aws/123456789/v2/spectro-images/ghcr.io,k8s.gcr.io::public.ecr.aws/123456789/v2/spectro-images/k8s.gcr.io,registry.k8s.io::public.ecr.aws/123456789/v2/spectro-images/registry.k8s.io,quay.io::public.ecr.aws/123456789/v2/spectro-images/quay.io"
       #
       # Instruction for mirrorRegistries.
       # ----------------------------------
@@ -790,7 +790,8 @@ environment. Reach out to our support team if you need assistance.
     :::warning
 
     Ensure you have configured the **values.yaml** file with the required parameters before proceeding to the next
-    steps.
+    steps. For the parameter `ociImageRegistry.mirrorRegistries`, ensure a `/v2/` endpoint is used if your OCI registry
+    supports the Docker Registry protocol v2, otherwise container pull images will fail.
 
     :::