Skip to content

Commit 8bb6a4c

Browse files
committed
update description of the remotestate function
1 parent a36a6a3 commit 8bb6a4c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/stack-templates-functions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ Rendered stack template:
5353

5454
Pass data across units and stacks, can be used in pre/post hooks.
5555

56+
!!! Important
57+
58+
The function can take input only from Terraform-based units, i.e. Tfmodule, Kubernetes, Helm, and Printer.
59+
5660
**Argument**: string, path to remote state consisting of 3 parts separated by a dot: `"stack_name.unit_name.output_name"`. Since the name of the stack is unknown inside the stack template, you can use "this" instead:`"this.unit_name.output_name"`.
5761

5862
The `remoteState` function is integrated with the `yaml` syntax and can be used in following cases:

0 commit comments

Comments
 (0)