diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 37807166..823255e8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -17,13 +17,14 @@ - [Compatibility](ref/Introduction/compatibility.md) - [Getting Started](ref/getting-started/README.md) - [Requirements](ref/getting-started/requirements.md) - - [Installation](ref/getting-started/installation.md) + - [Deployment](ref/getting-started/deployment/README.md) + - [Single Node Wazuh Stack](ref/getting-started/deployment/single-node.md) + - [Multi Node Wazuh Stack](ref/getting-started/deployment/multi-node.md) + - [Wazuh Agent](ref/getting-started/deployment/wazuh-agent.md) - [Configuration](ref/configuration/README.md) - [CEnvironment Variabless](ref/configuration/environment-variables.md) - [Configuration files](ref/configuration/configuration-files.md) - [Upgrade](ref/upgrade.md) -- [Uninstall](ref/uninstall.md) - [Back Up and Restore](ref/backup-restore.md) - [Security](ref/security.md) -- [Performance](ref/performance.md) - [Glossary](ref/glossary.md) \ No newline at end of file diff --git a/docs/dev/build-image.md b/docs/dev/build-image.md index d04dc0dc..58a7c734 100644 --- a/docs/dev/build-image.md +++ b/docs/dev/build-image.md @@ -1 +1,32 @@ -# Build Image +# Wazuh Docker Image Builder + +The creation of the images for the Wazuh stack deployment in Docker is done with the build-images.yml script + +To execute the process, the following must be executed in the root of the wazuh-docker repository: + +``` +$ build-docker-images/build-images.sh +``` + +This script initializes the environment variables needed to build each of the images. + +The script allows you to build images from other versions of Wazuh, to do this you must use the -v or --version argument: + +``` +$ build-docker-images/build-images.sh -v 4.12.2 +``` + +To get all the available script options use the -h or --help option: + +``` +$ build-docker-images/build-images.sh -h + +Usage: build-docker-images/build-images.sh [OPTIONS] + + -d, --dev [Optional] Set the development stage you want to build, example rc1 or beta1, not used by default. + -f, --filebeat-module [Optional] Set Filebeat module version. By default 0.4. + -r, --revision [Optional] Package revision. By default 1 + -v, --version [Optional] Set the Wazuh version should be builded. By default, 4.12.2. + -h, --help Show this help. + +``` \ No newline at end of file diff --git a/docs/ref/getting-started/deployment/README.md b/docs/ref/getting-started/deployment/README.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/ref/getting-started/deployment/multi-node.md b/docs/ref/getting-started/deployment/multi-node.md new file mode 100644 index 00000000..32e7980e --- /dev/null +++ b/docs/ref/getting-started/deployment/multi-node.md @@ -0,0 +1,32 @@ +# Wazuh Docker deployment + +## Deploy Wazuh Docker in multi node configuration + +This deployment is defined in the `multi-node/docker-compose.yml` file with two Wazuh manager containers, three Wazuh indexer containers, and one Wazuh dashboard container. It can be deployed by following these steps: + +1) Enter the multi-node directory of the repository: +``` +$ cd multi-node +``` +2) Increase max_map_count on your host (Linux). This command must be run with root permissions: +``` +$ sysctl -w vm.max_map_count=262144 +``` +3) Run the certificate creation script: +``` +$ docker-compose -f generate-indexer-certs.yml run --rm generator +``` +4) Start the environment with docker-compose: + +- In the foregroud: +``` +$ docker-compose up +``` + +- In the background: +``` +$ docker-compose up -d +``` + + +The environment takes about 1 minute to get up (depending on your Docker host) for the first time since Wazuh Indexer must be started for the first time and the indexes and index patterns must be generated. \ No newline at end of file diff --git a/docs/ref/getting-started/deployment/single-node.md b/docs/ref/getting-started/deployment/single-node.md new file mode 100644 index 00000000..b34f58a3 --- /dev/null +++ b/docs/ref/getting-started/deployment/single-node.md @@ -0,0 +1,31 @@ +# Wazuh Docker deployment + +## Deploy Wazuh Docker in single node configuration + +This deployment is defined in the `single-node/docker-compose.yml` file with one Wazuh manager containers, one Wazuh indexer containers, and one Wazuh dashboard container. It can be deployed by following these steps: + +1) Enter the single-node directory of the repository: +``` +$ cd single-node +``` +2) Increase max_map_count on your host (Linux). This command must be run with root permissions: +``` +$ sysctl -w vm.max_map_count=262144 +``` +3) Run the certificate creation script: +``` +$ docker-compose -f generate-indexer-certs.yml run --rm generator +``` +4) Start the environment with docker-compose: + +- In the foregroud: +``` +$ docker-compose up +``` +- In the background: +``` +$ docker-compose up -d +``` + +The environment takes about 1 minute to get up (depending on your Docker host) for the first time since Wazuh Indexer must be started for the first time and the indexes and index patterns must be generated. + diff --git a/docs/ref/getting-started/deployment/wazuh-agent.md b/docs/ref/getting-started/deployment/wazuh-agent.md new file mode 100644 index 00000000..7ec70984 --- /dev/null +++ b/docs/ref/getting-started/deployment/wazuh-agent.md @@ -0,0 +1,24 @@ +# Wazuh Docker deployment + +## Deploy Wazuh agent + +1) Enter the `wazuh-agent` directory of the repository. +``` +$ cd wazuh-agent +``` +2) Edit the `docker-compose.yml` file, changing the current value of the `WAZUH_MANAGER_SERVER` variable to the IP or URL of the Wazuh manager: +``` + environment: + - WAZUH_MANAGER_SERVER= +``` +3) Start the environment with docker-compose: + +- In the foregroud: +``` +$ docker-compose up +``` + +- In the background: +``` +$ docker-compose up -d +``` \ No newline at end of file diff --git a/docs/ref/getting-started/installation.md b/docs/ref/getting-started/installation.md deleted file mode 100644 index 25267fe2..00000000 --- a/docs/ref/getting-started/installation.md +++ /dev/null @@ -1 +0,0 @@ -# Installation diff --git a/docs/ref/performance.md b/docs/ref/performance.md deleted file mode 100644 index 6babb314..00000000 --- a/docs/ref/performance.md +++ /dev/null @@ -1 +0,0 @@ -# Performance diff --git a/docs/ref/uninstall.md b/docs/ref/uninstall.md deleted file mode 100644 index 316df265..00000000 --- a/docs/ref/uninstall.md +++ /dev/null @@ -1 +0,0 @@ -# Uninstall