Skip to content

Commit c1923d1

Browse files
authored
Update the landing add-ons page (#703)
1 parent 6981d54 commit c1923d1

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

docs/addons/addons.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ authors:
1717

1818
[Sveltos](https://github.com/projectsveltos "Manage Kubernetes add-ons") is a set of Kubernetes controllers that run in the management cluster. From the management cluster, Sveltos can manage add-ons and applications on a fleet of managed Kubernetes clusters.
1919

20-
Sveltos comes with support to automatically discover [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) powered clusters, but it doesn't stop there. You can easily [register](../register/register-cluster.md) any other cluster (on-prem, Cloud) and manage Kubernetes add-ons seamlessly.
20+
Sveltos comes with support to automatically discover [Cluster API (CAPI)](https://github.com/kubernetes-sigs/cluster-api) powered clusters, but it doesn't stop there. We can easily [register](../register/register-cluster.md) any other cluster (on-prem, Cloud) and manage Kubernetes add-ons seamlessly.
2121

2222
![Sveltos managing clusters](../assets/multi-clusters.png)
2323

24-
## How it works?
24+
## How does it work?
2525

26-
[ClusterProfile](https://github.com/projectsveltos/sveltos-manager/blob/main/api/v1beta1/clusterprofile_types.go "ClusterProfile to manage Kubernetes add-ons") and [Profile](https://github.com/projectsveltos/sveltos-manager/blob/main/api/v1beta1/profile_types.go "Profile to manage Kubernetes add-ons") are the CustomerResourceDefinitions used to instruct Sveltos which add-ons to deploy on a set of clusters.
26+
[ClusterProfile](https://github.com/projectsveltos/sveltos-manager/blob/main/api/v1beta1/clusterprofile_types.go "ClusterProfile to manage Kubernetes add-ons") and [Profile](https://github.com/projectsveltos/sveltos-manager/blob/main/api/v1beta1/profile_types.go "Profile to manage Kubernetes add-ons") are the Custom Resource Definitions (CRDs) used to instruct Sveltos which add-ons to deploy on a set of clusters.
2727

2828
- __ClusterProfile__: It is a cluster-wide resource. It can match any cluster and reference any resource regardless of their namespace.
2929

3030
- __Profile__: It is a namespace-scoped resource that is specific to a single namespace. It can only match clusters and reference resources within its own namespace.
3131

32-
By creating a **ClusterProfile**, **Profile** instances, we can easily deploy the following points across a set of Kubernetes clusters.
32+
By creating a **ClusterProfile** and **Profile** instances, we can easily deploy the following points across a set of Kubernetes clusters.
3333

3434
- Helm charts
3535
- Resources assembled with Kustomize
@@ -42,14 +42,16 @@ Define which Kubernetes add-ons to deploy and where:
4242

4343
Simple as that!
4444

45-
## Example: Deploy Kyverno using a ClusterProfile
45+
!!!note "CRDs Details"
46+
To get a list of all the available options defined in a ClusterProfile and Profile resources, take a look at the [ClusterProfile](./clusterprofile.md) and the [Profile](./profile.md) deep dive documentation.
4647

47-
The below example deploys a Kyverno Helm chart in every cluster with the label selector set to `env=prod`.
48+
## Example: Deploy Kyverno using a ClusterProfile
4849

49-
### Step 1: Register Clusters with Sveltos
50+
The example deploys a Kyverno Helm chart in every cluster with the label selector set to `env=prod`.
5051

51-
The first step is to register clusters with Sveltos to receive the required addons and deployments. If the clusters are not registered yet, follow the instructions outlined [here](../register/register-cluster.md). This applies to non-CAPI clusters.
52+
### Step 1: Register Clusters with Sveltos (non-CAPI clusters)
5253

54+
The first step is to register clusters with Sveltos to receive the required addons and deployments. If the clusters are not registered yet, follow the instructions outlined [here](../register/register-cluster.md).
5355

5456
```bash
5557
$ kubectl get sveltosclusters -n projectsveltos --show-labels
@@ -60,11 +62,20 @@ cluster13 true v1.26.9+rke2r1 sveltos-agent=present
6062
```
6163

6264
!!! note
63-
The CAPI clusters are registered in the **projectsveltos** namespace. If you register the clusters in a different namespace, update the command above.
65+
The CAPI clusters are detected automatically by Sveltos. They are registered in the **projectsveltos** namespace by default. If we register the clusters in a different namespace, update the command above.
66+
67+
### Step 2: Assign Labels
68+
69+
Once the clusters are registered and in a "READY" state, we can assign labels and start deploying add-ons and applications. For that, we can use the `kubectl label` command.
6470

65-
### Step 2: Create the ClusterProfile
71+
```bash
72+
$ kubectl label sveltosclusters cluster12 -n projectsveltos env=prod
73+
$ kubectl label sveltosclusters cluster13 -n projectsveltos env=prod
74+
```
6675

67-
The second step is to create a `ClusterProfile` and apply it to the **management** cluster.
76+
### Step 3: Create the ClusterProfile
77+
78+
The third step is to create a `ClusterProfile` and apply it to the **management** cluster.
6879

6980
!!! example "Sveltos ClusterProfile Kyverno"
7081
```yaml
@@ -90,6 +101,8 @@ The second step is to create a `ClusterProfile` and apply it to the **management
90101
```
91102

92103
```bash
104+
$ export KUBECONFIG=/path/to/kubeconfig/management/cluster
105+
93106
$ kubectl apply -f "clusterprofile_kyverno.yaml"
94107

95108
$ sveltosctl show addons
@@ -107,7 +120,7 @@ $ sveltosctl show addons
107120
![Sveltos in action](../assets/addons_deployment.gif)
108121

109122
!!! note
110-
If you are not aware of the `sveltosctl` utility, have a look at the installation documentation found [here](../getting_started/sveltosctl/sveltosctl.md).
123+
To explore and install the `sveltosctl` utility, take a look at the installation guide found [here](../getting_started/sveltosctl/sveltosctl.md).
111124

112125
## More Resources
113126

0 commit comments

Comments
 (0)