diff --git a/docs/book/src/developer/e2e.md b/docs/book/src/developer/e2e.md index f34934cff..8df00f36a 100644 --- a/docs/book/src/developer/e2e.md +++ b/docs/book/src/developer/e2e.md @@ -4,7 +4,7 @@ * The end-to-end tests for `VPC` and `PowerVS` run on an internal prow cluster on IBM Cloud. * Resource management is handled via [boskos](https://github.com/kubernetes-sigs/boskos) which is an efficient way to lease infra and clean up after every run. -* The E2E tests use the Cluster API test framework. For more information on developing E2E tests, refer [here](https://cluster-api.sigs.k8s.io/developer/e2e). +* The E2E tests use the Cluster API test framework. For more information on developing E2E tests, refer [here](https://cluster-api.sigs.k8s.io/developer/core/e2e). ### Jobs diff --git a/docs/book/src/developer/tilt.md b/docs/book/src/developer/tilt.md index 500a08517..8454a8f8b 100644 --- a/docs/book/src/developer/tilt.md +++ b/docs/book/src/developer/tilt.md @@ -75,7 +75,7 @@ Next, create a `tilt-settings.yaml` file and place it in your local copy of `clu Make sure to set a valid API key for the field `IBMCLOUD_API_KEY`. ```yaml -default_registry: "gcr.io/you-project-name-here" +default_registry: "localhost:5001" provider_repos: - ../cluster-api-provider-ibmcloud enable_providers: @@ -103,7 +103,7 @@ extra_args: To deploy workload cluster with cloud controller manager, set `PROVIDER_ID_FORMAT` to `v2` and enable cluster resourceset feature gate by setting `EXP_CLUSTER_RESOURCE_SET` to `true under kustomize_substitutions. ```yaml -default_registry: "gcr.io/you-project-name-here" +default_registry: "localhost:5001" provider_repos: - ../cluster-api-provider-ibmcloud enable_providers: @@ -118,10 +118,10 @@ kustomize_substitutions: ### 2. Configuration to deploy workload cluster from ClusterClass template -To deploy workload cluster with [clusterclass-template](/topics/powervs/clusterclass-cluster.html), set the `PROVIDER_ID_FORMAT` to `v2` and enable the feature gates `EXP_CLUSTER_RESOURCE_SET` and `CLUSTER_TOPOLOGY` to `true`under kustomize_substitutions. +To deploy workload cluster with [clusterclass-template](https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/templates/cluster-template-powervs-clusterclass.yaml), set the `PROVIDER_ID_FORMAT` to `v2` and enable the feature gates `EXP_CLUSTER_RESOURCE_SET` and `CLUSTER_TOPOLOGY` to `true`under kustomize_substitutions. ```yaml -default_registry: "gcr.io/you-project-name-here" +default_registry: "localhost:5001" provider_repos: - ../cluster-api-provider-ibmcloud enable_providers: @@ -139,7 +139,7 @@ kustomize_substitutions: To deploy workload cluster with Custom Service Endpoint, Set `SERVICE_ENDPOINT` environmental variable in semi-colon separated format: `${ServiceRegion}:${ServiceID1}=${URL1},${ServiceID2}=${URL2...}` ```yaml -default_registry: "gcr.io/you-project-name-here" +default_registry: "localhost:5001" provider_repos: - ../cluster-api-provider-ibmcloud enable_providers: @@ -154,10 +154,10 @@ kustomize_substitutions: ### 4. Configuration to use observability tools -- cluster-api provides support for deploying observability tools, More information about it is available in cluster-api [book](https://cluster-api.sigs.k8s.io/developer/logging#developing-and-testing-logs). +- cluster-api provides support for deploying observability tools, More information about it is available in cluster-api [book](https://cluster-api.sigs.k8s.io/developer/core/logging#developing-and-testing-logs). ```yaml -default_registry: "gcr.io/you-project-name-here" +default_registry: "localhost:5001" deploy_observability: - promtail - loki @@ -188,7 +188,7 @@ extra_args: - "--logging-format=json" ``` -**NOTE**: For information about all the fields that can be used in the `tilt-settings.yaml` file, check them [here](https://cluster-api.sigs.k8s.io/developer/tilt.html#tilt-settings-fields). +**NOTE**: For information about all the fields that can be used in the `tilt-settings.yaml` file, check them [here](https://cluster-api.sigs.k8s.io/developer/core/tilt.html#tilt-settings-fields). ## Run Tilt diff --git a/docs/book/src/user/troubleshooting.md b/docs/book/src/user/troubleshooting.md index f18a0a7db..cc640ea3d 100644 --- a/docs/book/src/user/troubleshooting.md +++ b/docs/book/src/user/troubleshooting.md @@ -52,3 +52,10 @@ ``` ssh -J root@ root@ ``` + +### 3. Failed to apply the create infra template with release not found error + +While trying to create a cluster from unreleased version like from main branch, we will run into error like `release not found for version vX.XX.XX`. In that case following changes needs to be made before running the corresponding generate cluster command: + +- While creating a PowerVS cluster instead of `--flavor=powervs-create-infra` use `--from=./templates/cluster-template-powervs-create-infra.yaml`. +- While creating a VPC cluster instead of `--flavor=vpc-clusterclass` use `--from ./templates/cluster-template-vpc-clusterclass.yaml`. \ No newline at end of file