feat(helm): publishing chart

This commit is contained in:
Dario Tranchitella
2022-08-23 11:00:27 +02:00
parent 626a0eed64
commit e12509a970
4 changed files with 14 additions and 14 deletions

View File

@@ -73,12 +73,12 @@ kubectl cluster-info
```
## Install Kamaji
There are multiple ways to deploy Kamaji, including a [single YAML file](../config/install.yaml) and [Helm Chart](../helm/kamaji).
There are multiple ways to deploy Kamaji, including a [single YAML file](../config/install.yaml) and [Helm Chart](../charts/kamaji).
### Multi-tenant datastore
The Kamaji controller needs to access a multi-tenant datastore in order to save data of the tenants' clusters.
Install a multi-tenant `etcd` in the admin cluster as three replicas StatefulSet with data persistence.
The Helm [Chart](../helm/kamaji/) provides the installation of an internal `etcd`.
The Helm [Chart](../charts/kamaji/) provides the installation of an internal `etcd`.
However, an externally managed `etcd` is highly recommended.
If you'd like to use an external one, you can specify the overrides by setting the value `etcd.deploy=false`.
@@ -88,7 +88,7 @@ Optionally, Kamaji offers the possibility of using a different storage system th
Install with the `helm` in a dedicated namespace of the Admin cluster:
```bash
helm install --create-namespace --namespace kamaji-system kamaji ../helm/kamaji
helm install --create-namespace --namespace kamaji-system kamaji clastix/kamaji
```
The Kamaji controller and the multi-tenant `etcd` are now running:

View File

@@ -47,10 +47,10 @@ Any regular and conformant Kubernetes v1.22+ cluster can be turned into a Kamaji
Make sure you have a `kubeconfig` file with admin permissions on the cluster you want to turn into Kamaji Admin Cluster.
## Install Kamaji
There are multiple ways to deploy Kamaji, including a [single YAML file](../config/install.yaml) and [Helm Chart](../helm/kamaji).
There are multiple ways to deploy Kamaji, including a [single YAML file](../config/install.yaml) and [Helm Chart](../charts/kamaji).
### Multi-tenant datastore
The Kamaji controller needs to access a multi-tenant datastore in order to save data of the tenants' clusters. Install a multi-tenant `etcd` in the admin cluster as three replicas StatefulSet with data persistence. The Helm [Chart](../helm/kamaji/) provides the installation of an internal `etcd`. However, an externally managed `etcd` is highly recommended. If you'd like to use an external one, you can specify the overrides by setting the value `etcd.deploy=false`.
The Kamaji controller needs to access a multi-tenant datastore in order to save data of the tenants' clusters. Install a multi-tenant `etcd` in the admin cluster as three replicas StatefulSet with data persistence. The Helm [Chart](../charts/kamaji/) provides the installation of an internal `etcd`. However, an externally managed `etcd` is highly recommended. If you'd like to use an external one, you can specify the overrides by setting the value `etcd.deploy=false`.
Optionally, Kamaji offers the possibility of using a different storage system than `etcd` for the tenants' clusters, like MySQL compatible database, thanks to the [kine](https://github.com/k3s-io/kine) integration [here](../deploy/kine/mysql/README.md).
@@ -58,7 +58,7 @@ Optionally, Kamaji offers the possibility of using a different storage system th
Install with the `helm` in a dedicated namespace of the Admin cluster:
```bash
helm install --create-namespace --namespace kamaji-system kamaji ../helm/kamaji
helm install --create-namespace --namespace kamaji-system kamaji clastix/kamaji
```
The Kamaji controller and the multi-tenant `etcd` are now running:

View File

@@ -30,7 +30,7 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e
To install the Chart with the release name `kamaji`:
helm upgrade --install --namespace kamaji-system --create-namespace kamaji
helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji
Show the status:
@@ -38,7 +38,7 @@ Show the status:
Upgrade the Chart
helm upgrade kamaji -n kamaji-system .
helm upgrade kamaji -n kamaji-system clastix/kamaji
Uninstall the Chart
@@ -52,13 +52,13 @@ The `--values` option is the preferred method because it allows you to keep your
Specify your overrides file when you install the Chart:
helm upgrade kamaji --install --namespace kamaji-system --create-namespace kamaji --values myvalues.yaml
helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml
The values in your overrides file `myvalues.yaml` will override their counterparts in the Chart's values.yaml file. Any values in `values.yaml` that werent overridden will keep their defaults.
If you only need to make minor customizations, you can specify them on the command line by using the `--set` option. For example:
helm upgrade kamaji --install --namespace kamaji-system --create-namespace kamaji --set etcd.deploy=false
helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false
Here the values you can override:

View File

@@ -21,7 +21,7 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e
To install the Chart with the release name `kamaji`:
helm upgrade --install --namespace kamaji-system --create-namespace kamaji
helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji
Show the status:
@@ -29,7 +29,7 @@ Show the status:
Upgrade the Chart
helm upgrade kamaji -n kamaji-system .
helm upgrade kamaji -n kamaji-system clastix/kamaji
Uninstall the Chart
@@ -43,13 +43,13 @@ The `--values` option is the preferred method because it allows you to keep your
Specify your overrides file when you install the Chart:
helm upgrade kamaji --install --namespace kamaji-system --create-namespace kamaji --values myvalues.yaml
helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml
The values in your overrides file `myvalues.yaml` will override their counterparts in the Chart's values.yaml file. Any values in `values.yaml` that werent overridden will keep their defaults.
If you only need to make minor customizations, you can specify them on the command line by using the `--set` option. For example:
helm upgrade kamaji --install --namespace kamaji-system --create-namespace kamaji --set etcd.deploy=false
helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false
Here the values you can override: