Skip to content

Commit 0d2f2fe

Browse files
Iheanacho-aiIheanacho-ai
committed
docs: add v1.14
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
1 parent f5f5918 commit 0d2f2fe

286 files changed

Lines changed: 53443 additions & 262 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Makefile‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ docs.json: common.yaml omni.yaml ## Generate and validate docs.json from multipl
4949
talos-v1.9.yaml \
5050
talos-v1.8.yaml \
5151
talos-v1.7.yaml \
52-
talos-v1.6.yaml \
5352
omni.yaml \
5453
kubernetes-guides.yaml \
5554
changelog.yaml \
@@ -65,7 +64,6 @@ docs.json-local: common.yaml omni.yaml docs-gen/main.go ## Generate docs.json us
6564
../talos-v1.9.yaml \
6665
../talos-v1.8.yaml \
6766
../talos-v1.7.yaml \
68-
../talos-v1.6.yaml \
6967
../omni.yaml \
7068
../kubernetes-guides.yaml \
7169
../changelog.yaml \
@@ -82,7 +80,6 @@ check-missing: ## Check for MDX files not included in config files
8280
talos-v1.9.yaml \
8381
talos-v1.8.yaml \
8482
talos-v1.7.yaml \
85-
talos-v1.6.yaml \
8683
omni.yaml \
8784
kubernetes-guides.yaml \
8885
changelog.yaml
@@ -98,7 +95,6 @@ check-missing-local: ## Check for missing files using local Go build
9895
../talos-v1.9.yaml \
9996
../talos-v1.8.yaml \
10097
../talos-v1.7.yaml \
101-
../talos-v1.6.yaml \
10298
../omni.yaml \
10399
../kubernetes-guides.yaml \
104100
../changelog.yaml

‎public/docs.json‎

Lines changed: 0 additions & 258 deletions
Original file line numberDiff line numberDiff line change
@@ -2329,264 +2329,6 @@
23292329
]
23302330
}
23312331
]
2332-
},
2333-
{
2334-
"version": "v1.6",
2335-
"groups": [
2336-
{
2337-
"group": "Overview",
2338-
"pages": [
2339-
"talos/v1.6/overview/what-is-talos"
2340-
]
2341-
},
2342-
{
2343-
"group": "Getting Started",
2344-
"pages": [
2345-
"talos/v1.6/getting-started/system-requirements",
2346-
"talos/v1.6/getting-started/talosctl",
2347-
"talos/v1.6/getting-started/quickstart",
2348-
"talos/v1.6/getting-started/getting-started",
2349-
"talos/v1.6/getting-started/prodnotes",
2350-
"talos/v1.6/getting-started/deploy-first-workload",
2351-
"talos/v1.6/getting-started/what's-new-in-talos",
2352-
"talos/v1.6/getting-started/support-matrix"
2353-
]
2354-
},
2355-
{
2356-
"group": "Platform specific installation",
2357-
"pages": [
2358-
{
2359-
"group": "Bare Metal Platforms",
2360-
"pages": [
2361-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/digital-rebar",
2362-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/equinix-metal",
2363-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/iso",
2364-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/matchbox",
2365-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/network-config",
2366-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/pxe",
2367-
"talos/v1.6/platform-specific-installations/bare-metal-platforms/secureboot"
2368-
]
2369-
},
2370-
{
2371-
"group": "Virtualized Platforms",
2372-
"pages": [
2373-
"talos/v1.6/platform-specific-installations/virtualized-platforms/hyper-v",
2374-
"talos/v1.6/platform-specific-installations/virtualized-platforms/kvm",
2375-
"talos/v1.6/platform-specific-installations/virtualized-platforms/proxmox",
2376-
"talos/v1.6/platform-specific-installations/virtualized-platforms/vagrant-libvirt",
2377-
"talos/v1.6/platform-specific-installations/virtualized-platforms/vmware",
2378-
"talos/v1.6/platform-specific-installations/virtualized-platforms/xen"
2379-
]
2380-
},
2381-
{
2382-
"group": "Cloud Platforms",
2383-
"pages": [
2384-
"talos/v1.6/platform-specific-installations/cloud-platforms/aws",
2385-
"talos/v1.6/platform-specific-installations/cloud-platforms/azure",
2386-
"talos/v1.6/platform-specific-installations/cloud-platforms/digitalocean",
2387-
"talos/v1.6/platform-specific-installations/cloud-platforms/exoscale",
2388-
"talos/v1.6/platform-specific-installations/cloud-platforms/gcp",
2389-
"talos/v1.6/platform-specific-installations/cloud-platforms/hetzner",
2390-
"talos/v1.6/platform-specific-installations/cloud-platforms/nocloud",
2391-
"talos/v1.6/platform-specific-installations/cloud-platforms/openstack",
2392-
"talos/v1.6/platform-specific-installations/cloud-platforms/oracle",
2393-
"talos/v1.6/platform-specific-installations/cloud-platforms/scaleway",
2394-
"talos/v1.6/platform-specific-installations/cloud-platforms/upcloud",
2395-
"talos/v1.6/platform-specific-installations/cloud-platforms/vultr"
2396-
]
2397-
},
2398-
{
2399-
"group": "Local Platforms",
2400-
"pages": [
2401-
"talos/v1.6/platform-specific-installations/local-platforms/docker",
2402-
"talos/v1.6/platform-specific-installations/local-platforms/qemu",
2403-
"talos/v1.6/platform-specific-installations/local-platforms/virtualbox"
2404-
]
2405-
},
2406-
{
2407-
"group": "Single Board Computers",
2408-
"pages": [
2409-
"talos/v1.6/platform-specific-installations/single-board-computers/bananapi_m64",
2410-
"talos/v1.6/platform-specific-installations/single-board-computers/nanopi_r4s",
2411-
"talos/v1.6/platform-specific-installations/single-board-computers/jetson_nano",
2412-
"talos/v1.6/platform-specific-installations/single-board-computers/libretech_all_h3_cc_h5",
2413-
"talos/v1.6/platform-specific-installations/single-board-computers/pine64",
2414-
"talos/v1.6/platform-specific-installations/single-board-computers/rock64",
2415-
"talos/v1.6/platform-specific-installations/single-board-computers/rockpi_4",
2416-
"talos/v1.6/platform-specific-installations/single-board-computers/rockpi_4c",
2417-
"talos/v1.6/platform-specific-installations/single-board-computers/rpi_generic"
2418-
]
2419-
},
2420-
"talos/v1.6/platform-specific-installations/boot-assets",
2421-
"talos/v1.6/platform-specific-installations/air-gapped",
2422-
"talos/v1.6/platform-specific-installations/omni"
2423-
]
2424-
},
2425-
{
2426-
"group": "Deploying and managing workloads",
2427-
"pages": [
2428-
"talos/v1.6/deploy-and-manage-workloads/interactive-dashboard",
2429-
"talos/v1.6/deploy-and-manage-workloads/scaling-up",
2430-
"talos/v1.6/deploy-and-manage-workloads/scaling-down",
2431-
"talos/v1.6/deploy-and-manage-workloads/workers-on-controlplane"
2432-
]
2433-
},
2434-
{
2435-
"group": "Networking",
2436-
"pages": [
2437-
"talos/v1.6/networking/advanced-networking",
2438-
"talos/v1.6/networking/corporate-proxies",
2439-
"talos/v1.6/networking/egress-domains",
2440-
"talos/v1.6/networking/ingress-firewall",
2441-
"talos/v1.6/networking/kubespan",
2442-
"talos/v1.6/networking/metal-network-configuration",
2443-
"talos/v1.6/networking/device-selector",
2444-
"talos/v1.6/networking/predictable-interface-names",
2445-
"talos/v1.6/networking/siderolink",
2446-
"talos/v1.6/networking/vip",
2447-
"talos/v1.6/networking/wireguard-network"
2448-
]
2449-
},
2450-
{
2451-
"group": "Security",
2452-
"pages": [
2453-
"talos/v1.6/security/cert-management",
2454-
"talos/v1.6/security/certificate-authorities",
2455-
"talos/v1.6/security/iam-roles-for-service-accounts",
2456-
"talos/v1.6/security/machine-config-oauth",
2457-
"talos/v1.6/security/rbac",
2458-
"talos/v1.6/security/verifying-images"
2459-
]
2460-
},
2461-
{
2462-
"group": "Build and extend Talos",
2463-
"pages": [
2464-
{
2465-
"group": "Custom Images \u0026 Development",
2466-
"pages": [
2467-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/building-images",
2468-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/proprietary-kernel-modules",
2469-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/customizing-the-kernel",
2470-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/developing-talos",
2471-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/extension-services",
2472-
"talos/v1.6/build-and-extend-talos/custom-images-and-development/system-extensions"
2473-
]
2474-
},
2475-
{
2476-
"group": "Cluster Operations \u0026 Maintenance",
2477-
"pages": [
2478-
"talos/v1.6/build-and-extend-talos/cluster-operations-and-maintenance/disaster-recovery",
2479-
"talos/v1.6/build-and-extend-talos/cluster-operations-and-maintenance/etcd-maintenance"
2480-
]
2481-
}
2482-
]
2483-
},
2484-
{
2485-
"group": "Configure your Talos cluster",
2486-
"pages": [
2487-
{
2488-
"group": "System Configuration",
2489-
"pages": [
2490-
"talos/v1.6/configure-your-talos-cluster/system-configuration/patching",
2491-
"talos/v1.6/configure-your-talos-cluster/system-configuration/editing-machine-configuration",
2492-
"talos/v1.6/configure-your-talos-cluster/system-configuration/discovery",
2493-
"talos/v1.6/configure-your-talos-cluster/system-configuration/reproducible-machine-configuration",
2494-
"talos/v1.6/configure-your-talos-cluster/system-configuration/insecure"
2495-
]
2496-
},
2497-
{
2498-
"group": "Images \u0026 Container Runtime",
2499-
"pages": [
2500-
"talos/v1.6/configure-your-talos-cluster/images-container-runtime/containerd",
2501-
"talos/v1.6/configure-your-talos-cluster/images-container-runtime/pull-through-cache",
2502-
"talos/v1.6/configure-your-talos-cluster/images-container-runtime/static-pods"
2503-
]
2504-
},
2505-
{
2506-
"group": "Storage \u0026 Disk Management",
2507-
"pages": [
2508-
"talos/v1.6/configure-your-talos-cluster/storage-and-disk-management/disk-encryption"
2509-
]
2510-
},
2511-
{
2512-
"group": "Logging \u0026 Telemetry",
2513-
"pages": [
2514-
"talos/v1.6/configure-your-talos-cluster/logging-and-telemetry/logging"
2515-
]
2516-
},
2517-
{
2518-
"group": "Hardware \u0026 Drivers",
2519-
"pages": [
2520-
"talos/v1.6/configure-your-talos-cluster/hardware-and-drivers/nvidia-fabricmanager",
2521-
"talos/v1.6/configure-your-talos-cluster/hardware-and-drivers/nvidia-gpu",
2522-
"talos/v1.6/configure-your-talos-cluster/hardware-and-drivers/nvidia-gpu-proprietary"
2523-
]
2524-
},
2525-
{
2526-
"group": "Lifecycle Management",
2527-
"pages": [
2528-
"talos/v1.6/configure-your-talos-cluster/lifecycle-management/upgrading-talos",
2529-
"talos/v1.6/configure-your-talos-cluster/lifecycle-management/resetting-a-machine"
2530-
]
2531-
}
2532-
]
2533-
},
2534-
{
2535-
"group": "Advanced guides",
2536-
"pages": [
2537-
"talos/v1.6/advanced-guides/migrating-from-kubeadm"
2538-
]
2539-
},
2540-
{
2541-
"group": "Reference",
2542-
"pages": [
2543-
"talos/v1.6/reference/configuration/overview",
2544-
"talos/v1.6/reference/configuration/v1alpha1/config",
2545-
"talos/v1.6/reference/kernel",
2546-
"talos/v1.6/reference/cli",
2547-
"talos/v1.6/reference/api",
2548-
"talos/v1.6/reference/configuration/siderolink/siderolinkconfig",
2549-
{
2550-
"group": "Network",
2551-
"pages": [
2552-
"talos/v1.6/reference/configuration/network/networkdefaultactionconfig",
2553-
"talos/v1.6/reference/configuration/network/networkruleconfig"
2554-
]
2555-
},
2556-
{
2557-
"group": "Runtime",
2558-
"pages": [
2559-
"talos/v1.6/reference/configuration/runtime/eventsinkconfig",
2560-
"talos/v1.6/reference/configuration/runtime/kmsglogconfig"
2561-
]
2562-
}
2563-
]
2564-
},
2565-
{
2566-
"group": "Troubleshooting and support",
2567-
"pages": [
2568-
"talos/v1.6/troubleshooting/troubleshooting",
2569-
"talos/v1.6/troubleshooting/faqs"
2570-
]
2571-
},
2572-
{
2573-
"group": "Learn more",
2574-
"pages": [
2575-
"talos/v1.6/learn-more/architecture",
2576-
"talos/v1.6/learn-more/components",
2577-
"talos/v1.6/learn-more/control-plane",
2578-
"talos/v1.6/learn-more/controllers-resources",
2579-
"talos/v1.6/learn-more/image-factory",
2580-
"talos/v1.6/learn-more/knowledge-base",
2581-
"talos/v1.6/learn-more/kubespan",
2582-
"talos/v1.6/learn-more/networking-resources",
2583-
"talos/v1.6/learn-more/philosophy",
2584-
"talos/v1.6/learn-more/process-capabilities",
2585-
"talos/v1.6/learn-more/talos-network-connectivity",
2586-
"talos/v1.6/learn-more/talosctl"
2587-
]
2588-
}
2589-
]
25902332
}
25912333
]
25922334
},

‎public/talos/v1.14/advanced-guides/SBOM.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: "SBOMs"
3+
description: "A guide on using Software Bill of Materials for Talos Linux."
4+
---
5+
6+
import { VersionWarningBanner } from "/snippets/version-warning-banner.jsx"
7+
8+
<VersionWarningBanner />
9+
10+
import { release_v1_13 } from '/snippets/custom-variables.mdx';
11+
12+
Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building a software product.
13+
SBOMs are used to provide transparency and traceability of software components, which is essential for security, compliance, and efficient management of software supply chains.
14+
15+
Talos Linux provides SBOMs for core operating system components, including the Linux kernel, built-in components like `containerd`, and other software packages used to build Talos Linux.
16+
When a system extension is installed, it can also provide its own SBOM, which will be included in the overall SBOM for the Talos Linux system.
17+
18+
## Acquiring SBOMs
19+
20+
SBOMs for Talos Linux are provided in SPDX format, which is a standard format for representing SBOMs.
21+
You can acquire SBOMs for Talos Linux in the following ways:
22+
23+
* Download the SBOM for a specific Talos Linux release from the <a href={`https://github.com/siderolabs/talos/releases/tag/${release_v1_13}`}> GitHub release</a> page:
24+
* `talos-amd64.spdx.json` for the amd64 architecture.
25+
* `talos-arm64.spdx.json` for the arm64 architecture.
26+
* Acquire the SBOM from a running Talos Linux system using the `talosctl` command:
27+
* core Talos Linux SBOM in the `/usr/share/spdx` directory.
28+
* extension SBOMs in the `/usr/local/share/spdx` directory.
29+
30+
## SBOMs as resources
31+
32+
Talos Linux SBOMs are also available as resources in the Talos Linux system.
33+
You can access the SBOMs using the `talosctl` command:
34+
35+
<CodeBlock lang="sh">
36+
{`
37+
talosctl get sboms
38+
NODE NAMESPACE TYPE ID VERSION VERSION LICENSE
39+
172.20.0.2 runtime SBOMItem Talos 1 ${release_v1_13}
40+
172.20.0.2 runtime SBOMItem apparmor 1 v3.1.7 GPL-2.0-or-later
41+
172.20.0.2 runtime SBOMItem cel.dev/expr 1 v0.24.0
42+
...
43+
`}
44+
</CodeBlock>
45+
46+
You can also get the SBOM for a specific component using the `talosctl get sbom` command:
47+
48+
```yaml
49+
# talosctl get sbom kernel -o yaml
50+
node: 172.20.0.2
51+
metadata:
52+
namespace: runtime
53+
type: SBOMItems.talos.dev
54+
id: kernel
55+
version: 1
56+
owner: runtime.SBOMItemController
57+
phase: running
58+
created: 2025-07-24T14:20:29Z
59+
updated: 2025-07-24T14:20:29Z
60+
spec:
61+
name: kernel
62+
version: 6.12.38
63+
license: GPL-2.0-only
64+
cpes:
65+
- cpe:2.3:o:linux:linux_kernel:6.12.38:*:*:*:*:*:*:*
66+
```
67+
68+
## Scanning SBOMs
69+
70+
You can scan SBOMs for known vulnerabilities using tools like [Grype](https://github.com/anchore/grype).
71+
You will need two source files for scanning:
72+
73+
* The SBOM file in SPDX format.
74+
* The vulnerability exclusion database (VEX).
75+
76+
VEX database is used to filter out vulnerabilities that are not applicable to the specific software version or configuration,
77+
which helps to reduce false positives in vulnerability scanning.
78+
79+
<Note> The VEX database is available to Enterprise customers of Talos Linux. Contact [Sidero support](https://www.siderolabs.com/contact/) for access. </Note>
80+
81+
The basic command to scan the SBOM is as follows:
82+
83+
```bash
84+
grype sbom:talos-amd64.spdx.json
85+
```
86+
87+
With VEX database, the command becomes:
88+
89+
```bash
90+
grype sbom:talos-amd64.spdx.json --vex vex.json
91+
```

0 commit comments

Comments
 (0)