README
¶
Talos Linux
A modern OS for Kubernetes.
Talos is a modern OS for running Kubernetes: secure, immutable, and minimal. Talos is fully open source, production-ready, and supported by the people at Sidero Labs All system management is done via an API - there is no shell or interactive console. Benefits include:
- Security: Talos reduces your attack surface: It's minimal, hardened, and immutable. All API access is secured with mutual TLS (mTLS) authentication.
- Predictability: Talos eliminates configuration drift, reduces unknown factors by employing immutable infrastructure ideology, and delivers atomic updates.
- Evolvability: Talos simplifies your architecture, increases your agility, and always delivers current stable Kubernetes and Linux versions.
Documentation
For instructions on deploying and managing Talos, see the Documentation.
Community
- Slack: Join our slack channel
- Support: Questions, bugs, feature requests GitHub Discussions
- Forum: community
- Twitter: @SideroLabs
- Email: info@SideroLabs.com
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.
Office Hours
- When: Mondays at 16:30 UTC.
- Where: Google Meet.
You can subscribe to this meeting by joining the community forum above.
Note: You can convert the meeting hours to your local time.
Contributing
Contributions are welcomed and appreciated! See Contributing for our guidelines.
License
Some software we distribute is under the General Public License family of licenses or other licenses that require we provide you with the source code. If you would like a copy of the source code for this software, please contact us via email: info at SideroLabs.com.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
installer
command
Package installer provides the installer implementation.
|
Package installer provides the installer implementation. |
|
installer/cmd
Package cmd implements the installer command.
|
Package cmd implements the installer command. |
|
installer/pkg
Package pkg contains the installer cmd logic.
|
Package pkg contains the installer cmd logic. |
|
installer/pkg/install
Package install provides the installation routine.
|
Package install provides the installation routine. |
|
installer/pkg/ova
Package ova implements OVA creation.
|
Package ova implements OVA creation. |
|
talosctl
command
Package talosctl provides the talosctl utility implementation.
|
Package talosctl provides the talosctl utility implementation. |
|
talosctl/cmd
Package cmd provides the talosctl command implementation.
|
Package cmd provides the talosctl command implementation. |
|
talosctl/cmd/mgmt/cluster
Package cluster implements "cluster" subcommands.
|
Package cluster implements "cluster" subcommands. |
|
talosctl/cmd/mgmt/debug
Package debug implements "debug" subcommands.
|
Package debug implements "debug" subcommands. |
|
talosctl/cmd/mgmt/gen
Package gen implements the genration of various artifacts.
|
Package gen implements the genration of various artifacts. |
|
talosctl/cmd/talos/output
Package output provides writers in different formats.
|
Package output provides writers in different formats. |
|
talosctl/pkg/mgmt/helpers
Package helpers provides helpers for talosctl.
|
Package helpers provides helpers for talosctl. |
|
talosctl/pkg/talos/global
Package global provides global flags for talosctl.
|
Package global provides global flags for talosctl. |
|
internal
|
|
|
app/apid
Package apid implements apid functionality.
|
Package apid implements apid functionality. |
|
app/apid/pkg/backend
Package backend implements backends satisfying proxy.Backend interface
|
Package backend implements backends satisfying proxy.Backend interface |
|
app/apid/pkg/director
Package director provides proxy call routing facility
|
Package director provides proxy call routing facility |
|
app/apid/pkg/provider
Package provider provides TLS config for client & server.
|
Package provider provides TLS config for client & server. |
|
app/dashboard
Package dashboard implements dashboard functionality.
|
Package dashboard implements dashboard functionality. |
|
app/init
command
Package init implements booting process.
|
Package init implements booting process. |
|
app/machined
command
Package machined provides machined implementation.
|
Package machined provides machined implementation. |
|
app/machined/internal/server/v1alpha1
Package runtime provides the runtime implementation.
|
Package runtime provides the runtime implementation. |
|
app/machined/pkg/adapters/cluster
Package cluster implements adapters wrapping resources/cluster to provide additional functionality.
|
Package cluster implements adapters wrapping resources/cluster to provide additional functionality. |
|
app/machined/pkg/adapters/hardware
Package hardware implements adapters wrapping resources/hardware to provide additional functionality.
|
Package hardware implements adapters wrapping resources/hardware to provide additional functionality. |
|
app/machined/pkg/adapters/k8s
Package k8s implements adapters wrapping resources/k8s to provide additional functionality.
|
Package k8s implements adapters wrapping resources/k8s to provide additional functionality. |
|
app/machined/pkg/adapters/kubespan
Package kubespan implements adapters wrapping resources/kubespan to provide additional functionality.
|
Package kubespan implements adapters wrapping resources/kubespan to provide additional functionality. |
|
app/machined/pkg/adapters/network
Package network implements adapters wrapping resources/network to provide additional functionality.
|
Package network implements adapters wrapping resources/network to provide additional functionality. |
|
app/machined/pkg/adapters/perf
Package perf implements adapters wrapping resources/perf to provide additional functionality.
|
Package perf implements adapters wrapping resources/perf to provide additional functionality. |
|
app/machined/pkg/controllers
Package controllers provides common methods for controller operations.
|
Package controllers provides common methods for controller operations. |
|
app/machined/pkg/controllers/cluster
Package cluster provides controllers which manage Talos cluster resources.
|
Package cluster provides controllers which manage Talos cluster resources. |
|
app/machined/pkg/controllers/config
Package config provides controllers which manage config resources.
|
Package config provides controllers which manage config resources. |
|
app/machined/pkg/controllers/ctest
Package ctest provides basic types and functions for controller testing.
|
Package ctest provides basic types and functions for controller testing. |
|
app/machined/pkg/controllers/etcd
Package etcd provides controllers which manage etcd resources.
|
Package etcd provides controllers which manage etcd resources. |
|
app/machined/pkg/controllers/files
Package files provides controllers which manage file resources.
|
Package files provides controllers which manage file resources. |
|
app/machined/pkg/controllers/hardware
Package hardware provides the hardware controller implementation.
|
Package hardware provides the hardware controller implementation. |
|
app/machined/pkg/controllers/k8s
Package k8s provides controllers which manage Kubernetes resources.
|
Package k8s provides controllers which manage Kubernetes resources. |
|
app/machined/pkg/controllers/kubeaccess
Package kubeaccess provides controllers which manage Talos API access from Kubernetes workloads.
|
Package kubeaccess provides controllers which manage Talos API access from Kubernetes workloads. |
|
app/machined/pkg/controllers/kubespan
Package kubespan provides controllers which manage Talos KubeSpan feature.
|
Package kubespan provides controllers which manage Talos KubeSpan feature. |
|
app/machined/pkg/controllers/network
Package network provides controllers which manage network resources.
|
Package network provides controllers which manage network resources. |
|
app/machined/pkg/controllers/network/operator
Package operator implements network operators.
|
Package operator implements network operators. |
|
app/machined/pkg/controllers/network/operator/vip
Package vip contains implementations of specific methods to acquire/release virtual IPs.
|
Package vip contains implementations of specific methods to acquire/release virtual IPs. |
|
app/machined/pkg/controllers/network/watch
Package watch provides netlink watchers via multicast groups.
|
Package watch provides netlink watchers via multicast groups. |
|
app/machined/pkg/controllers/runtime
Package runtime provides the runtime implementation.
|
Package runtime provides the runtime implementation. |
|
app/machined/pkg/controllers/secrets
Package secrets provides controllers which manage secret resources.
|
Package secrets provides controllers which manage secret resources. |
|
app/machined/pkg/controllers/siderolink
Package siderolink provides controllers which manage file resources.
|
Package siderolink provides controllers which manage file resources. |
|
app/machined/pkg/controllers/time
Package time contains controllers managing time, synchronization, etc.
|
Package time contains controllers managing time, synchronization, etc. |
|
app/machined/pkg/controllers/v1alpha1
Package v1alpha1 provides controllers managing v1alpha1 resources.
|
Package v1alpha1 provides controllers managing v1alpha1 resources. |
|
app/machined/pkg/runtime
Package runtime defines interfaces for accessing runtime specific settings, and state.
|
Package runtime defines interfaces for accessing runtime specific settings, and state. |
|
app/machined/pkg/runtime/disk
Package disk contains abstract utility function to filter disks in MachineState.Disk call.
|
Package disk contains abstract utility function to filter disks in MachineState.Disk call. |
|
app/machined/pkg/runtime/logging
Package logging provides implementations of runtime.LoggingManager.
|
Package logging provides implementations of runtime.LoggingManager. |
|
app/machined/pkg/runtime/v1alpha1
Package v1alpha1 implements a `Runtime`.
|
Package v1alpha1 implements a `Runtime`. |
|
app/machined/pkg/runtime/v1alpha1/board
Package board provides the function to discover the current board.
|
Package board provides the function to discover the current board. |
|
app/machined/pkg/runtime/v1alpha1/board/bananapi_m64
Package bananapim64 provides the Banana Pi M64 board implementation.
|
Package bananapim64 provides the Banana Pi M64 board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/jetson_nano
Package jetsonnano provides the Jetson Nano board implementation.
|
Package jetsonnano provides the Jetson Nano board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/libretech_all_h3_cc_h5
Package libretechallh3cch5 provides the LibretechAllH3CCH5 board implementation.
|
Package libretechallh3cch5 provides the LibretechAllH3CCH5 board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/nanopi_r4s
Package nanopir4s provides the Nano Pi R4S board implementation.
|
Package nanopir4s provides the Nano Pi R4S board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/pine64
Package pine64 provides the Pine64 board implementation.
|
Package pine64 provides the Pine64 board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/rock64
Package rock64 provides the Pine64 Rock64 board implementation.
|
Package rock64 provides the Pine64 Rock64 board implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/rockpi4
Package rockpi4 provides the Radxa rock pi implementation.
|
Package rockpi4 provides the Radxa rock pi implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/rockpi4c
Package rockpi4c provides the Radxa rock pi implementation.
|
Package rockpi4c provides the Radxa rock pi implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/rpi_4
Package rpi4 provides the Raspberry Pi 4 Model B implementation.
|
Package rpi4 provides the Raspberry Pi 4 Model B implementation. |
|
app/machined/pkg/runtime/v1alpha1/board/rpi_generic
Package rpigeneric provides the Raspberry Pi Compute Module 4 implementation.
|
Package rpigeneric provides the Raspberry Pi Compute Module 4 implementation. |
|
app/machined/pkg/runtime/v1alpha1/bootloader
Package bootloader provides bootloader implementation.
|
Package bootloader provides bootloader implementation. |
|
app/machined/pkg/runtime/v1alpha1/bootloader/grub
Package grub provides the interface to the GRUB bootloader: config management, installation, etc.
|
Package grub provides the interface to the GRUB bootloader: config management, installation, etc. |
|
app/machined/pkg/runtime/v1alpha1/platform
Package platform provides functions to get the runtime.Platform.
|
Package platform provides functions to get the runtime.Platform. |
|
app/machined/pkg/runtime/v1alpha1/platform/aws
Package aws contains the AWS implementation of the [platform.Platform].
|
Package aws contains the AWS implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/azure
Package azure contains the Azure implementation of the [platform.Platform].
|
Package azure contains the Azure implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/container
Package container contains the Container implementation of the [platform.Platform].
|
Package container contains the Container implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/digitalocean
Package digitalocean contains the Digital Ocean implementation of the [platform.Platform].
|
Package digitalocean contains the Digital Ocean implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/equinixmetal
Package equinixmetal contains the Equinix Metal implementation of the [platform.Platform].
|
Package equinixmetal contains the Equinix Metal implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/errors
Package errors contains errors used by the platform package.
|
Package errors contains errors used by the platform package. |
|
app/machined/pkg/runtime/v1alpha1/platform/exoscale
Package exoscale contains the Exoscale platform implementation.
|
Package exoscale contains the Exoscale platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/gcp
Package gcp contains the GCP implementation of the [platform.Platform].
|
Package gcp contains the GCP implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/hcloud
Package hcloud contains the Hcloud implementation of the [platform.Platform].
|
Package hcloud contains the Hcloud implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/internal/address
Package address provides utility functions for address parsing.
|
Package address provides utility functions for address parsing. |
|
app/machined/pkg/runtime/v1alpha1/platform/internal/netutils
Package netutils provides network-related helpers for platform implementation.
|
Package netutils provides network-related helpers for platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/metal
Package metal contains the metal implementation of the [platform.Platform].
|
Package metal contains the metal implementation of the [platform.Platform]. |
|
app/machined/pkg/runtime/v1alpha1/platform/nocloud
Package nocloud provides the NoCloud platform implementation.
|
Package nocloud provides the NoCloud platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/openstack
Package openstack provides the Openstack platform implementation.
|
Package openstack provides the Openstack platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/oracle
Package oracle provides the Oracle platform implementation.
|
Package oracle provides the Oracle platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/scaleway
Package scaleway provides the Scaleway platform implementation.
|
Package scaleway provides the Scaleway platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/upcloud
Package upcloud provides the UpCloud platform implementation.
|
Package upcloud provides the UpCloud platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/vmware
Package vmware provides the VMware platform implementation.
|
Package vmware provides the VMware platform implementation. |
|
app/machined/pkg/runtime/v1alpha1/platform/vultr
Package vultr provides the Vultr platform implementation.
|
Package vultr provides the Vultr platform implementation. |
|
app/machined/pkg/runtime/v1alpha2
Package v1alpha2 provides runtime implementation based on os-runtime.
|
Package v1alpha2 provides runtime implementation based on os-runtime. |
|
app/machined/pkg/system/runner
Package runner provides a runner for running services.
|
Package runner provides a runner for running services. |
|
app/machined/pkg/system/services/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
app/resources
Package resources implements resources API server.
|
Package resources implements resources API server. |
|
app/storaged
Package internal contains server implementation.
|
Package internal contains server implementation. |
|
app/trustd/internal/provider
Package provider provides TLS config for client & server.
|
Package provider provides TLS config for client & server. |
|
app/wrapperd
Package wrapperd provides a wrapper for running services.
|
Package wrapperd provides a wrapper for running services. |
|
pkg/capability
Package capability provides utility functions to work with capabilities.
|
Package capability provides utility functions to work with capabilities. |
|
pkg/configuration
Package configuration implements configuration generation.
|
Package configuration implements configuration generation. |
|
pkg/console
Package console contains console-related functionality.
|
Package console contains console-related functionality. |
|
pkg/containers
Package containers provides the container implementatiom.
|
Package containers provides the container implementatiom. |
|
pkg/containers/containerd
Package containerd implements containers.Inspector via containerd API
|
Package containerd implements containers.Inspector via containerd API |
|
pkg/containers/cri
Package cri implements containers.Inspector via CRI
|
Package cri implements containers.Inspector via CRI |
|
pkg/containers/cri/containerd
Package containerd provides support for containerd CRI plugin
|
Package containerd provides support for containerd CRI plugin |
|
pkg/cri
Package cri provides minimal CRI client.
|
Package cri provides minimal CRI client. |
|
pkg/dashboard
Package dashboard implements a text-based UI dashboard.
|
Package dashboard implements a text-based UI dashboard. |
|
pkg/dashboard/apidata
Package apidata implements the types and the data sources for the data sourced from various Talos APIs.
|
Package apidata implements the types and the data sources for the data sourced from various Talos APIs. |
|
pkg/dashboard/components
Package components implements specific widgets for the dashboard.
|
Package components implements specific widgets for the dashboard. |
|
pkg/dashboard/logdata
Package logdata implements the types and the data sources for the data sourced from the Talos dmesg API.
|
Package logdata implements the types and the data sources for the data sourced from the Talos dmesg API. |
|
pkg/dashboard/resourcedata
Package resourcedata implements the types and the data sources for the data sourced from the Talos resource API (COSI).
|
Package resourcedata implements the types and the data sources for the data sourced from the Talos resource API (COSI). |
|
pkg/discovery/registry
Package registry provides code to push and pull Affiliates to different registries.
|
Package registry provides code to push and pull Affiliates to different registries. |
|
pkg/encryption
Package encryption provides modules for the partition encryption handling.
|
Package encryption provides modules for the partition encryption handling. |
|
pkg/encryption/keys
Package keys contains various encryption KeyHandler implementations.
|
Package keys contains various encryption KeyHandler implementations. |
|
pkg/extensions
Package extensions provides function to manage system extensions.
|
Package extensions provides function to manage system extensions. |
|
pkg/logind
Package logind provides D-Bus logind mock to facilitate graceful kubelet shutdown.
|
Package logind provides D-Bus logind mock to facilitate graceful kubelet shutdown. |
|
pkg/meta
Package meta provides access to META partition: key-value partition persisted across reboots.
|
Package meta provides access to META partition: key-value partition persisted across reboots. |
|
pkg/meta/internal/adv
Package adv provides common interfaces to access ADV data.
|
Package adv provides common interfaces to access ADV data. |
|
pkg/meta/internal/adv/syslinux
Package syslinux provides syslinux-compatible ADV data.
|
Package syslinux provides syslinux-compatible ADV data. |
|
pkg/meta/internal/adv/talos
Package talos implements modern ADV which supports large size for the values and tags.
|
Package talos implements modern ADV which supports large size for the values and tags. |
|
pkg/miniprocfs
Package miniprocfs contains optimized small interface to access /proc filesystem.
|
Package miniprocfs contains optimized small interface to access /proc filesystem. |
|
pkg/ntp
Package ntp provides a time sync client via SNTP protocol.
|
Package ntp provides a time sync client via SNTP protocol. |
|
pkg/partition
Package partition provides common utils for system partition format.
|
Package partition provides common utils for system partition format. |
|
pkg/pci
Package pci provides methods to access PCI-related data.
|
Package pci provides methods to access PCI-related data. |
|
pkg/smbios
Package smbios provides access to SMBIOS information.
|
Package smbios provides access to SMBIOS information. |
|
pkg/timex
Package timex provides a simple wrapper around adjtimex syscall.
|
Package timex provides a simple wrapper around adjtimex syscall. |
|
pkg/toml
Package toml provides utility functions for TOML handling.
|
Package toml provides utility functions for TOML handling. |
|
pkg/tui/installer
Package installer contains terminal UI based talos interactive installer parts.
|
Package installer contains terminal UI based talos interactive installer parts. |
|
pkg
|
|
|
archiver
Package archiver provides a service to archive part of the filesystem into tar archive.
|
Package archiver provides a service to archive part of the filesystem into tar archive. |
|
cli
Package cli provides utilities for CLI tools.
|
Package cli provides utilities for CLI tools. |
|
cluster
Package cluster provides functions to access, check and inspect Talos clusters.
|
Package cluster provides functions to access, check and inspect Talos clusters. |
|
cluster/check
Package check provides set of checks to verify cluster readiness.
|
Package check provides set of checks to verify cluster readiness. |
|
cluster/kubernetes
Package kubernetes provides cluster-wide kubernetes utilities.
|
Package kubernetes provides cluster-wide kubernetes utilities. |
|
cluster/sonobuoy
Package sonobuoy provides functions to run Kubernetes e2e tests.
|
Package sonobuoy provides functions to run Kubernetes e2e tests. |
|
conditions
Package conditions provides a set of conditions which can be used to wait for some condition to be met.
|
Package conditions provides a set of conditions which can be used to wait for some condition to be met. |
|
copy
Package copy provides a file copy utility implementation.
|
Package copy provides a file copy utility implementation. |
|
filetree
Package filetree provides file tree operations.
|
Package filetree provides file tree operations. |
|
flannel
Package flannel provides flannel default manifest.
|
Package flannel provides flannel default manifest. |
|
follow
Package follow provides Reader which follows file updates and turns it into a stream.
|
Package follow provides Reader which follows file updates and turns it into a stream. |
|
grpc/codec
Package codec registers the gRPC for optimized marshaling.
|
Package codec registers the gRPC for optimized marshaling. |
|
grpc/dialer
Package dialer ...
|
Package dialer ... |
|
grpc/middleware/log
Package log provides simple grpc logging middleware
|
Package log provides simple grpc logging middleware |
|
grpc/proxy/backend
Package backend implements common proxy backends satisfying proxy.Backend interface
|
Package backend implements common proxy backends satisfying proxy.Backend interface |
|
httpdefaults
Package httpdefaults provides default HTTP client settings for Talos.
|
Package httpdefaults provides default HTTP client settings for Talos. |
|
images
Package images provides some default images.
|
Package images provides some default images. |
|
kernel
Package kernel provides the utilities to interact with the kernel.
|
Package kernel provides the utilities to interact with the kernel. |
|
kernel/kspp
Package kspp implements KSPP kernel parameters enforcement.
|
Package kspp implements KSPP kernel parameters enforcement. |
|
kubeconfig
Package kubeconfig provides Kubernetes config file generation.
|
Package kubeconfig provides Kubernetes config file generation. |
|
kubernetes/kubelet
Package kubelet provides minimal client for the kubelet API.
|
Package kubelet provides minimal client for the kubelet API. |
|
logging
Package logging provides logging primitives.
|
Package logging provides logging primitives. |
|
makefs
Package makefs provides function to format and grow filesystems.
|
Package makefs provides function to format and grow filesystems. |
|
minimal
Package minimal provides the minimal/recommended limits for different machine types.
|
Package minimal provides the minimal/recommended limits for different machine types. |
|
provision
Package provision provides abstract definitions for Talos cluster provisioners.
|
Package provision provides abstract definitions for Talos cluster provisioners. |
|
provision/access
Package access provides methods to access provisioned Talos cluster.
|
Package access provides methods to access provisioned Talos cluster. |
|
provision/internal/cniutils
Package cniutils provides helper functions to parse CNI results.
|
Package cniutils provides helper functions to parse CNI results. |
|
provision/internal/inmemhttp
Package inmemhttp implements temporary HTTP server which is based off memory fs.
|
Package inmemhttp implements temporary HTTP server which is based off memory fs. |
|
provision/providers/docker
Package docker implements Provisioner via docker.
|
Package docker implements Provisioner via docker. |
|
provision/providers/vm
Package vm implements common methods for VM provisioners.
|
Package vm implements common methods for VM provisioners. |
|
reporter
Package reporter implements the console reporter.
|
Package reporter implements the console reporter. |
|
safepath
Package safepath provides a set of functions to make paths safe for use with.
|
Package safepath provides a set of functions to make paths safe for use with. |
|
startup
Package startup provides utility function for process startup
|
Package startup provides utility function for process startup |
|
version
Package version defines version information.
|
Package version defines version information. |
|
machinery
module
|
|
|
tools
|
|
|
docgen
module
|
|
|
gotagsrewrite
module
|
|
|
structprotogen
module
|
Click to show internal directories.
Click to hide internal directories.