Skip to content

Commit

Permalink
website: documentation for local values
Browse files Browse the repository at this point in the history
  • Loading branch information
apparentlymart committed Jul 1, 2017
1 parent 7a39610 commit d570e6f
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
49 changes: 49 additions & 0 deletions website/docs/configuration/locals.html.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: "docs"
page_title: "Configuring Local Values"
sidebar_current: "docs-config-locals"
description: |-
Local values assign a name to an expression that can then be used multiple times
within a module.
---

# Variable Configuration

Local values assign a name to an expression, that can then be used multiple
times within a module.

Comparing to functions in a traditional programming language,
if [variables](./variables.html) are analogous to function arguments and
[outputs](./outputs.html) are analogous to function return values then
_local values_ are comparable to a function's local variables.

This page assumes you're familiar with the
[configuration syntax](/docs/configuration/syntax.html)
already.

## Example

Local values are defined in `locals` blocks:

```hcl
locals {
greeting = "hello"
instance_ids = "${aws_instance.foo.*.id}"
defaulted_foo = "${var.foo != "" ? var.foo : "default_foo"}"
}
```

## Description

The `locals` block defines one or more local variables within a module.
Each `locals` block can have as many locals as needed, and there can be any
number of `locals` blocks within a module.

The names given for the items in the `locals` block must be unique throughout
a module. The given value can be any expression that is valid within
the current module.

The expression of a local value can refer to other locals, but as usual
reference cycles are not allowed. That is, a local cannot refer to itself
or to a variable that refers (directly or indirectly) back to it.
4 changes: 4 additions & 0 deletions website/layouts/docs.erb
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
<a href="/docs/configuration/outputs.html">Outputs</a>
</li>

<li<%= sidebar_current("docs-config-locals") %>>
<a href="/docs/configuration/locals.html">Local Values</a>
</li>

<li<%= sidebar_current("docs-config-modules") %>>
<a href="/docs/configuration/modules.html">Modules</a>
</li>
Expand Down

0 comments on commit d570e6f

Please sign in to comment.