Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance local development documentation #2162

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/book/src/developer/e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions docs/book/src/developer/tilt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -104,7 +104,7 @@ extra_args:
To deploy workload cluster with [clusterclass-template](/topics/powervs/clusterclass-cluster.html), 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:
Expand All @@ -121,7 +121,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:
Expand All @@ -136,10 +136,10 @@ kustomize_substitutions:

### 3. 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
Expand Down Expand Up @@ -169,7 +169,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

Expand Down
7 changes: 7 additions & 0 deletions docs/book/src/user/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,10 @@
```
ssh -J root@<public_ip> root@<dhcp_ip>
```

### 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`.