From 29ab1b0510e7049d93417ffa7d0e04ee31923877 Mon Sep 17 00:00:00 2001 From: Erik Wilson Date: Wed, 26 Jun 2019 10:04:21 -0700 Subject: [PATCH] Update k3s docs per comments --- content/k3s/latest/en/configuration/_index.md | 6 +++--- content/k3s/latest/en/installation/_index.md | 12 ++++++------ content/k3s/latest/en/quick-start/_index.md | 4 ++-- content/k3s/latest/en/running/_index.md | 16 ++++++++++------ 4 files changed, 21 insertions(+), 17 deletions(-) diff --git a/content/k3s/latest/en/configuration/_index.md b/content/k3s/latest/en/configuration/_index.md index 0135e5e41ed..3c7e4728f76 100644 --- a/content/k3s/latest/en/configuration/_index.md +++ b/content/k3s/latest/en/configuration/_index.md @@ -83,7 +83,7 @@ yes then you just need to run the agent with the `--docker` flag. k3s will generate config.toml for containerd in `/var/lib/rancher/k3s/agent/etc/containerd/config.toml`, for advanced customization for this file you can create another file called `config.toml.tmpl` in the same directory and it will be used instead. -The `config.toml.tmpl` will be treated as a Golang template file, and the `config.Node` structure is being passed to the template,the following is an example on how to use the structure to customize the configuration file https://github.com/rancher/k3s/blob/master/pkg/agent/templates/templates.go#L16-L32 +The `config.toml.tmpl` will be treated as a Golang template file, and the `config.Node` structure is being passed to the template, the following is an example on how to use the structure to customize the configuration file https://github.com/rancher/k3s/blob/master/pkg/agent/templates/templates.go#L16-L32 Rootless -------- @@ -93,7 +93,7 @@ _**WARNING**:_ Some advanced magic, user beware Initial rootless support has been added but there are a series of significant usability issues surrounding it. We are releasing the initial support for those interested in rootless and hopefully some people can help to improve the usability. First ensure you have proper setup and support for user namespaces. Refer to the -[requirements section](https://github.com/rootless-containers/rootlesskit#setup) in rootlesskit for instructions. +[requirements section](https://github.com/rootless-containers/rootlesskit#setup) in RootlessKit for instructions. In short, latest Ubuntu is your best bet for this to work. @@ -123,7 +123,7 @@ In short, latest Ubuntu is your best bet for this to work. **Running w/ Rootless**: Just add `--rootless` flag to either server or agent. So run `k3s server --rootless` and then look for the message -`Wrote kubeconfig [SOME PATH]` for where your kubeconfig to access you cluster is. Becareful, if you use `-o` to write +`Wrote kubeconfig [SOME PATH]` for where your kubeconfig to access you cluster is. Be careful, if you use `-o` to write the kubeconfig to a different directory it will probably not work. This is because the k3s instance in running in a different mount namespace. diff --git a/content/k3s/latest/en/installation/_index.md b/content/k3s/latest/en/installation/_index.md index 980deee37db..04cf298aebe 100644 --- a/content/k3s/latest/en/installation/_index.md +++ b/content/k3s/latest/en/installation/_index.md @@ -9,7 +9,7 @@ Install Script -------------- The install script will attempt to download the latest release, to specify a specific -version for download we can use the `INSTALL_K3S_VERSION` environment variable, eg: +version for download we can use the `INSTALL_K3S_VERSION` environment variable, for example: ```sh curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=vX.Y.Z-rc1 sh - ``` @@ -20,7 +20,7 @@ environment variable to the command: curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="--disable-agent" sh - ``` -The installer can also be run without performing downloads by setting `INSTALL_K3S_SKIP_DOWNLOAD=true`, eg: +The installer can also be run without performing downloads by setting `INSTALL_K3S_SKIP_DOWNLOAD=true`, for example: ```sh curl -sfL https://github.com/rancher/k3s/releases/download/vX.Y.Z/k3s -o /usr/local/bin/k3s chmod 0755 /usr/local/bin/k3s @@ -228,11 +228,11 @@ The following information on server options is also available through `k3s serve * `--node-label` _value_ - (agent) Registring kubelet with set of labels + (agent) Registering kubelet with set of labels * `--node-taint` _value_ - (agent) Registring kubelet with set of taints + (agent) Registering kubelet with set of taints Agent Options ------------------ @@ -305,11 +305,11 @@ The following information on agent options is also available through `k3s agent * `--node-label` _value_ - (agent) Registring kubelet with set of labels + (agent) Registering kubelet with set of labels * `--node-taint` _value_ - (agent) Registring kubelet with set of taints + (agent) Registering kubelet with set of taints Customizing components ---------------------- diff --git a/content/k3s/latest/en/quick-start/_index.md b/content/k3s/latest/en/quick-start/_index.md index a54bcb42627..e24d414c2c1 100644 --- a/content/k3s/latest/en/quick-start/_index.md +++ b/content/k3s/latest/en/quick-start/_index.md @@ -15,7 +15,7 @@ curl -sfL https://get.k3s.io | sh - ``` A kubeconfig file is written to `/etc/rancher/k3s/k3s.yaml` and the service is automatically started or restarted. -The install script will install k3s and additional utilities, such as `kubectl`, `crictl`, `k3s-killall.sh`, and `k3s-uninstall.sh`, eg: +The install script will install k3s and additional utilities, such as `kubectl`, `crictl`, `k3s-killall.sh`, and `k3s-uninstall.sh`, for example: ```bash sudo kubectl get nodes @@ -23,7 +23,7 @@ sudo kubectl get nodes `K3S_TOKEN` is created at `/var/lib/rancher/k3s/server/node-token` on your server. To install on worker nodes we should pass `K3S_URL` along with -`K3S_TOKEN` or `K3S_CLUSTER_SECRET` environment variables, eg: +`K3S_TOKEN` or `K3S_CLUSTER_SECRET` environment variables, for example: ```bash curl -sfL https://get.k3s.io | K3S_URL=https://myserver:6443 K3S_TOKEN=XXX sh - ``` diff --git a/content/k3s/latest/en/running/_index.md b/content/k3s/latest/en/running/_index.md index 4810494f109..3d085171d76 100644 --- a/content/k3s/latest/en/running/_index.md +++ b/content/k3s/latest/en/running/_index.md @@ -9,7 +9,11 @@ Starting the Server ------------------ The installation script will auto-detect if your OS is using systemd or openrc and start the service. -When running with openrc logs will be created at `/var/log/k3s.log`, or with systemd in `/var/log/syslog` and viewed using `journalctl -u k3s`. +When running with openrc logs will be created at `/var/log/k3s.log`, or with systemd in `/var/log/syslog` and viewed using `journalctl -u k3s`. An example of installing and auto-starting with the install script: + +```bash +curl -sfL https://get.k3s.io | sh - +``` When running the server manually you should get an output similar to: @@ -137,7 +141,7 @@ Then update **/etc/update-extlinux.conf** by adding: default_kernel_opts="... cgroup_enable=cpuset cgroup_memory=1 cgroup_enable=memory" ``` -Than update the config and reboot +Then update the config and reboot: ```bash update-extlinux @@ -155,7 +159,7 @@ Running in Docker (and docker-compose) [k3d](https://github.com/rancher/k3d) is a utility designed to easily run k3s in Docker. It can be installed via the [brew](https://brew.sh/) utility for MacOS. `rancher/k3s` images are also available to run k3s server and agent from Docker. A `docker-compose.yml` is in the root of the k3s repo that -serves as an example of how to run k3s from Docker. To run from `docker-compose` from this repo run +serves as an example of how to run k3s from Docker. To run from `docker-compose` from this repo run: docker-compose up --scale node=3 # kubeconfig is written to current dir @@ -186,7 +190,7 @@ serves as an example of how to run k3s agent from Docker. Alternatively the Dock Air-Gap Support --------------- -k3s supports pre-loading of containerd images by placing them in the `images` directory for the agent before starting, eg: +k3s supports pre-loading of containerd images by placing them in the `images` directory for the agent before starting, for example: ```sh sudo mkdir -p /var/lib/rancher/k3s/agent/images/ sudo cp ./k3s-airgap-images-$ARCH.tar /var/lib/rancher/k3s/agent/images/ @@ -206,7 +210,7 @@ k3s additionally provides a `--resolv-conf` flag for kubelets, which may help wi Upgrades -------- -To upgrade k3s from an older version you can re-run the installation script using the same flags, eg: +To upgrade k3s from an older version you can re-run the installation script using the same flags, for example: ```sh curl -sfL https://get.k3s.io | sh - @@ -253,4 +257,4 @@ Hyperkube k3s is bundled in a nice wrapper to remove the majority of the headache of running k8s. If you don't want that wrapper and just want a smaller k8s distro, the releases includes the `hyperkube` binary you can use. It's then up to you to know how to use `hyperkube`. If -you want individual binaries you will need to compile them yourself from source +you want individual binaries you will need to compile them yourself from source.