eliot

Eliot

This is early alpha version! Might be buggy, there's not all features yet implemented and code might get large breaking changes until the first release.

Eliot is a open source system for managing containerized applications on top of the IoT device with an emphasis to usability, simplicity, security and stability. Eliot gives simplified app delivery, isolation and additional security to traditional installations.

Docker and Kubernetes have inspired heavily and if you're familiar with those, you find really easy to get started with Eliot.

You can find documentation from http://docs.eliot.run

_{Built with ❤︎ by Erno Aapa and contributors}

Usage

Eliot is based on top of the containerd to provide simple API for managing containers.

Eliot is built from following components

• eli - Command line tool for managing the device
• eliotd - GRPC API for client to manage containers
• eliot-discovery - (Optional) component to make device automatically discoverable by the eli client

What is pod?

A Pod is a group of one or more containers what are tightly coupled to each other to build the service. Often the pod contains only one container but sometimes you need some external service, for example in-memory database, addition to your process. In this case, both containers should be in the same pod.

Features

• Manage running pods (softwares) in the device
• Attach to container remotely for debugging
• develop-in-device fast development start

Get list of devices

# List all the devices what are discoverable in the network
eli get devices

Start new pod

eli creates pods based on yaml configuration file.

cat <<EOF >> pods.yaml
metadata:
  name: "node-hello"
spec:
  containers:
    - name: "hello-world"
      image: "docker.io/eaapa/hello-world:latest"
EOF

Note: You can define multiple pods in same yaml file by separating them with --- line.

eli create -f pods.yaml

List running pods

eli get pods

View details of pod

eli describe pod <pod name>

Installation

Prerequisites

• containerd - see the installation docs
• runc (required by containerd)

Install

eliotd is just single binary what you can download from releases or build as described below. By default eliotd uses /run/containerd/containerd.sock socket file to connect containerd. If you have the file somewhere else, please provide --containerd flag.

Install from releases

TODO

Build from the sources

Install Go 1.9.x and clone the repository to your $GOPATH

BIN=eliotd make build
BIN=eli make build

Development

See the development getting started documentation.