docs: Lima onboarding details (#4098)

* docs: add Lima preferences details

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

* docs: add Lima Kubernetes details

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

* docs: use new simplified limactl

Use the simplified template:// and limactl parameters,
instead of exposing the yaml and yq directly to the user.

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

---------

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
This commit is contained in:
Anders Björklund 2023-09-27 08:33:35 +02:00 committed by GitHub
parent a48d823cd2
commit 4438e3abf6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 43 additions and 2 deletions

View file

@ -54,14 +54,30 @@ Consider creating a custom Lima instance to:
$ limactl start --name=docker template://docker-rootful
```
- To select the number of CPUs, the memory, and the disk size, add the `--set` option to the `limactl start` command:
- To select the number of CPUs, the memory, and the disk size, add the options to the `limactl start` command:
```shell-session
--set='.cpus = 2 | .memory = "2GiB" | .disk = "50GiB"'
--cpus=2 --memory=2 --disk=50
```
2. Wait for the instance to start, and restart the Lima extension.
- Go to **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Preferences > Extension: Lima**, to change the instance name and type.
- Podman (default)
- Type: podman
- Name: podman
![Lima preferences Podman](img/lima-preferences-podman.png)
- Docker
- Type: docker
- Name: docker
![Lima preferences Docker](img/lima-preferences-docker.png)
- Go to **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Extensions > Lima**, to disable and enable the extension after changes.
#### Verification
- To verify the connection to a running "podman" instance:

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

View file

@ -15,6 +15,7 @@ In the future, Podman Desktop might be able to create Lima instances.
Consider creating a custom Lima instance to:
- Control the assigned resources: CPUs, memory, and disk size.
- Control which Kubernetes distribution (`template`) to install.
#### Prerequisites
@ -41,12 +42,36 @@ Consider creating a custom Lima instance to:
$ limactl start template://k8s
```
- To select the number of CPUs, the memory, and the disk size, add the options to the `limactl start` command:
```shell-session
--cpus=4 --memory=4 --disk=100
```
2. Wait for the instance to start, and restart the Lima extension.
- Go to **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Preferences > Extension: Lima**, to change the instance name and type.
- k3s
- Type: kubernetes
- Name: k3s
![Lima preferences k3s](img/lima-preferences-k3s.png)
- k8s
- Type: kubernetes
- Name: k8s
![Lima preferences k8s](img/lima-preferences-k8s.png)
- Go to **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Extensions > Lima**, to disable and enable the extension after changes.
#### Verification
1. When the installation is done, the location of the KUBECONFIG file is printed. See [Configuring access to a Kubernetes cluster](/docs/kubernetes/configuring-access-to-a-kubernetes-cluster).
- Go to **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Preferences > Path to the kubeconfig file**, to set the path of the file.
1. Use the `kubectl.lima` wrapper script to connect to the cluster:
```shell-session

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB