Skip to content

Commit 9f992a3

Browse files
Move content to correct sections for generated summary
Signed-off-by: Danil Grigorev <[email protected]>
1 parent 978da7f commit 9f992a3

40 files changed

+70
-65
lines changed
File renamed without changes.

docs/book/src/01_user/00.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# User guide
2+
3+
This section contains quick start and concepts relevant to a new operator user.
File renamed without changes.

docs/book/src/user/quick-start.md renamed to docs/book/src/01_user/02_quick-start.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This is a quickstart guide for getting Cluster API Operator up and running on your Kubernetes cluster.
44

5+
For more detailed information, please refer to the full documentation.
6+
57
## Prerequisites
68

79
- [Running Kubernetes cluster](https://cluster-api.sigs.k8s.io/user/quick-start#install-andor-configure-a-kubernetes-cluster).
@@ -25,42 +27,47 @@ kubectl create secret generic "${CREDENTIALS_SECRET_NAME}" --from-literal=AWS_B6
2527

2628
### Installing Cluster API Operator
2729

28-
#### Method 1: Apply Manifests from Release Assets
29-
30-
Before installing the Cluster API Operator this way, you must first ensure that cert-manager is installed, as the operator does not manage cert-manager installations. To install cert-manager, run the following command:
31-
32-
```bash
33-
kubectl apply -f https://github.com/jetstack/cert-manager/releases/latest/download/cert-manager.yaml
34-
```
35-
36-
Wait for cert-manager to be ready before proceeding.
37-
38-
After cert-manager is successfully installed, you can install the Cluster API operator directly by applying the latest release assets:
30+
Add helm repository:
3931

4032
```bash
41-
kubectl apply -f https://github.com/kubernetes-sigs/cluster-api-operator/releases/latest/download/operator-components.yaml
33+
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
34+
helm repo update
4235
```
4336

44-
#### Method 2: Use Helm Charts
45-
46-
Alternatively, you can install the Cluster API operator using Helm charts:
37+
Deploy Cluster API components with docker provider using a single command during operator installation
4738

4839
```bash
49-
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
50-
helm repo update
51-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system
40+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
5241
```
5342

54-
##### Installing cert-manager using Helm chart
43+
Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).
5544

56-
CAPI operator Helm chart supports provisioning of cert-manager as a dependency. It is disabled by default, but you can enable it with `--set cert-manager.enabled=true` option to `helm install` command or inside of `cert-manager` section in [values.yaml](https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/hack/charts/cluster-api-operator/values.yaml) file. Additionally you can define other [parameters](https://artifacthub.io/packages/helm/cert-manager/cert-manager#configuration) provided by the cert-manager chart.
45+
Other options for installing Cluster API Operator are described in [installation documentation](../02_installation/).
46+
47+
# Example API Usage
5748

58-
##### Installing providers using Helm chart
49+
Deploy latest version of core Cluster API components:
5950

60-
Deploy Cluster API components with docker provider using a single command during operator installation:
51+
```yaml
52+
apiVersion: operator.cluster.x-k8s.io/v1alpha2
53+
kind: CoreProvider
54+
metadata:
55+
name: cluster-api
56+
namespace: capi-system
6157

62-
```bash
63-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
6458
```
6559

66-
Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).
60+
Deploy Cluster API AWS provider with specific version, custom manager options and flags:
61+
62+
```yaml
63+
---
64+
apiVersion: operator.cluster.x-k8s.io/v1alpha2
65+
kind: InfrastructureProvider
66+
metadata:
67+
name: aws
68+
namespace: capa-system
69+
spec:
70+
version: v2.1.4
71+
configSecret:
72+
name: aws-variables
73+
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Cluster API Provider Lifecycle
2+
3+
This section contains lifecycle operations a user can perform on a provider manifest, such as:
4+
- Install
5+
- Upgrade
6+
- Modify
7+
- Delete

0 commit comments

Comments
 (0)