Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balena-os/balenaos-in-container
Run balenaOS as a docker container
https://github.com/balena-os/balenaos-in-container
containerization containers docker resin resinos
Last synced: about 1 month ago
JSON representation
Run balenaOS as a docker container
- Host: GitHub
- URL: https://github.com/balena-os/balenaos-in-container
- Owner: balena-os
- License: apache-2.0
- Created: 2018-01-11T18:55:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T20:21:16.000Z (5 months ago)
- Last Synced: 2024-11-06T07:40:14.642Z (about 2 months ago)
- Topics: containerization, containers, docker, resin, resinos
- Language: Shell
- Homepage: https://www.balena.io/os/
- Size: 161 KB
- Stars: 49
- Watchers: 9
- Forks: 14
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# balenaOS in a docker container
This is a tool which enables running balenaOS docker images as a docker container.
## Prerequisites
Before running this tool make sure:
1. Docker daemon is running
2. Current user has privileges to run docker commands.
3. Depending on what balenaOS image you are trying to boot, you might need aufs or overlayfs on your host.
4. The balenaOS image is compatible with the architecture where you are running the script. e.g. If you are running this script on your laptop (x86_64), you can run balenaOS images built for the NUC which are also x86_64. [***](#running-other-architectures)
5. `balenaos-in-container` does not support [`cgroups v2`](https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html) yet. Check the version of `cgroups` of your machine. [Guides for Linux users](https://unix.stackexchange.com/questions/619681/how-can-i-find-out-what-version-of-cgroups-i-have), and [Docker Desktop on Mac users](https://docs.docker.com/desktop/mac/release-notes/#bug-fixes-and-minor-changes-1). Downgrade your `cgroups` to v1 if you want to use `balenaos-in-container`.
## How to use
```bash
docker-compose up --build
```
This assumes you have a `config.json` in the project directory. It can be downloaded from your balenaCloud dashboard. Once you have added an application click "Add a new device", click to expand the "Advanced" section and check "Download configuration file only" now click "Download configuration file".
You can find the latest balenaOS images on [dockerhub](https://hub.docker.com/r/resin/resinos/tags).
If you need to clear volumes and start with a clean state, use the following compose commands:
```bash
# bring down all services and remove volumes
docker-compose down --volumes --remove-orphans
# build and bring up services again with new volumes
docker-compose up -d --build
```
## Running other architectures
It's possible to run a container images that target other platforms than your host system by registering QEMU's user-mode emulation.
Check out https://github.com/dbhi/qus/#setup for how to set that up.
## Development
Want to contribute? Great! Throw pull requests at us.