Skip to content

Commit

Permalink
Add Raspberian installation steps to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ernoaapa committed Apr 18, 2018
1 parent 39fd7cd commit e0734fc
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 13 deletions.
4 changes: 3 additions & 1 deletion README.md
@@ -1,5 +1,7 @@

![Eliot](docs/eliot-logo-medium.png) [![Go Report Card](https://goreportcard.com/badge/github.com/ernoaapa/eliot)](https://goreportcard.com/report/github.com/ernoaapa/eliot)
![Eliot](docs/eliot-logo-medium.png)

[![Go Report Card](https://goreportcard.com/badge/github.com/ernoaapa/eliot)](https://goreportcard.com/report/github.com/ernoaapa/eliot)[![Go Report Card](https://img.shields.io/badge/deb-packagecloud.io-844fec.svg)](https://packagecloud.io/ernoaapa/eliot)

> This is early alpha version! There's not all features yet implemented, not heavily tested with different devices and code might get large breaking changes until the first release.
Expand Down
4 changes: 2 additions & 2 deletions docs/SUMMARY.md
Expand Up @@ -5,8 +5,8 @@
* [Use Cases](introduction.md#use-cases)
* [Eliot vs. Other](introduction.md#eliot-vs-other)
* [Installation](installation.md)
* [Install Eliot client](installation.md#install-eliot-client)
* [Install EliotOS](installation.md#install-eliotos)
* [Install CLI](installation.md#install-cli)
* [Install device](installation.md#install-device)
* [Getting Started](getting_started.md)
* [Core Concepts](getting_started.md#core-concepts)
* [Deploy first app](getting_started.md#deploy-first-app)
Expand Down
2 changes: 1 addition & 1 deletion docs/eliotos.md
@@ -1,6 +1,6 @@

# EliotOS
EliotOS is minimal Linux Operating System, built with [Linuxkit](https://github.com/linuxkit/linuxkit), which contains only minimal components to run Eliot.
EliotOS is minimal Linux Operating System, built with [Linuxkit](https://github.com/linuxkit/linuxkit), which contains only minimal components to run Eliot. At the moment, EliotOS supports only RaspberryPI3.

- `Linux kernel`
- `containerd` - Container runtime
Expand Down
42 changes: 33 additions & 9 deletions docs/installation.md
@@ -1,7 +1,7 @@
# Installation
> At the moment Eliot is tested only on RaspberryPI 3b with [EliotOS](eliotos.md) but installing it to other environments should be pretty straight forward. If you happen to test in some other device, [please let us know!](https://github.com/ernoaapa/eliot/issues/new)
> At the moment Eliot is tested only on RaspberryPI 3b, but installing it to other environments should be pretty straight forward. If you happen to test in some other device, [please let us know!](https://github.com/ernoaapa/eliot/issues/new)
## Install Eliot client
## Install CLI
Eliot client, called `eli`, is just a binary what you can download from [Eliot releases](https://github.com/ernoaapa/eliot/releases).

### MacOS
Expand All @@ -13,11 +13,16 @@ Eliot client, called `eli`, is just a binary what you can download from [Eliot r
2. Place it into your $PATH
3. Test `eli --version`

## Install EliotOS
By far the easiest and most secure way to use Eliot is by using [EliotOS](eliotos.md). EliotOS is minimal Linux Operating System, built with [linuxkit](https://github.com/linuxkit/linuxkit), which contains only minimal components to run Eliot which are Linux kernel, `runc`, `containerd` and `eliotd` daemon. Check the [EliotOS](eliotos.md) section for more info.
## Install device
There's three options for device installation

1. [Use EliotOS on RaspberryPI 3](/installation.html#eliotos-on-raspberrypi3)
2. [Use Debian linux (e.g. Raspbian) and use deb packages](/installation.html#debian-raspbian-installation)
3. [Manual installation to any linux](/installation.html#manual-installation)

### EliotOS on RaspberryPI3
By far the easiest and most secure way to use Eliot is by using [EliotOS](eliotos.md). EliotOS is minimal Linux Operating System, built with [linuxkit](https://github.com/linuxkit/linuxkit), which contains only minimal components to run Eliot which are Linux kernel, `runc`, `containerd` and `eliotd` daemon. Check the [EliotOS](eliotos.md) section for more info.

### RaspberryPI 3
`eli` provides [build command](client.md#eli-build-device) to build [EliotOS](eliotos.md) for RaspberryPI3 and install it to the sdcard.

1. Format sdcard as you would normally
Expand All @@ -30,7 +35,26 @@ By far the easiest and most secure way to use Eliot is by using [EliotOS](elioto

Next step is to follow [getting started guide](getting_started.md#deploy-first-app) and deploy first app!

## Manual installation
- Install and run [runc](https://github.com/opencontainers/runc)
- Install and run [containerd](https://github.com/containerd/containerd)
- Install and run [eliotd](https://github.com/ernoaapa/eliot)
### Debian (Raspbian) installation
Eliot provides deb packages through packagecloud for Debian linux, for example Raspbian, to install Eliot and all dependencies.

<a href="https://packagecloud.io/ernoaapa/eliot"><img height="46" width="158" alt="Eliot DEB Repository · packagecloud" src="https://packagecloud.io/images/packagecloud-badge.png" /></a>

```shell
# Install eliot deb repository
curl -s https://packagecloud.io/install/repositories/ernoaapa/eliot/script.deb.sh | sudo bash

# Install Eliot and dependencies
apt-get update && apt-get install -y eliot

# Start the services
systemctl start containerd && systemctl enable containerd
systemctl start eliotd && systemctl enable eliotd
```

That's it! Now try running `eli get nodes` and you should see your device!

### Manual installation
- Build and install [runc](https://github.com/opencontainers/runc)
- Build and install and run [containerd](https://github.com/containerd/containerd)
- Build and install and run [eliotd](https://github.com/ernoaapa/eliot)

0 comments on commit e0734fc

Please sign in to comment.