Skip to content

Commit

Permalink
docs: make it possible for lima to provide both
Browse files Browse the repository at this point in the history
Signed-off-by: Anders F Björklund <[email protected]>
  • Loading branch information
afbjorklund authored and benoitf committed Nov 14, 2023
1 parent 6bee813 commit 57006e5
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions website/docs/lima/customizing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
sidebar_position: 4
title: Customizing Lima instance
description: Customizing Lima
keywords: [podman desktop, containers, kubernetes, lima]
tags: [lima]
---

# Customizing the Lima instance for varying workloads

You can customize Lima instance, using YAML and `yq`.

#### Procedure

- To create a new instance:

```shell-session
$ limactl create <instance>
```

- To edit an existing instance:

```shell-session
$ limactl edit <instance>
```

Some of the things you can edit:

- Change the number of CPUs, the memory, and the disk size
- Change the operating system (the Linux distribution)
- Modify the cluster setup (the Kubernetes distribution)
- Run **both** of container workloads and Kubernetes workloads

### Containers

You can install a container engine, in addition to the existing runtime.

For instance you can install [Podman Engine](https://github.com/containers/podman),
or you can install [Docker Engine](https://github.com/docker/docker).
After that you can port forward the socket, to the host `Dir`.

- `/var/run/docker.sock`
- `/run/podman/podman.sock`

```bash
export DOCKER_HOST="unix://{{.Dir}}/sock/docker.sock"
```

### Kubernetes

You can install Kubernetes, on top of the existing container engine.

For instance you can use [CRI-O](https://github.com/cri-o/cri-o) for Podman,
or [CRI-Dockerd](https://github.com/Mirantis/cri-dockerd) for Docker.
After that you can copy the `kubeconfig.yaml` file, to the host `Dir`.

- `/etc/rancher/k3s/k3s.yaml`
- `/etc/kubernetes/admin.conf`

```bash
export KUBECONFIG="{{.Dir}}/copied-from-guest/kubeconfig.yaml"
```

0 comments on commit 57006e5

Please sign in to comment.