Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ernoaapa
ernoaapa committed Jan 29, 2018
1 parent 39772fe commit f73a7d0
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 24 deletions.
4 changes: 3 additions & 1 deletion book.json
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
{
"gitbook": ">= 3.2.3",
"root": "./docs",
"title": "Eliot - Docker and Kubernetes inspired container platform for IoT devices",
"plugins": [
"insert-logo",
"analytics",
"terminal",
"anchors",
"github",
"include-html"
"include-html",
"easyseo"
],
"pluginsConfig": {
"insert-logo": {
Expand Down
6 changes: 0 additions & 6 deletions build/docs.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
# Small script to build and update documentation to GitHub Pages
#

# npm install gitbook-plugin-insert-logo
# npm install gitbook-plugin-analytics
# npm install gitbook-plugin-terminal
# npm install gitbook-plugin-anchors
# npm install gitbook-plugin-github@2.0.0

rm -rf _book
gitbook install
gitbook build
Expand Down
13 changes: 11 additions & 2 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
```description
Eliot is, Kubernetes and Docker inspired, a open source system for managing containerized applications on top of the IoT device with an emphasis to usability, simplicity, security and stability.
```
```keywords
IoT,container,Kubernetes,Docker,Eliot,containerd,runc,linuxkit,connected devices,devops,security
```

![Eliot](https://raw.githubusercontent.com/ernoaapa/eliot/master/docs/eliot-logo-medium.png)
> 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.
> This is early alpha version! There are not all features yet implemented, not heavily tested with different devices and code might get large breaking changes until the first release.
[Eliot](/~https://github.com/ernoaapa/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.
[Eliot](/~https://github.com/ernoaapa/eliot) is an open source system for managing containerized applications on top of the IoT device with an emphasis on usability, simplicity, security, and stability. Eliot gives simplified app delivery, isolation and additional security to traditional installations.

[Docker](https://www.docker.com) and [Kubernetes](https://www.kubernetes.io) have inspired heavily and if you're familiar with those, you find really easy to get started with Eliot.

## See it in action!
!INCLUDE "asciinema-demo.html"

Or check out [this introduction article in Medium](https://medium.com/@aapaerno/announcing-eliot-container-platform-for-iot-devices-ad071e1917fd)

!INCLUDE "subscribe-form.html"

<sub>Built with ❤︎ by [Erno Aapa](/~https://github.com/ernoaapa) and [contributors](/~https://github.com/ernoaapa/eliot/contributors)</sub>
30 changes: 15 additions & 15 deletions docs/introduction.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Who?

[Eliot](/~https://github.com/ernoaapa/eliot) is a open source system for managing containerized applications on top of the IoT device with an emphasis to usability, simplicity and security. Eliot gives simplified app deployment, isolation and additional security to connected device solutions.
[Eliot](/~https://github.com/ernoaapa/eliot) is an open source system for managing containerized applications on top of the IoT device with an emphasis on usability, simplicity, and security. Eliot gives simplified app deployment, isolation and additional security to connected device solutions.

In consideration of connected device limitations like unstable connection, limited computing resources, hardware connectivity, Eliot connects devices to single easy to use platform where you can manage devices and applications easily and safely.

Expand All @@ -10,8 +10,8 @@ In consideration of connected device limitations like unstable connection, limit
## Motivation

I was building modern connected device product what users are located around the world.
I have over 10 years of software engineer experience with five years of DevOps and faced problem that there's no state-of-the-art solution for managing connected devices a way that is common nowadays in cloud solutions.
Most platforms and services focus heavily to the cloud connectivity, data processing and analysis, but I needed a solution to manage device Operating System and application deployment to build easy to use, modern service for our customers.
I have over 10 years of software engineer experience with five years of DevOps and faced the problem that there's no state-of-the-art solution for managing connected devices a way that is common nowadays in cloud solutions.
Most platforms and services focus heavily to the cloud connectivity, data processing, and analysis, but I needed a solution to manage device Operating System and application deployment to build easy to use, modern service for our customers.

Key features needed:
- Quick realtime in-device development
Expand All @@ -25,39 +25,39 @@ And that's the day when [Eliot](/~https://github.com/ernoaapa/eliot) were born ❤

## Use cases

Eliot have small footprint and minimal requirements why it's suitable to wide range or use cases.
Linux is used nowadays everywhere; info screens, sensors, factories, home IoT, security, cars, etc. and Eliot can support most of them as long as there is enough resources and new enough Linux kernel. Thanks to Golang, there's releases available to wide range of architectures.
Eliot has a small footprint and minimal requirements why it's suitable for a wide range or use cases.
Linux is used nowadays everywhere; info screens, sensors, factories, home IoT, security, cars, etc. and Eliot can support most of them as long as there are enough resources and new enough Linux kernel. Thanks to Golang, there's releases available to wide range of architectures.

## Eliot vs. Other

### Docker

[Docker](https://www.docker.com) is a software technology providing containers, promoted by the company [Docker, Inc.](http://www.docker.com/company), and provides full blown container platform for cloud environment, taking care of container distribution, orchestration, authentication, infrastructure, etc. Docker have been playing a big role pushing out the container technology.
[Docker](https://www.docker.com) is a software technology providing containers, promoted by the company [Docker, Inc.](http://www.docker.com/company), and provides full-blown container platform for the cloud environment, taking care of container distribution, orchestration, authentication, infrastructure, etc. Docker has been playing a big role pushing out the container technology.

At the heart ❤︎ of Docker is [containerd](https://containerd.io), which provides an additional layer of abstraction and automation of operating-system-level virtualization on Windows and Linux. Docker extracted and open sourced to accelerate the innovation across the ecosystem and donated it to open foundation. _And Eliot is based on the containerd!_

Eliot and Docker are not competing against each other; they are working together, in Open Source, to take the ecosystem forward.

### Kubernetes

[Kubernetes](https://www.kubernetes.io) is great platform for orchestrating containerized software in cloud environment. Kubernetes have been one of the fastest growing open source project in past years and new integrations and 3rd party support is popping out everyday.
[Kubernetes](https://www.kubernetes.io) is a great platform for orchestrating containerized software in the cloud environment. Kubernetes have been one of the fastest growing open source project in past years and new integrations and 3rd party support are popping out every day.

Keys to Kubernetes great success, addition to great community, are simple concepts and consistent APIs.
That's why Eliot is following the great leader and picks many great concepts that works in IoT domain and implements them same way!
Keys to Kubernetes great success, addition to the great community, are simple concepts and consistent APIs.
That's why Eliot is following the great leader and picks many great concepts that work in IoT domain and implements them the same way!
Kubernetes is pushing the boundaries of cloud computing and Eliot is working on in IoT.

### AWS, Azure, Google, IBM
All cloud IoT solutions ([AWS](https://aws.amazon.com/iot/), [Azure](https://azure.microsoft.com/en-us/suites/iot-suite/), [Google](https://cloud.google.com/solutions/iot/), [IBM](https://www.ibm.com/internet-of-things)) base to the same practice, you use SDK to implement software that collects data from sensor and send it to the cloud where data gets processed and analysed. Analysis result can send message back to the device to trigger some action.
All cloud IoT solutions ([AWS](https://aws.amazon.com/iot/), [Azure](https://azure.microsoft.com/en-us/suites/iot-suite/), [Google](https://cloud.google.com/solutions/iot/), [IBM](https://www.ibm.com/internet-of-things)) base to the same practice, you use SDK to implement software that collects data from the sensor and send it to the cloud where data gets processed and analyzed. Analysis result can send a message back to the device to trigger some action.

Eliot don't try to provide this kind of features at all, actually you can use any cloud service with Eliot.
Eliot provides a easy way to deliver your cloud integration to the device and gives you a way to update the software across thousands of devices safely and easily.
Eliot doesn't try to provide this kind of features at all, actually, you can use any cloud service with Eliot.
Eliot provides an easy way to deliver your cloud integration to the device and gives you a way to update the software across thousands of devices safely and easily.

Even better, might be that you don't need to code anything! There might be available open source implementation made by someone in Docker community or you can share your code to the thousands of Docker users around the world with single command.
Even better, might be that you don't need to code anything! There might be available open source implementation made by someone in Docker community or you can share your code with the thousands of Docker users around the world with a single command.

### Ansible, Chef, SaltStack

Configuration management tools (e.g. [Ansible](https://www.ansible.com), [Chef](https://www.chef.io), [SaltStack](https://saltstack.com/)) are configuration management tools for managing servers. Communication models are often point-to-point and are limited up to thousands of nodes with strong focus to make configuration changes as real time as possible.
Configuration management tools (e.g. [Ansible](https://www.ansible.com), [Chef](https://www.chef.io), [SaltStack](https://saltstack.com/)) are configuration management tools for managing servers. Communication models are often point-to-point and are limited up to thousands of nodes with a strong focus to make configuration changes as real-time as possible.

These are show stoppers for IoT solutions because you might have hundred thousands or more devices distributed around the world which have poor connection rarely available.

Eliot build solution from ground up for IoT devices with focus to things that are important in IoT solutions; security, scalability, stability.
Eliot builds the solution from the ground up for IoT devices with the focus on things that are important in IoT solutions; security, scalability, stability.

0 comments on commit f73a7d0

Please sign in to comment.