Updates README.md to document uninstall and Traefik, Helm integration (references #86, #96, #97)

This commit is contained in:
Matej Gera 2019-03-06 08:43:47 +01:00
parent 36370fdfbd
commit d11d985b42
No known key found for this signature in database
GPG Key ID: 1D4618B21B7E4666

View File

@ -101,6 +101,21 @@ Auto-deploying manifests
Any file found in `/var/lib/rancher/k3s/server/manifests` will automatically be deployed to Any file found in `/var/lib/rancher/k3s/server/manifests` will automatically be deployed to
Kubernetes in a manner similar to `kubectl apply`. Kubernetes in a manner similar to `kubectl apply`.
It is also possible to deploy Helm charts. k3s supports a CRD controller for installing charts. A YAML file specification can look as following (example taken from `/var/lib/rancher/k3s/server/manifests/traefik.yaml`):
```
apiVersion: k3s.cattle.io/v1
kind: HelmChart
metadata:
name: traefik
namespace: kube-system
spec:
chart: stable/traefik
set:
rbac.enabled: "true"
ssl.enabled: "true"
```
Building from source Building from source
-------------------- --------------------
@ -132,6 +147,11 @@ helper scripts
To build the full release binary run `make` and that will create `./dist/artifacts/k3s` To build the full release binary run `make` and that will create `./dist/artifacts/k3s`
Uninstalling server
-----------------
If you installed your k3s server with the help of `install.sh` script from the root directory, you may use the uninstall script generated during installation, which will be created on your server node at `/usr/local/bin/k3s-uninstall.sh`
Kubernetes source Kubernetes source
----------------- -----------------
@ -237,6 +257,13 @@ CoreDNS is deployed on start of the agent, to disable add `--no-deploy coredns`
If you don't install CoreDNS you will need to install a cluster DNS provider yourself. If you don't install CoreDNS you will need to install a cluster DNS provider yourself.
Traefik
-------
Traefik is deployed by default when starting the server; to disable it, start the server with `--no-deploy traefik` like this
k3s server --no-deploy traefik
Service load balancer Service load balancer
--------------------- ---------------------