Skip to content

Commit 399c0b6

Browse files
authored
Update README.md (#120)
Signed-off-by: Jann Fischer <[email protected]>
1 parent 97ccf08 commit 399c0b6

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

hack/demo-env/README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,41 @@ Both, vclusters and Argo CD installations, will require that LoadBalancer functi
2020

2121
## Set up
2222

23+
### Host cluster
24+
25+
The author uses [microk8s](https://microk8s.io/) as the host Kubernetes cluster. On Fedora, you can install it using `snap`, for Mac OS refer to their [installation tutorial](https://ubuntu.com/tutorials/install-microk8s-on-mac-os#1-overview). Microk8s comes with metallb, which makes things very easy.
26+
27+
After installing microk8s, you want to enable metallb and hostpath storage in that cluster. metallb gives your cluster load balancer capabilities, and the hostpath storage will allow vcluster to persist its configuration:
28+
29+
```shell
30+
sudo microk8s.enable metallb
31+
sudo microk8s.enable hostpath-storage
32+
```
33+
34+
You may want to export the kubectl configuration from microk8s so that your non-root user can easily use it. The following assumes that you will not have an existing kubectl configuration in your user's home, as it will overwrite any existing configuration.
35+
36+
```shell
37+
mkdir -p ~/.kube
38+
sudo microk8s.config > ~/.kube/config
39+
```
40+
41+
What's left is to install the metallb configuration. You should be good now.
42+
43+
```
44+
kubectl apply -n metallb-system -f hack/demo-env/metallb-ipaddresspool.yaml
45+
```
46+
47+
### Virtual clusters
48+
2349
Make sure you have administrative access to a cluster and [vcluster](https://github.com/loft-sh/vcluster) is installed on your machine and within your `$PATH`.
2450

25-
To setup, run
51+
To setup all required virtual clusters, run
2652

2753
```
2854
./hack/demo-env/setup-vcluster-env.sh create
2955
```
3056

31-
This will create three vclusters on your current cluster, and install opinionated Argo CD into each of them.
57+
This will create three vclusters on your current cluster, and install an opinionated Argo CD into each of them.
3258

3359
You will need `vcluster` in your `$PATH`, and the current kubeconfig context must be configured to connect to your cluster as a cluster admin.
3460

0 commit comments

Comments
 (0)