Skip to content

Commit

Permalink
docs: update getting-started.md
Browse files Browse the repository at this point in the history
Clarifies even further that Talos is loaded to RAM until configuration is applied.

See #10349

Signed-off-by: ihelmer07 <ihelmer07@gmail.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
  • Loading branch information
ihelmer07 authored and smira committed Feb 13, 2025
1 parent 94cf9fb commit 58661de
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
10 changes: 7 additions & 3 deletions website/content/v1.10/introduction/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,18 @@ The endpoint should be formatted like:
When Talos boots without a configuration, such as when booting off the Talos ISO, it
enters maintenance mode and waits for a configuration to be provided.

> A configuration can be passed in on boot via kernel parameters or metadata servers.
> See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
> NOTE: Talos initially loads the OS to RAM, and only installs to disk after the configuration is applied.
> If you reboot the machine before applying machine config, make sure your boot media is still present.
Unlike traditional Linux, Talos Linux is _not_ configured by SSHing to the server and issuing commands.
Instead, the entire state of the machine is defined by a `machine config` file which is passed to the server.
This allows machines to be managed in a declarative way, and lends itself to GitOps and modern operations paradigms.

The state of a machine is completely defined by, and can be reproduced from, the machine configuration file.

> A configuration can be passed in on boot via kernel parameters or metadata servers.
> See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
To generate the machine configurations for a cluster, run this command on the workstation where you installed `talosctl`:

```sh
Expand Down Expand Up @@ -158,7 +162,7 @@ You can verify which disks your nodes have by using the `talosctl get disks --in
For example, the `talosctl get disks` command below shows that the system has a `vda` drive, not an `sda`:

```sh
$ talosctl -n 192.168.0.2 disks --insecure
$ talosctl -n 192.168.0.2 get disks --insecure
DEV MODEL SERIAL TYPE UUID WWID MODALIAS NAME SIZE BUS_PATH
/dev/vda - - HDD - - virtio:d00000002v00001AF4 - 69 GB /pci0000:00/0000:00:06.0/virtio2/
```
Expand Down
8 changes: 6 additions & 2 deletions website/content/v1.9/introduction/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,18 @@ The endpoint should be formatted like:
When Talos boots without a configuration, such as when booting off the Talos ISO, it
enters maintenance mode and waits for a configuration to be provided.

> A configuration can be passed in on boot via kernel parameters or metadata servers.
> See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
> NOTE: Talos initially loads the OS to RAM, and only installs to disk after the configuration is applied.
> If you reboot the machine before applying machine config, make sure your boot media is still present.
Unlike traditional Linux, Talos Linux is _not_ configured by SSHing to the server and issuing commands.
Instead, the entire state of the machine is defined by a `machine config` file which is passed to the server.
This allows machines to be managed in a declarative way, and lends itself to GitOps and modern operations paradigms.

The state of a machine is completely defined by, and can be reproduced from, the machine configuration file.

> A configuration can be passed in on boot via kernel parameters or metadata servers.
> See [Production Notes]({{< relref "prodnotes#configure-talos" >}}).
To generate the machine configurations for a cluster, run this command on the workstation where you installed `talosctl`:

```sh
Expand Down

0 comments on commit 58661de

Please sign in to comment.