Skip to content

Commit 488874f

Browse files
committed
Tidy up Configuration Options page
Signed-off-by: Brad Davidson <[email protected]>
1 parent d8f4403 commit 488874f

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

docs/installation/configuration.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,13 @@ title: "Configuration Options"
33
weight: 20
44
---
55

6-
This page focuses on the options that can be used when you set up K3s for the first time:
7-
8-
- [K3s Install Script](#configuration-with-install-script)
9-
- [K3s Binary](#configuration-with-binary)
10-
- [Configuration File](#configuration-file)
11-
12-
For more advanced options, refer to [this page](../advanced/advanced.md).
6+
This page focuses on the options that are commonly used when setting up K3s for the first time. Refer to the documentation on [Advanced Options and Configuration](../advanced/advanced.md) for more in-depth coverage.
137

148
## Configuration with install script
159

1610
As mentioned in the [Quick-Start Guide](../quick-start/quick-start.md), you can use the installation script available at https://get.k3s.io to install K3s as a service on systemd and openrc based systems.
1711

18-
You can use a combination of `INSTALL_K3S_EXEC`, `K3S_` environment variables, and command flags to configure the installation.
12+
You can use a combination of `INSTALL_K3S_EXEC`, `K3S_` environment variables, and command flags to pass configuration to the service configuration. The prefixed environment variables, `INSTALL_K3S_EXEC` value, and trailing shell arguments are all persisted into the service configuration. After installation, configuration may be altered by editing the environment file, editing the service configuration, or simply re-running the installer with new options.
1913

2014
To illustrate this, the following commands all result in the same behavior of registering a server without flannel and with a token:
2115

@@ -42,7 +36,7 @@ For details on all environment variables, see [Environment Variables.](../refere
4236
## Configuration with binary
4337

4438
As stated, the installation script is primarily concerned with configuring K3s to run as a service.
45-
If you choose to not use the script, you can run K3s simply by downloading the binary from our [release page](https://github.com/k3s-io/k3s/releases/latest), placing it on your path, and executing it. Or you can install K3s without enabling it as a service:
39+
If you choose to not use the script, you can run K3s simply by downloading the binary from our [release page](https://github.com/k3s-io/k3s/releases/latest), placing it on your path, and executing it. This is not particularly useful for permanent installations, but may be useful when performing quick tests that do not merit managing K3s as a system service.
4640
```bash
4741
curl -sfL https://get.k3s.io | INSTALL_K3S_SKIP_ENABLE=true sh -
4842
```
@@ -68,7 +62,7 @@ You can also use the `--help` flag to see a list of all available options.
6862

6963
:::info Matching Flags
7064
It is important to match critical flags on your server/agent installations. For example, if you use the flag
71-
`--disable servicelb` or `--cluster-cidr=10.42.0.0/16` on your master node, but don't set it on other server nodes, the nodes will fail to join. They will print errors with:
65+
`--disable servicelb` or `--cluster-cidr=10.42.0.0/16` on your master node, but don't set it on other server nodes, the nodes will fail to join. They will print errors such as:
7266
`failed to validate server configuration: critical configuration value mismatch.`
7367
:::
7468
## Configuration File
@@ -177,4 +171,4 @@ This results in a server with:
177171
- A kubeconfig file with permissions `644`
178172
- Flannel backend set to `none`
179173
- The token set to `secret`
180-
- Debug logging enabled
174+
- Debug logging enabled

0 commit comments

Comments
 (0)