Andrey Smirnov 46121c9fec
docs: rework machine config documentation generation
Generate a structured table of contents following the structure of the
config.

Make high-level examples follow the full structure of the config.

Document new multi-doc machine config.

Fixes #8023

Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
2023-12-08 14:16:40 +04:00

775 B

description, title
description title
KmsgLogConfig is a event sink config document. KmsgLogConfig

{{< highlight yaml >}} apiVersion: v1alpha1 kind: KmsgLogConfig name: remote-log # Name of the config document. url: tcp://192.168.3.7:3478/ # The URL encodes the log destination. {{< /highlight >}}

Field Type Description Value(s)
name string Name of the config document.
url URL
The URL encodes the log destination.The scheme must be tcp:// or udp://.
The path must be empty.
The port is required.
Show example(s){{< highlight yaml >}}
url: udp://10.3.7.3:2810
{{< /highlight >}}