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

feat(ui) - remove eks distro option from docs #1748

Merged
merged 1 commit into from
May 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 7 additions & 22 deletions docs/pages/deploying-vclusters/supported-distros.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ vcluster create my-vcluster
```

Start using it:

```
kubectl get ns
...
Expand All @@ -34,6 +35,7 @@ vcluster create my-vcluster --distro k0s
```

Start using it:

```
kubectl get ns
...
Expand All @@ -54,33 +56,16 @@ vcluster create my-vcluster --distro k8s
```

Connect to the vCluster and start using it:

```
kubectl get ns
...
```

Behind the scenes, a different helm chart will be deployed (`vcluster-k8s`), that holds specific configuration to support vanilla k8s. Check the [GitHub repository](https://github.com/loft-sh/vcluster/tree/v0.19/charts/k8s) for all available chart options.


## eks

When choosing this option, vCluster will deploy a separate etcd cluster.

In order to use eks as backing cluster, create a vCluster with the following command:

```
vcluster create my-vcluster --distro eks
```

Connect to the vCluster and start using it:
```
kubectl get ns
...
```

Behind the scenes, a different helm chart will be deployed (`vcluster-eks`), that holds a specific configuration to support vanilla k8s. Check the [GitHub repository](https://github.com/loft-sh/vcluster/tree/v0.19/charts/eks) for all available chart options.


## Other Distributions

vCluster has no dependencies on any specific Kubernetes distribution, so you should be able to run it with most certified Kubernetes distributions.
Expand All @@ -91,11 +76,11 @@ Most multi binary distributions work by just overriding the images of the k8s ch

```yaml
api:
image: custom-domain.com/custom-kube-apiserver:v1.21.5
image: custom-domain.com/custom-kube-apiserver:v1.21.5
controller:
image: custom-domain.com/custom-kube-controller-manager:v1.21.5
image: custom-domain.com/custom-kube-controller-manager:v1.21.5
etcd:
image: custom-domain.com/custom-etcd:v3.4.16
image: custom-domain.com/custom-etcd:v3.4.16
```

And then deploy vCluster with:
Expand All @@ -106,11 +91,11 @@ vcluster create my-vcluster -n test --distro k8s -f values.yaml

If you want to create a separate chart for the Kubernetes distribution, a good starting point is to copy one of [our distro charts](https://github.com/loft-sh/vcluster/tree/v0.19/charts) and then modify it to work with your distribution.
vCluster only needs the following information from the virtual Kubernetes distribution to function properly:

1. The api server central authority certificate (usually found at `/pki/ca.crt`)
2. The api server central authority key (usually found at `/pki/ca.key`)
3. An admin kube config to contact the virtual Kubernetes control plane (usually found at `/pki/admin.conf`)

For multi binary distributions, vCluster can even create those with a pre-install hook as found in the [k8s chart](https://github.com/loft-sh/vcluster/tree/v0.19/charts/k8s/templates).

In general, if you need vCluster to support another Kubernetes distribution, we are always happy to help you or accept a pull request in our GitHub repository.