You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/k3s/latest/en/installation/install-options/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ Command | Description
57
57
<spanclass='nowrap'>`k3s ctr`</span> | Run an embedded [ctr](https://github.com/projectatomic/containerd/blob/master/docs/cli.md). This is a CLI for containerd, the container daemon used by K3s. Useful for debugging.
58
58
<spanclass='nowrap'>`k3s help`</span> | Shows a list of commands or help for one command
59
59
60
-
The `k3s server` and `k3s agent` commands have additional configuration options that can be viewed with <spanclass='nowrap'>`k3s server --help`</span> or <spanclass='nowrap'>`k3s agent --help`</span>. For convenience, that help text is presented here:
60
+
The `k3s server` and `k3s agent` commands have additional configuration options that can be viewed with <spanclass='nowrap'>`k3s server --help`</span> or <spanclass='nowrap'>`k3s agent --help`</span>.
-[Customized Flags for Kubernetes Processes](#customized-flags-for-kubernetes-processes)
26
27
-[Experimental Options](#experimental-options)
27
28
-[Deprecated Options](#deprecated-options)
28
-
-[K3s Server Cli Help](#k3s-server-cli-help)
29
+
-[K3s Server Cli Help](#k3s-server-cli-help)
29
30
30
31
31
32
# Commonly Used Options
@@ -53,6 +54,40 @@ In this section, you'll learn how to configure the K3s server.
53
54
|`--write-kubeconfig value, -o` value |`K3S_KUBECONFIG_OUTPUT`| Write kubeconfig for admin client to this file |
54
55
|`--write-kubeconfig-mode` value |`K3S_KUBECONFIG_MODE`| Write kubeconfig with this [mode.](https://en.wikipedia.org/wiki/Chmod) The option to allow writing to the kubeconfig file is useful for allowing a K3s cluster to be imported into Rancher. An example value is 644. |
55
56
57
+
# Agent Options
58
+
59
+
K3s agent options are available as server options because the server has the agent process embedded within.
60
+
61
+
### Agent Nodes
62
+
63
+
| Flag | Environment Variable | Description |
64
+
|------|----------------------|-------------|
65
+
|`--node-name` value |`K3S_NODE_NAME`| Node name |
66
+
| `--with-node-id` | N/A | Append id to node name | (agent/node)
67
+
|`--node-label` value | N/A | Registering and starting kubelet with set of labels |
68
+
|`--node-taint` value | N/A | Registering kubelet with set of taints |
69
+
70
+
### Agent Runtime
71
+
72
+
| Flag | Default | Description |
73
+
|------|---------|-------------|
74
+
| `--docker` | N/A | Use docker instead of containerd | (agent/runtime)
75
+
|`--container-runtime-endpoint` value | N/A | Disable embedded containerd and use alternative CRI implementation |
76
+
|`--pause-image` value | "docker.io/rancher/pause:3.1" | Customized pause image for containerd or Docker sandbox |
77
+
|`--private-registry` value | "/etc/rancher/k3s/registries.yaml" | Private registry configuration file |
78
+
79
+
### Agent Networking
80
+
81
+
the agent options are there because the server has the agent process embedded within
82
+
83
+
| Flag | Environment Variable | Description |
84
+
|------|----------------------|-------------|
85
+
|`--node-ip value, -i` value | N/A | IP address to advertise for node |
86
+
|`--node-external-ip` value | N/A | External IP address to advertise for node |
87
+
|`--resolv-conf` value |`K3S_RESOLV_CONF`| Kubelet resolv.conf file |
88
+
|`--flannel-iface` value | N/A | Override default flannel interface |
@@ -171,7 +178,7 @@ In this section, you'll learn how to configure the K3s server.
171
178
|`--cluster-secret` value |`K3S_CLUSTER_SECRET`| Use --token |
172
179
173
180
174
-
###K3s Server CLI Help
181
+
# K3s Server CLI Help
175
182
176
183
> If an option appears in brackets below, for example `[$K3S_TOKEN]`, it means that the option can be passed in as an environment variable of that name.
0 commit comments