Skip to main content
Version: 1.5.0 (latest)

common.configuration.providers.vault

VaultDocProvider Objects

class VaultDocProvider(BaseDocProvider)

[view_source]

A toml-backed Vault abstract config provider.

This provider allows implementation of providers that store secrets in external vaults: like Hashicorp, Google Secrets or Airflow Metadata. The basic working principle is obtain config and secrets values from Vault keys and reconstitute a secrets.toml like document that is then used as a cache.

The implemented must provide _look_vault method that returns a value from external vault from external key.

To reduce number of calls to external vaults the provider is searching for a known configuration fragments which should be toml documents and merging them with the

  • only keys with secret type hint (CredentialsConfiguration, TSecretValue) will be looked up by default.
  • provider gathers toml document fragments that contain source and destination credentials in path specified below
  • single values will not be retrieved, only toml fragments by default

__init__

def __init__(only_secrets: bool, only_toml_fragments: bool) -> None

[view_source]

Initializes the toml backed Vault provider by loading a toml fragment from dlt_secrets_toml key and using it as initial configuration.

extended_summary

Arguments:

  • only_secrets bool - Only looks for secret values (CredentialsConfiguration, TSecretValue) by returning None (not found)
  • only_toml_fragments bool - Only load the known toml fragments and ignore any other lookups by returning None (not found)

This demo works on codespaces. Codespaces is a development environment available for free to anyone with a Github account. You'll be asked to fork the demo repository and from there the README guides you with further steps.
The demo uses the Continue VSCode extension.

Off to codespaces!

DHelp

Ask a question

Welcome to "Codex Central", your next-gen help center, driven by OpenAI's GPT-4 model. It's more than just a forum or a FAQ hub – it's a dynamic knowledge base where coders can find AI-assisted solutions to their pressing problems. With GPT-4's powerful comprehension and predictive abilities, Codex Central provides instantaneous issue resolution, insightful debugging, and personalized guidance. Get your code running smoothly with the unparalleled support at Codex Central - coding help reimagined with AI prowess.