From 28fe74b66517a5211dbac77718ec78b1d51d066e Mon Sep 17 00:00:00 2001 From: jarpat Date: Mon, 29 Jan 2024 13:42:16 -0500 Subject: [PATCH] update doc --- docs/user/Dependencies.md | 47 +++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/docs/user/Dependencies.md b/docs/user/Dependencies.md index 189624e..4e86936 100644 --- a/docs/user/Dependencies.md +++ b/docs/user/Dependencies.md @@ -1,33 +1,36 @@ # Dependency Versions -The following list details our dependencies and versions (~ indicates multiple possible sources): - -| SOURCE | NAME | VERSION | -|----------------|----------------------|-------------| -| ~ | python | >=3.10 | -| ~ | pip | >=22.0 | -| ~ | terraform | >=1.4.5 | -| ~ | docker | >=20.10.17 | -| ~ | helm | >=3 | -| ~ | kubectl | 1.26 - 1.28 | -| ~ | git | any | -| ~ | jq | >=1.6 | -| pip | ansible | 9.1.0 | -| pip | openshift | 0.13.1 | -| pip | kubernetes | 26.1.0 | -| pip | dnspython | 2.3.0 | -| pip | jmespath | 1.0.1 | -| ansible-galaxy | community.general | 5.6.0 | -| ansible-galaxy | community.postgresql | 2.2.0 | -| ansible-galaxy | kubernetes.core | 2.3.2 | -| ansible-galaxy | ansible.posix | 1.4.0 | -| ansible-galaxy | ansible.utils | 2.6.1 | +The following table details our dependencies and versions (~ indicates multiple possible sources) + +For dependency installation instructions and sources, links have been provided in the table below: + +| SOURCE | NAME | VERSION | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| ~ | [python](https://www.python.org/downloads/) | >=3.10 | +| ~ | [pip](https://packaging.python.org/en/latest/guides/installing-using-linux-tools/#installing-pip-setuptools-wheel-with-linux-package-managers) | >=22.0 | +| ~ | [terraform](https://www.terraform.io/downloads) | >=1.4.5 | +| ~ | [docker](https://docs.docker.com/engine/install/) | >=20.10.17 | +| ~ | [helm](https://helm.sh/docs/intro/install/) | >=3 | +| ~ | [kubectl](https://kubernetes.io/docs/tasks/tools/) | 1.26 - 1.28 | +| ~ | [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | any | +| ~ | [jq](https://jqlang.github.io/jq/download/) | >=1.6 | +| pip | ansible | 9.1.0 (ansible core v2.16.1) | +| pip | openshift | 0.13.1 | +| pip | kubernetes | 26.1.0 | +| pip | dnspython | 2.3.0 | +| pip | jmespath | 1.0.1 | +| ansible-galaxy | community.general | 5.6.0 | +| ansible-galaxy | community.postgresql | 2.2.0 | +| ansible-galaxy | kubernetes.core | 2.3.2 | +| ansible-galaxy | ansible.posix | 1.4.0 | +| ansible-galaxy | ansible.utils | 2.6.1 | Python dependencies can be installed via `pip` using the `requirements.txt` provided in this project ```bash pip install -r ./requirements.txt ``` + Ansible dependencies can be installed via `ansible-galaxy` using the `requirements.yaml` provided in this project. ```bash