Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: provide documentation for Talos 1.6 #8071

Merged
merged 1 commit into from
Dec 15, 2023
Merged

Conversation

smira
Copy link
Member

@smira smira commented Dec 14, 2023

Updated lots of documentation with new/updated flows.

Provide What's New for Talos 1.6.0.

Update Troubleshooting guide to cover more steps.

Make Talos 1.6 docs the default.

@smira smira added this to the v1.7 milestone Dec 14, 2023
@smira

This comment was marked as resolved.

website/content/v1.6/_index.md Outdated Show resolved Hide resolved
@@ -27,11 +26,11 @@ If you are just getting familiar with Talos, we recommend starting here:
### Community

- GitHub: [repo](https://github.com/siderolabs/talos)
- Slack: Join our [slack channel](https://slack.dev.talos-systems.io)
- Support: Questions, bugs, feature requests [GitHub Discussions](https://github.com/siderolabs/talos/discussions)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

restructured to push people more to GitHub

@@ -1,449 +0,0 @@
---
title: "Troubleshooting Control Plane"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved into generic troubleshooting guide below

- the controlplane nodes
- the worker nodes

Talos enforces a high level of security by using mutual TLS for authentication and authorization.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was pretty strange document, and not sure what it adds to the stuff we already have

> Note: if you edit or patch the machine config on a running control plane node to set `allowSchedulingOnControlPlanes: true`, it will be applied immediately, but will not have any effect until the next reboot.
You may reboot the nodes via `talosctl reboot`.

You may also immediately make the control plane nodes schedulable by running the below:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talos now is reactive on that config change

@@ -19,7 +19,7 @@ As Talos Linux is fully contained in the UKI image, the full operating system is

## Acquiring the SecureBoot Assets

Sidero Labs is going to provide Talos images signed with the Sidero Labs Secureboot key in August 2023, but until then, you can use the following instructions to build your own.
Sidero Labs is going to provide Talos images signed with the Sidero Labs SecureBoot key early 2024 via [Image Factory]({{< relref "../../../learn-more/image-factory" >}}), but until then, you can use the following instructions to build your own.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤞

ghcr.io/siderolabs/gvisor:20231214.0-v1.5.0-beta.0
ghcr.io/siderolabs/intel-ucode:20230613
```shell
$ crane export ghcr.io/siderolabs/extensions:{{< release >}} | tar x -O image-digests | egrep 'gvisor|intel-ucode'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

modified the example to show full hashes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

egrep is kinda deprecated, grep -E please

## `hostPath` mounts

The simplest way to use local storage is to use `hostPath` mounts.
When using `hostPath` mounts, make sure the root directory of the mount is mounted into the `kubelet` container:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great long-overdue documentation ❤️

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I feel people are confused and think the minimum is to use OpenEBS

Copy link
Member

@utkuozdemir utkuozdemir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our docs seem to have leveled up 👍

Copy link
Member

@TimJones TimJones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/troubleshooting.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/what-is-new/index.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/what-is-new/index.md Outdated Show resolved Hide resolved
website/content/v1.6/introduction/what-is-new/index.md Outdated Show resolved Hide resolved
Updated lots of documentation with new/updated flows.

Provide What's New for Talos 1.6.0.

Update Troubleshooting guide to cover more steps.

Make Talos 1.6 docs the default.

Signed-off-by: Andrey Smirnov <[email protected]>
@smira
Copy link
Member Author

smira commented Dec 15, 2023

Thank you very much @TimJones, applied everything!

@smira
Copy link
Member Author

smira commented Dec 15, 2023

/m

@smira
Copy link
Member Author

smira commented Dec 15, 2023

/m

@smira smira merged commit d803e40 into siderolabs:main Dec 15, 2023
18 checks passed
If the initial boot requires firmware, a [custom ISO can be built]({{< relref "../../talos-guides/install/boot-assets" >}}) with the firmware included using the Image Factory service or using the `imager`.
This also ensures that the linux-firmware is not tied to a specific Talos version.

The list of firmware packages which are now available as extensions:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is confusing, we have more firmware as extensions, the list below is the ones we removed for 1.6

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I tried to say 'are now available' as extensions, in the sense they moved out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants