Merge pull request #2898 from hashicorp/d-config-tasks-env

Mention templates & env vars in configuring tasks

website/source/docs/job-specification/env.html.md

@@ -26,7 +26,7 @@ job "docs" {
   group "example" {
     task "server" {
       env {
-        my-key = "my-value"
+        my_key = "my-value"
       }
     }
   }
@@ -37,7 +37,8 @@ job "docs" {
 
 The "parameters" for the `env` stanza can be any key-value. The keys and values
 are both of type `string`, but they can be specified as other types. They will
-automatically be converted to strings.
+automatically be converted to strings. Invalid characters such as dashes (`-`)
+will be converted to underscores.
 
 ## `env` Examples
 

website/source/docs/job-specification/template.html.md

@@ -119,6 +119,7 @@ template {
   ---
     bind_port:   {{ env "NOMAD_PORT_db" }}
     scratch_dir: {{ env "NOMAD_TASK_DIR" }}
+    node_id:     {{ env "node.unique.id" }}
     service_key: {{ key "service/my-key" }}
   EOH
 

website/source/docs/operating-a-job/configuring-tasks.html.md

@@ -3,28 +3,28 @@ layout: "docs"
 page_title: "Configuring Tasks - Operating a Job"
 sidebar_current: "docs-operating-a-job-configuring-tasks"
 description: |-
-  Most applications require some kind of configuration. Whether this
+  Most applications require some kind of configuration. Whether the
-  configuration is provided via the command line or via a configuration file,
+  configuration is provided via the command line, environment variables, or a
-  Nomad has built-in functionality for configuration. This section details two
+  configuration file, Nomad has built-in functionality for configuration. This
-  common patterns for configuring tasks.
+  section details three common patterns for configuring tasks.
 ---
 
 # Configuring Tasks
 
-Most applications require some kind of configuration. The simplest way is via
+Most applications require some kind of local configuration. While command line
-command-line arguments, but often times tasks consume complex configurations via
+arguments are the simplest method, many applications require more complex
-config files. This section explores how to configure Nomad jobs to support many
+configurations provided via environment variables or configuration files. This
-common configuration use cases.
+section explores how to configure Nomad jobs to support many common
+configuration use cases.
 
 ## Command-line Arguments
 
-Many tasks accept configuration via command-line arguments that do not change
+Many tasks accept configuration via command-line arguments.  For example,
-over time.
+consider the [http-echo](https://github.com/hashicorp/http-echo) server which
+is a small go binary that renders the provided text as a webpage. The binary
+accepts two parameters:
 
-For example, consider the [http-echo](https://github.com/hashicorp/http-echo)
+* `-listen` - the `address:port` to listen on
-server which is a small go binary that renders the provided text as a webpage. The binary accepts two parameters:
-
-* `-listen` - the address:port to listen on
 * `-text` - the text to render as the HTML page
 
 Outside of Nomad, the server is started like this:
@@ -64,13 +64,15 @@ job "docs" {
 }
 ```
 
-~> **This assumes** the <tt>http-echo</tt> binary is already installed and available in the system path. Nomad can also optionally fetch the binary using the <tt>artifact</tt> resource.
+~> **This assumes** the <tt>http-echo</tt> binary is already installed and
+   available in the system path. Nomad can also optionally fetch the binary
+   using the <tt>artifact</tt> resource.
 
 Nomad has many [drivers](/docs/drivers/index.html), and most support passing
-arguments to their tasks via the `args` parameter. This option also optionally
+arguments to their tasks via the `args` parameter. This parameter also supports
-accepts [Nomad interpolation](/docs/runtime/interpolation.html). For example, if
+[Nomad interpolation](/docs/runtime/interpolation.html). For example, if you
-you wanted Nomad to dynamically allocate a high port to bind the service on
+wanted Nomad to dynamically allocate a high port to bind the service on instead
-instead of relying on a static port for the previous job:
+of relying on a static port for the previous job:
 
 ```hcl
 job "docs" {
@@ -99,15 +101,78 @@ job "docs" {
 }
 ```
 
+## Environment Variables
+
+Some applications can be configured via environment variables. [The
+Twelve-Factor App](https://12factor.net/config) document suggests configuring
+applications through environment variables. Nomad supports custom environment
+variables in two ways:
+
+* Interpolation in an `env` stanza
+* Templated in the a `template` stanza
+
+### `env` stanza
+
+Each task may have an `env` stanza which specifies environment variables:
+
+```hcl
+task "server" {
+  env {
+    my_key = "my-value"
+  }
+}
+```
+
+The `env` stanza also supports
+[interpolation](/docs/runtime/interpolation.html):
+
+```hcl
+task "server" {
+  env {
+    LISTEN_PORT = "${NOMAD_PORT_http}"
+  }
+}
+```
+
+See the [`env`](/docs/job-specification/env.html.md) docs for details.
+
+
+### Environment Templates
+
+Nomad's [`template`][template] stanza can be used
+to generate environment variables. Environment variables may be templated with
+[Node attributes and metadata][nodevars], the contents of files on disk, Consul
+keys, or secrets from Vault:
+
+```hcl
+template {
+  data = <<EOH
+LOG_LEVEL="{{key "service/geo-api/log-verbosity"}}"
+API_KEY="{{with secret "secret/geo-api-key"}}{{.Data.key}}{{end}}"
+CERT={{ file "path/to/cert.pem" | to JSON }}
+NODE_ID="{{ env "node.unique.id" }}"
+EOH
+
+  destination = "secrets/config.env"
+  env         = true
+}
+```
+
+The template will be written to disk and then read as environment variables
+before your task is launched.
+
 ## Configuration Files
 
-Not all applications accept their configuration via command-line flags.
+Sometimes applications accept their configurations using files to support
-Sometimes applications accept their configurations using files instead. Nomad
+complex data structures. Nomad supports downloading
-supports downloading [artifacts](/docs/job-specification/artifact.html) prior to
+[artifacts][artifact] and
-launching tasks. This allows shipping of configuration files and other assets
+[templating][template] them prior to launching
-that the task needs to run properly.
+tasks.
+This allows shipping of configuration files and other assets that the task
+needs to run properly.
 
-Here is an example job which pulls down a configuration file as an artifact:
+Here is an example job which pulls down a configuration file as an artifact and
+templates it:
 
 ```hcl
 job "docs" {
@@ -118,7 +183,12 @@ job "docs" {
       driver = "exec"
 
       artifact {
-        source      = "http://example.com/config.hcl"
+        source      = "http://example.com/config.hcl.tmpl"
+        destination = "local/config.hcl.tmpl"
+      }
+
+      template {
+        source      = "local/config.hcl.tmpl"
         destination = "local/config.hcl"
       }
 
@@ -133,4 +203,9 @@ job "docs" {
 }
 ```
 
-For more information on the artifact resource, please see the [artifact documentation](/docs/job-specification/artifact.html).
+For more information on the artifact resource, please see the [artifact
+documentation](/docs/job-specification/artifact.html).
+
+[artifact]: /docs/job-specification/artifact.html "Nomad artifact Job Specification"
+[nodevars]: /docs/runtime/interpolation.html#interpreted_node_vars "Nomad Node Variables"
+[template]: /docs/job-specification/template.html "Nomad template Job Specification"