docs: add guide for using external secret references#343
Draft
Aaron ("AJ") Steers (aaronsteers) wants to merge 2 commits intomainfrom
Draft
docs: add guide for using external secret references#343Aaron ("AJ") Steers (aaronsteers) wants to merge 2 commits intomainfrom
Aaron ("AJ") Steers (aaronsteers) wants to merge 2 commits intomainfrom
Conversation
…dinate:: prefix Co-Authored-By: AJ Steers <[email protected]>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Thanks for opening this pull request!Your contribution is appreciated. Here are some helpful tips and resources. 💡 Show Tips and TricksTerraform Example Commands
📚 Show Repo GuidanceAbout This RepositoryThis repository uses Speakeasy to generate the Terraform provider from the Airbyte OpenAPI specification. The CI will automatically build the provider, validate code generation, and run acceptance tests across Terraform versions 1.0-1.4. Note: This is a generated codebase. Direct modifications to generated files are not accepted - changes must be made to the upstream OpenAPI spec. |
Co-Authored-By: AJ Steers <[email protected]>
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new guide (
docs/guides/secret_references.md) documenting how to use thesecret_coordinate::prefix when configuring connectors via Terraform. This allows users with a custom secret storage configured to reference secrets in their external secret manager (AWS SM, GCP SM, Azure Key Vault, etc.) instead of passing raw values.Covers:
secret_coordinate::prefix worksairbyte_sourceresource withjsonencode()include_secret_coordinates = trueA corresponding template file (
templates/guides/secret_references.md.tmpl) is included so that the guide survives thedocs-generatepipeline (which regeneratesdocs/fromtemplates/).Companion PR: airbytehq/airbyte#73672 (adds the main
secret_coordinate::documentation to docs.airbyte.com)Updates since last revision
templates/guides/secret_references.md.tmplto fix the "Verify Docs Are Up-to-Date" CI check, which was deleting the manually-added guide during doc generation.Review & Testing Checklist for Human
secret_coordinate::my-pg-password). Confirm this is correct — is it the secret name, a full path, or an ARN? This was inferred from code reading ofSecretsHelpers.kt, not end-to-end testing. This is the highest-risk item.https://docs.airbyte.com/platform/understanding-airbyte/secrets#external-secret-referencesand.../enterprise-flex/external-secrets, both of which are being added in the companion PR (docs: add external secret references documentation forsecret_coordinate::prefix airbyte#73672). Ensure those land before or alongside this PR.Suggested test plan: Have someone with a workspace that has custom secret storage configured attempt to create a source via Terraform using the
secret_coordinate::prefix pattern shown in the guide, and verify the secret resolves correctly.Notes
airbyte_sourceresource withjsonencode()(v1.0+ pattern), consistent with the v1 migration guide.secret_coordinate::(secret name vs. full coordinate path) is the highest-risk item — this was derived from code analysis ofSecretsHelpers.kt, not from runtime testing.docs/guides/secret_references.mdandtemplates/guides/secret_references.md.tmplmust stay in sync. The CI "Verify Docs Are Up-to-Date" check enforces this.Link to Devin run: https://app.devin.ai/sessions/94c36f482f634314936fea1261ad61e3
Requested by: Aaron ("AJ") Steers (@aaronsteers)