README
¶
balenaEngine: Moby-based container engine for IoT
Overview
balenaEngine is a new container engine purpose-built for embedded and IoT use cases and compatible with Docker containers. Based on Docker’s Moby Project, balenaEngine supports container deltas for 10-70x more efficient bandwidth usage, has 3x smaller binaries, uses RAM and storage more conservatively, and focuses on atomicity and durability of container pulling.
Features
- Small footprint
- 3.5x smaller than Docker CE, packaged as a single binary
- Multi-arch support
- Available for a wide variety of chipset architectures, supporting everything from tiny IoT devices to large industrial gateways
- True container deltas
- Bandwidth-efficient updates with binary diffs, 10-70x smaller than pulling layers
- Minimal wear-and-tear
- Extract layers as they arrive to prevent excessive writing to disk, protecting your storage from eventual corruption
- Failure-resistant pulls
- Atomic and durable image pulls defend against partial container pulls in the event of power failure
- Conservative memory use
- Prevents page cache thrashing during image pull, so your application runs undisturbed in low-memory situations
Transitioning from Docker CE
We left out Docker features that we saw as most needed in cloud deployments and therefore not warranting inclusion in a lightweight IoT-focused container engine. Specifically, we’ve excluded:
- Docker Swarm
- Cloud logging drivers
- Plugin support
- Overlay networking drivers
- Non-boltdb discovery backends (consul, zookeeper, etcd, etc.)
Unless you depend on one of the features in Docker that balenaEngine omits, using balenaEngine should be a drop-in replacement.
Licensing
balenaEngine is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
Directories
¶
| Path | Synopsis |
|---|---|
|
types
Package types is used for API stability in the types and response to the consumers of the API stats endpoint.
|
Package types is used for API stability in the types and response to the consumers of the API stats endpoint. |
|
types/backend
Package backend includes types to send information to server backends.
|
Package backend includes types to send information to server backends. |
|
types/filters
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
|
Package filters provides tools for encoding a mapping of keys to a set of multiple values. |
|
types/plugins/logdriver
Package logdriver is a generated protocol buffer package.
|
Package logdriver is a generated protocol buffer package. |
|
types/swarm/runtime
Package runtime is a generated protocol buffer package.
|
Package runtime is a generated protocol buffer package. |
|
types/versions/v1p19
Package v1p19 provides specific API types for the API version 1, patch 19.
|
Package v1p19 provides specific API types for the API version 1, patch 19. |
|
types/versions/v1p20
Package v1p20 provides specific API types for the API version 1, patch 20.
|
Package v1p20 provides specific API types for the API version 1, patch 20. |
|
Package builder defines interfaces for any Docker builder to implement.
|
Package builder defines interfaces for any Docker builder to implement. |
|
dockerfile
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline.
|
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline. |
|
remotecontext
Package remotecontext is a generated protocol buffer package.
|
Package remotecontext is a generated protocol buffer package. |
|
Package client is a Go client for the Docker Engine API.
|
Package client is a Go client for the Docker Engine API. |
|
cmd
|
|
|
contrib
|
|
|
Package daemon exposes the functions that occur on the host server that the Docker daemon is running.
|
Package daemon exposes the functions that occur on the host server that the Docker daemon is running. |
|
logger
Package logger defines interfaces that logger drivers implement to log messages.
|
Package logger defines interfaces that logger drivers implement to log messages. |
|
logger/awslogs
Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs
|
Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs |
|
logger/etwlogs
Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd".
|
Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd". |
|
logger/fluentd
Package fluentd provides the log driver for forwarding server logs to fluentd endpoints.
|
Package fluentd provides the log driver for forwarding server logs to fluentd endpoints. |
|
logger/gelf
Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format.
|
Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format. |
|
logger/journald
Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format.
|
Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format. |
|
logger/jsonfilelog
Package jsonfilelog provides the default Logger implementation for Docker logging.
|
Package jsonfilelog provides the default Logger implementation for Docker logging. |
|
logger/local
Package local provides a logger implementation that stores logs on disk.
|
Package local provides a logger implementation that stores logs on disk. |
|
logger/logentries
Package logentries provides the log driver for forwarding server logs to logentries endpoints.
|
Package logentries provides the log driver for forwarding server logs to logentries endpoints. |
|
logger/splunk
Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint.
|
Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint. |
|
logger/syslog
Package syslog provides the logdriver for forwarding server logs to syslog endpoints.
|
Package syslog provides the logdriver for forwarding server logs to syslog endpoints. |
|
Package dockerversion is auto-generated at build-time
|
Package dockerversion is auto-generated at build-time |
|
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors.
|
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors. |
|
hack
|
|
|
Package integration provides integrations tests for Moby (API).
|
Package integration provides integrations tests for Moby (API). |
|
integration-cli
|
|
|
checker
Package checker provides Docker specific implementations of the go-check.Checker interface.
|
Package checker provides Docker specific implementations of the go-check.Checker interface. |
|
internal
|
|
|
Package layer is package for managing read-only and read-write mounts on the union file system driver.
|
Package layer is package for managing read-only and read-write mounts on the union file system driver. |
|
migrate
|
|
|
pkg
|
|
|
aaparser
Package aaparser is a convenience package interacting with `apparmor_parser`.
|
Package aaparser is a convenience package interacting with `apparmor_parser`. |
|
filenotify
Package filenotify provides a mechanism for watching file(s) for changes.
|
Package filenotify provides a mechanism for watching file(s) for changes. |
|
locker
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks.
|
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks. |
|
parsers
Package parsers provides helper functions to parse and validate different type of string.
|
Package parsers provides helper functions to parse and validate different type of string. |
|
parsers/kernel
Package kernel provides helper function to get, parse and compare kernel versions for different platforms.
|
Package kernel provides helper function to get, parse and compare kernel versions for different platforms. |
|
parsers/operatingsystem
Package operatingsystem provides helper function to get the operating system name for different platforms.
|
Package operatingsystem provides helper function to get the operating system name for different platforms. |
|
pidfile
Package pidfile provides structure and helper functions to create and remove PID file.
|
Package pidfile provides structure and helper functions to create and remove PID file. |
|
platform
Package platform provides helper function to get the runtime architecture for different platforms.
|
Package platform provides helper function to get the runtime architecture for different platforms. |
|
plugins
Package plugins provides structures and helper functions to manage Docker plugins.
|
Package plugins provides structures and helper functions to manage Docker plugins. |
|
pools
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
|
signal
Package signal provides helper functions for dealing with signals across various operating systems.
|
Package signal provides helper functions for dealing with signals across various operating systems. |
|
streamformatter
Package streamformatter provides helper functions to format a stream.
|
Package streamformatter provides helper functions to format a stream. |
|
stringid
Package stringid provides helper functions for dealing with string identifiers
|
Package stringid provides helper functions for dealing with string identifiers |
|
tailfile
Package tailfile provides helper functions to read the nth lines of any ReadSeeker.
|
Package tailfile provides helper functions to read the nth lines of any ReadSeeker. |
|
tarsum
Package tarsum provides algorithms to perform checksum calculation on filesystem layers.
|
Package tarsum provides algorithms to perform checksum calculation on filesystem layers. |
|
term
Package term provides structures and helper functions to work with terminal (state, sizes).
|
Package term provides structures and helper functions to work with terminal (state, sizes). |
|
truncindex
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id.
|
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id. |
|
urlutil
Package urlutil provides helper function to check urls kind.
|
Package urlutil provides helper function to check urls kind. |
|
useragent
Package useragent provides helper functions to pack version information into a single User-Agent header.
|
Package useragent provides helper functions to pack version information into a single User-Agent header. |
|
profiles
|
|
|
Package registry contains client primitives to interact with a remote Docker registry.
|
Package registry contains client primitives to interact with a remote Docker registry. |
|
local
Package local provides the default implementation for volumes.
|
Package local provides the default implementation for volumes. |
Click to show internal directories.
Click to hide internal directories.