Skip to content

Commit

Permalink
📖 Update internal components list
Browse files Browse the repository at this point in the history
Signed-off-by: mudler <[email protected]>
  • Loading branch information
mudler committed Mar 15, 2023
1 parent 58d09a9 commit 70f7fbd
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 10 deletions.
18 changes: 15 additions & 3 deletions docs/content/en/docs/Architecture/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,21 @@ Every component is extensible and modular such as it can be customized and repla

### Internal components

Kairos encompasses several components, some externally, most notably:

Kairos encompasses several components, external and internal.

Internal:
- [kairos](https://github.com/kairos-io/kairos) is the main repository, building the `kairos-agent` and containing the image definitions which runs on our CI pipelines.
- [immucore](https://github.com/kairos-io/immucore) is the immutability management interface.
- [AuroraBoot](https://github.com/kairos-io/AuroraBoot) is the Kairos Node bootstrapper
- [elemental-cli](https://github.com/kairos-io/elemental-cli) manages the installation, reset, and upgrade of the Kairos node.
- [system packages](https://github.com/kairos-io/packages) contains additional packages, cross-distro, partly used in framework images
- [kcrypt](https://github.com/kairos-io/kcrypt) is the component responsible for encryption and decryption of data at rest
- [kcrypt-challenger](https://github.com/kairos-io/kcrypt-challenger) is the `kairos` plugin that works with the TPM chip to unlock LUKS partitions
- [osbuilder](https://github.com/kairos-io/osbuilder) is used to build bootable artifacts from container images
- [entangle](https://github.com/kairos-io/entangle) a CRD to interconnect Kubernetes clusters
- [entangle-proxy](https://github.com/kairos-io/entangle-proxy) a CRD to control interconnetted clusters

External:
- [K3s](https://k3s.io) as a Kubernetes distribution
- [edgevpn](https://mudler.github.io/edgevpn) (optional) as fabric for the distributed network, node coordination and bootstrap. Provides also embedded DNS capabilities for the cluster. Internally uses [libp2p](https://github.com/libp2p/go-libp2p) for the P2P mesh capabilities.
- [elemental-toolkit](https://rancher.github.io/elemental-toolkit/docs/) as a fundament to build the Linux derivative. Indeed, any `Elemental` docs applies to `Kairos` as well.
- [nohang](https://github.com/hakavlad/nohang) A sophisticated low memory handler for Linux.
4 changes: 0 additions & 4 deletions docs/content/en/docs/Reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,6 @@ kairos:
device: ""
poweroff: false

# Cloud init syntax to setup users.
# See https://rancher.github.io/elemental-toolkit/docs/reference/cloud_init/
stages:
network:
- name: "Setup users"
Expand Down Expand Up @@ -90,8 +88,6 @@ kairos:
device: ""
poweroff: false
# Cloud init syntax to setup users.
# See https://rancher.github.io/elemental-toolkit/docs/reference/cloud_init/
stages:
network:
- name: "Setup users"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/docs/Reference/recovery_mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >
The Kairos recovery mode can be used to recover a damaged system or to regain access remotely (with assistance) to a machine which has been lost access to. The recovery mode is accessible only from the GRUB menu, from both the LiveCD, and an installed system.

{{% alert title="Note" %}}
On installed system, there are two recovery modes available during boot. Below describes only how the Kairos remote recovery works. The manual recovery entry has nothing special from the standard Elemental-toolkit recovery mode. It can be used to reset the A/B partitions (with the user/pass used during setup) and perform any other operation without remote access.
On installed system, there are two recovery modes available during boot. Below describes only how the Kairos remote recovery works. It can be used to reset the A/B partitions (with the user/pass used during setup) and perform any other operation without remote access.
{{% /alert %}}

## Boot into recovery mode
Expand Down
1 change: 0 additions & 1 deletion docs/content/en/docs/Reference/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,3 @@ On all nodes, which are deployed with the P2P full-mesh feature of the cluster,
## See also

- [Dracut debug docs](https://fedoraproject.org/wiki/How_to_debug_Dracut_problems)
- [Elemental troubleshooting docs](https://rancher.github.io/elemental-toolkit/docs/reference/troubleshooting/)
1 change: 0 additions & 1 deletion tests/assets/autoinstall.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ install:
auto: true
reboot: true
device: /dev/vda
# https://rancher.github.io/elemental-toolkit/docs/customizing/configure_grub/#grub-environment-variables
grub_options:
extra_cmdline: "foobarzz"

Expand Down

0 comments on commit 70f7fbd

Please sign in to comment.