Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kmadel authored Jan 20, 2025
1 parent d304b9a commit d7152ca
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# vCluster Chart for Embedded K8s Binaries
Customized vCluster Helm chart for use with custom vcluster container images that embed Kubernetes binaries directly into the vCluster container image instead of the Kubernetes binaries being copied from upstream container images attached as init containers to the vCluster `Pod`.

The `.tgz` for the chart may be downloades from the [repository releases](https://github.com/loft-demos/vcluster-charts/releases) and the chart is meant to be used with the vcluster-pro images published in the [loft-demos/k8s-image-mirror GHCR](https://github.com/loft-demos/k8s-image-mirror/pkgs/container/vcluster-pro).
The `.tgz` for the chart may be downloades from the [repository releases](https://github.com/loft-demos/vcluster-charts/releases) and the chart is meant to be used with the vcluster-pro images published in the [loft-demos/k8s-image-mirror GitHub Container Registry](https://github.com/loft-demos/k8s-image-mirror/pkgs/container/vcluster-pro).

## Usage
Create a `vcluster.yaml` with the following values (along with any other additional configuration needed based on the [vCluster configuration reference documentation](https://www.vcluster.com/docs/vcluster/configure/vcluster-yaml/):

> [!NOTE]
> Currently only the `k8s` plain vanilla Kubernetes distubtion is supporte and `k8s` is the default `controlPlane.distro` that is enabled by default, so no additional configuration is needed for the `distro`.
> Currently, only the [vanilla Kubernetes distribution](https://kubernetes.io/releases/) is supported. `k8s` is the default `controlPlane.distro` and is enabled by default, so no additional configuration is needed for the `distro`.
```yaml
controlPlane:
Expand All @@ -27,8 +27,6 @@ helm install my-vcluster vcluster/vcluster --values vcluster.yaml
```

For Air-Gapped Environments:
```
Deploy a vCluster with vCluster embedded binaries chart:
```bash
helm install my-vcluster ./vcluster-0.22.3.tgz --values vcluster.yaml
```

0 comments on commit d7152ca

Please sign in to comment.