Add tftp base directory configuration docs (#122)

* Also update the getting started guide
CiscoCloud · Nov 17, 2017 · 803fc88 · 803fc88
1 parent 2d28301
commit 803fc88
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/docs/current/data-model-howto.md b/docs/current/data-model-howto.md
@@ -524,6 +524,15 @@ By declaring cdn_addr and a cdn_port we will use that as a source. The agent wil
 
 The transport (http/s) should be included with the agent URL.
 
+#### env.agent.tftp_server
+
+Configuration for the tftp_server
+
+| name       | description                                                   | required | schema  | default            |
+|:-----------|:--------------------------------------------------------------|:---------|:--------|:-------------------|
+| base_dir | The directory that vaquero agent will use to serve tftp files from  | no       | string  | /var/vaquero/pxeroms  |
+
+
 #### env.release_tag
 `release_tag` must be a valid [commit_ish](https://git-scm.com/docs/git#git-ltcommit-ishgt) string corresponding to a specific [Github Release](https://help.github.com/articles/about-releases/) (e.g., v0.1.0) or commit_id.
 

diff --git a/docs/current/getting-started.md b/docs/current/getting-started.md
@@ -11,10 +11,11 @@ page.title: Getting Started
 This getting started guide provides a simple Vagrant-based environment to run Vaquero in "standalone mode" and requires the following prerequisites before moving forward:
 
 1. [Latest Vagrant](https://www.vagrantup.com/)
-2. [VirtualBox 5.1.x (v5.2.x is not supported by Vagrant at this time)](https://www.virtualbox.org/wiki/Download_Old_Builds_5_1)
-3. [Install VirtualBox Extension Pack to match your version of VirtualBox](https://www.virtualbox.org/wiki/Download_Old_Builds_5_1) Adds functionality to PXE boot for Intel cards
-4. Access to [vaquero docker repository](
+1. [VirtualBox 5.1.x (v5.2.x is not supported by Vagrant at this time)](https://www.virtualbox.org/wiki/Download_Old_Builds_5_1)
+1. [Install VirtualBox Extension Pack to match your version of VirtualBox](https://www.virtualbox.org/wiki/Download_Old_Builds_5_1) Adds functionality to PXE boot for Intel cards
+1. Access to [vaquero docker repository](
 https://hub.docker.com/r/thecsikos/vaquero/); this is currently a private docker repository
+1. The [undionly.kpxe](http://boot.ipxe.org/undionly.kpxe) boot file from [http://ipxe.org/](http://ipxe.org/)
 
 ## Try it out locally
 
@@ -27,6 +28,15 @@ git clone https://github.com/CiscoCloud/vaquero-vagrant.git
 cd vaquero-vagrant
 ```
 
+### Boot file
+
+Before continuing, add the undionly.kpxe boot file from above into the pxeroms directory otherwise vagrant will complain.
+
+```
+# Adjust your source path accordingly
+mv ~/downloads/undionly.kpxe pxeroms/
+```
+
 ### Start it up and jump into the VM
 
 The provided Vagrantfile allows for various options to override the default configuration, but we'll use the defaults for now. For more information on the additional options, please take a look at the Vagrantfile.
@@ -60,6 +70,7 @@ and finally, start Vaquero in standalone mode:
 docker run \
   -v /vagrant/config/dir-sot.yaml:/vaquero/config.yaml \
   -v /var/vaquero/files:/var/vaquero/files \
+  -v /vagrant/pxeroms:/vagrant/pxeroms \
   -v /vagrant/local:/vagrant/local \
   -v /vagrant/provision_files/secret:/vaquero/secret \
   --net="host" \