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

Add information about embedded registry #296

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

manuelbuil
Copy link
Contributor

This PR:

  • Adds information about the embedded registry (mostly copied from k3s)
  • Includes extra information about private registries (thanks @dereknola )

The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1
:::

K3s includes an embedded distributed OCI-compliant registry mirror.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
K3s includes an embedded distributed OCI-compliant registry mirror.
RKE2 includes an embedded distributed OCI-compliant registry mirror.

@@ -2,7 +2,7 @@
title: Air-Gap Install
---

RKE2 can be installed in an air-gapped environment with two different methods. You can either deploy via the `rke2-airgap-images` tarball release artifact, or by using a private registry.
RKE2 can be installed in an air-gapped environment with three different methods. You can either deploy via the [rke2-airgap-images tarball release artifact](#tarball-method), by using a [private registry](#private-registry-method) or by using the [embedded registry mirror](#embedded-registry-mirror).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't install RKE2 via the embedded registry. It just makes the image pulls easier.

Copy link
Member

@brandond brandond Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically you can use the embedded registry to provide the rke2-runtime image as long as there is already another cluster member to pull it from. That is an important restriction. You'd need to airgap or private registry the first node, and then the rest can use the embedded mirror.

---

:::info Version Gate
The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are going straight to GA with this feature.

Suggested change
The Embedded Registry Mirror is available as an experimental feature as of January 2024 releases: v1.26.13+rke2r1, v1.27.10+rke2r1, v1.28.6+rke2r1, v1.29.1+rke2r1
The Embedded Registry Mirror is available as of December 2024 releases: <INSERT VERSIONS>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe available as of X, GA as of Y?

In order to enable the embedded registry mirror, server nodes must be started with the `--embedded-registry` flag, or with `embedded-registry: true` in the configuration file.
This option enables the embedded mirror for use on all nodes in the cluster.

When enabled at a cluster level, all nodes will host a local OCI registry on port 6443,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double checking that this is true for RKE2, on port 6443?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's on the supervisor port. So 9345 for rke2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants