Skip to content
Snippets Groups Projects
Unverified Commit b874102c authored by Max Adamo's avatar Max Adamo
Browse files

update README files for accuracy and add new DEB package

parent d90defb1
No related branches found
No related tags found
No related merge requests found
......@@ -4,21 +4,12 @@
## Install the package
A virtual environment is not necessary for this application.
A virtual environment is not needed for this application.
### dependencies
`py-consul` is a fork of `python-consul` and is only available as PIP package.
DEB users can install these package:
* [python3-py-consul_1.2.4-1_all.deb](https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-py-consul_1.2.4-1_all.deb)
* optionally, if you are on Ubuntu Focal this package is newer [python3-hvac_0.11.2-1_all.deb](https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-hvac_0.11.2-1_all.deb)
RPM users _(**untested**)_ can install these packages:
* [py-consul-1.2.4-1.noarch.rpm](https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-py-consul_1.2.4-1_all.deb)
* [hvac-0.11.2-1.noarch.rpm](https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/hvac-0.11.2-1.noarch.rpm)
* [py-consul](https://pypi.org/project/py-consul/) is a fork of `python-consul` and is available only as PIP package.
* [hvac-0.11.2-1.noarch.rpm](https://pkgs.org/download/python3-hvac)
### packages
......@@ -33,6 +24,10 @@ packages/
### developer's notes
#### version number
the version number is defined inside `./wile_coyote/__init__.py`
#### install script
`test-acme01` can be used to build the package
......@@ -51,15 +46,13 @@ Usage: create-packages.sh
-r | --rpm Build RPM package
-w | --whl Build Wheel package
-a | --all Build All packages
--push-deb Push DEB package
```
#### version number
the version number is defined inside `./wile_coyote/__init__.py`
### read keys recursively from Vault
#### read keys recursively from Vault
Consul and Redis support recursive listing of all the keys. For Vault we rely on [rvault](https://github.com/kir4h/rvault)
Consul and Redis support recursive listing of all the keys.
For Vault we rely on [rvault](https://github.com/kir4h/rvault)
#### create README.rst
......
A tool to manage certificates lifecycle on Vault, Redis, Consul
===============================================================
.. figure:: https://filesender.geant.org/images/wile_coyote.jpg
:alt: Wile coyote
.. figure:: https://cds.geant.org/images/wile_coyote.jpg
:alt: Wile Coyote
Wile Coyote
Install the package
-------------------
A virtual environment is not needed for this application.
dependencies
~~~~~~~~~~~~
``py-consul`` is a fork of ``python-consul`` and is only available as
PIP package.
DEB users need to install:
- `python3-py-consul_1.2.4-1_all.deb <https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-py-consul_1.2.4-1_all.deb>`__
- optionally, this is newer for Ubuntu Focal
`python3-hvac_0.11.2-1_all.deb <https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-hvac_0.11.2-1_all.deb>`__
RPM users on CentOS 7 *(*\ **untested**\ *)* need to install:
- `py-consul-1.2.4-1.noarch.rpm <https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/python3-py-consul_1.2.4-1_all.deb>`__
- `hvac-0.11.2-1.noarch.rpm <https://gitlab.geant.org/geant-devops/wile_coyote/-/blob/main/packages/deb/hvac-0.11.2-1.noarch.rpm>`__
- `py-consul <https://pypi.org/project/py-consul/>`__ is a fork of
``python-consul`` and is available only as PIP package.
- `hvac-0.11.2-1.noarch.rpm <https://pkgs.org/download/python3-hvac>`__
packages
~~~~~~~~
......@@ -42,9 +34,16 @@ directories:
developer’s notes
~~~~~~~~~~~~~~~~~
version number
^^^^^^^^^^^^^^
the version number is defined inside ``./wile_coyote/__init__.py``
install script
^^^^^^^^^^^^^^
``test-acme01`` can be used to build the package
.. code:: shell
./create-packages.sh --help
......@@ -60,17 +59,13 @@ install script
-r | --rpm Build RPM package
-w | --whl Build Wheel package
-a | --all Build All packages
version number
^^^^^^^^^^^^^^
the version number is defined inside ``./wile_coyote/__init__.py``
--push-deb Push DEB package
read keys recursively from Vault
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Consul and Redis support recursive listing of all the keys. For Vault we
rely on `rvault <https://github.com/kir4h/rvault>`__
| Consul and Redis support recursive listing of all the keys.
| For Vault we rely on `rvault <https://github.com/kir4h/rvault>`__
create README.rst
^^^^^^^^^^^^^^^^^
......
File added
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment