Skip to main content

vault-sync

Build Status Coverage Status

What is vault-sync?

vault-sync is a command-line tool for synchronizing secrets from one Hashicorp Vault instance or another.

This can useful either for backup reasons or for ensuring that changes in one environment are correctly brought over to the other.

vault_sync has support for the following authentication methods:

  • token
  • approle
  • kubernetes (experimental)

Using vault-sync and config file

Vault-sync is a command-line tool that by default uses a small JSON document file to connect to the vault instances.

Any file can be used by the tool by using the --config=<path to file> flag. Do note however that pydantic is used to strictly enforce the layout of the JSON document.

Example configs:

One time sync with token:

{
    "source": {
        "auth_method": "token",
        "url": "https://test1.com",
        "token": "aabbccddeeff",
        "kv_store": "store1"
    },
    "destination": {
        "auth_method": "token",
        "url": "https://test2.com",
        "token": "0011223344",
        "kv_store": "store2"
    }
}

Sync every 5 minutes (with kubernetes and approle auth_methods):

{
    "source": {
        "auth_method": "kubernetes",
        "url": "https://test1.com",
        "token_path": "/run/secrets/kubernetes.io/serviceaccount/token",
        "secret_id": "vrl-vault-sync",
        "kv_store": "store1"
    },
    "destination": {
        "auth_method": "approle",
        "url": "https://test2.com",
        "role_id": "8d900c30-e078-4981-a1be-01c2a0770f2b",
        "secret_id": "d1c5468e-15ee-427f-b69d-b77d214b2bfd",
        "kv_store": "store2"
    },
    "schedule": {
      "every": 300
    }
}

(*) approle is the default auth_method, so its fine to remove "auth_method": "approle" from your configuration.

Metadata

Release files for vault-sync 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vault-sync 0.3.3
File Size Uploaded Provenance Actions
vault_sync-0.3.3.tar.gz 9.8 kB Without provenance Details for vault_sync-0.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vault-sync 0.3.3
File Interpreter ABI Platform Actions
vault_sync-0.3.3-py3-none-any.whl Python 3 none any Details for vault_sync-0.3.3-py3-none-any.whl

Total release size: 20.5 kB

Release files / vault_sync-0.3.3.tar.gz

Download URL vault_sync-0.3.3.tar.gz
Size 9.8 kB
Tags Source
SHA-256 checksum
How to use checksums
943cc3c851008947442cc5f624f735318b67801c0af3c86f904bab17a7cf7115
BLAKE2b-256 checksum
How to use checksums
0e7cd839638f30ae3f017cc416564e85341b9af84995399d814e7a8c10243531
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.10 Linux/6.12.28

Release files / vault_sync-0.3.3-py3-none-any.whl

Download URL vault_sync-0.3.3-py3-none-any.whl
Size 10.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
666a548e83eb51049bc42318383003c8550708d737ae1ba0cf699fd60d39dedd
BLAKE2b-256 checksum
How to use checksums
0acda8d8959cbff87e097d04c163cdeee6baee20f701bcb55ac56827aa785bbb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.10 Linux/6.12.28

Security for vault-sync 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page