Skip to content

Commit

Permalink
Improved --instance-name and label-issue documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidcr01 committed May 10, 2024
1 parent 851c3cd commit 6fe1ba0
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions deployability/modules/allocation/README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,22 @@ If one wishes to execute the allocaation module without installing the Workflow
- Local deployment (Vagrant)

```bash
python3 modules/allocation/main.py --action create --provider '{{ vagrant }}' --size '{{ large }}' --composite-name '{{ composite-name }}' --instance-name '{{ name }}' --inventory-output '{{ inventory }}' --track-output '{{ track }}'
python3 modules/allocation/main.py --action create --provider '{{ vagrant }}' --size '{{ large }}' --composite-name '{{ composite-name }}' --instance-name '{{ name }}' --inventory-output '{{ inventory }}' --track-output '{{ track }}'
```

>Note: In the case of Vagrant it is mandatory to specify either --instance-name or --label-issue parameters.

Example:
```bash
python3 modules/allocation/main.py --action create --provider vagrant --size large --composite-name linux-ubuntu-22.04-amd64 --instance-name "ubuntu_2204_amd_large" --inventory-output "/tmp/dtt1-poc/agent-linux-ubuntu-22.04-amd64/inventory.yaml" --track-output "/tmp/dtt1-poc/agent-linux-ubuntu-22.04-amd64/track.yaml"
```

Example 2:
```bash
python3 modules/allocation/main.py --action create --provider vagrant --size micro --composite-name linux-ubuntu-22.04-amd64 --label-issue "https://github.com/wazuh/internal-devel-requests/issues/1115" --inventory-output "/tmp/dtt1-poc/agent-linux-ubuntu-22.04-amd64/inventory.yaml" --track-output "/tmp/dtt1-poc/agent-linux-ubuntu-22.04-amd64/track.yaml"
```

- AWS deployment

```bash
Expand Down Expand Up @@ -283,7 +290,7 @@ If one wishes to execute the allocaation module without installing the Workflow
This argument allows us to define in which directory the files referring to the VM will be generated. By default, **/tmp/wazuh-qa**

- --label-issue
This argument is only used in the case of AWS and is not mandatory, it allows us to create a label to reference the created instance to an issue on GitHub. It has to be a GitHub URL of a Wazuh repository, for example: **https://github.com/wazuh/internal-devel-requests/issues/1008**
This argument is mandatory for the Vagrant deploy if the **--instance-name** is not specified. For AWS deploy, it is not mandatory. It allows to create a label to reference the created instance to an issue on GitHub. It has to be a GitHub URL of a Wazuh repository, for example: **https://github.com/wazuh/internal-devel-requests/issues/1008**

- --label-team
This argument it is mandatory for AWS deploy, allows you to set the team that owns the VM to be able to track it. The valid options are: **qa**, **core**, **framework**, **devops**, **frontend**, **operations**, **cloud**, **threat-intel**, **marketing**, **documentation**
Expand All @@ -292,7 +299,7 @@ If one wishes to execute the allocaation module without installing the Workflow
This argument it is mandatory for AWS deploy, allows you to define the date on which the machine can be deleted. The allowed values are **1d** (where the **1** refers to the number of days the machine is needed) or with the following format **"2024-03-20 21:00:00"**

- --instance-name
This argument allows us to define a custom name for the instance. It is compulsory for the Vagrant deploy. For the AWS deploy, if this argument is not used, the instance name is defined by other parameters entered, such as --label-issue or --composite-name.
This argument is mandatory for the Vagrant if the **--label-issue** is not specified. It allows us to define a custom name for the instance. In AWS deploy, if this argument is not used, the instance name is defined by other parameters entered, such as --label-issue or --composite-name.
---

### Technical documentation
Expand Down

0 comments on commit 6fe1ba0

Please sign in to comment.