ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/layouts/functions.erb

499 lines
14 KiB
Plaintext
Raw Normal View History

website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
<% wrap_layout :inner do %>
website: Reorganize nav sidebars to improve jumps between sections
2018-12-21 03:18:13 +01:00
<% content_for :sidebar do %>
website: move docs/index.html to docs/cli-index.html Terraform is way bigger than the core CLI tools and the language now, and the docs have grown accordingly. So we're adding a global index page to help users get around the many sections of the docs site, and bumping the CLI/core docs down so they're no longer at the top of the hierarchy. The "right" (as in, conceptually pure) way to do this would be to actually create a new level of directory hierarchy in between. But that would be real expensive and annoying — the amount of 301s and links to edit would be monumental, and it wouldn't gain us much beyond a certain picture-straightening satisfaction, so I'm resisting the temptation.
2019-03-11 17:49:45 +01:00
<h4><a href="/docs/cli-index.html">Terraform CLI</a></h4>
website: Structural edit of configuration language docs This commit is a wide-ranging set of edits to the pages under /docs/configuration. Among other things, it - Separates style conventions out into their own page. - Separates type constraints and conversion info into their own page. - Conflates similar complex types a little more freely, since the distinction is only relevant when restricting inputs for a reusable module or resource. - Clarifies several concepts that confused me during edits.
2018-12-11 01:14:33 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<a href="#" class="subnav-toggle">(Expand/collapse all)</a>
website: Reorganize nav sidebars to improve jumps between sections
2018-12-21 03:18:13 +01:00
<ul class="nav docs-sidenav">
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
website: Reorganize nav sidebars to improve jumps between sections
2018-12-21 03:18:13 +01:00
<a class="back" href="/docs/configuration/index.html">Configuration Language</a>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</li>
website: Structural edit of configuration language docs This commit is a wide-ranging set of edits to the pages under /docs/configuration. Among other things, it - Separates style conventions out into their own page. - Separates type constraints and conversion info into their own page. - Conflates similar complex types a little more freely, since the distinction is only relevant when restricting inputs for a reusable module or resource. - Clarifies several concepts that confused me during edits.
2018-12-11 01:14:33 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions.html">Functions</a>
<ul class="nav nav-visible">
<li id="docs-funcs-numeric">
<a href="#docs-funcs-numeric">Numeric Functions</a>
<ul class="nav">
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/abs.html">abs</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/ceil.html">ceil</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/floor.html">floor</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/log.html">log</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/max.html">max</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/min.html">min</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
lang/funcs: parseint function
2019-09-10 05:42:45 +02:00
<li>
<a href="/docs/configuration/functions/parseint.html">parseint</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/pow.html">pow</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/signum.html">signum</a>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-string">
<a href="#docs-funcs-string">String Functions</a>
<ul class="nav">
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/chomp.html">chomp</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/format.html">format</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/formatlist.html">formatlist</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/indent.html">indent</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/join.html">join</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/lower.html">lower</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
lang: "regex" and "regexall" functions These existing upstream cty functions allow matching strings against regular expression patterns, which can be useful if you need to consume a non-standard string format that Terraform doesn't (and can't) have a built-in function for.
2019-08-06 17:21:22 +02:00
<li>
<a href="/docs/configuration/functions/regex.html">regex</a>
</li>
<li>
<a href="/docs/configuration/functions/regexall.html">regexall</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/replace.html">replace</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/split.html">split</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
lang/funcs: add 'strrev' interpolation function. (#21091)
2019-04-24 20:52:39 +02:00
<li>
<a href="/docs/configuration/functions/strrev.html">strrev</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/substr.html">substr</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/title.html">title</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
lang/funcs: Add more `trim*` functions (#23016) * lang/funcs: Add `trim*` functions
2019-11-18 14:31:44 +01:00
<li>
<a href="/docs/configuration/functions/trim.html">trim</a>
</li>
<li>
<a href="/docs/configuration/functions/trimprefix.html">trimprefix</a>
</li>
<li>
<a href="/docs/configuration/functions/trimsuffix.html">trimsuffix</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/trimspace.html">trimspace</a>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/upper.html">upper</a>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-collection">
<a href="#docs-funcs-collection">Collection Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/chunklist.html">chunklist</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/coalesce.html">coalesce</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/coalescelist.html">coalescelist</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/compact.html">compact</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
lang/funcs: add acc tests for functions (#21112) * lang/funcs: testing of functions through the lang package API The function-specific unit tests do not cover the HCL conversion that happens when the functions are called in a terraform configuration. For e.g., HCL converts sets to lists before passing it to the function. This means that we could not test passing a set in the function _unit_ tests. This adds a higher-level acceptance test, plus a check that every (pure) function has a test. * website/docs: update function documentation
2019-04-29 19:11:28 +02:00
<li>
<a href="/docs/configuration/functions/concat.html">concat</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/contains.html">contains</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/distinct.html">distinct</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/element.html">element</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/flatten.html">flatten</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/index.html">index</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/keys.html">keys</a>
</li>
website: document the functions "keys", "lookup", and "values" I missed these on the first pass because in the legacy function table they are, for some reason, added in a different place than the others.
2018-06-02 03:56:34 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/length.html">length</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/list.html">list</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/lookup.html">lookup</a>
</li>
website: document the functions "keys", "lookup", and "values" I missed these on the first pass because in the legacy function table they are, for some reason, added in a different place than the others.
2018-06-02 03:56:34 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/map.html">map</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/matchkeys.html">matchkeys</a>
</li>
lang/funcs: Port the "reverse" function from the old functions set This has the same functionality as the "reverse" function that was implemented in the "config" package, but adapted to the new language type system.
2019-03-20 01:09:01 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/merge.html">merge</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
lang: "range" function This is similar to the function of the same name in Python, generating a sequence of numbers as a list that can then be used in other sequence-oriented operations. The primary use-case for it is to turn a count expressed as a number into a list of that length, which can then be iterated over or passed to a collection function to produce that number of something else, as shown in the example at the end of its documentation page.
2019-05-26 22:09:44 +02:00
<li>
<a href="/docs/configuration/functions/range.html">range</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/reverse.html">reverse</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/setintersection.html">setintersection</a>
</li>
lang/functions: set functions from cty The sethaselement, setintersection, and setunion functions are defined in the cty stdlib. Making them available in Terraform will make it easier to work with sets, and complement the currently-Terraform-specific setproduct function. In the long run setproduct should probably move into the cty stdlib too, but since it was submitted as a Terraform function originally we'll leave it here now for simplicity's sake and reorganize later.
2019-01-15 20:51:21 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/setproduct.html">setproduct</a>
</li>
lang/funcs: Convert the "setproduct" function to the new approach In our new world it produces either a set of a tuple type or a list of a tuple type, depending on the given argument types. The resulting collection's element tuple type is decided by the element types of the given collections, allowing type information to propagate even if unknown values are present.
2019-01-15 18:47:14 +01:00
lang: add setsubtract function (#23424) * add setdifference and setsubtract functions and docs * remove setdifference as it is not implemented correct in underlying lib * Update setintersection.html.md * Update setproduct.html.md * Update setunion.html.md
2020-02-06 18:49:11 +01:00
<li>
<a href="/docs/configuration/functions/setsubtract.html">setsubtract</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/setunion.html">setunion</a>
</li>
lang/functions: set functions from cty The sethaselement, setintersection, and setunion functions are defined in the cty stdlib. Making them available in Terraform will make it easier to work with sets, and complement the currently-Terraform-specific setproduct function. In the long run setproduct should probably move into the cty stdlib too, but since it was submitted as a Terraform function originally we'll leave it here now for simplicity's sake and reorganize later.
2019-01-15 20:51:21 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/slice.html">slice</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/sort.html">sort</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/transpose.html">transpose</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/values.html">values</a>
</li>
website: document the functions "keys", "lookup", and "values" I missed these on the first pass because in the legacy function table they are, for some reason, added in a different place than the others.
2018-06-02 03:56:34 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/zipmap.html">zipmap</a>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-encoding">
<a href="#docs-funcs-encoding">Encoding Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/base64decode.html">base64decode</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/base64encode.html">base64encode</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/base64gzip.html">base64gzip</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/csvdecode.html">csvdecode</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/jsondecode.html">jsondecode</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/jsonencode.html">jsonencode</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/urlencode.html">urlencode</a>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
</li>
lang: yamldecode and yamlencode functions These follow the same principle as jsondecode and jsonencode, but use YAML instead of JSON. YAML has a much more complex information model than JSON, so we can only support a subset of it during decoding, but hopefully the subset supported here is a useful one. Because there are many different ways to _generate_ YAML, the yamlencode function is forced to make some decisions, and those decisions are likely to affect compatibility with other real-world YAML parsers. Although the format here is intended to be generic and compatible, we may find that there are problems with it that'll we'll want to adjust for in a future release, so yamlencode is therefore marked as experimental for now until the underlying library is ready to commit to ongoing byte-for-byte compatibility in serialization. The main use-case here is met by yamldecode, which will allow reading in files written in YAML format by humans for use in Terraform modules, in situations where a higher-level input format than direct Terraform language declarations is helpful.
2019-05-26 19:25:18 +02:00
<li>
<a href="/docs/configuration/functions/yamldecode.html">yamldecode</a>
</li>
<li>
<a href="/docs/configuration/functions/yamlencode.html">yamlencode</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-file">
<a href="#docs-funcs-file">Filesystem Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
lang/funcs: add "abspath" function (#21409)
2019-07-02 14:30:30 +02:00
<li>
<a href="/docs/configuration/functions/abspath.html">abspath</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/dirname.html">dirname</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/pathexpand.html">pathexpand</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/basename.html">basename</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/file.html">file</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/fileexists.html">fileexists</a>
</li>
lang: Add fileexists function
2018-10-11 12:40:09 +02:00
lang/funcs: Add fileset function Reference: https://github.com/hashicorp/terraform/issues/16697 Enumerates a set of regular file names from a given glob pattern. Implemented via the Go stdlib `path/filepath.Glob()` functionality. Notably, stdlib does not support `**` or `{}` extended patterns. See also: https://github.com/golang/go/issues/11862 To support the extended glob patterns, it will require adding a dependency on a third party library or adding our own matching code.
2019-08-20 10:50:01 +02:00
<li>
<a href="/docs/configuration/functions/fileset.html">fileset</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filebase64.html">filebase64</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/templatefile.html">templatefile</a>
lang/funcs: templatefile function This function is similar to the template_file data source offered by the template provider, but having it built in to the language makes it more convenient to use, allowing templates to be rendered from files anywhere an inline template would normally be allowed: user_data = templatefile("${path.module}/userdata.tmpl", { hostname = format("petserver%02d", count.index) }) Unlike the template_file data source, this function allows values of any type in its variables map, passing them through verbatim to the template. Its tighter integration with Terraform also allows it to return better error messages with source location information from the template itself. The template_file data source was originally created to work around the fact that HIL didn't have any support for map values at the time, and even once map support was added it wasn't very usable. With HCL2 expressions, there's little reason left to use a data source to render a template; the only remaining reason left to use template_file is to render a template that is constructed dynamically during the Terraform run, which is a very rare need.
2018-12-21 02:42:42 +01:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
<li id="docs-funcs-datetime">
<a href="#docs-funcs-datetime">Date and Time Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/formatdate.html">formatdate</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/timeadd.html">timeadd</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/timestamp.html">timestamp</a>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-crypto">
<a href="#docs-funcs-crypto">Hash and Crypto Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/base64sha256.html">base64sha256</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/base64sha512.html">base64sha512</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/bcrypt.html">bcrypt</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filebase64sha256.html">filebase64sha256</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filebase64sha512.html">filebase64sha512</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filemd5.html">filemd5</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filesha1.html">filesha1</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filesha256.html">filesha256</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/filesha512.html">filesha512</a>
</li>
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/md5.html">md5</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/rsadecrypt.html">rsadecrypt</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/sha1.html">sha1</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/sha256.html">sha256</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/sha512.html">sha512</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/uuid.html">uuid</a>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
</li>
lang/funcs: New "uuidv5" function This generates name-based uuids, rather than pseudorandom uuids as with the "uuid" function.
2019-05-08 11:13:30 +02:00
<li>
<a href="/docs/configuration/functions/uuidv5.html">uuidv5</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li id="docs-funcs-ipnet">
<a href="#docs-funcs-ipnet">IP Network Functions</a>
<ul class="nav">
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/cidrhost.html">cidrhost</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/cidrnetmask.html">cidrnetmask</a>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/cidrsubnet.html">cidrsubnet</a>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
</ul>
</li>
website: Add remaining functions to the functions section sidebar These links don't lead anywhere yet.
2018-05-07 04:43:53 +02:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="#docs-funcs-conversion">Type Conversion Functions</a>
<ul class="nav" id="docs-funcs-conversion">
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
lang: "try" and "can" functions These are intended to make it easier to work with arbitrary data structures whose shape might not be known statically, such as the result of jsondecode(...) or yamldecode(...) of data from a separate system. For example, in an object value which has attributes that may or may not be set we can concisely provide a fallback value to use when the attribute isn't set: try(local.example.foo, "fallback-foo") Using a "try to evaluate" model rather than explicit testing fits better with the usual programming model of the Terraform language where values are normally automatically converted to the necessary type where possible: the given expression is subject to all of the same normal type conversions, which avoids inadvertently creating a more restrictive evaluation model as might happen if this were handled using checks like a hypothetical isobject(...) function, etc.
2020-01-03 23:01:14 +01:00
<li>
<a href="/docs/configuration/functions/can.html">can</a>
</li>
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/tobool.html">tobool</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/tolist.html">tolist</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/tomap.html">tomap</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/tonumber.html">tonumber</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/toset.html">toset</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
website: in functions sidebar, default lists to collapsed (#20945) Find-in-page is still supported with the 'expand/collapse all' control.
2019-04-12 01:54:18 +02:00
<li>
<a href="/docs/configuration/functions/tostring.html">tostring</a>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
</li>
lang: "try" and "can" functions These are intended to make it easier to work with arbitrary data structures whose shape might not be known statically, such as the result of jsondecode(...) or yamldecode(...) of data from a separate system. For example, in an object value which has attributes that may or may not be set we can concisely provide a fallback value to use when the attribute isn't set: try(local.example.foo, "fallback-foo") Using a "try to evaluate" model rather than explicit testing fits better with the usual programming model of the Terraform language where values are normally automatically converted to the necessary type where possible: the given expression is subject to all of the same normal type conversions, which avoids inadvertently creating a more restrictive evaluation model as might happen if this were handled using checks like a hypothetical isobject(...) function, etc.
2020-01-03 23:01:14 +01:00
<li>
<a href="/docs/configuration/functions/try.html">try</a>
</li>
lang/funcs: Type conversion functions It's not normally necessary to make explicit type conversions in Terraform because the language implicitly converts as necessary, but explicit conversions are useful in a few specialized cases: - When defining output values for a reusable module, it may be desirable to force a "cleaner" output type than would naturally arise from a computation, such as forcing a string containing digits into a number. - Our 0.12upgrade mechanism will use some of these to replace use of the undocumented, hidden type conversion functions in HIL, and force particular type interpretations in some tricky cases. - We've found that type conversion functions can be useful as _temporary_ workarounds for bugs in Terraform and in providers where implicit type conversion isn't working correctly or a type constraint isn't specified precisely enough for the automatic conversion behavior. These all follow the same convention of being named "to" followed by a short type name. Since we've had a long-standing convention of running all the words together in lowercase in function names, we stick to that here even though some of these names are quite strange, because these should be rarely-used functions anyway.
2019-01-17 18:11:48 +01:00
</ul>
</li>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
</ul>
website: Reorganize nav sidebars to improve jumps between sections
2018-12-21 03:18:13 +01:00
</li>
</ul>
website: Use a middleman partial for "other docs" list instead of hardcoding it This relies on a commit in the terraform-website repo, and should make updating that list much less annoying.
2019-03-08 12:58:58 +01:00
<%= partial("layouts/otherdocs", :locals => { :skip => "Terraform CLI" }) %>
website: Beginnings of "Functions" configuration section Previously we just listed out all of the functions in alphabetical order inside the "Interpolation Syntax" page, but that format doesn't leave much room for details and usage examples. Now we give each function its own page, and categorize them for easier navigation. While many functions are very simple and don't really warrant a full page, certain functions do have additional details that are worth mentioning and this structure scales better for those more complicated functions. So far this includes only the numeric and string functions. Other categories will follow in subsequent commits.
2018-05-07 03:32:16 +02:00
<% end %>
website: Reorganize nav sidebars to improve jumps between sections
2018-12-21 03:18:13 +01:00
<%= yield %>
<% end %>