add store and hook documentation #938
Conversation
mcalhoun
added
the
no-release
Graphite App
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
2 times, most recently
from
7b207e8 to
8075a0f
Compare
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
from
8075a0f to
c836143
Compare
mcalhoun
force-pushed
the
feature/add-artifactory-store
branch
from
40a0c36 to
a08e985
Compare
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
from
c836143 to
d3d2236
Compare
mcalhoun
force-pushed
the
feature/add-artifactory-store
branch
from
81f85de to
e4d7bb1
Compare
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
from
d3d2236 to
3d1c862
Compare
mcalhoun
force-pushed
the
feature/add-artifactory-store
branch
from
e4d7bb1 to
d3af0c0
Compare
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
from
3d1c862 to
704758a
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
mcalhoun
dismissed stale reviews from osterman and coderabbitai[bot]
The base branch was changed.
mcalhoun
removed
the
no-release
|
Warning Rate limit exceeded@mcalhoun has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 41 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (15)
📝 WalkthroughWalkthroughThis pull request involves a comprehensive documentation update focusing on reorganizing and clarifying references to Terraform Remote State across multiple documentation files. The changes primarily involve updating hyperlinks from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
website/docs/core-concepts/stacks/hooks.mdx (1)
38-40: Consider expanding the supported lifecycle events section.The documentation only lists one event (
after-terraform-apply). If this is indeed the only supported event, consider adding a note indicating that more events will be supported in future releases.website/docs/core-concepts/stacks/yaml-functions/store.mdx (1)
149-153: Consider adding mitigation strategies for the listed considerations.The considerations section lists important challenges but doesn't provide guidance on how to address them. Consider adding recommended approaches for:
- Handling sensitive data exposure
- Managing limited permissions scenarios
- Addressing cold-start scenarios
🧰 Tools
🪛 LanguageTool
[style] ~153-~153: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3205 characters long)
Context: ... store may not yet be available and the!storefunction call will fail.(EN_EXCESSIVE_EXCLAMATION)
website/docs/core-concepts/projects/configuration/configuration.mdx (1)
247-247: Add missing comma and verify link update.The link update maintains consistency with the documentation reorganization. However, a comma is missing after "e.g.".
-If you are relying on Atmos discovering the `atmos.yaml` based on your current working directory (e.g. at the root of repository), it will work for the `atmos` CLI +If you are relying on Atmos discovering the `atmos.yaml` based on your current working directory (e.g., at the root of repository), it will work for the `atmos` CLI🧰 Tools
🪛 LanguageTool
[style] ~247-~247: A comma is missing here.
Context: ...ased on your current working directory (e.g. at the root of repository), it will wor...(EG_NO_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
website/docs/core-concepts/components/terraform/brownfield.mdx(2 hunks)website/docs/core-concepts/components/terraform/state-backend.mdx(1 hunks)website/docs/core-concepts/projects/configuration/configuration.mdx(1 hunks)website/docs/core-concepts/projects/configuration/stores.mdx(1 hunks)website/docs/core-concepts/share-data/share-data.mdx(3 hunks)website/docs/core-concepts/stacks/hooks.mdx(1 hunks)website/docs/core-concepts/stacks/templates/functions/atmos.Component.mdx(1 hunks)website/docs/core-concepts/stacks/yaml-functions/store.mdx(1 hunks)website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx(2 hunks)website/docs/core-concepts/stacks/yaml-functions/yaml-functions.mdx(2 hunks)website/docs/quick-start/advanced/configure-cli.mdx(1 hunks)website/docs/quick-start/advanced/configure-repository.md(2 hunks)website/docs/quick-start/advanced/vendor-components.mdx(1 hunks)website/docs/quick-start/simple/configure-cli.mdx(1 hunks)website/docs/quick-start/simple/write-components.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (5)
- website/docs/core-concepts/components/terraform/state-backend.mdx
- website/docs/core-concepts/stacks/templates/functions/atmos.Component.mdx
- website/docs/quick-start/advanced/vendor-components.mdx
- website/docs/core-concepts/components/terraform/brownfield.mdx
- website/docs/quick-start/simple/configure-cli.mdx
🧰 Additional context used
📓 Learnings (2)
website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx (2)
Learnt from: aknysh
PR: cloudposse/atmos#810
File: website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx:0-0
Timestamp: 2024-12-03T04:01:16.446Z
Learning: In the `terraform.output.mdx` documentation file (`website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx`), the cache invalidation and cache scope behavior for the `!terraform.output` function are already described.
Learnt from: aknysh
PR: cloudposse/atmos#810
File: website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx:104-110
Timestamp: 2024-12-03T03:49:30.395Z
Learning: In the documentation for `!terraform.output`, warnings about template variable availability are already covered in other sections, so no need to suggest adding them here.
website/docs/core-concepts/stacks/yaml-functions/yaml-functions.mdx (2)
Learnt from: aknysh
PR: cloudposse/atmos#810
File: examples/tests/stacks/catalog/terraform/template-functions-test2/defaults.yaml:28-32
Timestamp: 2024-12-01T00:33:20.298Z
Learning: In `examples/tests/stacks/catalog/terraform/template-functions-test2/defaults.yaml`, `!exec atmos terraform output` is used in examples to demonstrate its usage, even though `!terraform.output` is the recommended approach according to the documentation.
Learnt from: aknysh
PR: cloudposse/atmos#810
File: website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx:0-0
Timestamp: 2024-12-03T04:01:16.446Z
Learning: In the `terraform.output.mdx` documentation file (`website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx`), the cache invalidation and cache scope behavior for the `!terraform.output` function are already described.
🪛 LanguageTool
website/docs/core-concepts/stacks/yaml-functions/store.mdx
[misspelling] ~104-~104: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...sing Go templates. If you need to get an value from the store froma component in...
(EN_A_VS_AN)
[typographical] ~141-~141: Consider using a typographic opening quote here.
Context: ... ``` :::tip Important By using the printf "%s-%s-%s" function, you are constructin...
(EN_QUOTES)
[style] ~153-~153: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3205 characters long)
Context: ... store may not yet be available and the !store function call will fail.
(EN_EXCESSIVE_EXCLAMATION)
website/docs/core-concepts/projects/configuration/stores.mdx
[duplication] ~115-~115: Possible typo: you repeated a word.
Context: ...# Authentication The AWS SSM Parameter Store store supports the standard AWS methods for a...
(ENGLISH_WORD_REPEAT_RULE)
website/docs/quick-start/simple/write-components.mdx
[style] ~112-~112: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...tween your root modules and can be used in conjunction with [remote state](/core-concepts/share-dat...
(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
website/docs/core-concepts/projects/configuration/configuration.mdx
[style] ~247-~247: A comma is missing here.
Context: ...ased on your current working directory (e.g. at the root of repository), it will wor...
(EG_NO_COMMA)
website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx
[style] ~256-~256: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 4909 characters long)
Context: ...ibe stacks or components. - When using !terraform.output with [`atmos describe ...
(EN_EXCESSIVE_EXCLAMATION)
website/docs/core-concepts/stacks/yaml-functions/yaml-functions.mdx
[style] ~42-~42: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2487 characters long)
Context: ...ctions in Atmos stack manifests - The [!terraform.output](/core-concepts/stac...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Graphite / mergeability_check
- GitHub Check: Graphite / mergeability_check
- GitHub Check: Acceptance Tests (windows-latest, windows)
- GitHub Check: Summary
🔇 Additional comments (12)
website/docs/core-concepts/projects/configuration/stores.mdx (1)
44-45: Add example using !env function for access tokens.Based on previous review feedback, an example showing how to safely use environment variables for access tokens would be beneficial.
website/docs/quick-start/simple/write-components.mdx (1)
112-112: LGTM! Link update is consistent.The update to the remote state documentation link aligns with the overall documentation reorganization.
🧰 Tools
🪛 LanguageTool
[style] ~112-~112: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...tween your root modules and can be used in conjunction with [remote state](/core-concepts/share-dat...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
website/docs/quick-start/advanced/configure-repository.md (1)
81-81: LGTM! Documentation link update is appropriate.The update to the remote state documentation link maintains consistency with the documentation restructuring.
website/docs/core-concepts/share-data/share-data.mdx (4)
17-20: LGTM! Clear and concise introduction.The rephrasing improves readability while maintaining technical accuracy.
23-25: LGTM! Accurate description of data sharing approaches.The text effectively introduces the available methods for sharing data between components.
34-65: LGTM! Well-documented new!storefunction.The new section provides clear examples and context for using the
!storeYAML function.
213-213: LGTM! Consistent link update.The hyperlink update aligns with the documentation reorganization.
website/docs/quick-start/advanced/configure-cli.mdx (1)
12-12: LGTM! Consistent documentation reference.The link update maintains consistency with the new documentation structure.
website/docs/core-concepts/stacks/yaml-functions/yaml-functions.mdx (2)
29-31: LGTM! Improved bullet point formatting.The reformatting enhances readability while maintaining accurate content.
42-43: LGTM! Updated link and description.The changes maintain consistency with the documentation reorganization.
🧰 Tools
🪛 LanguageTool
[style] ~42-~42: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2487 characters long)
Context: ...ctions in Atmos stack manifests - The [!terraform.output](/core-concepts/stac...(EN_EXCESSIVE_EXCLAMATION)
website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx (2)
12-12: LGTM! Consistent link update.The hyperlink update aligns with the documentation reorganization.
254-261: LGTM! Well-organized considerations.The reformatted section clearly presents important considerations for using the
!terraform.outputfunction.🧰 Tools
🪛 LanguageTool
[style] ~256-~256: Using many exclamation marks might seem excessive (in this case: 15 exclamation marks for a text that’s 4909 characters long)
Context: ...ibe stacks or components. - When using!terraform.outputwith [`atmos describe ...(EN_EXCESSIVE_EXCLAMATION)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
website/docs/core-concepts/stacks/yaml-functions/store.mdx (2)
41-61: Consider enhancing examples with expected outputs.The examples effectively demonstrate the syntax, but adding comments showing expected values would make them more instructive.
components: terraform: my_lambda_component: vars: vpc_config: security_group_id: !store security-group/lambda id + # Returns: "sg-1234567890abcdef0" security_group_id2: !store security-group/lambda2 {{ .stack }} id + # Returns: "sg-0987654321fedcba0" from current stack security_group_id3: !store security-group/lambda3 {{ .atmos_stack }} id + # Returns: "sg-abcdef1234567890" from current stack
102-105: Simplify the note about template identifiers.The note about template identifiers is important but could be more concise and clearer.
-:::note Using the `.stack` or `.atmos_stack` template identifiers to specify the stack is the same as calling the -`!store` function with two parameters without specifying the current stack, but without using `Go` templates. If you -need to get a value from the store from a component in the current stack, using the `!store` function with two -parameters is preferred because it has a simpler syntax and executes faster. ::: +:::note +For components in the current stack: +- `!store component {{ .stack }} key` is equivalent to `!store component key` +- Prefer the shorter two-parameter syntax for better readability and performance +:::
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/docs/core-concepts/stacks/yaml-functions/store.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/core-concepts/stacks/yaml-functions/store.mdx
[typographical] ~141-~141: Consider using a typographic opening quote here.
Context: ... ``` :::tip Important By using the printf "%s-%s-%s" function, you are constructin...
(EN_QUOTES)
[style] ~153-~153: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3205 characters long)
Context: ... store may not yet be available and the !store function call will fail.
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: website-deploy-preview
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (2)
website/docs/core-concepts/stacks/yaml-functions/store.mdx (2)
1-40: Strong introduction and clear argument definitions!The introduction effectively explains the purpose of the
!storefunction, and the argument definitions are precise and well-structured.
1-153: Well-structured and comprehensive documentation!The documentation effectively covers all aspects of the
!storefunction, from basic usage to advanced scenarios. The suggested improvements will further enhance its utility for users.🧰 Tools
🪛 LanguageTool
[typographical] ~141-~141: Consider using a typographic opening quote here.
Context: ... ``` :::tip Important By using theprintf "%s-%s-%s"function, you are constructin...(EN_QUOTES)
[style] ~153-~153: Using many exclamation marks might seem excessive (in this case: 11 exclamation marks for a text that’s 3205 characters long)
Context: ... store may not yet be available and the!storefunction call will fail.(EN_EXCESSIVE_EXCLAMATION)
mcalhoun
force-pushed
the
01-13-chore_docs_add_docs_for_hooks_and_store
branch
from
624d665 to
f7a399e
Compare
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
These changes were released in v1.148.1. |
what
Update documentation for the
storeandhookfunctionalitywhy
To allow users to learn how to configure and use the features.
Summary by CodeRabbit
Documentation Updates
/core-concepts/components/terraform/remote-stateto/core-concepts/share-data/remote-statestores.mdx: Guide on configuring remote storeshooks.mdx: Explanation of lifecycle event management!storefor reading values from remote storesNew Features