diff --git a/deployability/modules/allocation/README.MD b/deployability/modules/allocation/README.MD index 28b15b513c..8444c1b602 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. +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: ```bash @@ -33,6 +35,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/provision/README.MD b/deployability/modules/provision/README.MD index d32e422f91..11049eeafe 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. +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: ```bash diff --git a/deployability/modules/testing/README.MD b/deployability/modules/testing/README.MD index 682798e2f0..f2b625e3f4 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. +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: ```bash @@ -55,9 +57,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. diff --git a/deployability/modules/workflow_engine/README.MD b/deployability/modules/workflow_engine/README.MD index 95e6a0db5d..c4430d97a4 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. +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: ```bash