-
Notifications
You must be signed in to change notification settings - Fork 9.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation for linking Stacks #36408
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM from the technical perspective 🎉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great first draft. Let me know if you have any questions about these suggestions.
Co-authored-by: trujillo-adam <[email protected]>
Co-authored-by: trujillo-adam <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops didn't mean this as a review - but posting anyway cause I don't want to lose my comments 😂
``` | ||
|
||
</CodeBlockConfig> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Is correct!
- So, Stacks have a different VCS workflowIs actually a bit fuzzy depending on how you set up your Stack the first time. Most folks use a VCS-linked Stack so when you push to Github, HCP Terraform makes a new configuration version that you can apply (which is different then a deployment plan that rolls out a configuration version once it's been applied). There is also a second workflow you can go through manually, so you literally push the "Fetch configuration" button to start a configuration plan.
Since this article isn't about the second point (and we are in the Terraform language docs, not the HCP Terraform docs), I felt like it'd be distracting to talk about how to apply the configuration versus what folks care about here - which is that you have to apply it before the outputs are available.
|
||
# Declare outputs | ||
|
||
You must declare a `publish_output` block in your deployment configuration for each value you want to output from your current Stack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to explain what an expression is here, or how to reference a value. Wouldn't that be what we'd want to put in a reference article? This is usage so that feels a bit excessive, what I'm trying to communicate is:
- Declare a publish_output for each value you want to output from your Stack (can be value).
- Here is an example of what that looks like.
- To use this output, HCP Terraform needs to fetch your configuration and apply it.
- Look at the reference article if you want to learn more about syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved per request of @rkoron007. Did a quick review but do not have the context to know if the content is correct. Be forewarned.
Importing our docs outline into Github
Summary and pages affected:
publish_output
andupstream_input
blocks to the deployment configuration referenceTarget Release
1.11.x
CHANGELOG entry
(This is user-facing, but I'll leave the changelog entry to the team when this comes out)