diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 404170443..5ad14473e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,7 @@ Run: * A running Kubernetes cluster v1.26 or newer and Kubectl installed, verify Kubernetes version via `kubectl version` * Docker needs to be installed (e.g. docker-desktop, orbstack, rancher desktop etc.) -* Helm installed and verify via `helm version` +* Helm v3.10.0+ installed and verify via `helm version` * Golang version 1.22 and verify via `go version` #### 2. Git clone the repository `git clone https://github.com/loft-sh/vcluster.git` diff --git a/README.md b/README.md index 40585e5ea..788b60403 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ To learn more about vcluster, [**open the full getting started guide**](https:// ### 1. Download vcluster CLI -VCluster has a hard dependency on `helm`, if it is not installed on your machine, you can [install it](https://helm.sh/docs/intro/install/) beforehand or let vCluster install it for you. +VCluster has a hard dependency on `helm` (v3.10.0+), if it is not installed on your machine, you can [install it](https://helm.sh/docs/intro/install/) beforehand or let vCluster install it for you. Use one of the following commands to download the vcluster CLI binary from GitHub: diff --git a/chart/README.md b/chart/README.md index 5125c17c0..826388e1c 100644 --- a/chart/README.md +++ b/chart/README.md @@ -8,7 +8,7 @@ Create fully functional virtual Kubernetes clusters - Each vcluster runs inside ## Prerequisites - Kubernetes 1.18+ -- Helm 3+ +- Helm 3.10.0+ ## Get Helm Repository Info diff --git a/docs/pages/cli/vcluster_pro_start.md b/docs/pages/cli/vcluster_pro_start.md index 9f285cc81..0210ea478 100644 --- a/docs/pages/cli/vcluster_pro_start.md +++ b/docs/pages/cli/vcluster_pro_start.md @@ -29,7 +29,7 @@ Please make sure you meet the following requirements before running this command: 1. Current kube-context has admin access to the cluster -2. Helm v3 must be installed +2. Helm v3.10.0+ must be installed 3. kubectl must be installed ######################################################## diff --git a/docs/pages/getting-started/setup.mdx b/docs/pages/getting-started/setup.mdx index bc5707419..5935c937f 100644 --- a/docs/pages/getting-started/setup.mdx +++ b/docs/pages/getting-started/setup.mdx @@ -11,10 +11,10 @@ In this guide, you learn the following: 1. How to install the vCluster CLI. 1. [How to deploy vCluster](./deployment.mdx). -1. [How to connect to vCluster and how vCluster interacts with the host cluster](./connect.mdx). +1. [How to connect to vCluster and how vCluster interacts with the host cluster](./connect.mdx). 1. [How to uninstall vCluster](./cleanup.mdx). -These exercises should take about 10 minutes. +These exercises should take about 10 minutes. You can join the [Loft Users Slack](https://slack.loft.sh/) to ask questions in the #vcluster channel. @@ -22,13 +22,13 @@ Terms: * **vCluster**: the product; this also refers to a vCluster installation. * `vcluster`: the CLI. -* **host**: The Kubernetes cluster that you install vCluster on. +* **host**: The Kubernetes cluster that you install vCluster on. ## Before you begin - You have read [What Are Virtual Clusters](../what-are-virtual-clusters.mdx). -- You have installed [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) (check via `kubectl version`) and [Helm v3](https://helm.sh/docs/intro/install/) (check with `helm version`). +- You have installed [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) (check via `kubectl version`) and [Helm v3.10.0+](https://helm.sh/docs/intro/install/) (check with `helm version`). - You have access to a Kubernetes cluster to use as the host cluster (check with `kubectl get namespaces`) ## Install the vCluster CLI @@ -37,5 +37,5 @@ Use one of the following commands to download and install the vCluster CLI binar - +