chalkctl¶
chalkctl installs and operates the nodes of a chalkos cluster. It reads the cluster from an inventory, which names each node, its address, its image and its config files: the file --inventory names, else the file $CHALKOSINVENTORY names, else chalkos.yaml in the current directory. It talks to chalkd on each node over mutual TLS, and never builds or signs images.
Commands authenticate with the cluster's secrets file, which holds every CA key and which only --secrets names, or with a client file of the admin, operator or reader role, which chalkctl client new writes. Each command's help says which it needs. A command that accepts both takes --config or --secrets, not both, else the client file $CHALKOSCONFIG names, else ~/.config/chalkos/config.
A command's flags go after its name, anywhere among its arguments, and -- ends them: every argument after it is read as a positional argument.
Examples¶
# Generate the cluster's secrets, install and bootstrap a control plane, write a kubeconfig.
chalkctl gen secrets --recipient age1...
chalkctl install cp1 --secrets secrets.age \
--fingerprint 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08
chalkctl bootstrap cp1 --secrets secrets.age
chalkctl kubeconfig --secrets secrets.age
See also¶
- chalkctl apply: Deliver a node's config from the inventory: short for config apply
- chalkctl bootstrap: Initialise the cluster on a control plane
- chalkctl client: Manage client files
- chalkctl completion: Write a shell completion script
- chalkctl config: Deliver a node's config and act on its trial or pending config
- chalkctl disks: List a node's disks
- chalkctl etcd: Manage the cluster's etcd members
- chalkctl gen: Generate files of a cluster
- chalkctl image: Pull chalkos images from a registry
- chalkctl install: Install a node that waits in maintenance mode
- chalkctl kubeconfig: Write an admin kubeconfig
- chalkctl logs: Show a node's journal
- chalkctl node: Manage a node's access, activate its staged image, reboot it and show its diagnostics and routes
- chalkctl recovery-key: Print a node's recovery key
- chalkctl registry: Manage the images of the cluster registry
- chalkctl rotate: Rotate os-ca, node-ca, kubernetes-ca, service-account-key or encryption-key
- chalkctl secureboot: Create Secure Boot keys and enrol them in a node's firmware
- chalkctl status: Show an installed node's status
- chalkctl storage: Manage a node's volumes
- chalkctl upgrade: Install new images on the cluster's nodes, or boot their previous ones again
- chalkctl validate: Check nodes' config against the schemas of their images
- chalkctl version: Print the version and the git revision of the build