{"id":15167111,"url":"https://github.com/lkubb/salt-vault-formula","last_synced_at":"2026-01-21T19:36:21.634Z","repository":{"id":134852581,"uuid":"546035156","full_name":"lkubb/salt-vault-formula","owner":"lkubb","description":"Manage Hashicorp Vault with Salt. Features better integration with Salt.","archived":false,"fork":false,"pushed_at":"2024-11-13T23:41:12.000Z","size":471,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T03:29:39.776Z","etag":null,"topics":["devops","hashicorp-vault","salt-formula","saltstack","saltstack-formula","vault"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lkubb.png","metadata":{"files":{"readme":"docs/README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-05T12:11:00.000Z","updated_at":"2024-11-13T23:41:16.000Z","dependencies_parsed_at":"2025-02-14T21:47:25.594Z","dependency_job_id":"d0fb2ce9-4b5e-440d-aa4d-206db98d4ced","html_url":"https://github.com/lkubb/salt-vault-formula","commit_stats":{"total_commits":118,"total_committers":1,"mean_commits":118.0,"dds":0.0,"last_synced_commit":"404c6ba371a07e4b605304ff447215e8a1591d22"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lkubb/salt-vault-formula","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-vault-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-vault-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-vault-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-vault-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lkubb","download_url":"https://codeload.github.com/lkubb/salt-vault-formula/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-vault-formula/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28641276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T18:04:35.752Z","status":"ssl_error","status_checked_at":"2026-01-21T18:03:55.054Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devops","hashicorp-vault","salt-formula","saltstack","saltstack-formula","vault"],"created_at":"2024-09-27T05:24:45.113Z","updated_at":"2026-01-21T19:36:21.610Z","avatar_url":"https://github.com/lkubb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nVault Formula\n=============\n\n|img_sr| |img_pc|\n\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :alt: pre-commit\n   :scale: 100%\n   :target: https://github.com/pre-commit/pre-commit\n\nManage Hashicorp Vault with Salt.\n\nThis formula contains several custom modules. The ``vault`` modules should be backwards-compatible with the ones currently found in Salt and might become available there at some point. For details, see `#62684 \u003chttps://github.com/saltstack/salt/pull/62684\u003e`_ and `#63314 \u003chttps://github.com/saltstack/salt/pull/63314\u003e`_.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nIf you need (non-default) configuration, please refer to:\n\n- `how to configure the formula with map.jinja \u003cmap.jinja.rst\u003e`_\n- the ``pillar.example`` file\n- the `Special notes`_ section\n\nSpecial notes\n-------------\n\n\nConfiguration\n-------------\nAn example pillar is provided, please see `pillar.example`. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the ``parameters/\u003cgrain\u003e/\u003cvalue\u003e.yaml`` files for non-sensitive settings. The underlying logic is explained in `map.jinja`.\n\n\nAvailable states\n----------------\n\nThe following states are found in this formula:\n\n.. contents::\n   :local:\n\n\n``vault``\n^^^^^^^^^\n*Meta-state*.\n\nThis installs Vault,\nmanages the Vault and system swap configuration\nand then starts the Vault service.\nAlso ensures the cluster is initialized if ``vault:init``\nis not false.\n\n\n``vault.package``\n^^^^^^^^^^^^^^^^^\nInstalls Vault (+ necessary service unit overrides) only.\n\n\n``vault.package.repo``\n^^^^^^^^^^^^^^^^^^^^^^\nThis state will install the configured vault repository.\nThis works for apt/dnf/yum/zypper-based distributions only by default.\n\n\n``vault.config``\n^^^^^^^^^^^^^^^^\nEnsures the system and Vault is configured as specified.\n\n\n``vault.config.file``\n^^^^^^^^^^^^^^^^^^^^^\nManages the Vault configuration.\nHas a dependency on `vault.package`_.\n\n\n``vault.config.system``\n^^^^^^^^^^^^^^^^^^^^^^^\nManages system settings required for Vault: disable swap.\nIncludes `vault.package`_.\n\n\n``vault.cert``\n^^^^^^^^^^^^^^\nGenerates a TLS certificate + key for Vault.\nDepends on `vault.package`_.\n\n\n``vault.service``\n^^^^^^^^^^^^^^^^^\nStarts the vault service and enables it at boot time.\nHas a dependency on `vault.config`_.\n\n\n``vault.initialize``\n^^^^^^^^^^^^^^^^^^^^\nEnsures a running Vault cluster has been initialized.\nWill output key shares and initial root token to file paths.\n**Ensure you provide the correct GPG keys in order to encrypt\nthe output.**\n\n\n``vault.database``\n^^^^^^^^^^^^^^^^^^\nManages database connections and their roles.\n\n\n``vault.leases``\n^^^^^^^^^^^^^^^^\nManages cached leases and associated beacons.\n\n\n``vault.pki``\n^^^^^^^^^^^^^\n\n\n\n``vault.pki.base``\n^^^^^^^^^^^^^^^^^^\nManages PKI backend URL endpoints.\n\n\n``vault.pki.ca``\n^^^^^^^^^^^^^^^^\nManages intermediate CAs on PKI backend mounts.\n\n\n``vault.pki.roles``\n^^^^^^^^^^^^^^^^^^^\nManages present and absent roles on configured PKI mounts.\n\n\n``vault.plugins``\n^^^^^^^^^^^^^^^^^\nManages present/absent custom plugins.\nFor present ones, pulls binaries from a URI and registers them.\n\n\n``vault.secrets``\n^^^^^^^^^^^^^^^^^\nManages Vault KV secrets.\n\n\n``vault.ssh``\n^^^^^^^^^^^^^\nManages SSH secret backend roles and, if required, CAs.\n\n\n``vault.ssh.ca``\n^^^^^^^^^^^^^^^^\n\n\n\n``vault.ssh.roles``\n^^^^^^^^^^^^^^^^^^^\n\n\n\n``vault.clean``\n^^^^^^^^^^^^^^^\n*Meta-state*.\n\nUndoes everything performed in the ``vault`` meta-state\nin reverse order, i.e.\nstops the service,\nremoves the configuration file and then\nuninstalls the package.\n\n\n``vault.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nRemoves Vault and service unit overrides.\nHas a dependency on `vault.config.clean`_.\n\n\n``vault.package.repo.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nThis state will remove the configured vault repository.\nThis works for apt/dnf/yum/zypper-based distributions only by default.\n\n\n``vault.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^\nRemoves the Vault configuration only and has a\ndependency on `vault.service.clean`_.\n\n\n``vault.cert.clean``\n^^^^^^^^^^^^^^^^^^^^\nRemoves generated Vault TLS certificate + key.\nDepends on `vault.service.clean`_.\n\n\n``vault.service.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nStops the vault service and disables it at boot time.\n\n\n``vault.database.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^\nRemoves managed database connections and their roles.\nRequires ``remove_all_data_for_sure`` to be set to true\nto prevent accidental damage.\n\n\n``vault.leases.clean``\n^^^^^^^^^^^^^^^^^^^^^^\nRemoves managed leases.\n\n\n``vault.pki.clean``\n^^^^^^^^^^^^^^^^^^^\nDoes nothing at the moment.\n\n\n``vault.plugins.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``vault.secrets.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nRemoves managed secrets.\n\n\n``vault.ssh.clean``\n^^^^^^^^^^^^^^^^^^^\nRemoves managed SSH roles and SSH CAs.\nFor CAs, requires ``remove_all_data_for_sure`` to be set to true\nto prevent accidental damage.\n\n\n\nContributing to this repo\n-------------------------\n\nCommit messages\n^^^^^^^^^^^^^^^\n\n**Commit message formatting is significant!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\npre-commit\n^^^^^^^^^^\n\n`pre-commit \u003chttps://pre-commit.com/\u003e`_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.\nFirst install  the ``pre-commit`` package manager using the appropriate `method \u003chttps://pre-commit.com/#installation\u003e`_, then run ``bin/install-hooks`` and\nnow ``pre-commit`` will run automatically on each ``git commit``. ::\n\n  $ bin/install-hooks\n  pre-commit installed at .git/hooks/pre-commit\n  pre-commit installed at .git/hooks/commit-msg\n\nState documentation\n~~~~~~~~~~~~~~~~~~~\nThere is a script that semi-autodocuments available states: ``bin/slsdoc``.\n\nIf a ``.sls`` file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.\n\nThis means if you feel a state should be documented, make sure to write a comment explaining it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-vault-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flkubb%2Fsalt-vault-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-vault-formula/lists"}