Skip to content

📖 Add helm chart to getting started doc #94

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 22, 2023
Merged

📖 Add helm chart to getting started doc #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca338b5
Update getting started docs with helm chart instructions
alexander-demicev Mar 22, 2023
3722369
Add missing step to release docs
alexander-demicev Mar 22, 2023
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
7 changes: 7 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,16 @@ Wait for the cert-manager to be ready.

Install the Cluster API operator:

1. Operator can be installed directly by applying manifests from release assets:
```bash
kubectl apply -f https://github.com/kubernetes-sigs/cluster-api-operator/releases/latest/download/operator-components.yaml
```
2. Another option is using helm charts:
```bash
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
helm repo update
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system
```

***Note***: :warning: Take a look at RBAC permissions and adjust them, the operator will be creating and updating CRDs.
We are still working on figuring out the best way to handle this.
Expand Down
9 changes: 7 additions & 2 deletions docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

This documents describes release process for the Cluster API Operator.

1. Cut the release branch.
1. Create the release branch and cut release tag.

```bash
git checkout -b release-0.1
git push -u upstream release-0.1
```

```bash
export RELEASE_TAG=v0.1.1
Expand All @@ -28,7 +33,7 @@ make promote-images
Merge the PR after it was created and verify that image is present in the production registry.

```bash
docker pull registry.k8s.io/capi-operator:${RELEASE_TAG}
docker pull registry.k8s.io/capi-operator/cluster-api-operator:${RELEASE_TAG}
```

4. Publish the release on Github.
Expand Down