feat: override bundle registry with environment variable

TheGnouCommunity · May 14, 2024 · bf4fdea · bf4fdea
1 parent a9a5fba
commit bf4fdea
Show file tree

Hide file tree

Showing 15 changed files with 17 additions and 16 deletions.
diff --git a/apis/infrastructure/v1beta1/byocluster_types.go b/apis/infrastructure/v1beta1/byocluster_types.go
@@ -22,7 +22,7 @@ type ByoClusterSpec struct {
 	ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"`
 
 	// BundleLookupBaseRegistry is the base Registry URL that is used for pulling byoh bundle images,
-	// if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundles
+	// if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundle
 	// +optional
 	BundleLookupBaseRegistry string `json:"bundleLookupBaseRegistry,omitempty"`
 }

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_byoclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_byoclusters.yaml
@@ -33,7 +33,7 @@ spec:
               description: ByoClusterSpec defines the desired state of ByoCluster
               properties:
                 bundleLookupBaseRegistry:
-                  description: BundleLookupBaseRegistry is the base Registry URL that is used for pulling byoh bundle images, if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundles
+                  description: BundleLookupBaseRegistry is the base Registry URL that is used for pulling byoh bundle images, if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundle
                   type: string
                 controlPlaneEndpoint:
                   description: ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_byoclustertemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_byoclustertemplates.yaml
@@ -60,7 +60,7 @@ spec:
                       description: ByoClusterSpec defines the desired state of ByoCluster
                       properties:
                         bundleLookupBaseRegistry:
-                          description: BundleLookupBaseRegistry is the base Registry URL that is used for pulling byoh bundle images, if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundles
+                          description: BundleLookupBaseRegistry is the base Registry URL that is used for pulling byoh bundle images, if not set, the default will be set to docker.io/thegnoucommunity/cluster-api-byoh-bundle
                           type: string
                         controlPlaneEndpoint:
                           description: ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

diff --git a/docs/cluster_class.md b/docs/cluster_class.md
@@ -52,7 +52,7 @@ spec:
       schema:
         openAPIV3Schema:
           type: string
-          default: "docker.io/thegnoucommunity/cluster-api-byoh-bundles"
+          default: "docker.io/thegnoucommunity/cluster-api-byoh-bundle"
     - name: controlPlaneIpAddr
       required: true
       schema:

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -137,7 +137,7 @@ $ cat /etc/hosts
 ```
 
 If you are trying this on your own hosts, then for each host
-1. Download the [byoh-hostagent-linux-amd64](https://github.com/thegnoucommunity/cluster-api-provider-bringyourownhost/releases/download/v0.3.0/byoh-hostagent-linux-amd64)
+1. Download the [byoh-hostagent-linux-amd64](https://github.com/thegnoucommunity/cluster-api-provider-bringyourownhost/releases/download/v0.5.9/byoh-hostagent-linux-amd64)
 2. Copy the bootstrap-kubeconfig file as `bootstrap-kubeconfig.conf`
 3. Start the agent 
 ```shell
@@ -206,7 +206,7 @@ Generate the cluster.yaml for workload cluster
  - for vms as byohosts
     ```shell
     CONTROL_PLANE_ENDPOINT_IP=10.10.10.10 \
-    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundles \
+    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundle \
     clusterctl generate cluster byoh-cluster \
       --infrastructure byoh \
       --kubernetes-version v1.26.6 \
@@ -217,7 +217,7 @@ Generate the cluster.yaml for workload cluster
  - for docker hosts use the --flavor argument
     ```shell
     CONTROL_PLANE_ENDPOINT_IP=10.10.10.10 \
-    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundles \
+    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundle \
     clusterctl generate cluster byoh-cluster \
         --infrastructure byoh \
         --kubernetes-version v1.26.6 \

diff --git a/docs/local_dev.md b/docs/local_dev.md
@@ -222,7 +222,7 @@ The current list of supported tuples of OS, kubernetes Version, BYOH Bundle Name
 An example output looks like:
 
 The corresponding bundles (particular to a patch version) should be pushed to the OCI registry of choice
-By default, BYOH uses docker.io/thegnoucommunity/cluster-api-byoh-bundles
+By default, BYOH uses docker.io/thegnoucommunity/cluster-api-byoh-bundle
 
 Note: It may happen that a specific patch version of a k8s minor release is not available in the OCI registry
 

diff --git a/hack/getting_started.sh b/hack/getting_started.sh
@@ -477,7 +477,7 @@ function createWorkloadCluster() {
     calcControlPlaneIP
 
     CONTROL_PLANE_ENDPOINT_IP=${controlPlaneEndPointIp} \
-    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundles \
+    BUNDLE_LOOKUP_BASE_REGISTRY=docker.io/thegnoucommunity/cluster-api-byoh-bundle \
     clusterctl generate cluster ${workerClusterName} \
         --infrastructure byoh \
         --kubernetes-version ${kubernetesVersion} \

diff --git a/test/e2e/byohost_reuse_test.go b/test/e2e/byohost_reuse_test.go
@@ -121,6 +121,7 @@ var _ = Describe("When BYO Host rejoins the capacity pool", func() {
 		By("Creating a cluster")
 
 		setControlPlaneIP(context.Background(), dockerClient)
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/cluster_upgrade_test.go b/test/e2e/cluster_upgrade_test.go
@@ -105,7 +105,7 @@ var _ = Describe("Cluster upgrade test [K8s-upgrade]", func() {
 		By("creating a workload cluster with one control plane node and one worker node")
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/clusterclass_upgrade_test.go b/test/e2e/clusterclass_upgrade_test.go
@@ -105,7 +105,7 @@ var _ = Describe("Clusterclass upgrade test [K8s-upgrade]", func() {
 		By("creating a workload cluster with one control plane node and one worker node")
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/config/provider.yaml b/test/e2e/config/provider.yaml
@@ -104,7 +104,7 @@ variables:
   # NOTE: INIT_WITH_BINARY is used only by the clusterctl upgrade test to initialize the management cluster to be upgraded
   INIT_WITH_BINARY: "https://github.com/kubernetes-sigs/cluster-api/releases/download/v1.4.4/clusterctl-{OS}-{ARCH}"
   BUNDLE_LOOKUP_TAG: "v1.26.6"
-  BUNDLE_LOOKUP_BASE_REGISTRY: "docker.io/thegnoucommunity/cluster-api-byoh-bundles"
+  BUNDLE_LOOKUP_BASE_REGISTRY: "docker.io/thegnoucommunity/cluster-api-byoh-bundle"
   CONTROL_PLANE_ENDPOINT_IP: ""
   MANUAL_CSR_APPROVAL: "disable"
 

diff --git a/test/e2e/e2e_clusterclass_test.go b/test/e2e/e2e_clusterclass_test.go
@@ -115,7 +115,7 @@ var _ = Describe("When BYOH joins existing cluster [Cluster-Class]", func() {
 		}()
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/e2e_installer_test.go b/test/e2e/e2e_installer_test.go
@@ -116,7 +116,7 @@ var _ = Describe("When BYOH joins existing cluster [Installer]", func() {
 		}()
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/e2e_test.go b/test/e2e/e2e_test.go
@@ -115,7 +115,7 @@ var _ = Describe("When BYOH joins existing cluster [PR-Blocking]", func() {
 		}()
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{

diff --git a/test/e2e/md_scale_test.go b/test/e2e/md_scale_test.go
@@ -104,7 +104,7 @@ var _ = Describe("When testing MachineDeployment scale out/in", func() {
 		By("creating a workload cluster with one control plane node and one worker node")
 
 		setControlPlaneIP(context.Background(), dockerClient)
-		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundles")
+		os.Setenv("BUNDLE_LOOKUP_BASE_REGISTRY", "docker.io/thegnoucommunity/cluster-api-byoh-bundle")
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,
 			ConfigCluster: clusterctl.ConfigClusterInput{