Skip to content

Commit d9049e1

Browse files
authored
Add files via upload (#63)
Add files via upload
1 parent ade7231 commit d9049e1

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@
77

88
<img src="https://raw.githubusercontent.com/projectsveltos/sveltos-manager/master/logos/logo.png" width="100">
99

10-
Sveltos is a policy driven approach to manage kubernetes resources and helm charts in ClusterAPI clusters. Sveltos provides declarative APIs to provision new features like Helm charts, ingress controllers, CNIs, storage classes and other resources in a given set of Kubernetes clusters.
10+
## What it is
11+
Sveltos is tool for policy driven management of kubernetes resources and helm charts in [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) powered Kubernetes clusters. Sveltos provides declarative APIs to provision features like Helm charts, ingress controllers, CNIs, storage classes and other resources in a given set of Kubernetes clusters. Sveltos is a freely available and open source. Sveltos is very lightweight and can be installed onto any Kubernetes clusters in minutes.
1112

1213
## How it works
1314
The project follows the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) and it uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
1415

15-
The project requires [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) to be installed in such cluster.
16-
17-
[ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
16+
The project requires [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) to be installed in such cluster. [ClusterAPI](https://github.com/kubernetes-sigs/cluster-api) is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
1817

1918
## Description
2019
![sveltos logo](./doc/sveltos.png)
@@ -59,7 +58,11 @@ spec:
5958

6059
As soon as a CAPI cluster is a match for above ClusterProfile instance, all referenced features are automatically deployed in such cluster.
6160

62-
To see Sveltos in action, have a look at this [video](https://youtu.be/Ai5Mr9haWKM)
61+
## Sveltos in action
62+
63+
![Sveltos in action](doc/SveltosOverview.gif)
64+
65+
To see the full demo, have a look at this [youtube video](https://youtu.be/Ai5Mr9haWKM)
6366

6467
## Features List
6568
1. Flexible cluster selection (see [video](https://youtu.be/Ai5Mr9haWKM))
@@ -69,7 +72,7 @@ To see Sveltos in action, have a look at this [video](https://youtu.be/Ai5Mr9haW
6972
5. Conflict detection
7073
6. Declaritive API and CLI
7174

72-
## Getting Started
75+
## Test Sveltos on your laptop
7376
If you want to test it out, just execute, `make create-cluster` and it will:
7477
1. create a [KIND](https://sigs.k8s.io/kind) cluster;
7578
2. install ClusterAPI;
@@ -78,7 +81,18 @@ If you want to test it out, just execute, `make create-cluster` and it will:
7881
5. create a ClusterProfile instance;
7982
6. modify CAPI Cluster labels so to match ClusterProfile selector.
8083

81-
# Understanding how to configure and use the project
84+
## Install Sveltos
85+
If you want to install it on local or remote Kubernetes cluster.
86+
87+
1. install ClusterAPI. [ClusterAPI instruction](https://cluster-api.sigs.k8s.io/user/quick-start.html) can be followed.
88+
89+
2. install the CRD and Deployment in the management cluster applying this YAML file:
90+
91+
```
92+
kubectl create -f https://raw.githubusercontent.com/projectsveltos/cluster-api-feature-manager/master/manifest/manifest.yaml
93+
```
94+
95+
# Understanding how to configure and use Sveltos
8296

8397
## ClusterSelector
8498
The clusterSelector field is a Kubernetes [label selector](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#resources-that-support-set-based-requirements) that matches against labels on CAPI clusters.
@@ -192,7 +206,7 @@ that will cause the Kyverno ClusterPolicy *no-gateway* to be withdrawn from any
192206
### DryRun
193207
In a dry-run execution, you can execute a workflow so that the entire flow of the execution (all the operations that are executed in an actual run) is shown, but no actual code is executed and there are no side effects.
194208

195-
Some applies here. Sometimes it is useful to see what will happen if a ClusterProfile is added/modified/deleted. So potential changes in matching CAPI clusters can be seen, validated and only then eventually applied.
209+
Same applies here. Sometimes it is useful to see what will happen if a ClusterProfile is added/modified/deleted. So potential changes in matching CAPI clusters can be seen, validated and only then eventually applied.
196210

197211
A ClusterProfile in DryRun mode will make no changes to matching clusters. It will though generate a report indicating, per CAPI Cluster, what those changes would be.
198212

@@ -373,19 +387,6 @@ Another example of misconfiguration is when two different ClusterProfiles match
373387

374388
In such a case, only one ClusterProfile will be elected and given permission to manage a specific helm release in a given CAPI cluster. Other ClusterProfiles will report such misconfiguration.
375389

376-
## Getting started on any Kubernetes cluster
377-
You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
378-
379-
First you need to install ClusterAPI in such cluster. [ClusterAPI instruction](https://cluster-api.sigs.k8s.io/user/quick-start.html) can be followed.
380-
381-
Second you need to install the CRD and Deployment for the project in the management cluster:
382-
383-
### Deploy YAML
384-
You can post the YAML to the management cluster
385-
386-
```
387-
kubectl create -f https://raw.githubusercontent.com/projectsveltos/cluster-api-feature-manager/master/manifest/manifest.yaml
388-
```
389390

390391
### Uninstall CRDs
391392
To delete the CRDs from the cluster:

doc/SveltosOverview.gif

17.5 MB
Loading

0 commit comments

Comments
 (0)