This issue aims to define what makes the new installation guide able to be published.
Teams involved
@wazuh/content: this team elaborates the guide, schema, pages hierarchy, etc. All redaction is on his own.
@wazuh/cicd: this team (specifically the installer team) must deliver the called Unattended installer. This installer allows the user to simplify the Wazuh deployment. All technical-related issues (installer development, resources placing on public URLs, automated testing, etc) must be done by his team.
Validation
@agusofa from @wazuh/content ensuring the Content team criteria.
@alberpilot from @wazuh/cicd ensuring the Installer team development and infrastructure criteria.
@havidarou, @jctello, and @orsifacundo from @wazuh/operations ensuring the usability and customer/users focus mindset.
Additionally, @santiago-bassett could provide feedback.
Installer team acceptance cirteria
- All-In-One deployment:
- [ ] The unattended installer must be able to install an AIO deployment (Wazuh manager + Opendistro for Elasticsearch + filebeat OSS + Opendistro for Kibana).
- [ ] After running the unattended installer the user must be able to connect Wazuh agents to the Wazuh manager and start seeing alerts on the Wazuh Kibana plugin.
- Distributed deployment:
- [ ] The unattended installer must be able to install only the Wazuh manager and filebeat OSS component.
- [ ] The unattended installer must be able to create the whole infrastructure certificates (all elasticsearch - filebeat - kibana communications), previously specification file given, no matter the host where the certificates are created.
- [ ] If the create certificate option is not activated, the unattended installer must stop
- Common (AIO & distributed)
- [ ] All action steps must be logged in the standard output. All steps must show the timestamp, message type (info, error, warning), and the step description. This output must be written in the log file too, located at `/var/log/wazuh-unattended-installation.log`
- [ ] If the debug flag is activated, all commands (commands and output) must be logged in standard output and debug file.
- [ ] A random password must be generated during the installation, avoiding the default one. This new random password must be shown in the installation process output.
- [ ] If a component installation fails, the installer must roll back the installation, cleaning all installed components and their folders. The rollback must be logged too.
- [ ] Every function invocation must manage the possible error and if it occurs, an exit with a rollback (if necessary). Example: importFunction "common.sh" could be importFunction "common.sh" || (logger -e "It was not possible to import common.sh library. Exiting" && exit 1)
- [ ] The unattended installer must not be running indefinitely. All necessary steps must be controlled by timeouts.
- [ ] The unattended installer must check if all needed resources are available (on-line and off-line) before starting installing/configuring actions.
This issue aims to define what makes the new installation guide able to be published.
Teams involved
Validation
Content team tasks:
Content team acceptance cirteria
Documentation testing
Information structure
Editorial
Final checks
Installers team tasks
To-Do:
Tentative:
Installer team acceptance cirteria
- All-In-One deployment: - [ ] The unattended installer must be able to install an AIO deployment (Wazuh manager + Opendistro for Elasticsearch + filebeat OSS + Opendistro for Kibana). - [ ] After running the unattended installer the user must be able to connect Wazuh agents to the Wazuh manager and start seeing alerts on the Wazuh Kibana plugin. - Distributed deployment: - [ ] The unattended installer must be able to install only the Wazuh manager and filebeat OSS component. - [ ] The unattended installer must be able to create the whole infrastructure certificates (all elasticsearch - filebeat - kibana communications), previously specification file given, no matter the host where the certificates are created. - [ ] If the create certificate option is not activated, the unattended installer must stop - Common (AIO & distributed) - [ ] All action steps must be logged in the standard output. All steps must show the timestamp, message type (info, error, warning), and the step description. This output must be written in the log file too, located at `/var/log/wazuh-unattended-installation.log` - [ ] If the debug flag is activated, all commands (commands and output) must be logged in standard output and debug file. - [ ] A random password must be generated during the installation, avoiding the default one. This new random password must be shown in the installation process output. - [ ] If a component installation fails, the installer must roll back the installation, cleaning all installed components and their folders. The rollback must be logged too. - [ ] Every function invocation must manage the possible error and if it occurs, an exit with a rollback (if necessary). Example: importFunction "common.sh" could be importFunction "common.sh" || (logger -e "It was not possible to import common.sh library. Exiting" && exit 1) - [ ] The unattended installer must not be running indefinitely. All necessary steps must be controlled by timeouts. - [ ] The unattended installer must check if all needed resources are available (on-line and off-line) before starting installing/configuring actions.