Skip to content

Commit

Permalink
Merge pull request #151 from kairos-io/reduce-sizes
Browse files Browse the repository at this point in the history
Reduce doc sizes to make kairos-agent smaller
  • Loading branch information
mauromorales committed Feb 26, 2024
2 parents bd1178b + b6261ec commit 6d7da61
Show file tree
Hide file tree
Showing 85 changed files with 65 additions and 126 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -1 +1,3 @@
.hugo_build.lock
node_modules/
public/
4 changes: 1 addition & 3 deletions content/en/blog/kairos-canonical.md
Expand Up @@ -2,9 +2,7 @@
title: "Kairos, SpectroCloud, and Canonical Collaborate to Deliver Revolutionary Telco Radio Edge Solution"
date: 2023-03-13
linkTitle: "Kairos, SpectroCloud, and Canonical Collaboration at MWC"
description: |
Kairos, the open-source distributed infrastructure platform, has collaborated with SpectroCloud and Canonical to develop a revolutionary Telco Radio Edge solution. The solution leverages the latest advances in OpenRAN automation and distributed compute management, and is set to take center stage at this year's Mobile World Congress.
description: Kairos, the open-source distributed infrastructure platform, has collaborated with SpectroCloud and Canonical to develop a revolutionary Telco Radio Edge solution. The solution leverages the latest advances in OpenRAN automation and distributed compute management, and is set to take center stage at this year's Mobile World Congress.
author: Ettore Di Giacinto ([Twitter](https://twitter.com/mudler_it)) ([GitHub](https://github.com/mudler))
---

Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Advanced/_index.md
Expand Up @@ -3,7 +3,6 @@ title: "Advanced"
linkTitle: "Advanced"
icon: fa-regular fa-gear
weight: 5
description: >
Advanced settings
description: Advanced settings
---

1 change: 0 additions & 1 deletion content/en/docs/Advanced/after-install.md
Expand Up @@ -2,7 +2,6 @@
title: "Pushing configuration to a node after installation"
linkTitle: "After install"
weight: 1
description: >
---

Kairos configuration mechanism is based on the `cloud-config `file given during installation, however, it's possible to extend the configuration by providing additional cloud-configs in either `/oem` or `/usr/local/cloud-config`.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/build.md
Expand Up @@ -2,7 +2,6 @@
title: "Build Kairos appliances"
linkTitle: "Build"
weight: 5
description: >
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Advanced/bundles.md
Expand Up @@ -2,8 +2,7 @@
title: "Bundles"
linkTitle: "Bundles"
weight: 5
description: >
Bundles are a powerful feature of Kairos that allow you to customize and configure your operating system. This section explains how to use and build custom bundles.
description: Bundles are a powerful feature of Kairos that allow you to customize and configure your operating system. This section explains how to use and build custom bundles.

---

Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/coco.md
Expand Up @@ -2,7 +2,6 @@
title: "Confidential computing setup"
linkTitle: "Confidential Computing"
weight: 9
description: >
---

{{% alert title="Note" %}}
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/configuring_partitions.md
Expand Up @@ -2,7 +2,6 @@
title: "Configuring partitions"
linkTitle: "Configuring partitions"
weight: 1
description: >
---

{{% alert title="Note" color="warning" %}}
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/customizing.md
Expand Up @@ -2,7 +2,6 @@
title: "Customizing the system image"
linkTitle: "Customization"
weight: 2
description: >
---

Kairos is an open source, container-based operating system. To modify Kairos and add a package, you'll need to build a container image from the [Kairos images]({{< relref "../reference/image_matrix" >}}). Here's an example with Docker which adds `figlet`:
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/livelayering.md
Expand Up @@ -2,7 +2,6 @@
title: "Live layering"
linkTitle: "Live layering"
weight: 4
description: >
---

Live layering allows to activates/deactivates system extension images. System extension images may – dynamically at runtime — extend the `/usr/` and `/opt/` directory hierarchies with additional files.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/networking.md
Expand Up @@ -2,7 +2,6 @@
title: "Networking"
linkTitle: "Networking"
weight: 3
description: >
---

By default, Kairos ISOs are configured to automatically get an IP from the network interface. However, depending on the base system you have chosen, there are different way to configure networking. This section collects information on setting network configuration depending on the base that is being chosen (openSUSE, Alpine, Ubuntu).
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Advanced/partition_encryption.md
Expand Up @@ -2,8 +2,7 @@
title: "Encrypting User Data with Kairos"
linkTitle: "Encrypting User Data with Kairos"
weight: 5
description: >
This section describes how to encrypt partition with LUKS in Kairos.
description: This section describes how to encrypt partition with LUKS in Kairos.
---

{{% alert title="Note" color="warning" %}}
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Advanced/private_registry_auth.md
Expand Up @@ -3,7 +3,6 @@ title: "Private registries authentication"
linkTitle: "Private registries authentication"
weight: 2
date: 2023-08-08
description: >
---


Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/_index.md
Expand Up @@ -3,6 +3,5 @@ title: "Architecture"
linkTitle: "Architecture"
icon: fa-regular fa-diagram-project
weight: 4
description: >
---

1 change: 0 additions & 1 deletion content/en/docs/Architecture/cloud-init.md
Expand Up @@ -3,7 +3,6 @@ title: "Cloud init based"
linkTitle: "Cloud init based"
weight: 3
date: 2022-11-13
description: >
---

Kairos supports the [standard cloud-init syntax](https://github.com/mudler/yip#compatibility-with-cloud-init-format) and [its own extended syntax](https://github.com/mudler/yip) to allow to configure a system declaratively with a cloud-config centric approach.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/container.md
Expand Up @@ -3,7 +3,6 @@ title: "Container based"
linkTitle: "Container"
weight: 2
date: 2022-11-13
description: >
---

Kairos is a container-based operating system (OS).
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/immutable.md
Expand Up @@ -3,7 +3,6 @@ title: "Immutable"
linkTitle: "Immutable"
weight: 1
date: 2022-11-13
description: >
---

Kairos adopts an immutable layout and derivatives created with its toolkit, inherit the same immutability attributes.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/meta.md
Expand Up @@ -3,7 +3,6 @@ title: "Meta-Distribution"
linkTitle: "Meta-Distribution"
weight: 4
date: 2022-11-13
description: >
---

We like to define Kairos as a meta-Linux Distribution, as its goal is to convert other distros to an immutable layout with Kubernetes Native components.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Architecture/network.md
Expand Up @@ -3,8 +3,7 @@ title: "P2P Network"
linkTitle: "P2P Network"
weight: 5
date: 2023-02-15
description: >
How Kairos leverage Peer-to-peer (P2P) to self-coordinate clusters at the edge.
description: How Kairos leverage Peer-to-peer (P2P) to self-coordinate clusters at the edge.
---

## Introduction
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/secureboot.md
Expand Up @@ -3,7 +3,6 @@ title: "SecureBoot support"
linkTitle: "SecureBoot support"
weight: 3
date: 2024-01-29
description: >
---


Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Architecture/trustedboot.md
Expand Up @@ -3,7 +3,6 @@ title: "Trusted Boot Architecture"
linkTitle: "Trusted Boot"
weight: 6
date: 2022-11-13
description: >
---

{{% alert title="Warning" %}}
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Development/_index.md
Expand Up @@ -3,5 +3,4 @@ title: "Development"
linkTitle: "Development"
weight: 7
icon: fa-regular fa-terminal
description: >
---
3 changes: 1 addition & 2 deletions content/en/docs/Development/debugging-station.md
Expand Up @@ -3,8 +3,7 @@ title: "Debugging station"
linkTitle: "Debugging station"
weight: 4
date: 2023-03-15
description: >
Debugging station
description: Debugging station
---

When developing or troubleshooting Kairos, it can be useful to share a local cluster with another peer. This section illustrates how to use [Entangle]({{< relref "../reference/entangle" >}}) to achieve that. We call this setup _debugging-station_.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Development/development.md
Expand Up @@ -3,8 +3,7 @@ title: "Development notes"
linkTitle: "Development"
weight: 1
date: 2022-11-13
description: >
Guidelines when developing Kairos
description: Guidelines when developing Kairos
---

Here you can find development notes intended for maintainers and guidance for new contributors.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Development/nvidia.md
Expand Up @@ -3,8 +3,7 @@ title: "Booting Kairos on Nvidia Jetson ARM"
linkTitle: "Booting Kairos on Nvidia Jetson ARM"
weight: 5
date: 2022-11-13
description: >
This page contains a reference on how to run Kairos on Nvidia Jetson ARM
description: This page contains a reference on how to run Kairos on Nvidia Jetson ARM
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/_index.md
Expand Up @@ -3,8 +3,7 @@ title: "Examples"
linkTitle: "Examples"
icon: fa-regular fa-file
weight: 5
description: >
This section contains various examples, how-to and tutorial to use Kairos
description: This section contains various examples, how-to and tutorial to use Kairos
---

Welcome to the examples section of the Kairos documentation! Here, you will find a variety of examples that demonstrate how to use Kairos to create and manage Kubernetes clusters on bare metal.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/airgap.md
Expand Up @@ -2,8 +2,7 @@
title: "How to Create an Airgap K3s Installation with Kairos"
linkTitle: "Airgapped ISO with AuroraBoot"
weight: 4
description: >
This section describe examples on how to use AuroraBoot and Kairos bundles to create ISOs for airgapped installs
description: This section describe examples on how to use AuroraBoot and Kairos bundles to create ISOs for airgapped installs
---

If you want to create an [airgap K3s installation](https://docs.k3s.io/installation/airgap), Kairos provides a convenient way to do so using AuroraBoot. In this guide, we will go through the process of creating a custom ISO of Kairos that contains a configuration file and a [bundle]({{< relref "../advanced/bundles" >}}) that executes preparatory steps after installation. The bundle will overlay new files in the system and prepare the node for having an airgapped K3s installation.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/bundles.md
Expand Up @@ -2,8 +2,7 @@
title: "Bundles"
linkTitle: "Bundles"
weight: 4
description: >
This section describe examples on how to use a Kairos bundle to deploy MetalLB on top of K3s
description: This section describe examples on how to use a Kairos bundle to deploy MetalLB on top of K3s
---

Welcome to the guide on setting up MetalLB on a Kairos cluster with K3s! This tutorial will walk you through the steps of using a Kairos [bundle]({{< relref "../advanced/bundles" >}}) to automatically configure MetalLB on your local network with an IP range of `192.168.1.10-192.168.1.20`. Check out the [MetalLB]({{< relref "../examples/metallb" >}}) example to configure it without a [bundle]({{< relref "../advanced/bundles" >}}).
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/core.md
Expand Up @@ -2,8 +2,7 @@
title: "Using Kairos Core Images as an Installer"
linkTitle: "Using Kairos Core Images as an Installer"
weight: 4
description: >
Core images serve as the foundation for creating downstream images or as an installer for deploying other images during the installation process. In this guide, we'll take a closer look at using Kairos core images as an installer to deploy other container images.
description: Core images serve as the foundation for creating downstream images or as an installer for deploying other images during the installation process. In this guide, we'll take a closer look at using Kairos core images as an installer to deploy other container images.
---

Kairos is a powerful, open-source meta-distribution that allows you to easily deploy and manage nodes on your Immutable infrastructure.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/ha.md
Expand Up @@ -2,8 +2,7 @@
title: "High Availability K3s deployments"
linkTitle: "HA with K3s"
weight: 3
description: >
This section contains instructions how to deploy Kairos with a High Available control-plane for K3s
description: This section contains instructions how to deploy Kairos with a High Available control-plane for K3s
---

Please refer to the [k3s HA](https://docs.k3s.io/installation/ha-embedded) documentation.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/localai.md
Expand Up @@ -2,8 +2,7 @@
title: "LocalAI"
linkTitle: "LocalAI"
weight: 4
description: >
This section describe examples on how to deploy Kairos with k3s and LocalAI
description: This section describe examples on how to deploy Kairos with k3s and LocalAI
---

{{% alert title="Warning" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/metallb.md
Expand Up @@ -2,8 +2,7 @@
title: "MetalLB"
linkTitle: "MetalLB"
weight: 4
description: >
This section describe examples on how to deploy Kairos with k3s and MetalLB
description: This section describe examples on how to deploy Kairos with k3s and MetalLB
---

Welcome to the guide on using MetalLB with Kairos and K3s on a bare metal host!
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/multi-node-p2p-ha-kubevip.md
Expand Up @@ -3,8 +3,7 @@ title: "Deploying a High-Availability K3s Cluster with KubeVIP"
linkTitle: "Deploying a High-Availability K3s Cluster with KubeVIP"
weight: 6
date: 2022-11-13
description: >
This guide walks through the process of deploying a highly-available, P2P self-coordinated k3s cluster with KubeVIP, which provides a high available Elastic IP for the control plane.
description: This guide walks through the process of deploying a highly-available, P2P self-coordinated k3s cluster with KubeVIP, which provides a high available Elastic IP for the control plane.
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/multi-node-p2p-ha.md
Expand Up @@ -3,8 +3,7 @@ title: "Configuring Automatic High Availability in Kairos"
linkTitle: "Configuring Automatic High Availability in Kairos"
weight: 6
date: 2022-11-13
description: >
Kairos makes it easy to configure automatic High Availability (HA) in your cluster by using cloud-config. With just a few simple steps, you can have a fully-functioning HA setup in your cluster.
description: Kairos makes it easy to configure automatic High Availability (HA) in your cluster by using cloud-config. With just a few simple steps, you can have a fully-functioning HA setup in your cluster.
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/multi-node-p2p.md
Expand Up @@ -3,8 +3,7 @@ title: "P2P multi-node cluster"
linkTitle: "P2P multi-node cluster"
weight: 6
date: 2022-11-13
description: >
Install Kairos with p2p support, on a multi-node cluster
description: Install Kairos with p2p support, on a multi-node cluster
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/multi-node.md
Expand Up @@ -2,8 +2,7 @@
title: "Multi Node k3s cluster"
linkTitle: "Multi node k3s cluster"
weight: 1
description: >
This section describe examples on how to deploy Kairos with k3s as a multi-node cluster
description: This section describe examples on how to deploy Kairos with k3s as a multi-node cluster
---

In the example below we will use a bare metal host to provision a Kairos cluster in the local network with K3s and one master node.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/openamt.md
Expand Up @@ -3,8 +3,7 @@ title: "Intel Open AMT Registration"
linkTitle: "Intel Open AMT Registration"
weight: 6
date: 2023-04-17
description: >
This bundle configures Intel AMT devices during Kairos installation.
description: This bundle configures Intel AMT devices during Kairos installation.
---

If Kairos is installed on a device with an Intel AMT device, the device can be automatically registered with an MPS server.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/p2p_e2e.md
Expand Up @@ -3,8 +3,7 @@ title: "P2P multi-node cluster with AuroraBoot"
linkTitle: "P2P multi-node cluster with AuroraBoot"
weight: 6
date: 2023-02-15
description: >
Full end to end example to bootstrap a self-coordinated cluster with Kairos and AuroraBoot
description: Full end to end example to bootstrap a self-coordinated cluster with Kairos and AuroraBoot
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/single-node-p2p.md
Expand Up @@ -3,8 +3,7 @@ title: "P2P single-node cluster"
linkTitle: "P2P single-node cluster"
weight: 6
date: 2022-11-13
description: >
This documentation page provides instructions on how to install Kairos with P2P support on a single-node cluster
description: This documentation page provides instructions on how to install Kairos with P2P support on a single-node cluster
---

{{% alert title="Note" color="warning" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Examples/single-node.md
Expand Up @@ -2,8 +2,7 @@
title: "Single Node k3s cluster"
linkTitle: "Single node k3s cluster"
weight: 1
description: >
This section describe examples on how to deploy Kairos with k3s as a single-node cluster
description: This section describe examples on how to deploy Kairos with k3s as a single-node cluster
---

In the example below we will use a bare metal host to provision a Kairos node in the local network with K3s.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Examples/wifi.md
Expand Up @@ -2,7 +2,6 @@
title: "Configuring wifi via cloud-config"
linkTitle: "Configuring wifi via cloud-config"
weight: 1
description: >
---


Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Getting started/_index.md
Expand Up @@ -3,8 +3,7 @@ title: "Getting Started"
linkTitle: "Getting Started"
weight: 2
icon: fa-regular fa-flag-checkered
description: >
Getting started with Kairos
description: Getting started with Kairos
---

{{% alert title="Note" %}}
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Installation/_index.md
Expand Up @@ -3,7 +3,6 @@ title: "Installation"
linkTitle: "Installation"
icon: fa-regular fa-computer
weight: 2
description: >
Kairos Installation reference
description: Kairos Installation reference
---

3 changes: 1 addition & 2 deletions content/en/docs/Installation/automated.md
Expand Up @@ -3,8 +3,7 @@ title: "Automated"
linkTitle: "Automated"
weight: 3
date: 2022-11-13
description: >
Install Kairos automatically, with zero touch provisioning
description: Install Kairos automatically, with zero touch provisioning
---

To automate Kairos installation, you can configure a specific portion of the installation configuration file. The configuration file can then be supplied in a few different ways, such as creating an additional ISO to mount, specifying a URL, or even creating an ISO from a container image with an embedded configuration file.
Expand Down

0 comments on commit 6d7da61

Please sign in to comment.