github-personal/matchbox
1
0
Fork 0
mirror of https://github.com/outbackdingo/matchbox.git synced 2026-01-28 02:19:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

scripts: Improve devnet script to allow using rkt or docker

Browse Source 
* Add create, status, and destroy subcommands that use docker as
the container runtime for testing local QEMU/KVM clusters. Before,
only rkt could be used.
* Update local QEMU/KVM tutorial documentation
This commit is contained in:
Dalton Hubble
2017-06-12 00:42:58 -07:00
parent 299701e7ea
commit cfbb9cebd0
4 changed files with 106 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
Documentation/getting-started-docker.md
View File

@@ -1,4 +1,3 @@
# Getting started with Docker
In this tutorial, we'll run `matchbox` on your Linux machine with Docker to network boot and provision a cluster of QEMU/KVM Container Linux machines locally. You'll be able to create Kubernetes clusters, etcd3 clusters, and test network setups.
@@ -26,13 +25,13 @@ $ git clone https://github.com/coreos/matchbox.git
$ cd matchbox
```
Download CoreOS Container Linux image assets referenced by the `etcd-docker` [example](../examples) to `examples/assets`.
Download CoreOS Container Linux image assets referenced by the `etcd3` [example](../examples) to `examples/assets`.
```sh
$ ./scripts/get-coreos stable 1353.7.0 ./examples/assets
```
For development convenience, add `/etc/hosts` entries for nodes so they may be referenced by name as you would in production.
For development convenience, add `/etc/hosts` entries for nodes so they may be referenced by name.
```sh
# /etc/hosts
@@ -44,11 +43,19 @@ For development convenience, add `/etc/hosts` entries for nodes so they may be r
## Containers
Run the latest `matchbox` Docker image from `quay.io/coreos/matchbox` with the `etcd-docker` example. The container should receive the IP address 172.17.0.2 on the `docker0` bridge.
Run the `matchbox` and `dnsmasq` services on the `docker0` bridge. `dnsmasq` will run DHCP, DNS and TFTP services to create a suitable network boot environment. `matchbox` will serve configs to machines as they PXE boot.
The `devnet` convenience script can start these services and accepts the name of any example cluster in [examples](../examples).
```sh
$ sudo docker pull quay.io/coreos/matchbox:latest
$ sudo docker run -p 8080:8080 --rm -v $PWD/examples:/var/lib/matchbox:Z -v $PWD/examples/groups/etcd3:/var/lib/matchbox/groups:Z quay.io/coreos/matchbox:latest -address=0.0.0.0:8080 -log-level=debug
$ export CONTAINER_RUNTIME=docker
$ sudo -E ./scripts/devnet create etcd3
```
Inspect the logs.
```
$ sudo -E ./scripts/devnet status
```
Take a look at the [etcd3 groups](../examples/groups/etcd3) to get an idea of how machines are mapped to Profiles. Explore some endpoints exposed by the service, say for QEMU/KVM node1.
@@ -57,19 +64,18 @@ Take a look at the [etcd3 groups](../examples/groups/etcd3) to get an idea of ho
* Ignition [http://127.0.0.1:8080/ignition?mac=52:54:00:a1:9c:ae](http://127.0.0.1:8080/ignition?mac=52:54:00:a1:9c:ae)
* Metadata [http://127.0.0.1:8080/metadata?mac=52:54:00:a1:9c:ae](http://127.0.0.1:8080/metadata?mac=52:54:00:a1:9c:ae)
## Network
### Manual
Since the virtual network has no network boot services, use the `dnsmasq` image to create an iPXE network boot environment which runs DHCP, DNS, and TFTP.
If you prefer to start the containers yourself, instead of using `devnet`,
```sh
$ sudo docker run -p 8080:8080 --rm -v $PWD/examples:/var/lib/matchbox:Z -v $PWD/examples/groups/etcd3:/var/lib/matchbox/groups:Z quay.io/coreos/matchbox:latest -address=0.0.0.0:8080 -log-level=debug
$ sudo docker run --name dnsmasq --cap-add=NET_ADMIN -v $PWD/contrib/dnsmasq/docker0.conf:/etc/dnsmasq.conf:Z quay.io/coreos/dnsmasq -d
```
In this case, dnsmasq runs a DHCP server allocating IPs to VMs between 172.17.0.43 and 172.17.0.99, resolves `matchbox.foo` to 172.17.0.2 (the IP where `matchbox` runs), and points iPXE clients to `http://matchbox.foo:8080/boot.ipxe`.
## Client VMs
Create QEMU/KVM VMs which have known hardware attributes. The nodes will be attached to the `docker0` bridge, where Docker's containers run.
Create QEMU/KVM VMs which have known hardware attributes. The nodes will be attached to the `docker0` bridge, where Docker containers run.
```sh
$ sudo ./scripts/libvirt create-docker
@@ -110,8 +116,7 @@ $ etcdctl get /message
Clean up the containers and VM machines.
```sh
$ sudo docker rm -f dnsmasq
$ sudo ./scripts/libvirt poweroff
$ sudo -E ./scripts/devnet destroy
$ sudo ./scripts/libvirt destroy
```

15
Documentation/getting-started-rkt.md
View File

@@ -27,7 +27,7 @@ $ git clone https://github.com/coreos/matchbox.git
$ cd matchbox
```
Download CoreOS Container Linux image assets referenced by the `etcd` [example](../examples) to `examples/assets`.
Download CoreOS Container Linux image assets referenced by the `etcd3` [example](../examples) to `examples/assets`.
```sh
$ ./scripts/get-coreos stable 1353.7.0 ./examples/assets
@@ -74,18 +74,19 @@ For development convenience, you may wish to add `/etc/hosts` entries for nodes
## Containers
Run the `matchbox` and `dnsmasq` services on the `metal0` bridge. `dnsmasq` will run DHCP, DNS, and TFTP services to create a suitable network boot environment. `matchbox` will serve provisioning configs to machines on the network which attempt to PXE boot.
Run the `matchbox` and `dnsmasq` services on the `metal0` bridge. `dnsmasq` will run DHCP, DNS, and TFTP services to create a suitable network boot environment. `matchbox` will serve configs to machinesas they PXE boot.
The `devnet` wrapper script rkt runs `matchbox` and `dnsmasq` in systemd transient units. Create can take the name of any example cluster in [examples](../examples).
The `devnet` convenience script can rkt run these services in systemd transient units and accepts the name of any example cluster in [examples](../examples).
```sh
$ sudo ./scripts/devnet create etcd3
$ export CONTAINER_RUNTIME=rkt
$ sudo -E ./scripts/devnet create etcd3
```
Inspect the journal logs or check the status of the systemd services.
Inspect the journal logs.
```
$ sudo ./scripts/devnet status
$ sudo -E ./scripts/devnet status
$ journalctl -f -u dev-matchbox
$ journalctl -f -u dev-dnsmasq
```
@@ -167,7 +168,7 @@ $ etcdctl get /message
Clean up the systemd units running `matchbox` and `dnsmasq`.
```sh
$ sudo ./scripts/devnet destroy
$ sudo -E ./scripts/devnet destroy
```
Clean up VM machines.

1
contrib/dnsmasq/docker0.conf
View File

@@ -1,5 +1,6 @@
# dnsmasq.conf
no-daemon
dhcp-range=172.17.0.50,172.17.0.99
dhcp-option=3,172.17.0.1
dhcp-host=52:54:00:a1:9c:ae,172.17.0.21,1h

88
scripts/devnet
View File

@@ -8,14 +8,16 @@ set -u
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
EXAMPLE=${2:-}
# Local Container Runtime (docker or rkt)
CONTAINER_RUNTIME="${CONTAINER_RUNTIME:-rkt}"
BRIDGE=metal0
ASSETS_DIR="${ASSETS_DIR:-$PWD/examples/assets}"
CONFIG_DIR="${CONFIG_DIR:-$PWD/examples/etc/matchbox}"
COREOS_CHANNEL=stable
COREOS_VERSION=1353.7.0
MATCHBOX_ARGS=""
ASSETS_DIR="${ASSETS_DIR:-$PWD/examples/assets}"
CONFIG_DIR="${CONFIG_DIR:-$PWD/examples/etc/matchbox}"
if [ "$EUID" -ne 0 ]
then echo "Please run as root"
exit
@@ -41,11 +43,35 @@ function usage {
echo "USAGE: ${0##*/} <command>"
echo "Commands:"
echo -e "\tcreate\tcreate matchbox and PXE services on the bridge"
echo -e "\tstatus\tshow the systemctl status of matchbox and dnsmasq"
echo -e "\tstatus\tshow the status of matchbox and dnsmasq"
echo -e "\tdestroy\tdestroy the services on the bridge"
}
function check {
function create {
case "$CONTAINER_RUNTIME" in
"rkt") rkt_create;;
"docker") docker_create;;
*) docker_create;;
esac
}
function status {
case "$CONTAINER_RUNTIME" in
"rkt") rkt_status;;
"docker") docker_status;;
*) docker_status;;
esac
}
function destroy {
case "$CONTAINER_RUNTIME" in
"rkt") rkt_destroy;;
"docker") docker_destroy;;
*) docker_destroy;;
esac
}
function rkt_check {
# SELinux, if present, it cannot be in Enforcing mode
if [ $(getenforce) == 'Enforcing' ]; then
echo "SELinux must be in permissive mode: 'setenforce Permissive'"
@@ -57,8 +83,8 @@ function check {
fi
}
function create {
check
function rkt_create {
rkt_check
if [ -z "$EXAMPLE" ]; then
echo "Starting matchbox"
@@ -109,7 +135,7 @@ function create {
status
}
function status {
function rkt_status {
echo ""
systemctl status dev-matchbox --lines=0 --no-pager
systemctl status dev-dnsmasq --lines=0 --no-pager
@@ -118,11 +144,55 @@ function status {
echo "Use 'journalctl -f -u dev-matchbox', etc. to tail the logs."
}
function destroy {
function rkt_destroy {
rkt stop --uuid-file=/var/run/matchbox-pod.uuid
rkt stop --uuid-file=/var/run/dnsmasq-pod.uuid
systemctl reset-failed dev-matchbox > /dev/null 2>&1
systemctl reset-failed dev-dnsmasq > /dev/null 2>&1
}
function docker_create {
if [ -z "$EXAMPLE" ]; then
echo "Starting matchbox"
else
echo "Starting matchbox configured to boot $EXAMPLE"
fi
if [ -z "$EXAMPLE" ]; then
# Mount a data volume with assets and enable gRPC
MATCHBOX_ARGS="-rpc-address=0.0.0.0:8081"
DATA_MOUNT=""
else
# Mount the given EXAMPLE
DATA_MOUNT="-v $PWD/examples:/var/lib/matchbox -v $DIR/../examples/groups/$EXAMPLE:/var/lib/matchbox/groups"
fi
docker run --name matchbox \
-d \
-p 8080:8080 \
-v $CONFIG_DIR:/etc/matchbox:Z \
-v $ASSETS_DIR:/var/lib/matchbox/assets:Z \
$DATA_MOUNT \
quay.io/coreos/matchbox:v0.6.1 -address=0.0.0.0:8080 -log-level=debug $MATCHBOX_ARGS
echo "Starting dnsmasq to provide DHCP/TFTP/DNS services"
docker run --name dnsmasq \
-d \
--cap-add=NET_ADMIN \
-v $PWD/contrib/dnsmasq/docker0.conf:/etc/dnsmasq.conf:Z \
quay.io/coreos/dnsmasq:v0.4.0 -d
}
function docker_status {
docker logs matchbox
docker logs dnsmasq
}
function docker_destroy {
docker stop matchbox
docker stop dnsmasq
docker rm matchbox
docker rm dnsmasq
}
main $@