From 4dadfc6d29690c164f1ef98fc6c1efbcecbc1abc Mon Sep 17 00:00:00 2001
From: ebarriosjr <ebarriosjr@users.noreply.github.com>
Date: Tue, 24 Sep 2019 15:22:04 +0200
Subject: [PATCH] Added documentation for nomad pot driver. (#6369)

Added new external driver for Pot to nomad documentation
---
 .../docs/drivers/external/index.html.md       |  2 +
 .../source/docs/drivers/external/pot.html.md  | 90 +++++++++++++++++++
 website/source/layouts/docs.erb               |  4 +
 3 files changed, 96 insertions(+)
 create mode 100644 website/source/docs/drivers/external/pot.html.md

diff --git a/website/source/docs/drivers/external/index.html.md b/website/source/docs/drivers/external/index.html.md
index 1405ae36a..5b02e5ae9 100644
--- a/website/source/docs/drivers/external/index.html.md
+++ b/website/source/docs/drivers/external/index.html.md
@@ -25,8 +25,10 @@ Below is a list of community-supported task drivers you can use with Nomad:
 - [LXC][lxc]
 - [Singularity][singularity]
 - [Jail task driver][jail-task-driver]
+- [Pot][pot]
 
 [lxc]: /docs/drivers/external/lxc.html
 [plugin_guide]: /docs/internals/plugins/index.html
 [singularity]: /docs/drivers/external/singularity.html
 [jail-task-driver]: /docs/drivers/external/jail-task-driver.html
+[pot]: /docs/drivers/external/pot.html
diff --git a/website/source/docs/drivers/external/pot.html.md b/website/source/docs/drivers/external/pot.html.md
new file mode 100644
index 000000000..261170adb
--- /dev/null
+++ b/website/source/docs/drivers/external/pot.html.md
@@ -0,0 +1,90 @@
+---
+layout: "docs"
+page_title: "Drivers: pot"
+sidebar_current: "docs-drivers-community-pot"
+description: |-
+  The Pot task driver is used to run pot (https://github.com/pizzamig/pot) containers using FreeBSD jails.
+---
+
+# Pot task Driver
+
+Name: `pot`
+
+The Pot task driver provides an interface for using [pot][pot-github-repo] for dynamically running applications inside a FreeBSD Jail. 
+You can download the external nomad-pot-driver [here][nomad-pot-driver].
+
+## Task Configuration
+
+```hcl
+task "nginx-pot" {
+    driver = "pot"
+
+    config {
+      image = "https://pot-registry.zapto.org/registry/"
+      pot = "FBSD120-nginx"
+      tag = "1.0"
+      command = "nginx -g 'daemon off;'"
+      network_mode = "public-bridge" 
+      port_map = {
+        http = "80"
+      }
+      copy = [
+        "/root/index.html:/usr/local/www/nginx-dist/index.html",
+        "/root/nginx.conf:/usr/local/etc/nginx/nginx.conf"
+      ]
+      mount = [ 
+        "/tmp/test:/root/test",  
+      ]
+      mount_read_only = [
+        "/tmp/test2:/root/test2"
+      ]
+   }
+}
+```
+
+The pot task driver supports the following parameters: 
+
+* `image` - The url for the http registry from where to get the image.
+
+* `pot` - Name of the image in the registry.
+
+* `tag` - Version of the image.
+ 
+* `command` - Command that is going to be executed once the jail is started.
+
+* `network_mode` - (Optional) Defines the network mode of the pot. Default: **"public-bridge"**
+
+  Possible values are:
+  
+  **"public-bridge"**  pot creates an internal virtual network with a NAT table where all traffic is going to be sent.
+  
+  **"host"** pot bounds the jail directly to a host port.
+
+* `port_map` - (Optional) Sets the port on which the application is listening inside of the jail. If not set, the application will inherit the port configuration from the image.
+
+* `copy` - (Optional) Copies a file from the host machine to the pot jail in the given directory.
+
+* `mount` - (Optional) Mounts a read/write folder from the host machine to the pot jail.
+
+* `mount_read_only` - (Optional) Mounts a read only directory inside the pot jail.
+
+## Client Requirements
+
+`pot Task Driver` requires the following:
+
+* 64-bit FreeBSD 12.0-RELEASE host .
+* The FreeBSD's Nomad binary (available as a package).
+* The pot-task-driver binary placed in the [plugin_dir][plugin_dir] directory. 
+* Installing [pot][pot-github-repo] and following the install [guide][pot-install-guide].
+* Webserver from where to serve the images. (simple file server)
+* Following lines need to be included in your rc.conf
+
+```
+nomad_user="root"
+nomad_env="PATH=/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/sbin:/bin"
+```
+
+[nomad-pot-driver]: https://github.com/trivago/nomad-pot-driver
+[plugin_dir]: /docs/configuration/index.html#plugin_dir
+[pot-github-repo]: https://github.com/pizzamig/pot
+[pot-install-guide]: https://github.com/pizzamig/pot/blob/master/share/doc/pot/Installation.md
diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb
index 5d5323079..f0b08cfd3 100644
--- a/website/source/layouts/docs.erb
+++ b/website/source/layouts/docs.erb
@@ -501,6 +501,10 @@
               <li<%= sidebar_current("docs-drivers-community-jail-task-driver") %>>
               <a href="/docs/drivers/external/jail-task-driver.html">Jailtask driver</a>
             </li>
+            </li>
+              <li<%= sidebar_current("docs-drivers-community-pot") %>>
+              <a href="/docs/drivers/external/pot.html">Pot</a>
+            </li>
             </ul>
           </li>