You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/addons/addons.md
+25-12Lines changed: 25 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,19 +17,19 @@ authors:
17
17
18
18
[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.
19
19
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.
[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.
27
27
28
28
-__ClusterProfile__: It is a cluster-wide resource. It can match any cluster and reference any resource regardless of their namespace.
29
29
30
30
-__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.
31
31
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.
33
33
34
34
- Helm charts
35
35
- Resources assembled with Kustomize
@@ -42,14 +42,16 @@ Define which Kubernetes add-ons to deploy and where:
42
42
43
43
Simple as that!
44
44
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.
46
47
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
48
49
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`.
50
51
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)
52
53
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).
53
55
54
56
```bash
55
57
$ kubectl get sveltosclusters -n projectsveltos --show-labels
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.

108
121
109
122
!!! 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).
0 commit comments