Add reference documentation

2025-05-16 14:02:00 -03:00
parent f3a74ffff7
commit b120eff771
22 changed files with 522 additions and 41 deletions
@@ -1 +0,0 @@
-# Introduction.
@@ -1 +0,0 @@
-# Compatibility.
@@ -1 +1,45 @@
-# Description.
+# Reference Manual - Description
+
+This section provides a detailed description of Wazuh-docker (version 4.12.0), its components, and its architecture when deployed using Docker containers. Understanding these aspects is key to effectively deploying and managing your Wazuh environment.
+
+## What is Wazuh?
+
+Wazuh is a free, open-source, and enterprise-ready security monitoring solution for threat detection, integrity monitoring, incident response, and compliance. It consists of several key components that work together to provide comprehensive security visibility.
+
+## What is Wazuh-docker?
+
+Wazuh-docker is a project that provides Docker images and `docker compose` configurations to simplify the deployment and management of the Wazuh platform. By containerizing Wazuh components, Wazuh-docker offers:
+
+-   **Rapid Deployment**: Quickly set up a full Wazuh environment.
+-   **Consistency**: Ensures that Wazuh runs the same way across different environments.
+-   **Scalability**: Easier to scale components as needed (especially with orchestrators like Kubernetes, though this documentation primarily focuses on Docker Compose).
+-   **Isolation**: Components run in isolated containers, reducing conflicts.
+-   **Portability**: Run Wazuh on Linux system that supports Docker.
+
+## Core Components in Wazuh-Docker
+
+The Wazuh-Docker project typically provides images for the following core Wazuh components, adapted for version 4.12.0:
+
+1.  **Wazuh Manager**:
+    -   The central component that collects and analyzes data from deployed Wazuh agents.
+    -   It performs log analysis, file integrity checking, rootkit detection, real-time alerting, and active response.
+    -   In a Docker deployment, the Wazuh manager runs in its own container. It exposes ports for agent communication and API access.
+
+2.  **Wazuh Indexer**:
+    -   A highly scalable, full-text search and analytics engine.
+    -   Based on OpenSearch (or historically Elasticsearch), it stores and indexes alerts and monitoring data generated by the Wazuh manager.
+    -   The Wazuh indexer container provides the data persistence layer for Wazuh alerts and events. For version 4.12.0, this is typically an OpenSearch-based component.
+
+3.  **Wazuh Dashboard**:
+    -   A flexible visualization tool based on OpenSearch Dashboards (or historically Kibana).
+    -   It provides a web interface for querying, visualizing, and analyzing Wazuh data stored in the Wazuh indexer.
+    -   Users can explore security events, manage agent configurations (via the Wazuh plugin), and generate reports.
+
+## Key Features of Wazuh-Docker Deployments
+
+-   **Docker Compose**: Most deployments are orchestrated using `docker-compose.yml` files, which define the services, networks, volumes, and configurations for the Wazuh stack.
+-   **Persistent Data**: Docker volumes are used to persist critical data, such as Wazuh manager configurations, agent keys, Wazuh indexer data, and Wazuh dashboard settings, even if containers are stopped or recreated.
+-   **Networking**: Docker networks are configured to allow communication between the Wazuh components.
+-   **Environment Variables**: Configuration of containers is often managed through environment variables passed at runtime.
+
+Understanding this architecture and the role of each component is fundamental for successful deployment, troubleshooting, and scaling of your Wazuh environment using Wazuh-Docker.
@@ -0,0 +1,47 @@
+# Reference Manual - Introduction
+
+Welcome to the Reference Manual for Wazuh-Docker, version 4.12.0. This manual provides comprehensive information about deploying, configuring, and managing your Wazuh environment using Docker.
+
+## Purpose of This Manual
+
+This Reference Manual is designed to be your go-to resource for understanding the intricacies of Wazuh-Docker. It aims to cover:
+
+-   The core concepts and architecture of Wazuh when deployed with Docker.
+-   Step-by-step guidance for getting started, from requirements to various deployment scenarios.
+-   Detailed explanations of configuration options, including environment variables and persistent data management.
+-   Procedures for common operational tasks like upgrading your deployment.
+-   A glossary of terms to help you understand Wazuh and Docker-specific terminology.
+
+## Who Should Use This Manual?
+
+This manual is intended for:
+
+-   **System Administrators** responsible for deploying and maintaining Wazuh.
+-   **Security Analysts** who use Wazuh and need to understand its Dockerized deployment.
+-   **DevOps Engineers** integrating Wazuh into their CI/CD pipelines or containerized infrastructure.
+-   Anyone seeking detailed technical information about Wazuh-Docker.
+
+## How This Manual is Organized
+
+This manual is structured to help you find information efficiently:
+
+-   **[Description](description.md)**: Provides a detailed overview of Wazuh-Docker, its components, and how they work together in a containerized setup.
+-   **[Getting Started](getting-started/getting-started.md)**: Guides you through the initial setup, from prerequisites to deploying your first Wazuh stack.
+    -   **[Requirements](getting-started/requirements.md)**: Lists the necessary hardware and software.
+    -   **[Deployment](getting-started/deployment/README.md)**: Offers instructions for different deployment models:
+        -   [Single Node Wazuh Stack](getting-started/deployment/single-node.md)
+        -   [Multi Node Wazuh Stack](getting-started/deployment/multi-node.md)
+        -   [Wazuh Agent](getting-started/deployment/wazuh-agent.md)
+-   **[Configuration](configuration/configuration.md)**: Explains how to customize your Wazuh-Docker deployment.
+    -   [Environment Variables](configuration/environment-variables.md)
+    -   [Configuration Files](configuration/configuration-files.md)
+-   **[Upgrade](upgrade.md)**: Provides instructions for upgrading your Wazuh-Docker deployment to a newer version.
+-   **[Glossary](glossary.md)**: Defines key terms and concepts.
+
+## Using This Manual
+
+-   If you are new to Wazuh-docker, we recommend starting with the [Description](description.md) and then proceeding to the [Getting Started](getting-started/getting-started.md) section.
+-   If you need to customize your deployment, refer to the [Configuration](configuration/configuration.md) section.
+-   For specific terms or concepts, consult the [Glossary](glossary.md).
+
+This manual refers to version 4.12.0 of Wazuh-Docker. Ensure you are using the documentation that corresponds to your deployed version.