From 8bb6a4cbf471fecce3d7d360257c75b52cbdd6d0 Mon Sep 17 00:00:00 2001 From: anastyakulyk Date: Wed, 25 Sep 2024 13:27:12 +0300 Subject: [PATCH] update description of the remotestate function --- docs/stack-templates-functions.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/stack-templates-functions.md b/docs/stack-templates-functions.md index 2ba7ff8a..b4b62b28 100644 --- a/docs/stack-templates-functions.md +++ b/docs/stack-templates-functions.md @@ -53,6 +53,10 @@ Rendered stack template: Pass data across units and stacks, can be used in pre/post hooks. +!!! Important + + The function can take input only from Terraform-based units, i.e. Tfmodule, Kubernetes, Helm, and Printer. + **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"`. The `remoteState` function is integrated with the `yaml` syntax and can be used in following cases: