Skip to content

Commit

Permalink
fix(#4851): Fixing paths in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pro-akim committed Feb 19, 2024
1 parent f90331b commit 30668d8
Showing 1 changed file with 29 additions and 15 deletions.
44 changes: 29 additions & 15 deletions deployability/modules/provision/README.MD
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
## Provision module

### User documentation
### User documentation

The execution of the Provision is done through the installation of the library Worfklow library or launching the module using python command. The execution can be done from any operating system.

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.


1. Activate the environment:

```bash
Expand All @@ -25,7 +26,7 @@ Initially, Python libraries must be installed. It is recommended to use virtual
3. Install requirements:

```bash
pip3 install -r /deployability/deps/requirements.txt
pip3 install -r deployability/deps/requirements.txt
```

Now, it is possible to use worklow engine library to launch provision module doing the following steps:
Expand Down Expand Up @@ -53,9 +54,6 @@ Now, it is possible to use worklow engine library to launch provision module doi
variables:
agents-os:
- linux-ubuntu-22.04-amd64
- windows-11-amd64
- macos-ventura-13.04-amd64
- linux-centos-7-arm64
manager-os: linux-ubuntu-22.04-amd64
infra-provider: vagrant
working-dir: /tmp/dtt1-poc
Expand All @@ -69,9 +67,9 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- testing/main.py
- modules/testing/main.py
- inventory: "{working-dir}/agent-{agent}/inventory.yaml"
- dependencies:
- dependencies:
- manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
- agent: "{working-dir}/agent-{agent}/inventory.yaml"
- tests: "install,register,stop"
Expand All @@ -93,7 +91,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- testing/main.py
- modules/testing/main.py
- inventory: "{working-dir}/agent-{agent}/inventory.yaml"
- dependencies:
- manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
Expand All @@ -108,6 +106,22 @@ Now, it is possible to use worklow engine library to launch provision module doi
- variable: agents-os
as: agent

# Unique manager provision task
- task: "provision-manager"
description: "Provision the manager."
do:
this: process
with:
path: python3
args:
- modules/provision/main.py
- inventory-manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
- install:
- component: wazuh-manager
type: package
depends-on:
- "allocate-manager"

# Unique manager allocate task
- task: "allocate-manager"
description: "Allocate resources for the manager."
Expand All @@ -116,7 +130,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- allocation/main.py
- modules/allocation/main.py
- action: create
- provider: "{infra-provider}"
- size: large
Expand All @@ -128,7 +142,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- allocation/main.py
- modules/allocation/main.py
- action: delete
- track-output: "{working-dir}/manager-{manager-os}/track.yaml"

Expand All @@ -140,7 +154,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- provision/main.py
- modules/provision/main.py
- inventory-agent: "{working-dir}/agent-{agent}/inventory.yaml"
- inventory-manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
- install:
Expand All @@ -162,7 +176,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- provision/main.py
- modules/provision/main.py
- inventory-agent: "{working-dir}/agent-{agent}/inventory.yaml"
- inventory-manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
- uninstall:
Expand All @@ -182,7 +196,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- allocation/main.py
- modules/allocation/main.py
- action: create
- provider: "{infra-provider}"
- size: small
Expand All @@ -194,7 +208,7 @@ Now, it is possible to use worklow engine library to launch provision module doi
with:
path: python3
args:
- allocation.py
- modules/allocation/main.py
- action: delete
- track-output: "{working-dir}/agent-{agent}/track.yaml"
foreach:
Expand Down Expand Up @@ -273,7 +287,7 @@ In both cases, the following information is required:
with:
path: python3
args:
- provision.py
- modules/provision/main.py
- inventory-manager: "{working-dir}/manager-{manager-os}/inventory.yaml"
- install:
- component: wazuh-manager
Expand Down

0 comments on commit 30668d8

Please sign in to comment.