Skip to content

Commit c19cc4c

Browse files
steverfrancissmira
authored andcommitted
docs: clarify direct access needed to nodes in insecure mode
And some small updates. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
1 parent b4c871e commit c19cc4c

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

website/content/_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h3 class="display-4 text-center mb-3">Hardened</h3>
127127
<h3 class="display-4 text-center mb-3">Immutable</h3>
128128
<p class="text-center">
129129
Talos improves security further by mounting the root filesystem as
130-
read-only and removing any host-level such as a shell and SSH.
130+
read-only and removing host-level access tools such as a shell and SSH.
131131
</p>
132132
</div>
133133
<div class="col-12 col-lg-4 mb-3">

website/content/v1.8/introduction/getting-started.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,6 @@ The endpoint should be formatted like:
8181

8282
> NOTE: For a production cluster, you should have three control plane nodes, and have the endpoint allocate traffic to all three - see [Production Notes]({{< relref "prodnotes#control-plane-nodes" >}}).
8383
84-
## Accessing the Talos API
85-
86-
Administrative tasks are performed by calling the Talos API (usually with `talosctl`) on Talos Linux control plane nodes - thus, ensure your control
87-
plane node is directly reachable on TCP port 50000 from the workstation where you run the `talosctl` client.
88-
This may require changing firewall rules or cloud provider access-lists.
89-
90-
For production configurations, see [Production Notes]({{< relref "prodnotes#decide-the-kubernetes-endpoint" >}}).
91-
9284
## Configure Talos Linux
9385

9486
When Talos boots without a configuration, such as when booting off the Talos ISO, it
@@ -182,9 +174,24 @@ to reflect `vda` instead of `sda`.
182174

183175
> For information on customizing your machine configurations (such as to specify the version of Kubernetes), using [machine configuration patches]({{< relref "../talos-guides/configuration/patching" >}}), or customizing configurations for individual machines (such as setting static IP addresses), see the [Production Notes]({{< relref "prodnotes#customizing-machine-configuration" >}}).
184176

185-
## Understand talosctl, endpoints and nodes
177+
## Accessing the Talos API
178+
179+
Administrative tasks are performed by calling the Talos API (usually with `talosctl`) on Talos Linux control plane nodes, who may forward the requests to other nodes.
180+
Thus:
181+
182+
- ensure your control plane node is directly reachable on TCP port 50000 from the workstation where you run the `talosctl` client.
183+
- until a node is a member of the cluster, it does not have the PKI infrastructure set up, and so will not accept API requests that are proxied through a control plane node.
184+
185+
Thus you will need direct access to the **worker** nodes on port 50000 from the workstation where you run `talosctl` in order to apply the initial configuration.
186+
Once the cluster is established, you will no longer need port 50000 access to the workers.
187+
(You can avoid requiring such access by passing in the initial configuration in one of other methods, such as by cloud `userdata` or via `talos.config=` kernel argument on a `metal` platform)
188+
189+
This may require changing firewall rules or cloud provider access-lists.
190+
191+
For production configurations, see [Production Notes]({{< relref "prodnotes#decide-the-kubernetes-endpoint" >}}).
192+
193+
## Understand how talosctl treats endpoints and nodes
186194

187-
It is important to understand the concept of `endpoints` and `nodes`.
188195
In short: `endpoints` are where `talosctl` _sends_ commands to, but the command _operates_ on the specified `nodes`.
189196
The endpoint will forward the command to the nodes, if needed.
190197

@@ -247,7 +254,7 @@ Apply the `controlplane.yaml` file to the control plane node, and the `worker.ya
247254
The `--insecure` flag is necessary because the PKI infrastructure has not yet been made available to the node.
248255
Note: the connection _will_ be encrypted, but not authenticated.
249256

250-
When using the `--insecure` flag, it is not necessary to specify an endpoint.
257+
> When using the `--insecure` flag, you cannot specify an endpoint, and must directly access the node on port 50000.
251258

252259
### Default talosconfig configuration file
253260

0 commit comments

Comments
 (0)