Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update about images #447

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 4 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,11 @@ For more information, please refer to the following resources:

## Images

The images are built and published to an object storage bucket hosted at the
[VEXXHOST](https://vexxhost.com) public cloud. These images are built and
published for the latest stable release of Kubernetes.
The Cluster API driver for Magnum relies on specific OpenStack images containing
all necessary dependencies for deploying Kubernetes clusters.

### Pre-built images

You can find the pre-built images for the latest stable release of Kubernetes
at the following URL:

#### Ubuntu 22.04

* [v1.23.17](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/ubuntu-2204-kube-v1.23.17.qcow2)
* [v1.24.16](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/ubuntu-2204-kube-v1.24.16.qcow2)
* [v1.25.12](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/ubuntu-2204-kube-v1.25.12.qcow2)
* [v1.26.7](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/ubuntu-2204-kube-v1.26.7.qcow2)
* [v1.27.4](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/ubuntu-2204-kube-v1.27.4.qcow2)

#### Flatcar

* [v1.24.16](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/flatcar-kube-v1.24.16.qcow2)
* [v1.25.12](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/flatcar-kube-v1.25.12.qcow2)
* [v1.26.7](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/flatcar-kube-v1.26.7.qcow2)
* [v1.27.4](https://object-storage.public.mtl1.vexxhost.net/swift/v1/a91f106f55e64246babde7402c21b87a/magnum-capi/flatcar-kube-v1.27.4.qcow2)

### Building images

The Cluster API driver for Magnum provides a tool in order to build images, you
can use it by installing the `magnum-cluster-api` package and running the
the following command:

```bash
magnum-cluster-api-image-builder
```
For more information on how to build images and where to find pre-built images,
refer to the [user guide](https://vexxhost.github.io/magnum-cluster-api/user/images/)

## Testing & Development

Expand Down
15 changes: 13 additions & 2 deletions docs/user/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ all necessary dependencies for deploying Kubernetes clusters. These images are
pre-configured with Kubernetes binaries, container runtimes, networking
components, and other required software.


### Building Images (Deprecated)

The images used by the Cluster API driver for Magnum are built using the
[`kubernetes-sigs/image-builder`](https://github.com/kubernetes-sigs/image-builder)
project. This project provides a comprehensive and flexible framework for
constructing Kubernetes-specific images.

### Building Images

In order to simplify the process of building images, the Cluster API driver for
Magnum provides a small Python utility which wraps the `image-builder` project.

Expand All @@ -26,3 +27,13 @@ $ magnum-cluster-api-image-builder --version v1.26.2

In the example above, this command will build the images for Kubernetes version
`v1.26.2`. The `--version` flag is optional and defaults to `v1.26.2`.

### Building Images (New)

The images used by the Cluster API driver for Magnum are built using the
[`vexxhost/capo-image-elements`](https://github.com/vexxhost/capo-image-elements)
project. This project provides a comprehensive and flexible framework for
constructing Kubernetes-specific images.

You can find pre-built images by this projet at
https://static.atmosphere.dev/artifacts/magnum-cluster-api/.
Loading