Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abiosoft/colima
Container runtimes on macOS (and Linux) with minimal setup
https://github.com/abiosoft/colima
containerd containerd-compose containers docker docker-compose k3s k8s kubernetes lima macos nerdctl
Last synced: about 2 months ago
JSON representation
Container runtimes on macOS (and Linux) with minimal setup
- Host: GitHub
- URL: https://github.com/abiosoft/colima
- Owner: abiosoft
- License: mit
- Created: 2021-09-04T09:52:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T05:35:17.000Z (4 months ago)
- Last Synced: 2024-05-21T00:24:35.832Z (4 months ago)
- Topics: containerd, containerd-compose, containers, docker, docker-compose, k3s, k8s, kubernetes, lima, macos, nerdctl
- Language: Go
- Homepage:
- Size: 2.55 MB
- Stars: 17,176
- Watchers: 58
- Forks: 352
- Open Issues: 279
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome - abiosoft/colima - Container runtimes on macOS (and Linux) with minimal setup (Go)
- Self-Hosting-Guide - Colima
- awesome - abiosoft/colima - Container runtimes on macOS (and Linux) with minimal setup (Go)
- awesome-rainmana - abiosoft/colima - Container runtimes on macOS (and Linux) with minimal setup (Go)
- awesomeness - colima
- my-awesome - abiosoft/colima - compose,containers,docker,docker-compose,incus,k3s,k8s,kubernetes,lima,macos,nerdctl pushed_at:2024-09 star:18.6k fork:0.4k Container runtimes on macOS (and Linux) with minimal setup (Go)
- awesome-ops - abiosoft/colima - 09-04|2024-08-06 | MacOS 和 Linux 上的容器运行时，只需最少的设置 | (Docker-Tools)
- StarryDivineSky - abiosoft/colima
README
## Colima - container runtimes on macOS (and Linux) with minimal setup.
[](https://github.com/abiosoft/colima/actions/workflows/go.yml)
[](https://github.com/abiosoft/colima/actions/workflows/integration.yml)
## Features
Support for Intel and Apple Silicion Macs, and Linux
- Simple CLI interface with sensible defaults
- Automatic Port Forwarding
- Volume mounts
- Multiple instances
- Support for multiple container runtimes
- [Docker](https://docker.com) (with optional Kubernetes)
- [Containerd](https://containerd.io) (with optional Kubernetes)
- [Incus](https://linuxcontainers.org/incus) (containers only)
## Getting Started
### Installation
Colima is available on Homebrew, MacPorts, and Nix. Check [here](docs/INSTALL.md) for other installation options.
```
# Homebrew
brew install colima
# MacPorts
sudo port install colima
# Nix
nix-env -iA nixpkgs.colima
```
Or stay on the bleeding edge (only Homebrew)
```
brew install --HEAD colima
```
### Upgrading
If upgrading from v0.5.6 or lower, it is required to start afresh by deleting existing instance.
```sh
colima delete # delete existing instance
colima start
```
## Usage
Start Colima with defaults
```
colima start
```
For more usage options
```
colima --help
colima start --help
```
Or use a config file
```
colima start --edit
```
## Runtimes
On initial startup, Colima initiates with a user specified runtime that defaults to Docker.
### Docker
Docker client is required for Docker runtime. Installable with brew `brew install docker`.
You can use the `docker` client on macOS after `colima start` with no additional setup.
### Containerd
`colima start --runtime containerd` starts and setup Containerd. You can use `colima nerdctl` to interact with
Containerd using [nerdctl](https://github.com/containerd/nerdctl).
It is recommended to run `colima nerdctl install` to install `nerdctl` alias script in $PATH.
### Kubernetes
kubectl is required for Kubernetes. Installable with `brew install kubectl`.
To enable Kubernetes, start Colima with `--kubernetes` flag.
```
colima start --kubernetes
```
#### Interacting with Image Registry
For Docker runtime, images built or pulled with Docker are accessible to Kubernetes.
For Containerd runtime, images built or pulled in the `k8s.io` namespace are accessible to Kubernetes.
### Incus
**Requires v0.7.0**
Incus client is required for Incus runtime. Installable with brew `brew install incus`.
`colima start --runtime incus` starts and setup Incus.
You can use the `incus` client on macOS after `colima start` with no additional setup.
### None
**Requires v0.7.0**
Colima can also be utilised solely as a headless virtual machine manager by specifying `none` runtime.
### Customizing the VM
The default VM created by Colima has 2 CPUs, 2GiB memory and 60GiB storage.
The VM can be customized either by passing additional flags to `colima start`.
e.g. `--cpu`, `--memory`, `--disk`, `--runtime`.
Or by editing the config file with `colima start --edit`.
**NOTE**: ~~disk size cannot be changed after the VM is created.~~ From v0.5.3, disk size can be increased.
#### Customization Examples
- create VM with 1CPU, 2GiB memory and 10GiB storage.
```
colima start --cpu 1 --memory 2 --disk 10
```
- modify an existing VM to 4CPUs and 8GiB memory.
```
colima stop
colima start --cpu 4 --memory 8
```
- create VM with Rosetta 2 emulation. Requires v0.5.3 and MacOS >= 13 (Ventura) on Apple Silicon.
```
colima start --vm-type=vz --vz-rosetta
```
## Project Goal
To provide container runtimes on macOS with minimal setup.
## What is with the name?
Colima means Containers on [Lima](https://github.com/lima-vm/lima).
Since Lima is aka Linux Machines. By transitivity, Colima can also mean Containers on Linux Machines.
## And the Logo?
The logo was contributed by [Daniel Hodvogner](https://github.com/dhodvogner). Check [this issue](https://github.com/abiosoft/colima/issues/781) for more.
## Troubleshooting and FAQs
Check [here](docs/FAQ.md) for Frequently Asked Questions.
## Community
- [GitHub Discussions](https://github.com/abiosoft/colima/discussions)
- [GitHub Issues](https://github.com/abiosoft/colima/issues)
- `#colima` channel in the CNCF Slack
- New account:
- Login:
## Help Wanted
- Documentation (wiki pages)
## License
MIT
## Sponsoring the Project
If you (or your company) are benefiting from the project and would like to support the contributors, kindly support the project.
[
](https://macstadium.com)