afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update node types to include lxc/docker type documentation, instead of being hidden within examples

Browse source
This commit is contained in:
Blake Harnden 2021-11-11 10:59:11 -08:00
parent 1ce6e51318
commit b78c07bd24
5 changed files with 58 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

61
daemon/examples/docker/README.md
View file

@ -1,61 +0,0 @@
# Docker Support
Information on how Docker can be leveraged and included to create
nodes based on Docker containers and images to interface with
existing CORE nodes, when needed.
## Installation
```shell
sudo apt install docker.io
```
## Configuration
Custom configuration required to avoid iptable rules being added and removing
the need for the default docker network, since core will be orchestrating
connections between nodes.
Place the file below in **/etc/docker/**
* daemon.json
## Group Setup
To use Docker nodes within the python GUI, you will need to make sure the user running the GUI is a member of the
docker group.
```shell
# add group if does not exist
sudo groupadd docker
# add user to group
sudo usermod -aG docker $USER
# to get this change to take effect, log out and back in or run the following
newgrp docker
```
## Tools and Versions Tested With
* Docker version 18.09.5, build e8ff056
* nsenter from util-linux 2.31.1
## Examples
This directory provides a few small examples creating Docker nodes
and linking them to themselves or with standard CORE nodes.
Images used by nodes need to have networking tools installed for CORE to automate
setup and configuration of the container.
Example Dockerfile:
```
FROM ubuntu:latest
RUN apt-get update
RUN apt-get install -y iproute2 ethtool
```
Build image:
```shell
sudo docker build -t <name> .
```

5
daemon/examples/docker/daemon.json
View file

@ -1,5 +0,0 @@
{
"bridge": "none",
"iptables": false
}

45
daemon/examples/lxd/README.md
View file

@ -1,45 +0,0 @@
# LXD Support
Information on how LXD can be leveraged and included to create
nodes based on LXC containers and images to interface with
existing CORE nodes, when needed.
## Installation
```shell
sudo snap install lxd
```
## Configuration
Initialize LXD and say no to adding a default bridge.
```shell
sudo lxd init
```
## Group Setup
To use LXC nodes within the python GUI, you will need to make sure the user running the GUI is a member of the
lxd group.
```shell
# add group if does not exist
sudo groupadd lxd
# add user to group
sudo usermod -aG lxd $USER
# to get this change to take effect, log out and back in or run the following
newgrp lxd
```
## Tools and Versions Tested With
* LXD 3.14
* nsenter from util-linux 2.31.1
## Examples
This directory provides a few small examples creating LXC nodes
using LXD and linking them to themselves or with standard CORE nodes.