Skip to content

Commit

Permalink
📖 Rephrase
Browse files Browse the repository at this point in the history
Signed-off-by: mudler <[email protected]>
  • Loading branch information
mudler committed Jan 9, 2023
1 parent f95ed32 commit c0eaa43
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 17 deletions.
27 changes: 18 additions & 9 deletions docs/content/en/docs/Examples/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,24 @@ description: >
This section describe examples on how to use Kairos bundles to apply custom configurations
---

In the example below we will use a bare metal host to provision a Kairos node in the local network with K3s and MetalLB using the `192.168.1.10-192.168.1.20` IP range. Instead of doing it manually as in the [MetalLB](/docs/examples/metallb) example, we will use a bundle to set up MetalLB automatically. See also the [bundle](/docs/advanced/bundles) documentation section to learn how to build bundles and how to use them. This section provides a simple example that uses a pre-configured bundle to setup `MetalLB`.
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](/docs/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](/docs/examples/metallb) example to configure it without a [bundle](/docs/advanced/bundles).

[MetalLB](https://metallb.universe.tf/) is a load-balancer implementation for bare metal Kubernetes clusters, using standard routing protocols. Can be used with [k3s](https://k3s.io) in Kairos to provide Load Balancing for baremetal and manage IPs in a cluster.
For those unfamiliar with [MetalLB](https://metallb.universe.tf/), it is an open-source load balancer implementation for bare metal Kubernetes clusters that utilizes standard routing protocols. When used with K3s on Kairos, it provides load balancing capabilities and helps manage IP addresses within a cluster.

## Installation

Use the [provider-kairos](https://github.com/kairos-io/provider-kairos) artifacts which contains `k3s`.
## Prerequisites

Before we begin, you will need to have the following:

We will use the MetalLB community [bundle](/docs/advanced/bundles) to deploy `MetaLB`.
1. Kairos [provider-kairos](https://github.com/kairos-io/provider-kairos) artifacts which includes K3s
1. A baremetal node to run the installation

Follow the [Installation](/docs/installation) documentation, and use the following cloud config file with Kairos:


## Installation

1. Follow the [Installation](/docs/installation) documentation for Kairos.
1. Use the following cloud configuration file when setting up Kairos:

```yaml
#cloud-config
Expand Down Expand Up @@ -46,7 +53,9 @@ metallb:
address_pool: 192.168.1.10-192.168.1.20
```
Notably:
There are a few key points to note in the configuration file:
- The `metallb` block is provided by the MetalLB bundle and allows us to specify the version of MetalLB that we want to deploy, as well as the `address_pool` available for our services.
- The `bundles` block enables the `run` [bundle](/docs/advanced/bundles) type. The bundle we are using is part of the [community-bundles](https://github.com/kairos-io/community-bundles) repository.

- we use the `metallb` block that is provided by the metallb bundle and set the `MetalLB` versin that we want to deploy and the `address_pool` available for our services.
- we use the `bundles` block to enable the `run` [bundle](/docs/advanced/bundles) type. The bundle used is part of [community-bundles](https://github.com/kairos-io/community-bundles)
And that's it! With these steps, you should now have MetalLB configured and ready to use on your Kairos cluster. If you have any questions or run into any issues, don't hesitate to check out the [bundle documentation](/docs/advanced/bundles) or reach out to the community for support.
17 changes: 9 additions & 8 deletions docs/content/en/docs/Examples/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,21 @@ description: >
This section provides examples on how to use Kairos core images
---

Kairos core images are part of the [assets released](https://github.com/kairos-io/kairos/releases) by the [kairos-io/kairos](https://github.com/kairos-io/kairos) repository. The images don't include k3s - such images can be used either as base for customizing and creating downstream images, or either as installer to pull during installation and deploy other images. This examples show how to use core images standalone as installer to deploy other images. To use the image as base for customization, see [customizing](/docs/advanced/customizing).
Welcome to the Kairos core image documentation! Our core images are released as part of the [kairos-io/kairos](https://github.com/kairos-io/kairos) repository and can be found in the releases section. These images don't include k3s, but can be used either as a base for customizing and creating downstream images or as an installer to pull and deploy other images during installation. In this guide, we'll be focusing on using the core images as an installer to deploy other images. If you're interested in using the core images as a base for customization, check out our [customizing](/docs/advanced/customizing) documentation.


## Installation

Use the [Kairos core](https://github.com/kairos-io/kairos/releases) artifacts which doesn't contain any Kubernetes engine, the only configuration section that needs to be applied is the portion about the container image:
To get started with installing a Kairos core image, you'll want to use the artifacts from the [Kairos core](https://github.com/kairos-io/kairos/releases) repository, which don't contain any Kubernetes engine. The only configuration you'll need to apply is to specify the container image you want to deploy in the install.image field of your cloud config file. You can find a list of available images in [our support matrix](/docs/reference/image_matrix). For example, to use an image from the [provider-kairos](https://github.com/kairos-io/provider-kairos) repository, your cloud config might look like this:

```yaml
#cloud-config
install:
# Here we specify the image that we want to deploy
image: "docker:<image>"
image: "docker:quay.io/kairos/kairos-opensuse:v1.4.0-k3sv1.26.0-k3s1"
```
You can pick an `<image>` from [our support matrix](/docs/reference/image_matrix), in the example below we will use an image from [provider-kairos](https://github.com/kairos-io/provider-kairos).

Follow the [Installation](/docs/installation) documentation, and use the following cloud config file:
Once you've chosen your image, follow the steps in our [Installation](/docs/installation) documentation to complete the process. After the installation is complete, the configuration in the k3s block will take effect, and you'll be able to use it just as you would with an image from the provider-kairos repository. For example:
```yaml
#cloud-config
Expand All @@ -44,7 +43,9 @@ k3s:
enable: true
```
Notably:
There are a few key points to note in the configuration file:
- we set `install.image` to the container image that we want to deploy. That can be a [custom image](/docs/advanced/customizing) or an [image from scratch](/docs/reference/build)
- we use the `k3s` block as we normally would do on a provider-kairos image. This is because after installation we would boot in the image specified in the `install.image` field, and thus the configuration would take effect
- we use the `k3s` block as we normally would do on a provider-kairos image. This is because after installation we would boot in the image specified in the `install.image` field, and thus the configuration would take effect

That's it! With these steps, you should now be able to use Kairos core images as an installer to deploy other container images

0 comments on commit c0eaa43

Please sign in to comment.