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 705fb92 commit d304b9a
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Customized vCluster Helm chart for use with custom vcluster container images tha

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).

### Usage
## 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.
> 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`.
```yaml
controlPlane:
Expand All @@ -19,9 +19,16 @@ controlPlane:
# such as: `vcluster-pro:0.22.3-k8s.v1.32.0`
tag: 0.22.3-k8s.v1.32.0
```
Deploy a vCluster with vCluster embedded binaries chart:
```bash
helm repo add vcluster https://loft-demos.github.io/helm-charts
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 d304b9a

Please sign in to comment.