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: k3d Rancher Desktop #342

Merged
merged 5 commits into from
Jul 10, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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
39 changes: 38 additions & 1 deletion docs/common/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,41 @@ If Docker is running, and working properly (run `docker run hello-world` in your

```shell
export DOCKER_HOST="unix://$HOME/.docker/run/docker.sock"
```
```

### Using Rancher Desktop instead of Docker Desktop

Firstly, you need to disable Traefik in your Rancher Desktop because our installation uses Traefik and port forwarding. Between the conflicts and the double routing, it's just easier to disable Traefik on Rancher Desktop.

#### macOS (Apple Silicon)

> This is experimental. It works, but all of the features it uses are considered beta or exprimental by Rancher Desktop.

For Apple Silicon macs you need to enable a few features in Rancher Desktop before this will work. Run the following command in your terminalL

```shell
rdctl set --container-engine.name docker \
--kubernetes.options.traefik=false \
--experimental.virtual-machine.type vz \
--experimental.virtual-machine.use-rosetta=true \
--experimental.virtual-machine.mount.type virtiofs \
--experimental.virtual-machine.socket-vmnet=true
```

If you have any issues, reach out to us on slack in kubfirst.slack.com.

#### macOS (Intel)

Not yet tested.

#### Windows Subsystem for Linux (WSL) on Windows

Rancher Desktop is not yet supported but Docker Desktop is with [WSL on Windows](https://learn.microsoft.com/en-us/windows/wsl/install). There are limitations within Docker Desktop and how it manages volumes which prevent us from supporting it at this moment.

### Using nerdctl instead of Docker Desktop

We didn't try kubefirst k3d cluster creation with [nerdctl](https://github.com/containerd/nerdctl) yet. If you are using it, let us know how it's working or if you need any help.

### Using Lima instead of Docker Desktop

We didn't try kubefirst k3d cluster creation with [Lima](https://github.com/lima-vm/lima) yet. If you are using it, let us know how it's working or if you need any help.
9 changes: 8 additions & 1 deletion docs/k3d/partials/github/_install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ mkcert -install
```

This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
## Working without SSH

If you need your kubefirst installation to avoid using ssh whenver possible, you can bypass ssh and kubefirst will configure itself, argo, github actions, argocd, and your entire gitops workflow to utilize https instead of ssh at all times.

Provide the flag `--git-protocol https` when building your k3d cluster and kubefirst will take care of the rest.

If you ever need to change this, you will need to rebuild the cluser or manually update the templates in your gitops repo.

## Create your new local cluster

Expand Down Expand Up @@ -91,4 +98,4 @@ You will be automatically connected to your new Kubernetes cluster. To view all

```bash
kubectl get pods -A
```
```
10 changes: 9 additions & 1 deletion docs/k3d/partials/gitlab/_install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ mkcert -install

This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.

## Working without SSH

If you need your kubefirst installation to avoid using ssh whenver possible, you can bypass ssh and kubefirst will configure itself, argo, github actions, argocd, and your entire gitops workflow to utilize https instead of ssh at all times.

Provide the flag `--git-protocol https` when building your k3d cluster and kubefirst will take care of the rest.

If you ever need to change this, you will need to rebuild the cluser or manually update the templates in your gitops repo.

## Create your new local cluster

To create a new kubefirst cluster locally, run
Expand Down Expand Up @@ -100,4 +108,4 @@ You will be automatically connected to your new Kubernetes cluster. To view all

```bash
kubectl get pods -A
```
```