Skip to content

Commit 43d5eb0

Browse files
Rahul Sharmaeljohnson92
authored andcommitted
update readme, add info about management cluster
1 parent 015590e commit 43d5eb0

File tree

2 files changed

+26
-11
lines changed

2 files changed

+26
-11
lines changed

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@
3030
<img src="https://github.com/linode/cluster-api-provider-linode/actions/workflows/codeql.yml/badge.svg"></a>
3131
</p>
3232

33-
------
34-
*PLEASE NOTE*: This project is considered ALPHA quality and should NOT be used for production, as it is currently in active development. Use at your own risk. APIs, configuration file formats, and functionality are all subject to change frequently. That said, please try it out in your development and test environments and let us know how it works for you. Contributions welcome! Thanks!
35-
3633
------
3734

3835
## What is Cluster API Provider Linode (CAPL)

docs/src/topics/getting-started.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,40 @@ to provision the node. If you are using a custom image ensure the [cloud_init](h
4848
By default, clusters are provisioned within VPC with disk encryption enabled. For Regions which do not have [VPC support](https://www.linode.com/docs/products/networking/vpc/#availability) yet, use the [VPCLess](./flavors/vpcless.md) flavor to have clusters provisioned. For disabling disk encryption, set `spec.template.spec.diskEncryption=disabled` in your generated LinodeMachineTemplate resources when creating a CAPL cluster.
4949
~~~
5050

51+
## Setup management cluster
52+
A clusterAPI management cluster is a kubernetes cluster that is responsible for managing the lifecycle of other child k8s clusters provisioned using Cluster API (CAPI). It serves as a control plane for provisioning, scaling, upgrading and deleting child kubernetes clusters.
53+
54+
Use any of the following to have a base management cluster:
55+
- Provision k8s cluster using [LKE](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-lke-linode-kubernetes-engine)
56+
- Bring/Use your own provisioned k8s cluster to be configured as management cluster
57+
5158
## Install CAPL on your management cluster
5259
```admonish warning
5360
The `linode-linode` infrastructure provider requires clusterctl version 1.7.2 or higher
5461
```
5562
Install CAPL and enable the helm addon provider which is used by the majority of the CAPL flavors
5663

5764
```bash
65+
export KUBECONFIG=<mgmt-cluster-kubeconfig>
5866
clusterctl init --infrastructure linode-linode --addon helm
59-
# Fetching providers
60-
# Installing cert-manager Version="v1.14.5"
61-
# Waiting for cert-manager to be available...
62-
# Installing Provider="cluster-api" Version="v1.7.3" TargetNamespace="capi-system"
63-
# Installing Provider="bootstrap-kubeadm" Version="v1.7.3" TargetNamespace="capi-kubeadm-bootstrap-system"
64-
# Installing Provider="control-plane-kubeadm" Version="v1.7.3" TargetNamespace="capi-kubeadm-control-plane-system"
65-
# Installing Provider="infrastructure-linode-linode" Version="v0.4.0" TargetNamespace="capl-system"
66-
# Installing Provider="addon-helm" Version="v0.2.4" TargetNamespace="caaph-system"
67+
```
68+
69+
Output will be something like:
70+
```bash
71+
Fetching providers
72+
Installing cert-manager version="v1.16.0"
73+
Waiting for cert-manager to be available...
74+
Installing provider="cluster-api" version="v1.9.5" targetNamespace="capi-system"
75+
Installing provider="bootstrap-kubeadm" version="v1.9.5" targetNamespace="capi-kubeadm-bootstrap-system"
76+
Installing provider="control-plane-kubeadm" version="v1.9.5" targetNamespace="capi-kubeadm-control-plane-system"
77+
Installing provider="infrastructure-linode-linode" version="v0.8.4" targetNamespace="capl-system"
78+
Installing provider="addon-helm" version="v0.3.1" targetNamespace="caaph-system"
79+
80+
Your management cluster has been initialized successfully!
81+
82+
You can now create your first workload cluster by running the following:
83+
84+
clusterctl generate cluster [name] --kubernetes-version [version] | kubectl apply -f -
6785
```
6886

6987
## Deploying your first cluster

0 commit comments

Comments
 (0)