Commit Graph

249 Commits

Author SHA1 Message Date
Fredrik Lönnegren e5490ae5b8 Add note about cloudinit synchronization
Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2025-10-10 10:17:00 +02:00
Eduardo Mínguez e908ef5c8d Add a note about selinux supportability 2025-09-15 15:49:16 +02:00
Scott Williams 4bf2ccee9e Fix typo for hostname in cloud-config example
Current docs have:

```
hostame: myserver
```

where it should be "hostname:"
2025-09-10 10:05:33 +02:00
Eduardo Mínguez 5c074eecd0 fix: Update 6.1 channels and how to find them 2025-09-10 10:01:25 +02:00
Francesco Giudici e95d9e3d20
LabelTemplates: fix IPv4/IPv6 released version (#476)
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-11 15:00:32 +02:00
Francesco Giudici e6b619732a make latest release button link absolute
to link always at the very latest release

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-10 12:36:50 +02:00
Francesco Giudici 71278bcc8d update operator latest version
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-10 12:36:50 +02:00
Francesco Giudici b59bf371e7 Troubleshoot: add Label Templates
document the "elemental-register dumpdata" command

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-10 10:09:41 +02:00
Francesco Giudici a84799b082 Label Templates: track version in which the label appears
Track the first Elemental release version from which the label has been
added. This will allow to easily identify which labels are available on
each elemental-register version.

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-10 10:09:41 +02:00
Francesco Giudici 6834c95205 networking: update nmc/nmstatectl link
update to latest available versions

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-10 10:09:41 +02:00
Francesco Giudici e864851de9 Declarative Networking: warn it's experimental
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-07-08 19:13:38 +02:00
David Cassany 1c50b76c46 Add release note regarding after-install-chroot not applicable in MachineRegistartion
Signed-off-by: David Cassany <dcassany@suse.com>
2025-07-02 17:30:56 +02:00
David Cassany d3689807f2 Update after-install-chroot note
Since elemental-register v1.7.x the note about using
after-install-chroot hook in MachineRegistration is not
correct anymore.

Signed-off-by: David Cassany <dcassany@suse.com>
2025-07-02 17:30:56 +02:00
Francesco Giudici a1b362cf1c release notes: sync 'next' version with stable one
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-06-23 12:05:27 +02:00
Francesco Giudici 1b59a53e53
Version examples directory to fix yaml examples (#470)
* Revert "Update registration example codeblock (#455)"

This reverts commit 2b7673685d.

* fix typo

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* 1.6 versioned examples folder

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* sed -i 's/@site\/examples/.\/examples/g' *md

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* 1.5 versioned examples folder

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* sed -i 's/@site\/examples/.\/examples/g' *md

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* 1.4 versioned examples folder

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* sed -i 's/@site\/examples/.\/examples/g' *md

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* 1.3 versioned examples folder

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* sed -i 's/@site\/examples/.\/examples/g' *md

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* 1.2 versioned examples folder

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* sed -i 's/@site\/examples/.\/examples/g' *md

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2025-06-13 14:22:15 +02:00
e-minguez e5f12efbc0 Replace immutable-rootfs with elemental-rootfs
Follow-up for https://github.com/rancher/elemental-toolkit/pull/2007
2025-06-03 18:52:34 +02:00
Fredrik Lönnegren 8146b166ea Add section on Finding images
Finding base sl-micro images for building custom-images.

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2025-06-03 10:54:47 +02:00
Fredrik Lönnegren 60bbc15a4a Update custom-images using latest versions
Adds a paragraph describing the image flavors in custom-images.md and
updates the versions of sl-micro to 6.0 for version 1.6 and 6.1 for the
next version.

Signed-off-by: Fredrik Lönnegren <fredrik.lonnegren@suse.com>
2025-06-03 10:54:47 +02:00
Meza 72bce3428f Remove extra white spaces
Signed-off-by: Meza <meza-xyz@proton.me>
2025-04-23 15:47:38 +02:00
David Cassany f6bef1f199 Update cloud-config reference docs
Signed-off-by: David Cassany <dcassany@suse.com>
2025-04-23 15:40:04 +02:00
Meza 6f84184e89
[Docs] Fix doc typos (#463)
* [Docs] Fix doc typos

Signed-off-by: Meza <meza-xyz@proton.me>

* Fix versioned_docs typos

Signed-off-by: Meza <meza-xyz@proton.me>

---------

Signed-off-by: Meza <meza-xyz@proton.me>
2025-04-22 10:30:37 +02:00
Dustin Groh cdde731593
Update quickstart-cli.md (#459)
Added a section to quickstart-cli to explain how to install the Elemental UI extension via CLI.
2025-02-07 11:42:15 +01:00
Francesco Giudici 16342fb021
HowTo: cover Rancher Provisioning IP options (#447)
* HowTo: sort topics lexicographically

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* HOWTO: cover Rancher Provisioning IP options

Share the Elemental way to configure the Internal and the External IP
addresses in K3s and RKE2

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-11-27 19:21:48 +01:00
Francesco Giudici 191aef1f58
Label Templates: document network ip address vars (#446)
* Label Templates/trivial: sort network variables

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* Label Templates: add ip address vars to the Network family

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-11-26 15:36:33 +01:00
Andrea Mazzotti b8e30ccb40
Document managedosimage lifecycle (#440)
* Mention ManagedOSImage expected lifecycle

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-11-26 09:59:26 +01:00
Andrea Mazzotti 2555fc22f0
Improve static network config (#438)
* Improve and backport static-network doc

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-11-26 09:45:46 +01:00
Andrea Mazzotti f90b531346
Document how to include Elemental UI extension (#437)
* Document how to include Elemental UI extension

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-11-12 13:47:21 +01:00
David Cassany Viladomat 28887107fc
Improving release notes visibility (#429)
* Improving release notes visibility

Signed-off-by: David Cassany <dcassany@suse.com>

* Fix typo

Signed-off-by: David Cassany <dcassany@suse.com>

---------

Signed-off-by: David Cassany <dcassany@suse.com>
2024-11-05 09:11:01 +00:00
David Cassany Viladomat f0281c3f87
Update custom installation docs (#425)
* Update custom installation docs

Signed-off-by: David Cassany <dcassany@suse.com>

* Update docs/custom-install.md

Co-authored-by: Andrea Mazzotti <andrea.mazzotti@suse.com>

* Fix Elemental client config file example

Signed-off-by: David Cassany <dcassany@suse.com>

* Use a non root user for the customization example

Signed-off-by: David Cassany <dcassany@suse.com>

* Apply changes to v1.6 docs too

Signed-off-by: David Cassany <dcassany@suse.com>

* Other Elemental partitions are essentially mounted under /run/elemental

Signed-off-by: David Cassany <dcassany@suse.com>

---------

Signed-off-by: David Cassany <dcassany@suse.com>
Co-authored-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-23 13:11:41 +02:00
Andrea Mazzotti d0f043a5f5
Document none Network Configurator option (#422)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-22 15:00:00 +02:00
David Cassany Viladomat 80167dfc1a
Add hooks docs for 1.6 and improve Next version (#421)
* Add hooks docs for 1.6 and improve Next version

This commit adds hooks documentation for version v1.6 and
it also improves the note explaining hooks usage in
MachineRegistration.config.cloud-config section

Signed-off-by: David Cassany <dcassany@suse.com>

* Add after-install-chroot in MachineRegistration example

Signed-off-by: David Cassany <dcassany@suse.com>

---------

Signed-off-by: David Cassany <dcassany@suse.com>
2024-10-21 15:53:39 +02:00
David Cassany Viladomat 70c0f83703
Update and simplify VMware docs (#413)
* Update and simplify VMware docs

Signed-off-by: David Cassany <dcassany@suse.com>

* Remove unused images

Signed-off-by: David Cassany <dcassany@suse.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Update docs/rancher-vmware.md

Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>

* Adapt versioned docs according to feedback

Signed-off-by: David Cassany <dcassany@suse.com>

---------

Signed-off-by: David Cassany <dcassany@suse.com>
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
2024-10-18 12:49:16 +02:00
David Cassany db4a37270a Add a note on how to provide installation hooks
Signed-off-by: David Cassany <dcassany@suse.com>
2024-10-10 12:20:34 +02:00
David Cassany Viladomat 7c718de34f Update docs/cloud-config-reference.md
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
2024-10-10 12:20:34 +02:00
David Cassany Viladomat 0eafc7e50d Update docs/cloud-config-reference.md
Co-authored-by: Francesco Giudici <francesco.giudici@gmail.com>
2024-10-10 12:20:34 +02:00
David Cassany 18d7aa2171 Adding documentation for hook stages
Signed-off-by: David Cassany <dcassany@suse.com>
2024-10-10 12:20:34 +02:00
Andrea Mazzotti 48df9cec13
Document how to install nmc or nmstatectl (#411)
* Document how to install nmc or nmstatectl

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-08 15:45:20 +02:00
Andrea Mazzotti 174d609d28
Document CA cert lifecycle (#407)
* Document CA cert lifecycle

Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-08 14:53:09 +02:00
Andrea Mazzotti 5834b443a9
Align documentation to net.ifnames=0 kernel arg (#410)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-08 14:48:37 +02:00
Andrea Mazzotti b4a3490bc0
Document custom partition size (#401)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-10-01 10:03:34 +02:00
Andrea Mazzotti afcdb5126f
Document snapshotter configuration (#398)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-09-25 14:41:16 +02:00
Andrea Mazzotti 9d4f1696eb
Document missing available UI extension (#373)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-09-24 07:59:33 +00:00
Francesco Giudici 5c616d6f9a
Label Templates: document machineInventoryAnnotations rendering (#380)
We now render also the machineInventoryAnnotations items: update the
docs.
While there, add some minor improvements to the Label Templates section.

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-09-24 07:16:51 +00:00
Francesco Giudici c8dd7d2158
Label Templates: document all the new available variables (#378)
* Label Templates: document new variables and update docs

* Label Templates: be coherent with feature naming.
Feature naming is "Label Templates".
Drop "template labels".
"templated labels" can be allowed.

* Label Templates: deprecate SMBIOS and Hardware labels

* Label Templates: add Storage Drive and Controller types

--------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-09-18 17:05:03 +02:00
Andrea Mazzotti 49d7bc1701
Actualize 1.6 channels (#375)
Signed-off-by: Andrea Mazzotti <andrea.mazzotti@suse.com>
2024-09-13 17:32:44 +02:00
Francesco Giudici 1157e5a9fc
channels: document the "registry" key (#371)
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-09-04 13:56:02 +00:00
Francesco Giudici 5c56154e25
Add 'System Annotations' table (#372)
* menu: drop SMBIOS/HW from the reference section
we now have them in the "Label Templates" section

* Improve Label Templates and MachineRegistration sections
fix also details which are no longer true or exact

* Add System Annotations table
add documentation about the annotations sent by the registering host
tracking live system data (OS, IP, etc.).

Add the arbitrary "System Annotations" name in order to be able to refer
them throughout the docs if needed.

---------

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-09-04 15:52:05 +02:00
David Cassany Viladomat 5b6b498801
Adds documentationf or pre-rootfs stage (#362)
Signed-off-by: David Cassany <dcassany@suse.com>
2024-09-03 15:20:57 +02:00
Francesco Giudici b70d808f62
label templates: document Random vars are rendered once (#370)
Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-08-30 06:56:18 +00:00
Francesco Giudici 2721f2b8ab
label templates: fix sanitization section (#369)
invalid chars are substituted with an hyphen, not an underscore:
fix the documentation

Fixes #365

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>
2024-08-30 08:53:55 +02:00