Skip to content

Commit f47f80f

Browse files
committed
Say that K3s agent process is embedded in server process
1 parent 6e49f59 commit f47f80f

File tree

2 files changed

+41
-34
lines changed

2 files changed

+41
-34
lines changed

content/k3s/latest/en/installation/install-options/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Command | Description
5757
<span class='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.
5858
<span class='nowrap'>`k3s help`</span> | Shows a list of commands or help for one command
5959

60-
The `k3s server` and `k3s agent` commands have additional configuration options that can be viewed with <span class='nowrap'>`k3s server --help`</span> or <span class='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 <span class='nowrap'>`k3s server --help`</span> or <span class='nowrap'>`k3s agent --help`</span>.
6161

6262
### Registration Options for the K3s Server
6363

content/k3s/latest/en/installation/install-options/server-config/_index.md

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ In this section, you'll learn how to configure the K3s server.
1111
- [Database](#database)
1212
- [Cluster Options](#cluster-options)
1313
- [Client Options](#client-options)
14+
- [Agent Options](#agent-options)
15+
- [Agent Nodes](#agent-nodes)
16+
- [Agent Runtime](#agent-runtime)
17+
- [Agent Networking](#agent-networking)
1418
- [Advanced Options](#advanced-options)
1519
- [Logging](#logging)
1620
- [Listeners](#listeners)
@@ -19,13 +23,10 @@ In this section, you'll learn how to configure the K3s server.
1923
- [Customized Options](#customized-options)
2024
- [Storage Class](#storage-class)
2125
- [Kubernetes Components](#kubernetes-components)
22-
- [Registering Agents](#registering-agent-nodes)
23-
- [Registering Agent Runtime](#registering-agent-runtime)
24-
- [Registering Agent Networking](#registering-agent)
2526
- [Customized Flags for Kubernetes Processes](#customized-flags-for-kubernetes-processes)
2627
- [Experimental Options](#experimental-options)
2728
- [Deprecated Options](#deprecated-options)
28-
- [K3s Server Cli Help](#k3s-server-cli-help)
29+
- [K3s Server Cli Help](#k3s-server-cli-help)
2930

3031

3132
# Commonly Used Options
@@ -53,6 +54,40 @@ In this section, you'll learn how to configure the K3s server.
5354
| `--write-kubeconfig value, -o` value | `K3S_KUBECONFIG_OUTPUT` | Write kubeconfig for admin client to this file |
5455
| `--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. |
5556

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 |
89+
| `--flannel-conf` value | N/A | Override default flannel config file |
90+
5691
# Advanced Options
5792

5893
### Logging
@@ -115,34 +150,6 @@ In this section, you'll learn how to configure the K3s server.
115150
| `--disable-cloud-controller` | Disable k3s default cloud controller manager |
116151
| `--disable-network-policy` | Disable k3s default network policy controller |
117152

118-
### Registering Agent Nodes
119-
120-
| Flag | Environment Variable | Description |
121-
|------|----------------------|-------------|
122-
| `--node-name` value | `K3S_NODE_NAME` | Node name |
123-
| `--with-node-id` | N/A | Append id to node name | (agent/node)
124-
| `--node-label` value | N/A | Registering and starting kubelet with set of labels |
125-
| `--node-taint` value | N/A | Registering kubelet with set of taints |
126-
127-
### Registering Agent Runtime
128-
129-
| Flag | Default | Description |
130-
|------|---------|-------------|
131-
| `--docker` | N/A | Use docker instead of containerd | (agent/runtime)
132-
| `--container-runtime-endpoint` value | N/A | Disable embedded containerd and use alternative CRI implementation |
133-
| `--pause-image` value | "docker.io/rancher/pause:3.1" | Customized pause image for containerd or Docker sandbox |
134-
| `--private-registry` value | "/etc/rancher/k3s/registries.yaml" | Private registry configuration file |
135-
136-
### Registering Agent Networking
137-
138-
| Flag | Environment Variable | Description |
139-
|------|----------------------|-------------|
140-
| `--node-ip value, -i` value | N/A | IP address to advertise for node |
141-
| `--node-external-ip` value | N/A | External IP address to advertise for node |
142-
| `--resolv-conf` value | `K3S_RESOLV_CONF` | Kubelet resolv.conf file |
143-
| `--flannel-iface` value | N/A | Override default flannel interface |
144-
| `--flannel-conf` value | N/A | Override default flannel config file |
145-
146153
### Customized Flags for Kubernetes Processes
147154

148155
| Flag | Description |
@@ -171,7 +178,7 @@ In this section, you'll learn how to configure the K3s server.
171178
| `--cluster-secret` value | `K3S_CLUSTER_SECRET` | Use --token |
172179

173180

174-
### K3s Server CLI Help
181+
# K3s Server CLI Help
175182

176183
> 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.
177184

0 commit comments

Comments
 (0)