base on Container runtimes on macOS (and Linux) with minimal setup ![colima-logo](colima.png) ## Colima - container runtimes on macOS (and Linux) with minimal setup. [![Go](https://github.com/abiosoft/colima/actions/workflows/go.yml/badge.svg)](https://github.com/abiosoft/colima/actions/workflows/go.yml) [![Integration](https://github.com/abiosoft/colima/actions/workflows/integration.yml/badge.svg)](https://github.com/abiosoft/colima/actions/workflows/integration.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/abiosoft/colima)](https://goreportcard.com/report/github.com/abiosoft/colima) ![Demonstration](colima.gif) ## Features Support for Intel and Apple Silicon macOS, 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 and virtual machines) ## Getting Started ### Installation Colima is available on Homebrew, MacPorts, Nix and [mise](http://github.com/jdx/mise). Check [here](docs/INSTALL.md) for other installation options. ``` # Homebrew brew install colima # MacPorts sudo port install colima # Nix nix-env -iA nixpkgs.colima # Mise mise use -g colima@latest ``` 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 ``` ## Using Templates When you run the `colima template` command, Colima opens the default configuration in a temporary file using your editor (VS Code by default, if installed). For example, you might see something like: ```sh /var/folders/hm/xmq4vxs13dl2hx2jyct65r080000gn/T/colima-2758922589.yaml ``` You can edit this temporary file as needed. Once you save and close the file in the editor, Colima automatically overwrites the default template config located at: ```sh ~/.colima/_templates/default.yaml ``` To see more options for working with templates, run: ``` colima template --help ``` ## 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 <small>**Requires v0.7.0**</small> 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. **Note:** Running virtual machines on Incus is only supported on m3 or newer Apple Silicon devices. ### None <small>**Requires v0.7.0**</small> 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 100GiB 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. ## How to Contribute? Check [here](docs/CONTRIBUTE.md) for the instructions on contributing to the project. ## 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: <https://slack.cncf.io/> - Login: <https://cloud-native.slack.com/> ## Help Wanted - Documentation and project website ## License MIT ## Sponsoring the Project If you (or your company) are benefiting from the project and would like to support the contributors, kindly sponsor. - [Github Sponsors](https://github.com/sponsors/abiosoft) - [Buy me a coffee](https://www.buymeacoffee.com/abiosoft) - [Patreon](https://patreon.com/colima) --- [<img src="https://uploads-ssl.webflow.com/5ac3c046c82724970fc60918/5c019d917bba312af7553b49_MacStadium-developerlogo.png" style="max-height: 150px"/>](https://macstadium.com) ", Assign "at most 3 tags" to the expected json: {"id":"2490","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"