Jesus Garcia
f04ed6e608
--- - All relevant content of README.md files was migrated to docs/ section in their respective section. - These README files has been deleted (4 files) - All README.md files (additional to the project's root and docs/) have been edited. --- - Both files build-docker-images/README.md and docs/dev/build-image.md have almost same content, so it was discarded the README file - As the directory and docker image are going to be disused, the certs-gen documentation contents of indexer-certs-creator/README.md was not mig> - The 'bash' command added to the docs/dev/build-image.md was removed - Added workflow usage docs file to the the SUMMARY.md file --- - Removed '$' parameter and added 'bash' to all markdown code blocks headings (```) ---
2.9 KiB
Reference Manual - Deployment
This section provides detailed instructions for deploying Wazuh-Docker (version 5.0.0) in various configurations. Choose the deployment model that best suits your needs, from simple single-node setups for testing to more robust multi-node configurations for production environments.
Overview of Deployment Options
Wazuh-Docker offers flexibility in how you can deploy the Wazuh stack. The primary methods covered in this documentation are:
-
- Description: Deploys all core Wazuh components (Wazuh manager, Wazuh indexer, Wazuh dashboard) as Docker containers on a single host machine.
- Use Cases: Ideal for development, testing, demonstrations, proof-of-concepts, and small-scale production environments where simplicity is prioritized and high availability is not a critical concern.
- Pros: Easiest and quickest to set up.
- Cons: Single point of failure; limited scalability compared to multi-node.
-
- Description: This typically refers to deploying a Wazuh Indexer cluster and potentially multiple Wazuh managers for improved scalability and resilience. While true multi-host orchestration often uses tools like Kubernetes, this section may cover configurations achievable with Docker Compose, possibly across multiple Docker hosts or with clustered services on a single powerful host.
- Use Cases: Production environments requiring higher availability, data redundancy (for Wazuh Indexer), and the ability to handle a larger number of agents.
- Pros: Improved fault tolerance (for clustered components like the Indexer), better performance distribution.
- Cons: More complex to set up and manage than a single-node deployment.
Before You Begin Deployment
Ensure you have:
- Met all the System Requirements.
- Installed Docker and Docker Compose on your host(s).
- Cloned the
wazuh-dockerrepository (version5.0.0) or downloaded the necessary deployment files.git clone https://github.com/wazuh/wazuh-docker.git cd wazuh-docker git checkout v5.0.0 - Made a backup of any existing Wazuh data if you are migrating or upgrading.
Choosing the Right Deployment
Consider the following factors when choosing a deployment model:
- Scale: How many agents do you plan to connect?
- Availability: What are your uptime requirements?
- Resources: What hardware resources (CPU, RAM, disk) are available?
- Complexity: What is your team's familiarity with Docker and distributed systems?
For most new users, starting with the Single Node Wazuh Stack is recommended to familiarize themselves with Wazuh-Docker. You can then explore more complex setups as your needs grow.
Navigate to the specific deployment guide linked above for detailed, step-by-step instructions.