From ec3848451763d053b2f7b139f64c8f13dda65c60 Mon Sep 17 00:00:00 2001 From: Marcelo Ariel Hamra Date: Fri, 3 May 2024 14:46:09 -0300 Subject: [PATCH 1/3] List command dependencies on the README file --- deployability/modules/allocation/README.MD | 11 +++++++++++ deployability/modules/testing/README.MD | 9 ++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/deployability/modules/allocation/README.MD b/deployability/modules/allocation/README.MD index 28b15b513c..3ec69ba989 100644 --- a/deployability/modules/allocation/README.MD +++ b/deployability/modules/allocation/README.MD @@ -33,6 +33,17 @@ Initially, you have to install the required Python libraries. We recommend using pip3 install -r deployability/deps/requirements.txt ``` +4. The module may execute any of these commands: + + - ssh + - ssh-keygen + - sshpass + - cat + - vagrant + - chmod + + These commands must be available to run on the Host Operating System. + #### Use the Allocation module through the Workflow engine Now, it is possible to use the Worklow engine library to launch the provision module by doing the following steps: diff --git a/deployability/modules/testing/README.MD b/deployability/modules/testing/README.MD index 682798e2f0..df9aeb9ad2 100644 --- a/deployability/modules/testing/README.MD +++ b/deployability/modules/testing/README.MD @@ -55,9 +55,16 @@ Initially, Python libraries must be installed, we recommended the use of virtual pip3 uninstall -y workflow_engine && pip3 install . ``` +6. The module may execute any of these commands: + + - ssh + - scp + + These commands must be available to run on the Host Operating System. + Run the module by doing the following steps: -6. Test fixture to execute: +7. Test fixture to execute: It will be necessary to create a fixture (YAML file) where the infrastructure, provisioning, and tests to be executed will be declared. From 9b3b339556a9dbe96d89500674b49e25eccd1b49 Mon Sep 17 00:00:00 2001 From: Marcelo Ariel Hamra Date: Fri, 3 May 2024 14:53:57 -0300 Subject: [PATCH 2/3] Add the Python and pip version to all README fles --- deployability/modules/allocation/README.MD | 2 ++ deployability/modules/provision/README.MD | 2 ++ deployability/modules/testing/README.MD | 2 ++ deployability/modules/workflow_engine/README.MD | 2 ++ 4 files changed, 8 insertions(+) diff --git a/deployability/modules/allocation/README.MD b/deployability/modules/allocation/README.MD index 3ec69ba989..b30c182265 100644 --- a/deployability/modules/allocation/README.MD +++ b/deployability/modules/allocation/README.MD @@ -11,6 +11,8 @@ Execution can be done from any operating system. Initially, you have to install the required Python libraries. We recommend using virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. +The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. + 1. Activate the environment: ```bash diff --git a/deployability/modules/provision/README.MD b/deployability/modules/provision/README.MD index d32e422f91..387945bbc9 100644 --- a/deployability/modules/provision/README.MD +++ b/deployability/modules/provision/README.MD @@ -14,6 +14,8 @@ The execution of the workflow is done through the installation of its library. Initially, Python libraries must be installed. we recommended the use of virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. +The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. + 1. Create the python environment: ```bash diff --git a/deployability/modules/testing/README.MD b/deployability/modules/testing/README.MD index df9aeb9ad2..e5c38d79a8 100644 --- a/deployability/modules/testing/README.MD +++ b/deployability/modules/testing/README.MD @@ -17,6 +17,8 @@ The execution of the workflow is done through the installation of its library. Initially, Python libraries must be installed, we recommended the use of virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. +The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. + 1. Create the python environment: ```bash diff --git a/deployability/modules/workflow_engine/README.MD b/deployability/modules/workflow_engine/README.MD index 95e6a0db5d..085f38922a 100644 --- a/deployability/modules/workflow_engine/README.MD +++ b/deployability/modules/workflow_engine/README.MD @@ -6,6 +6,8 @@ The execution of the Workflow is done through the installation of its library. Initially, Python libraries must be installed. It is recommended to use virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. +The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. + 1. Activate the environment: ```bash From 0b6f86cf83d0293cb456d8a73bcce7765685c596 Mon Sep 17 00:00:00 2001 From: Marcelo Ariel Hamra Date: Fri, 3 May 2024 15:10:08 -0300 Subject: [PATCH 3/3] README improvements. --- deployability/modules/allocation/README.MD | 2 +- deployability/modules/provision/README.MD | 2 +- deployability/modules/testing/README.MD | 2 +- deployability/modules/workflow_engine/README.MD | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/deployability/modules/allocation/README.MD b/deployability/modules/allocation/README.MD index b30c182265..8444c1b602 100644 --- a/deployability/modules/allocation/README.MD +++ b/deployability/modules/allocation/README.MD @@ -11,7 +11,7 @@ Execution can be done from any operating system. Initially, you have to install the required Python libraries. We recommend using virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. -The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. +To use this module, you should use a Debian-based system, we recommend using Ubuntu 22.04 for full compatibility, you must have installed at least Python 3.10.12 and pip3 22.0.2 1. Activate the environment: diff --git a/deployability/modules/provision/README.MD b/deployability/modules/provision/README.MD index 387945bbc9..11049eeafe 100644 --- a/deployability/modules/provision/README.MD +++ b/deployability/modules/provision/README.MD @@ -14,7 +14,7 @@ The execution of the workflow is done through the installation of its library. Initially, Python libraries must be installed. we recommended the use of virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. -The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. +To use this module, you should use a Debian-based system, we recommend using Ubuntu 22.04 for full compatibility, you must have installed at least Python 3.10.12 and pip3 22.0.2 1. Create the python environment: diff --git a/deployability/modules/testing/README.MD b/deployability/modules/testing/README.MD index e5c38d79a8..f2b625e3f4 100644 --- a/deployability/modules/testing/README.MD +++ b/deployability/modules/testing/README.MD @@ -17,7 +17,7 @@ The execution of the workflow is done through the installation of its library. Initially, Python libraries must be installed, we recommended the use of virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. -The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. +To use this module, you should use a Debian-based system, we recommend using Ubuntu 22.04 for full compatibility, you must have installed at least Python 3.10.12 and pip3 22.0.2 1. Create the python environment: diff --git a/deployability/modules/workflow_engine/README.MD b/deployability/modules/workflow_engine/README.MD index 085f38922a..c4430d97a4 100644 --- a/deployability/modules/workflow_engine/README.MD +++ b/deployability/modules/workflow_engine/README.MD @@ -6,7 +6,7 @@ The execution of the Workflow is done through the installation of its library. Initially, Python libraries must be installed. It is recommended to use virtual environments. Follow the technical documentation at https://docs.python.org/3/library/venv.html. -The Python version to use is 3.10.13 with pip3 version 22.0.2 or higher. +To use this module, you should use a Debian-based system, we recommend using Ubuntu 22.04 for full compatibility, you must have installed at least Python 3.10.12 and pip3 22.0.2 1. Activate the environment: