README
¶
Talos
A modern OS for Kubernetes.
Talos is a modern OS designed to be secure, immutable, and minimal. All system management is done via an API, and there is no shell or interactive console. Some of the capabilities and benefits provided by Talos include:
- Security: Talos reduces your attack surface by practicing the Principle of Least Privilege (PoLP) and by securing the API with mutual TLS (mTLS) authentication.
- Predictability: Talos eliminates unneeded variables and reduces unknown factors in your environment by employing immutable infrastructure ideology.
- Evolvability: Talos simplifies your architecture and increases your ability to easily accommodate future changes.
Documentation
For instructions on deploying and managing Talos, see the Documentation.
Community
- Slack: Join our slack channel
- Forum: community
- Twitter: @talossystems
- Email: info@talos-systems.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 two weekly meetings targeted for different audiences.
Office Hours
- When: Mondays at 17:00 UTC.
- Where: Google Meet.
Maintainers and Contributors
When attending this meeting, please add yourself to the meeting notes as an attendee. If you would like to discuss a specific topic, we encourage you to add it to the agenda.
- When: Thursdays at 17:00 UTC.
- Where: Google Meet.
You can subscribe to these meetings 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
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
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. |
|
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/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/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/system/services
nolint: golint nolint: golint nolint: golint nolint: golint nolint: golint nolint: golint
|
nolint: golint nolint: golint nolint: golint nolint: golint nolint: golint nolint: golint |
|
app/networkd/pkg/networkd
Package networkd handles the network interface configuration on a host.
|
Package networkd handles the network interface configuration on a host. |
|
app/networkd/pkg/nic
Package nic provides a way to describe and configure a network interface.
|
Package nic provides a way to describe and configure a network interface. |
|
app/networkd/pkg/reg
Package reg provides the gRPC network service implementation.
|
Package reg provides the gRPC network service implementation. |
|
app/routerd/pkg/director
Package director provides proxy call routing facility
|
Package director provides proxy call routing facility |
|
app/timed/pkg/timex
Package timex provides simple wrapper around adjtimex syscall.
|
Package timex provides simple wrapper around adjtimex syscall. |
|
pkg/circular
Package circular provides a buffer with circular semantics.
|
Package circular provides a buffer with circular semantics. |
|
pkg/cluster
Package cluster provides functions to access, check and inspect Talos clusters.
|
Package cluster provides functions to access, check and inspect Talos clusters. |
|
pkg/cluster/check
Package check provides set of checks to verify cluster readiness.
|
Package check provides set of checks to verify cluster readiness. |
|
pkg/cniutils
Package cniutils provides helper functions to parse CNI results.
|
Package cniutils provides helper functions to parse CNI results. |
|
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/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. |
|
pkg/kernel/vmlinuz
Package vmlinuz provides utilities for reading bzImage kernel format.
|
Package vmlinuz provides utilities for reading bzImage kernel format. |
|
pkg/kmsg
Package kmsg provides access to kernel log.
|
Package kmsg provides access to kernel log. |
|
pkg/kubeconfig
Package kubeconfig provides Kubernetes config file generation from machine config.
|
Package kubeconfig provides Kubernetes config file generation from machine config. |
|
pkg/loadbalancer
Package loadbalancer provides simple TCP loadbalancer.
|
Package loadbalancer provides simple TCP loadbalancer. |
|
pkg/loadbalancer/upstream
Package upstream provides utilities for choosing upstream backends based on score.
|
Package upstream provides utilities for choosing upstream backends based on score. |
|
pkg/provision
Package provision provides abstract definitions for Talos cluster provisioners.
|
Package provision provides abstract definitions for Talos cluster provisioners. |
|
pkg/provision/access
Package access provides methods to access provisioned Talos cluster.
|
Package access provides methods to access provisioned Talos cluster. |
|
pkg/provision/providers/docker
Package docker implements Provisioner via docker.
|
Package docker implements Provisioner via docker. |
|
pkg/provision/providers/firecracker
Package firecracker implements Provisioner via Firecracker VMs.
|
Package firecracker implements Provisioner via Firecracker VMs. |
|
pkg/provision/providers/vm
Package vm implements common methods for VM provisioners.
|
Package vm implements common methods for VM provisioners. |
|
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 |
|
blockdevice
Package blockdevice provides a library for working with block devices.
|
Package blockdevice provides a library for working with block devices. |
|
blockdevice/filesystem/xfs
Package xfs provides an interface to xfsprogs.
|
Package xfs provides an interface to xfsprogs. |
|
blockdevice/lba
Package lba provides a library for working with Logical Block Addresses.
|
Package lba provides a library for working with Logical Block Addresses. |
|
blockdevice/table
Package table provides a library for working with block device partition tables.
|
Package table provides a library for working with block device partition tables. |
|
blockdevice/table/gpt
Package gpt provides a library for working with GPT partitions.
|
Package gpt provides a library for working with GPT partitions. |
|
blockdevice/table/gpt/header
Package header provides a library for working with GPT headers.
|
Package header provides a library for working with GPT headers. |
|
blockdevice/table/gpt/partition
Package partition provides a library for working with GPT partitions.
|
Package partition provides a library for working with GPT partitions. |
|
cli
Package cli provides utilities for CLI tools.
|
Package cli provides utilities for CLI tools. |
|
client
Package client provides Talos API client.
|
Package client provides Talos API client. |
|
config
Package config provides methods to generate and consume Talos configuration.
|
Package config provides methods to generate and consume Talos configuration. |
|
config/configloader
Package configloader provides methods to load Talos config.
|
Package configloader provides methods to load Talos config. |
|
config/types/v1alpha1
Package v1alpha1 configuration file contains all the options available for configuring a machine.
|
Package v1alpha1 configuration file contains all the options available for configuring a machine. |
|
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/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 |
|
proc/reaper
Package reaper implements zombie process reaper with notifications.
|
Package reaper implements zombie process reaper with notifications. |
|
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.