Update docs and runbook

thevickypedia · Sep 18, 2024 · 40c3cfc · 40c3cfc
1 parent 3c7a3de
commit 40c3cfc
Show file tree

Hide file tree

Showing 13 changed files with 103 additions and 26 deletions.
diff --git a/.github/workflows/docker-description.yaml b/.github/workflows/docker-description.yaml
@@ -1,4 +1,4 @@
-name: Update Docker Hub Description
+name: Docker Hub Description
 
 on:
   push:

diff --git a/.github/workflows/markdown.yaml b/.github/workflows/markdown.yaml
@@ -1,4 +1,4 @@
-name: None Shall Pass
+name: none-shall-pass
 
 on:
   push:

diff --git a/README.md b/README.md
@@ -6,12 +6,16 @@ Lightweight API to store/retrieve secrets to/from an encrypted Database
 **Platform Supported**
 
 ![Platform][label-platform]
+![docker-image][image-size]
 
 **Deployments**
 
-[![pages][label-actions-pages]][gha_pages]
+[![docker][label-docker-build]][gha_docker]
 [![pypi][label-actions-pypi]][gha_pypi]
+[![docker_desc][label-docker-desc]][gha_docker_desc]
+
 [![markdown][label-actions-markdown]][gha_md_valid]
+[![pages][label-actions-pages]][gha_pages]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -112,6 +116,11 @@ pre-commit run --all-files
 
 [https://pypi.org/project/VaultAPI/][pypi]
 
+## Docker Image
+[![made-with-docker-doc][label-docker-doc]][docker-doc]
+
+[https://hub.docker.com/r/thevickypedia/vaultapi][docker]
+
 ## Runbook
 [![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
 
@@ -124,8 +133,11 @@ pre-commit run --all-files
 Licensed under the [MIT License][license]
 
 [label-actions-markdown]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml/badge.svg
+[label-docker-build]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml/badge.svg
+[label-docker-desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml/badge.svg
 [label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-VaultAPI-blue?style=for-the-badge&logo=Python
 [label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[label-docker-doc]: https://img.shields.io/badge/Made%20with-Docker-blue?style=for-the-badge&logo=Docker
 [label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
 [label-actions-pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment/badge.svg
@@ -139,12 +151,17 @@ Licensed under the [MIT License][license]
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
 [release-notes]: https://github.com/thevickypedia/VaultAPI/blob/master/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment
+[gha_docker]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml
+[gha_docker_desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml
 [gha_pypi]: https://github.com/thevickypedia/VaultAPI/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
+[docker]: https://hub.docker.com/r/thevickypedia/vaultapi
+[docker-doc]: https://docs.docker.com/
 [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[image-size]: https://img.shields.io/docker/image-size/thevickypedia/vaultapi/latest
 [pypi]: https://pypi.org/project/VaultAPI
 [pypi-files]: https://pypi.org/project/VaultAPI/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

diff --git a/docs/README.html b/docs/README.html
@@ -48,11 +48,14 @@ <h1>VaultAPI<a class="headerlink" href="#vaultapi" title="Permalink to this head
 <p>Lightweight API to store/retrieve secrets to/from an encrypted Database</p>
 <p><img alt="Python" src="https://img.shields.io/badge/python-3.10%20%7C%203.11-blue" /></p>
 <p><strong>Platform Supported</strong></p>
-<p><img alt="Platform" src="https://img.shields.io/badge/Platform-Linux%7CmacOS%7CWindows-1f425f.svg" /></p>
+<p><img alt="Platform" src="https://img.shields.io/badge/Platform-Linux%7CmacOS%7CWindows-1f425f.svg" />
+<img alt="docker-image" src="https://img.shields.io/docker/image-size/thevickypedia/vaultapi/latest" /></p>
 <p><strong>Deployments</strong></p>
-<p><a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment"><img alt="pages" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
+<p><a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml"><img alt="docker" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml/badge.svg" /></a>
 <a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/python-publish.yaml"><img alt="pypi" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/python-publish.yaml/badge.svg" /></a>
-<a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml"><img alt="markdown" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml/badge.svg" /></a></p>
+<a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml"><img alt="docker_desc" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml/badge.svg" /></a></p>
+<p><a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml"><img alt="markdown" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment"><img alt="pages" src="https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment/badge.svg" /></a></p>
 <p><a class="reference external" href="https://pypi.org/project/VaultAPI"><img alt="Pypi" src="https://img.shields.io/pypi/v/VaultAPI" /></a>
 <a class="reference external" href="https://pypi.org/project/VaultAPI/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/VaultAPI" /></a>
 <a class="reference external" href="https://pypi.org/project/VaultAPI"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/VaultAPI" /></a></p>
@@ -144,6 +147,11 @@ <h2>Pypi Package<a class="headerlink" href="#pypi-package" title="Permalink to t
 <p><a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/"><img alt="pypi-module" src="https://img.shields.io/badge/Pypi%20Package-VaultAPI-blue?style=for-the-badge&amp;logo=Python" /></a></p>
 <p><a class="reference external" href="https://pypi.org/project/VaultAPI">https://pypi.org/project/VaultAPI/</a></p>
 </section>
+<section id="docker-image">
+<h2>Docker Image<a class="headerlink" href="#docker-image" title="Permalink to this heading">¶</a></h2>
+<p><a class="reference external" href="https://docs.docker.com/"><img alt="made-with-docker-doc" src="https://img.shields.io/badge/Made%20with-Docker-blue?style=for-the-badge&amp;logo=Docker" /></a></p>
+<p><a class="reference external" href="https://hub.docker.com/r/thevickypedia/vaultapi">https://hub.docker.com/r/thevickypedia/vaultapi</a></p>
+</section>
 <section id="runbook">
 <h2>Runbook<a class="headerlink" href="#runbook" title="Permalink to this heading">¶</a></h2>
 <p><a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html"><img alt="made-with-sphinx-doc" src="https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&amp;logo=Sphinx" /></a></p>
@@ -173,6 +181,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#release-notes">Release Notes</a></li>
 <li><a class="reference internal" href="#linting">Linting</a></li>
 <li><a class="reference internal" href="#pypi-package">Pypi Package</a></li>
+<li><a class="reference internal" href="#docker-image">Docker Image</a></li>
 <li><a class="reference internal" href="#runbook">Runbook</a></li>
 <li><a class="reference internal" href="#license-copyright">License &amp; copyright</a></li>
 </ul>

diff --git a/docs/README.md b/docs/README.md
@@ -6,12 +6,16 @@ Lightweight API to store/retrieve secrets to/from an encrypted Database
 **Platform Supported**
 
 ![Platform][label-platform]
+![docker-image][image-size]
 
 **Deployments**
 
-[![pages][label-actions-pages]][gha_pages]
+[![docker][label-docker-build]][gha_docker]
 [![pypi][label-actions-pypi]][gha_pypi]
+[![docker_desc][label-docker-desc]][gha_docker_desc]
+
 [![markdown][label-actions-markdown]][gha_md_valid]
+[![pages][label-actions-pages]][gha_pages]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -112,6 +116,11 @@ pre-commit run --all-files
 
 [https://pypi.org/project/VaultAPI/][pypi]
 
+## Docker Image
+[![made-with-docker-doc][label-docker-doc]][docker-doc]
+
+[https://hub.docker.com/r/thevickypedia/vaultapi][docker]
+
 ## Runbook
 [![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
 
@@ -124,8 +133,11 @@ pre-commit run --all-files
 Licensed under the [MIT License][license]
 
 [label-actions-markdown]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml/badge.svg
+[label-docker-build]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml/badge.svg
+[label-docker-desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml/badge.svg
 [label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-VaultAPI-blue?style=for-the-badge&logo=Python
 [label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[label-docker-doc]: https://img.shields.io/badge/Made%20with-Docker-blue?style=for-the-badge&logo=Docker
 [label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
 [label-actions-pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment/badge.svg
@@ -139,12 +151,17 @@ Licensed under the [MIT License][license]
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
 [release-notes]: https://github.com/thevickypedia/VaultAPI/blob/master/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment
+[gha_docker]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml
+[gha_docker_desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml
 [gha_pypi]: https://github.com/thevickypedia/VaultAPI/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
+[docker]: https://hub.docker.com/r/thevickypedia/vaultapi
+[docker-doc]: https://docs.docker.com/
 [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[image-size]: https://img.shields.io/docker/image-size/thevickypedia/vaultapi/latest
 [pypi]: https://pypi.org/project/VaultAPI
 [pypi-files]: https://pypi.org/project/VaultAPI/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -6,12 +6,16 @@ Lightweight API to store/retrieve secrets to/from an encrypted Database
 **Platform Supported**
 
 ![Platform][label-platform]
+![docker-image][image-size]
 
 **Deployments**
 
-[![pages][label-actions-pages]][gha_pages]
+[![docker][label-docker-build]][gha_docker]
 [![pypi][label-actions-pypi]][gha_pypi]
+[![docker_desc][label-docker-desc]][gha_docker_desc]
+
 [![markdown][label-actions-markdown]][gha_md_valid]
+[![pages][label-actions-pages]][gha_pages]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -112,6 +116,11 @@ pre-commit run --all-files
 
 [https://pypi.org/project/VaultAPI/][pypi]
 
+## Docker Image
+[![made-with-docker-doc][label-docker-doc]][docker-doc]
+
+[https://hub.docker.com/r/thevickypedia/vaultapi][docker]
+
 ## Runbook
 [![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
 
@@ -124,8 +133,11 @@ pre-commit run --all-files
 Licensed under the [MIT License][license]
 
 [label-actions-markdown]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml/badge.svg
+[label-docker-build]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml/badge.svg
+[label-docker-desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml/badge.svg
 [label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-VaultAPI-blue?style=for-the-badge&logo=Python
 [label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[label-docker-doc]: https://img.shields.io/badge/Made%20with-Docker-blue?style=for-the-badge&logo=Docker
 [label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
 [label-actions-pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment/badge.svg
@@ -139,12 +151,17 @@ Licensed under the [MIT License][license]
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
 [release-notes]: https://github.com/thevickypedia/VaultAPI/blob/master/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/VaultAPI/actions/workflows/pages/pages-build-deployment
+[gha_docker]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-publish.yaml
+[gha_docker_desc]: https://github.com/thevickypedia/VaultAPI/actions/workflows/docker-description.yaml
 [gha_pypi]: https://github.com/thevickypedia/VaultAPI/actions/workflows/python-publish.yaml
 [gha_md_valid]: https://github.com/thevickypedia/VaultAPI/actions/workflows/markdown.yaml
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
+[docker]: https://hub.docker.com/r/thevickypedia/vaultapi
+[docker-doc]: https://docs.docker.com/
 [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
+[image-size]: https://img.shields.io/docker/image-size/thevickypedia/vaultapi/latest
 [pypi]: https://pypi.org/project/VaultAPI
 [pypi-files]: https://pypi.org/project/VaultAPI/#files
 [pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -73,16 +73,18 @@ <h2 id="_">_</h2>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#vaultapi.models.EnvConfig.allowed_ip_range">allowed_ip_range (vaultapi.models.EnvConfig attribute)</a>
+</li>
       <li><a href="index.html#vaultapi.models.EnvConfig.allowed_origins">allowed_origins (vaultapi.models.EnvConfig attribute)</a>
 
       <ul>
         <li><a href="index.html#vaultapi.models.Session.allowed_origins">(vaultapi.models.Session attribute)</a>
 </li>
       </ul></li>
-      <li><a href="index.html#vaultapi.models.EnvConfig.apikey">apikey (vaultapi.models.EnvConfig attribute)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#vaultapi.models.EnvConfig.apikey">apikey (vaultapi.models.EnvConfig attribute)</a>
+</li>
       <li><a href="index.html#vaultapi.exceptions.APIResponse">APIResponse</a>
 </li>
       <li><a href="index.html#vaultapi.models.EnvConfig.Config.arbitrary_types_allowed">arbitrary_types_allowed (vaultapi.models.EnvConfig.Config attribute)</a>
@@ -278,16 +280,18 @@ <h2 id="M">M</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#vaultapi.models.EnvConfig.parse_allowed_ip_range">parse_allowed_ip_range() (vaultapi.models.EnvConfig class method)</a>
+</li>
       <li><a href="index.html#vaultapi.models.EnvConfig.parse_allowed_origins">parse_allowed_origins() (vaultapi.models.EnvConfig class method)</a>
 </li>
       <li><a href="index.html#vaultapi.models.EnvConfig.parse_api_secret">parse_api_secret() (vaultapi.models.EnvConfig class method)</a>
 </li>
       <li><a href="index.html#vaultapi.models.EnvConfig.parse_apikey">parse_apikey() (vaultapi.models.EnvConfig class method)</a>
-</li>
-      <li><a href="index.html#vaultapi.models.EnvConfig.port">port (vaultapi.models.EnvConfig attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#vaultapi.models.EnvConfig.port">port (vaultapi.models.EnvConfig attribute)</a>
+</li>
       <li><a href="index.html#vaultapi.database.put_secret">put_secret() (in module vaultapi.database)</a>
 
       <ul>