docs: Fix store configuration format in documentation

[osterman]

what

• Updated store configuration examples to match actual implementation
• Changed all backend/config keys to type/options
• Fixed Azure Key Vault to use vault_url instead of vault_name
• Removed unsupported AWS Secrets Manager section
• Updated Redis configuration to use URL format
• Added complete Artifactory section with all options

why

GitHub issue #1860 reported that the documentation showed an incorrect format for store configuration. The code expects type/options keys, not backend/config keys. This created confusion for users following the documentation.

references

Closes #1860

Summary by CodeRabbit

• Documentation
  • Simplified store configuration schema for all backends (AWS SSM Parameter Store, Azure Key Vault, Google Secret Manager, Redis, Artifactory) using a unified type and options format.
  • Added support for additional optional configuration parameters including prefixes, delimiters, and credentials.
  • Enhanced configuration examples and clarified authentication methods across all store types.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update correcting store configuration examples in the stores reference guide. The outdated backend and config format is replaced with the current unified type and options schema across all supported store types.

Changes

Cohort / File(s)

Change Summary

Store Configuration Documentation website/docs/cli/configuration/stores.mdx

Updated all store configuration examples from legacy backend/config format to the current type/options schema. Renamed store type identifiers (aws/ssm → aws-ssm-parameter-store, azure/keyvault → azure-key-vault, gcp/secretmanager → google-secret-manager, redis → redis, artifactory → artifactory). Expanded optional configuration fields for AWS SSM, Azure Key Vault, Google Secret Manager, Redis, and Artifactory. Reorganized section headers from "Backend Configuration" to "Store Type Configuration" and enhanced authentication notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Pure documentation update with no code logic changes
• Straightforward format conversion and example updates across a single file
• Changes are consistent and repetitive in nature (applying the same schema transformation across multiple store types)

Possibly related PRs

• add redis store #1008 — Implements Redis store backend and registry handling, directly related since this PR updates the Redis store documentation to reflect the new unified type/options format introduced in that PR.

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating store configuration format documentation from backend/config to type/options.
Linked Issues check	✅ Passed	The changes directly address all objectives from #1860: documentation updated to use type/options format, Azure Key Vault now uses vault_url instead of vault_name, and examples match current implementation.
Out of Scope Changes check	✅ Passed	All changes are documentation updates directly addressing the configuration format discrepancy reported in #1860; no out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch osterman/issue-1860-docs-review

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 15bfcdf and 648c663.

📒 Files selected for processing (1)

• website/docs/cli/configuration/stores.mdx (5 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

website/**

📄 CodeRabbit inference engine (.cursor/rules/atmos-rules.mdc)

website/**: Update website documentation in the website/ directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
Keep website code in the website/ directory, follow the existing website architecture and style, and test website changes locally before committing
Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases

Files:

• website/docs/cli/configuration/stores.mdx

website/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

ALWAYS build website after doc changes: cd website && npm run build. Verify: no broken links, missing images, MDX component rendering.

Files:

• website/docs/cli/configuration/stores.mdx

🧠 Learnings (4)

📓 Common learnings

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.

Learnt from: Listener430
Repo: cloudposse/atmos PR: 934
File: tests/fixtures/scenarios/docs-generate/README.md.gotmpl:99-118
Timestamp: 2025-01-25T03:51:57.689Z
Learning: For the cloudposse/atmos repository, changes to template contents should be handled in dedicated PRs and are typically considered out of scope for PRs focused on other objectives.

📚 Learning: 2025-04-25T20:54:19.701Z

Learnt from: mcalhoun
Repo: cloudposse/atmos PR: 963
File: website/docs/core-concepts/projects/configuration/stores.mdx:286-286
Timestamp: 2025-04-25T20:54:19.701Z
Learning: For the AWS SSM Parameter Store implementation in Atmos, support for `read_role_arn` and `write_role_arn` options is essential to enable cross-account access, allowing users to run operations like `terraform plan` in multiple accounts while accessing values across keystores. Azure Key Vault would need similar capabilities for cross-tenant/subscription authentication.

Applied to files:

• website/docs/cli/configuration/stores.mdx

📚 Learning: 2025-02-11T08:21:33.143Z

Learnt from: shirkevich
Repo: cloudposse/atmos PR: 1034
File: website/docs/core-concepts/projects/configuration/stores.mdx:173-177
Timestamp: 2025-02-11T08:21:33.143Z
Learning: The parameter for configuring stack path delimiter in store configurations is consistently named `stack_delimiter` (not `stacks_delimiter`) across all store types in Atmos.

Applied to files:

• website/docs/cli/configuration/stores.mdx

📚 Learning: 2024-12-12T15:15:46.457Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 808
File: examples/demo-atmos-cli-imports/atmos.yaml:7-7
Timestamp: 2024-12-12T15:15:46.457Z
Learning: In example configuration files, such as `examples/demo-atmos-cli-imports/atmos.yaml`, it's acceptable to use `refs/heads/main` in remote URLs.

Applied to files:

• website/docs/cli/configuration/stores.mdx

🪛 LanguageTool

website/docs/cli/configuration/stores.mdx

[typographical] ~30-~30: Consider using a typographic opening quote here.
Context: ...key-vault options: vault_url: "https://my-keyvault.vault.azure.net/" ...

(EN_QUOTES)

---

[typographical] ~30-~30: Consider using a typographic close quote here.
Context: ...l: "https://my-keyvault.vault.azure.net/" # Google Secret Manager prod/gcp: ...

(EN_QUOTES)

---

[typographical] ~42-~42: Consider using a typographic opening quote here.
Context: ... type: redis options: url: "redis://localhost:6379" # Artifactory...

(EN_QUOTES)

---

[typographical] ~42-~42: Consider using a typographic close quote here.
Context: ...ions: url: "redis://localhost:6379" # Artifactory artifacts: type:...

(EN_QUOTES)

⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Acceptance Tests (windows)
• GitHub Check: Summary

🔇 Additional comments (8)

website/docs/cli/configuration/stores.mdx (8)

17-51: Configuration format update correctly reflects current implementation.

The refactored examples from backend/config to type/options align with the PR objectives and the actual codebase expectations. The Azure Key Vault correction from vault_name to vault_url resolves the core issue reported in #1860.

---

68-85: Store type definitions are clear and accurate.

The new "Supported Store Types" section provides good definitions. The gsm shorthand for Google Secret Manager is helpful.

---

89-105: AWS SSM configuration includes cross-account access options.

Good coverage of read_role_arn and write_role_arn for cross-account scenarios. The stack_delimiter parameter matches the established naming convention.

---

107-122: Azure Key Vault now shows correct vault_url format.

The change from vault_name to vault_url with full HTTPS endpoint resolves the configuration error users were experiencing. The note about Azure Default Credential chain is helpful context.

---

124-143: Google Secret Manager section expanded with optional configuration.

Good addition of optional credentials, locations, and standard optional fields (prefix, stack_delimiter).

---

145-160: Redis configuration with URL format support is clear.

The URL format with authentication support documented on line 160 is useful. Consider verifying this matches the actual supported Redis URL schemes in the implementation.

---

162-178: Artifactory section appropriately includes all core options.

Good addition of the complete artifactory store type with repo_name and optional fields (access_token, prefix, stack_delimiter).

---

1-204: [rewritten comment]
[classification tag]

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.28%. Comparing base (4f0c615) to head (fc5bbc7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1862   +/-   ##
=======================================
  Coverage   73.27%   73.28%           
=======================================
  Files         551      551           
  Lines       53458    53458           
=======================================
+ Hits        39170    39175    +5     
+ Misses      11442    11438    -4     
+ Partials     2846     2845    -1     

Flag	Coverage Δ
unittests	73.28% <ø> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

These changes were released in v1.202.0-rc.1.

[github-actions]

These changes were released in v1.203.0-test.1.