Merge pull request #64 from lkubb/vault-ssh

Fixes #58
salt-extensions · Jul 25, 2024 · 2f21851 · 2f21851
2 parents 259978d + d1b2dd3
commit 2f21851
Show file tree

Hide file tree

Showing 23 changed files with 2,676 additions and 10 deletions.
diff --git a/changelog/58.added.md b/changelog/58.added.md
@@ -0,0 +1 @@
+Added `vault_ssh` execution, state and wrapper modules for managing and using the SSH secret backend
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,11 +10,12 @@ Currently, you can
 * manage and dynamically retrieve secrets from the KV v1 and v2 secret backends
 * manage Vault policies
 * manage the Database secret engine
-* manage and issue certificates via the PKI secret engine
 * request, renew and monitor short-lived database credentials
+* manage and issue certificates via the PKI secret engine
+* manage and issue credentials/certificates via the SSH secret engine
 * write your own modules on top of the provided utilities
 
-There's much more coming though.
+There's more coming though.
 
 References
 ----------

diff --git a/docs/ref/modules/index.rst b/docs/ref/modules/index.rst
@@ -12,3 +12,4 @@ _________________
     vault
     vault_db
     vault_pki
+    vault_ssh
diff --git a/docs/ref/modules/saltext.vault.modules.vault_ssh.rst b/docs/ref/modules/saltext.vault.modules.vault_ssh.rst
@@ -0,0 +1,5 @@
+``vault_ssh``
+=============
+
+.. automodule:: saltext.vault.modules.vault_ssh
+    :members:
diff --git a/docs/ref/states/index.rst b/docs/ref/states/index.rst
@@ -13,3 +13,4 @@ _____________
     vault_db
     vault_pki
     vault_secret
+    vault_ssh
diff --git a/docs/ref/states/saltext.vault.states.vault_ssh.rst b/docs/ref/states/saltext.vault.states.vault_ssh.rst
@@ -0,0 +1,5 @@
+``vault_ssh``
+=============
+
+.. automodule:: saltext.vault.states.vault_ssh
+    :members:
diff --git a/docs/ref/wrapper/index.rst b/docs/ref/wrapper/index.rst
@@ -12,3 +12,4 @@ _______________
     vault
     vault_db
     vault_pki
+    vault_ssh
diff --git a/docs/ref/wrapper/saltext.vault.wrapper.vault_ssh.rst b/docs/ref/wrapper/saltext.vault.wrapper.vault_ssh.rst
@@ -0,0 +1,5 @@
+``vault_ssh``
+=============
+
+.. automodule:: saltext.vault.wrapper.vault_ssh
+    :members:
diff --git a/src/saltext/vault/modules/vault.py b/src/saltext/vault/modules/vault.py
@@ -1,5 +1,5 @@
 """
-Interface with a Vault server.
+Interface with a Vault server and the KV secret backend.
 
 .. important::
     This module requires the general :ref:`Vault setup <vault-setup>`.

diff --git a/src/saltext/vault/modules/vault_pki.py b/src/saltext/vault/modules/vault_pki.py
@@ -1,7 +1,5 @@
 """
-.. _vault_pki:
-
-Manage the Vault PKI secret engine.
+Manage the Vault PKI secret engine, request X.509 certificates.
 
 .. versionadded:: 1.1.0