diff --git a/Documentation/bootcfg.md b/Documentation/bootcfg.md index 9518b024..a6804070 100644 --- a/Documentation/bootcfg.md +++ b/Documentation/bootcfg.md @@ -5,7 +5,7 @@ Network boot endpoints provide iPXE, GRUB, and [Pixiecore](https://github.com/danderson/pixiecore/blob/master/README.api.md) support. `bootcfg` can be deployed as a binary, as an [appc](https://github.com/appc/spec) container with rkt, or as a Docker container. -Bootcfg Overview +![Bootcfg Overview](img/overview.png) ## Getting Started diff --git a/Documentation/getting-started-docker.md b/Documentation/getting-started-docker.md index 85cf75da..50684238 100644 --- a/Documentation/getting-started-docker.md +++ b/Documentation/getting-started-docker.md @@ -72,7 +72,6 @@ The example profile added autologin so you can verify that etcd works between no systemctl status etcd2 etcdctl set /message hello etcdctl get /message - fleetctl list-machines Clean up the VM machines. @@ -82,5 +81,5 @@ Clean up the VM machines. ## Going Further -Learn more about [bootcfg](bootcfg.md) or explore the other [example](../examples) clusters. Try the [k8s-docker example](kubernetes.md) to produce a TLS-authenticated Kubernetes cluster you can access locally with `kubectl` ([docs](../examples/README.md#kubernetes)). +Learn more about [bootcfg](bootcfg.md) or explore the other [example](../examples) clusters. Try the [k8s-docker example](kubernetes.md) to produce a TLS-authenticated Kubernetes cluster you can access locally with `kubectl`. diff --git a/Documentation/getting-started-rkt.md b/Documentation/getting-started-rkt.md index 35bd48cc..6b11870b 100644 --- a/Documentation/getting-started-rkt.md +++ b/Documentation/getting-started-rkt.md @@ -7,7 +7,7 @@ In this tutorial, we'll run `bootcfg` on your Linux machine with `rkt` and `CNI` ## Requirements -Install [rkt](https://coreos.com/rkt/docs/latest/distributions.html) 1.8 or higher ([example script](https://github.com/dghubble/phoenix/blob/master/scripts/fedora/sources.sh)) and setup rkt [privilege separation](https://coreos.com/rkt/docs/latest/trying-out-rkt.html). +Install [rkt](https://coreos.com/rkt/docs/latest/distributions.html) 1.8 or higher ([example script](https://github.com/dghubble/phoenix/blob/master/fedora/sources.sh)) and setup rkt [privilege separation](https://coreos.com/rkt/docs/latest/trying-out-rkt.html). Next, install the package dependencies. @@ -110,7 +110,6 @@ The example profile added autologin so you can verify that etcd works between no systemctl status etcd2 etcdctl set /message hello etcdctl get /message - fleetctl list-machines Press ^] three times to stop a rkt pod. Clean up the VM machines. @@ -119,5 +118,5 @@ Press ^] three times to stop a rkt pod. Clean up the VM machines. ## Going Further -Learn more about [bootcfg](bootcfg.md) or explore the other [example](../examples) clusters. Try the [k8s example](kubernetes.md) to produce a TLS-authenticated Kubernetes cluster you can access locally with `kubectl` ([docs](../examples/README.md#kubernetes)). +Learn more about [bootcfg](bootcfg.md) or explore the other [example](../examples) clusters. Try the [k8s example](kubernetes.md) to produce a TLS-authenticated Kubernetes cluster you can access locally with `kubectl`. diff --git a/Documentation/network-booting.md b/Documentation/network-booting.md index 8870ba15..d9ca64d9 100644 --- a/Documentation/network-booting.md +++ b/Documentation/network-booting.md @@ -7,7 +7,7 @@ This guide reviews network boot protocols and the different ways client machines The Preboot eXecution Environment (PXE) defines requirements for consistent, hardware-independent network-based machine booting and configuration. Formally, PXE specifies pre-boot protocol services that client NIC firmware must provide (DHCP, TFTP, UDP/IP), specifies boot firmware requirements, and defines a client-server protocol for obtaining a network boot program (NBP) which automates OS installation and configuration. -Basic PXE client server protocol flow +![PXE protocol](img/pxelinux.png) At power-on, if a client machine's BIOS or UEFI boot firmware is set to perform network booting, the network interface card's PXE firmware broadcasts a DHCPDISCOVER packet identifying itself as a PXEClient to the network environment. @@ -47,7 +47,7 @@ This approach has a number of drawbacks. TFTP can be slow, managing config files [iPXE](http://ipxe.org/) is an enhanced implementation of the PXE client firmware and a network boot program which uses iPXE scripts rather than config files and can download scripts and images with HTTP. -iPXE client server protocol flow +![iPXE flow](img/ipxe.png) A DHCPOFFER to iPXE client firmware specifies an HTTP boot script such as `http://bootcfg.foo/boot.ipxe`. @@ -76,4 +76,4 @@ Many networks have DHCP services which are impractical to modify or disable. Com To address this, PXE client firmware listens for DHCPOFFERs from a non-PXE DHCP server *and* a PXE-enabled **proxyDHCP server** configured to respond with the next server and boot filename only. Client firmware combines the two responses as if they had come from a single PXE-enabled DHCP server. -DHCP and proxyDHCP responses are merged to get PXE Options +![Proxy DHCP flow](img/proxydhcp.png) diff --git a/Documentation/network-setup.md b/Documentation/network-setup.md index a5435de0..40131b05 100644 --- a/Documentation/network-setup.md +++ b/Documentation/network-setup.md @@ -26,7 +26,7 @@ On simpler networks, such as what a developer might have at home, a relatively i This diagram can point you to the **right section(s)** of this document. -Network Setup Flow +![Network Setup](img/network-setup-flow.png) The setup of DHCP, TFTP, and DNS services on a network varies greatly. If you wish to use rkt or Docker to quickly run DHCP, proxyDHCP TFTP, or DNS services, use [coreos/dnsmasq](#coreos/dnsmasq). diff --git a/README.md b/README.md index 66a968c4..839fff70 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Guides and a service for network booting and provisioning CoreOS clusters on vir * [bootcfg Service](Documentation/bootcfg.md) * [Profiles](Documentation/bootcfg.md#profiles) -* [Groups](Documentation/bootcfg.md#groups-and-metadata) +* [Groups](Documentation/bootcfg.md#groups) * Config Templates * [Ignition](Documentation/ignition.md) * [Cloud-Config](Documentation/cloud-config.md) @@ -47,9 +47,9 @@ Guides and a service for network booting and provisioning CoreOS clusters on vir The [examples](examples) network boot and provision CoreOS clusters. Network boot [QEMU/KVM](scripts/README.md#libvirt) VMs to try the examples on your Linux laptop. * Multi-node [Kubernetes cluster](Documentation/kubernetes.md) -* Multi-node Kubernetes cluster with rkt container runtime (i.e. rktnetes) -* Multi-node [self-hosted Kubernetes cluster](Documentation/bootkube.md) -* [Upgrading](Documentation/bootkube-upgrades.md) a self-hosted Kubernetes cluster +* Multi-node [rktnetes](Documentation/rktnetes.md) cluster (i.e. Kubernetes with rkt as the container runtime) +* Multi-node [self-hosted](Documentation/bootkube.md) Kubernetes cluster +* [Upgrading](Documentation/bootkube-upgrades.md) self-hosted Kubernetes clusters * Multi-node etcd2 or etcd3 cluster * Multi-node [Torus](Documentation/torus.md) distributed storage cluster * Network boot or Install to Disk