Skip to content

Commit

Permalink
Merge pull request #5338 from wazuh/enhancement/5323-update-command-l…
Browse files Browse the repository at this point in the history
…ist-on-readme

List command dependencies on the README file
  • Loading branch information
rauldpm authored May 3, 2024
2 parents 38d421c + 0b6f86c commit 8beaf29
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
13 changes: 13 additions & 0 deletions deployability/modules/allocation/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions deployability/modules/provision/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 10 additions & 1 deletion deployability/modules/testing/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions deployability/modules/workflow_engine/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8beaf29

Please sign in to comment.