Skip to content

Vault: Add YDB storage backend documentation#2189

Open
kprokopenko wants to merge 2 commits into
hashicorp:mainfrom
ydb-platform:ydb-backend
Open

Vault: Add YDB storage backend documentation#2189
kprokopenko wants to merge 2 commits into
hashicorp:mainfrom
ydb-platform:ydb-backend

Conversation

@kprokopenko

@kprokopenko kprokopenko commented Apr 8, 2026

Copy link
Copy Markdown

Summary

  • Add documentation page for the new YDB physical storage backend for Vault
  • New file: content/vault/v1.21.x/content/docs/configuration/storage/ydb.mdx
  • Documents all configuration parameters, environment variables, authentication methods, HA setup, and transaction limits

Related

Details

The documentation covers:

  • Configuration parameters: dsn (required), table, ha_enabled, ha_coordination_node, authentication options, balancer, TLS CA, transaction limits
  • Environment variables: all parameters can be set via VAULT_YDB_* environment variables (which take precedence over HCL config)
  • Authentication methods: token, service account key (file or inline), static credentials, metadata auth, anonymous — documented in priority order
  • HA support: via YDB coordination nodes with semaphore-based distributed locking
  • Auto-table creation: backend creates the KV table automatically on first startup

Note: This backend is community-supported and has been reviewed by HashiCorp.

@kprokopenko kprokopenko requested a review from a team as a code owner April 8, 2026 10:37
@github-actions github-actions Bot added the Vault Content update for Vault product docs label Apr 8, 2026
@kprokopenko kprokopenko mentioned this pull request Apr 8, 2026
7 tasks
@github-actions

github-actions Bot commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Wed Apr 8 10:52:26 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Wed Apr 8 10:48:25 UTC 2026

@github-actions

github-actions Bot commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Broken Link Checker

No broken links found! 🎉

Comment on lines +18 to +20
- **Community Supported** – the YDB storage backend is supported by the
community. While it has undergone review by HashiCorp employees, they may not
be as knowledgeable about the technology. If you encounter problems with it,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, we don't document community backends/plugins in the official IBM documentation.

I can look into adding an entry to the Integrations page (it's meant for plugins, but I can see if it's possible.)

Alternatively, link to the relevant SDK on the Client libraries page.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback.

I didn’t understand the part about the official IBM documentation. I want to add one more section here: Backend Storage for Vault. The “Edit this page on GitHub” button leads to this repository. Also, I can see Community Supported Backends in this repository, for example, Cockroach.

Could you please advise me on the best course of action? It seems that the options you suggested are not quite what I’m looking for.

@schavis schavis Apr 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries. The link is a little misleading in that we do publish the docs out of this repo, but they're also official IBM docs rather than open source. I know we don't document community plugins on the official docs, but let me ask around to find out if there's a different policy for backend support. I'll try and get you an answer by next week.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kprokopenko I wanted to follow-up and let you know I haven't forgotten about this. As far as I can tell, the pages we have currently are there because they were (at least originally) official partnerships. I'm trying to find someone who can confirm the state of things so I can determine an appropriate solution going forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Vault Content update for Vault product docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants