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 via email: info at SideroLabs.com.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
talosctl/cmd/mgmt/cluster
Package cluster implements "cluster" subcommands.
|
Package cluster implements "cluster" subcommands. |
|
talosctl/cmd/talos/dashboard
Package dashboard implements simple UI for Talos cluster monitoring.
|
Package dashboard implements simple UI for Talos cluster monitoring. |
|
talosctl/cmd/talos/dashboard/components
Package components implements specific widgets for the dashboard.
|
Package components implements specific widgets for the dashboard. |
|
talosctl/cmd/talos/dashboard/data
Package data implements types to handle monitoring data, calculate values from it, etc.
|
Package data implements types to handle monitoring data, calculate values from it, etc. |
|
talosctl/cmd/talos/output
Package output provides writers in different formats.
|
Package output provides writers in different formats. |
|
internal
|
|
|
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/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/files
Package files provides controllers which manage file resources.
|
Package files provides controllers which manage file resources. |
|
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/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/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/bootloader/adv
Package adv provides common interfaces to access ADV data.
|
Package adv provides common interfaces to access ADV data. |
|
app/machined/pkg/runtime/v1alpha1/bootloader/adv/syslinux
Package syslinux provides syslinux-compatible ADV data.
|
Package syslinux provides syslinux-compatible ADV data. |
|
app/machined/pkg/runtime/v1alpha1/bootloader/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. |
|
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/v1alpha2
Package v1alpha2 provides runtime implementation based on os-runtime.
|
Package v1alpha2 provides runtime implementation based on os-runtime. |
|
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. |
|
pkg/capability
Package capability provides utility functions to work with capabilities.
|
Package capability provides utility functions to work with capabilities. |
|
pkg/circular
Package circular provides a buffer with circular semantics.
|
Package circular provides a buffer with circular semantics. |
|
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/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/kubeconfig
Package kubeconfig provides Kubernetes config file handling.
|
Package kubeconfig provides Kubernetes config file handling. |
|
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/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/timex
Package timex provides a simple wrapper around adjtimex syscall.
|
Package timex provides a simple wrapper around adjtimex syscall. |
|
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 to run Kubernetes e2e tests.
|
Package sonobuoy provides functions to to run Kubernetes e2e tests. |
|
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/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 |
|
images
Package images provides some default images.
|
Package images provides some default images. |
|
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. |
|
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. |
|
startup
Package startup provides utility function for process startup
|
Package startup provides utility function for process startup |
|
machinery
Module
|
Click to show internal directories.
Click to hide internal directories.