Skip to content

Commit

Permalink
docs: fork docs for v1.3
Browse files Browse the repository at this point in the history
Now master docs are generate for v1.3.0.

Signed-off-by: Andrey Smirnov <[email protected]>
  • Loading branch information
smira committed Sep 2, 2022
1 parent 0847400 commit cd6c53a
Show file tree
Hide file tree
Showing 126 changed files with 23,541 additions and 119 deletions.
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -814,9 +814,9 @@ RUN protoc \
/protos/time/*.proto

FROM scratch AS docs
COPY --from=docs-build /tmp/configuration.md /website/content/v1.2/reference/
COPY --from=docs-build /tmp/cli.md /website/content/v1.2/reference/
COPY --from=proto-docs-build /tmp/api.md /website/content/v1.2/reference/
COPY --from=docs-build /tmp/configuration.md /website/content/v1.3/reference/
COPY --from=docs-build /tmp/cli.md /website/content/v1.3/reference/
COPY --from=proto-docs-build /tmp/api.md /website/content/v1.3/reference/

# The talosctl-cni-bundle builds the CNI bundle for talosctl.

Expand Down
114 changes: 1 addition & 113 deletions hack/release.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ github_repo = "siderolabs/talos"
match_deps = "^github.com/((talos-systems|siderolabs)/[a-zA-Z0-9-]+)$"

# previous release
# TODO: frezbo: remove once we have 1.2.0 release
previous = "v1.2.0-beta.0"
previous = "v1.2.0"

pre_release = true

Expand All @@ -19,118 +18,7 @@ preface = """\
[notes.updates]
title = "Component Updates"
description="""\
* containerd: 1.6.8
* runc: v1.1.4
* Linux: 5.15.64
* Kubernetes: v1.25.0
* Flannel: v0.19.2
"""

[notes.track-cli-action-progress]
title = "Tracking progress of shutdown, reboot, reset and upgrade from CLI"
description = """\
`talosctl` subcommands `shutdown`, `reboot`, `reset` and `upgrade` now have a new flag `--wait` to
wait until the operation is completed, displaying information on the current status of each node.
A new `--debug` flag is added to these commands to get the kernel logs output from these nodes if the operation fails.
![track-cli-action-progress](https://www.talos.dev/images/track-reboot.gif)
"""

[notes.talos-config-kernel-param-variable-substitution]
title = "Variable substitution for URL query parameter in the talos.config kernel parameter"
description="""\
The kernel parameter talos.config can now substitute system information into placeholders inside its URL query values. This example shows all supported variables:
```http://example.com/metadata?h=${hostname}&m=${mac}&s=${serial}&u=${uuid}```
"""

[notes.strategic-merge]
title = "Strategic merge machine configuration patching"
description="""\
In addition to JSON (RFC6902) patches Talos now supports [strategic merge patching](https://www.talos.dev/v1.2/talos-guides/configuration/patching/).
For example, machine hostname can be set with the following patch:
```yaml
machine:
network:
hostname: worker1
```
Patch format is detected automatically.
"""

[notes.gen-secrets-from-pki]
title = "Generating Talos secrets from PKI directory"
description="""\
It is now possible to generate a secrets bundle from a Kubernetes PKI directory (e.g. `/etc/kubernetes/pki`).
You can also specify a bootstrap token to be used in the secrets bundle.
This secrets bundle can then be used to generate a machine config.
This facilitates migrating clusters (e.g. created using `kubeadm`) to Talos.
```
talosctl gen secrets --kubernetes-bootstrap-token znzio1.1ifu15frz7jd59pv --from-kubernetes-pki /etc/kubernetes/pki
talosctl gen config --with-secrets secrets.yaml my-cluster https://172.20.0.1:6443
```
"""

[notes.packet-capture]
title = "Packet Capture"
description="""\
Talos now supports capturing packets on a network interface with `talosctl pcap` command:
talosctl pcap --interface eth0
"""

[notes.stable-hostname]
title = "Stable Default Hostname"
description="""\
Talos now generates the default hostname (when there is no explicitly specified hostname) for the nodes based on the
node id (e.g. `talos-2gd-76y`) instead of using the DHCP assigned IP address (e.g. `talos-172-20-0-2`).
This ensures that the node hostname is not changed when DHCP assigns a new IP to a node.
Please note: the stable hostname generation algorithm changed between v1.2.0-beta.0 and v1.2.0-beta.1, please take care when upgrading
from versions >= 1.2.0-alpha.1 to versions >= 1.2.0-beta.1 when using stable default hostname feature.
"""

[notes.kubespan-kubernetes-nets]
title = "KubeSpan Kubernetes Network Advertisement"
description="""\
KubeSpan no longer by default advertises Kubernetes pod networks of the node over KubeSpan.
This means that CNI should handle encapsulation of pod-to-pod traffic into the node-to-node tunnel,
and node-to-node traffic will be handled by KubeSpan.
This provides better compatibility with popular CNIs like Calico and Cilium.
Old behavior can be restored by setting `.machine.kubespan.advertiseKubernetesNetworks = true` in the machine config.
"""

[notes.kubernetes-discovery]
title = "Kubernetes Discovery Backend"
description="""\
Kubernetes cluster discovery backend is now disabled by default for new clusters.
This backend doesn't provide any benefits over the Discovery Service based backend, while it
causes issues for KubeSpan enabled clusters when control plane endpoint is KubeSpan-routed.
For air-gapped installations when the Discovery Service is not enabled, Kubernetes Discovery Backend can be enabled by applying
the following machine configuration patch:
```yaml
cluster:
discovery:
registries:
kubernetes:
disabled: false
```
"""

[notes.apply-config]
title = "Apply Config Patches"
description="""\
`talosctl apply-config` now supports patching the machine config file in memory before submitting it to the node.
"""

[make_deps]
Expand Down
4 changes: 4 additions & 0 deletions website/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ offlineSearch = false
# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false

[[params.versions]]
url = "/v1.3/"
version = "v1.3 (pre-release)"

[[params.versions]]
url = "/v1.2/"
version = "v1.2 (latest)"
Expand Down
6 changes: 3 additions & 3 deletions website/content/v1.2/introduction/support-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ description: "Table of supported Talos Linux versions and respective platforms."

| Talos Version | 1.2 | 1.1 |
|----------------------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------|
| Release Date | 2022-09-01, TBD | 2022-06-22 (1.1.0) |
| End of Community Support | 1.3.0 release (2022-12-01, TBD) | 1.2.0 release (2022-09-01, TBD) |
| Release Date | 2022-09-01 | 2022-06-22 (1.1.0) |
| End of Community Support | 1.3.0 release (2022-12-01, TBD) | 1.2.0 release (2022-09-01) |
| Enterprise Support | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) | [offered by Sidero Labs Inc.](https://www.siderolabs.com/support/) |
| Kubernetes | 1.25, 1.24, 1.23 | 1.24, 1.23, 1.22 |
| Architecture | amd64, arm64 | amd64, arm64 |
Expand All @@ -19,7 +19,7 @@ description: "Table of supported Talos Linux versions and respective platforms."
| - local | Docker, QEMU | Docker, QEMU |
| **Cluster API** | | |
| [CAPI Bootstrap Provider Talos](https://github.com/siderolabs/cluster-api-bootstrap-provider-talos) | >= 0.5.5 | >= 0.5.3 |
| [CAPI Control Plane Provider Talos](https://github.com/siderolabs/cluster-api-control-plane-provider-talos) | >= 0.4.8 | >= 0.4.6 |
| [CAPI Control Plane Provider Talos](https://github.com/siderolabs/cluster-api-control-plane-provider-talos) | >= 0.4.9 | >= 0.4.6 |
| [Sidero](https://www.sidero.dev/) | >= 0.5.5 | >= 0.5.4 |
| **UI** | | |
| [Theila](https://github.com/siderolabs/theila) |||
Expand Down
57 changes: 57 additions & 0 deletions website/content/v1.3/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Welcome
no_list: true
linkTitle: "Documentation"
cascade:
type: docs
lastRelease: v1.3.0-alpha.0
kubernetesRelease: "v1.25.0"
prevKubernetesRelease: "1.25.0"
theilaRelease: "v0.2.1"
nvidiaContainerToolkitRelease: "v1.10.0"
nvidiaDriverRelease: "515.65.01"
preRelease: true
---

## Welcome

Welcome to the Talos documentation.
If you are just getting familiar with Talos, we recommend starting here:

- [What is Talos]({{< relref "introduction/what-is-talos" >}}): a quick description of Talos
- [Quickstart]({{< relref "introduction/quickstart" >}}): the fastest way to get a Talos cluster up and running
- [Getting Started]({{< relref "introduction/getting-started" >}}): a long-form, guided tour of getting a full Talos cluster deployed

## Open Source

### Community

- GitHub: [repo](https://github.com/siderolabs/talos)
- Slack: Join our [slack channel](https://slack.dev.talos-systems.io)
- Matrix: Join our Matrix channels:
- Community: [#talos:matrix.org](https://matrix.to/#/#talos:matrix.org)
- Support: [#talos-support:matrix.org](https://matrix.to/#/#talos-support:matrix.org)
- Support: Questions, bugs, feature requests [GitHub Discussions](https://github.com/siderolabs/talos/discussions)
- Forum: [community](https://groups.google.com/a/siderolabs.com/forum/#!forum/community)
- Twitter: [@SideroLabs](https://twitter.com/talossystems)
- Email: [[email protected]](mailto:[email protected])

If you're interested in this project and would like to help in engineering efforts, or have general usage questions, we are happy to have you!
We hold a weekly meeting that all audiences are welcome to attend.

We would appreciate your feedback so that we can make Talos even better!
To do so, you can take our [survey](https://docs.google.com/forms/d/1TUna5YTYGCKot68Y9YN_CLobY6z9JzLVCq1G7DoyNjA/edit).

### Office Hours

- When: Mondays at 16:30 UTC.
- Where: [Google Meet](https://meet.google.com/day-pxhv-zky).

You can subscribe to this meeting by joining the community forum above.

## Enterprise

If you are using Talos in a production setting, and need consulting services to get started or to integrate Talos into your existing environment, we can help.
Sidero Labs, Inc. offers support contracts with SLA (Service Level Agreement)-bound terms for mission-critical environments.

[Learn More](https://www.siderolabs.com/support/)
4 changes: 4 additions & 0 deletions website/content/v1.3/advanced/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Advanced Guides"
weight: 60
---
108 changes: 108 additions & 0 deletions website/content/v1.3/advanced/advanced-networking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
title: "Advanced Networking"
description: "How to configure advanced networking options on Talos Linux."
aliases:
- ../guides/advanced-networking
---

## Static Addressing

Static addressing is comprised of specifying `addresses`, `routes` ( remember to add your default gateway ), and `interface`.
Most likely you'll also want to define the `nameservers` so you have properly functioning DNS.

```yaml
machine:
network:
hostname: talos
nameservers:
- 10.0.0.1
interfaces:
- interface: eth0
addresses:
- 10.0.0.201/8
mtu: 8765
routes:
- network: 0.0.0.0/0
gateway: 10.0.0.1
- interface: eth1
ignore: true
time:
servers:
- time.cloudflare.com
```
## Additional Addresses for an Interface
In some environments you may need to set additional addresses on an interface.
In the following example, we set two additional addresses on the loopback interface.
```yaml
machine:
network:
interfaces:
- interface: lo
addresses:
- 192.168.0.21/24
- 10.2.2.2/24
```
## Bonding
The following example shows how to create a bonded interface.
```yaml
machine:
network:
interfaces:
- interface: bond0
dhcp: true
bond:
mode: 802.3ad
lacpRate: fast
xmitHashPolicy: layer3+4
miimon: 100
updelay: 200
downdelay: 200
interfaces:
- eth0
- eth1
```
## Setting Up a Bridge
The following example shows how to set up a bridge between two interfaces with an assigned static address.
```yaml
machine:
network:
interfaces:
- interface: br0
addresses:
- 192.168.0.42/24
bridge:
stp:
enabled: true
interfaces:
- eth0
- eth1
```
## VLANs
To setup vlans on a specific device use an array of VLANs to add.
The master device may be configured without addressing by setting dhcp to false.
```yaml
machine:
network:
interfaces:
- interface: eth0
dhcp: false
vlans:
- vlanId: 100
addresses:
- "192.168.2.10/28"
routes:
- network: 0.0.0.0/0
gateway: 192.168.2.1
```
Loading

0 comments on commit cd6c53a

Please sign in to comment.