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: website/content/v1.7/talos-guides/install/talosctl.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "talosctl"
3
-
description: "Install talos cli client."
3
+
description: "Install Talos Linux CLI"
4
4
---
5
5
6
6
## Recommended
@@ -32,7 +32,7 @@ It supports amd64 and arm64 architecture.
32
32
33
33
## Manual and Windows install
34
34
35
-
All versions can be manually downloaded from the [talos releases page](https://github.com/siderolabs/talos/releases/) including Linux, macOs, and Windows.
35
+
All versions can be manually downloaded from the [talos releases page](https://github.com/siderolabs/talos/releases/) including Linux, macOS, and Windows.
36
36
37
37
You will need to add the binary to a folder part of your executable `$PATH` to use it without providing the full path to the executable.
Copy file name to clipboardExpand all lines: website/content/v1.8/introduction/getting-started.md
+16-14
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This document will walk you through installing a simple Talos Cluster with a sin
8
8
9
9
> If this is your first use of Talos Linux, we recommend the [Quickstart]({{< relref "quickstart" >}}) first, to quickly create a local virtual cluster in containers on your workstation.
10
10
>
11
-
>For a production cluster, extra steps are needed - see [Production Notes]({{< relref "prodnotes" >}}).
11
+
>For a production cluster, extra steps are needed - see [Production Notes]({{< relref "prodnotes" >}}).
12
12
13
13
Regardless of where you run Talos, the steps to create a Kubernetes cluster are:
14
14
@@ -25,13 +25,15 @@ Regardless of where you run Talos, the steps to create a Kubernetes cluster are:
25
25
`talosctl` is a CLI tool which interfaces with the Talos API.
26
26
Talos Linux has no SSH access: `talosctl` is the tool you use to interact with the operating system on the machines.
27
27
28
-
Install `talosctl`before continuing:
28
+
You can download `talosctl`an MacOS and Linux via:
29
29
30
30
```bash
31
-
curl -sL https://talos.dev/install | sh
31
+
brew install siderolabs/tap/talosctl
32
32
```
33
33
34
-
> Note: If you boot systems off the ISO, Talos on the ISO image runs in RAM and acts as an installer.
34
+
For manually installation and other platform please see the [talosctl installation guide]({{< relref "../talos-guides/install/talosctl.md" >}}).
35
+
36
+
> Note: If you boot systems off the ISO, Talos on the ISO image runs in RAM and acts as an installer.
35
37
> The version of `talosctl` that is used to create the machine configurations controls the version of Talos Linux that is installed on the machines - NOT the image that the machines are initially booted off.
36
38
> For example, booting a machine off the Talos 1.3.7 ISO, but creating the initial configuration with `talosctl` binary of version 1.4.1, will result in a machine running Talos Linux version 1.4.1.
37
39
>
@@ -93,9 +95,9 @@ When Talos boots without a configuration, such as when booting off the Talos ISO
93
95
enters maintenance mode and waits for a configuration to be provided.
94
96
95
97
> A configuration can be passed in on boot via kernel parameters or metadata servers.
96
-
See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
98
+
> See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
97
99
98
-
Unlike traditional Linux, Talos Linux is *not* configured by SSHing to the server and issuing commands.
100
+
Unlike traditional Linux, Talos Linux is _not_ configured by SSHing to the server and issuing commands.
99
101
Instead, the entire state of the machine is defined by a `machine config` file which is passed to the server.
100
102
This allows machines to be managed in a declarative way, and lends itself to GitOps and modern operations paradigms.
101
103
The state of a machine is completely defined by, and can be reproduced from, the machine configuration file.
@@ -178,12 +180,12 @@ install:
178
180
179
181
to reflect `vda` instead of `sda`.
180
182
181
-
> 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" >}}).
183
+
> 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" >}}).
182
184
183
185
## Understand talosctl, endpoints and nodes
184
186
185
187
It is important to understand the concept of `endpoints` and `nodes`.
186
-
In short: `endpoints`are where `talosctl` *sends* commands to, but the command *operates* on the specified `nodes`.
188
+
In short: `endpoints`are where `talosctl` _sends_ commands to, but the command _operates_ on the specified `nodes`.
187
189
The endpoint will forward the command to the nodes, if needed.
188
190
189
191
### Endpoints
@@ -201,7 +203,7 @@ In this tutorial setup, the endpoint will always be the single control plane nod
201
203
202
204
Nodes are the target(s) you wish to perform the operation on.
203
205
204
-
> When specifying nodes, the IPs and/or hostnames are *as seen by the endpoint servers*, not as from the client.
206
+
> When specifying nodes, the IPs and/or hostnames are _as seen by the endpoint servers_, not as from the client.
205
207
> This is because all connections are proxied through the endpoints.
206
208
207
209
You may provide `-n` or `--nodes` to any `talosctl` command to supply the node or (comma-separated) nodes on which you wish to perform the operation.
@@ -212,7 +214,7 @@ For example, to see the containers running on node 192.168.0.200, by routing the
The client can be installed and updated via the [Homebrew package manager](https://brew.sh/) for macOS and Linux.
9
+
You will need to install `brew` and then you can install `talosctl` from the Sidero Labs tap.
10
+
11
+
```bash
12
+
brew install siderolabs/tap/talosctl
13
+
```
14
+
15
+
This will also keep your version of `talosctl` up to date with new releases.
16
+
This homebrew tap also has formulae for `omnictl` if you need to install that package.
17
+
18
+
> Note: Your `talosctl` version should match the version of Talos Linux you are running on a host.
19
+
> To install a specific version of `talosctl` with `brew` you can follow [this github issue](https://github.com/siderolabs/homebrew-tap/issues/75).
20
+
21
+
## Alternative install
22
+
23
+
You can automatically install the correct version of `talosctl` for your operating system and architecture with an installer script.
24
+
This script won't keep your version updated with releases and you will need to re-run the script to download a new version.
25
+
26
+
```bash
27
+
curl -sL https://talos.dev/install | sh
28
+
```
29
+
30
+
This script will work on macOS, Linux, and WSL on Windows.
31
+
It supports amd64 and arm64 architecture.
32
+
33
+
## Manual and Windows install
34
+
35
+
All versions can be manually downloaded from the [talos releases page](https://github.com/siderolabs/talos/releases/) including Linux, macOS, and Windows.
36
+
37
+
You will need to add the binary to a folder part of your executable `$PATH` to use it without providing the full path to the executable.
0 commit comments