mirror of
https://github.com/wazuh/wazuh-docker.git
synced 2025-11-01 04:23:43 +00:00
Add env vars, tests and upgrade doc
This commit is contained in:
vcerenu
@@ -1 +1,28 @@
|
||||
# Run Tests
|
||||
# Pull Request Test Execution
|
||||
|
||||
This repository includes automated tests designed to validate the correct deployment of Wazuh using Docker. These tests are executed on every pull request (PR) to ensure the integrity and stability of the system when changes are introduced.
|
||||
|
||||
## Purpose
|
||||
|
||||
The main objective of the tests is to verify that the Wazuh Docker environment can be successfully deployed and that all its core components (Wazuh Manager, Indexer, Dashboard, and Agents) operate as expected after any modification in the codebase.
|
||||
|
||||
## When Tests Run
|
||||
|
||||
- Tests are automatically triggered on every pull request (PR) opened against the repository.
|
||||
- They also run when changes are pushed to an existing PR.
|
||||
|
||||
## What Is Tested
|
||||
|
||||
The tests aim to ensure:
|
||||
- Successful build and startup of all Docker containers.
|
||||
- Proper communication between components (e.g., Manager ↔ Indexer, Dashboard ↔ API).
|
||||
- No critical errors appear in the logs.
|
||||
- Key services are healthy and accessible.
|
||||
|
||||
## Benefits
|
||||
|
||||
- Reduces the risk of breaking the deployment flow.
|
||||
- Ensures system consistency during feature development and refactoring.
|
||||
- Provides early feedback on integration issues before merging.
|
||||
|
||||
---
|
||||
|
||||
@@ -1 +1,116 @@
|
||||
# Environment Variabless
|
||||
# Environment Variables in Wazuh Docker Deployment
|
||||
|
||||
This document outlines the environment variables applicable to the Wazuh Docker deployment, covering the Wazuh Manager, Indexer, Dashboard, and Agent components. It also explains how to override configuration settings using environment variables.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Wazuh Manager](#wazuh-manager)
|
||||
- [Wazuh Indexer](#wazuh-indexer)
|
||||
- [Wazuh Dashboard](#wazuh-dashboard)
|
||||
- [Wazuh Agent](#wazuh-agent)
|
||||
- [Overriding Configuration Files with Environment Variables](#overriding-configuration-files-with-environment-variables)
|
||||
|
||||
---
|
||||
|
||||
## Wazuh Manager
|
||||
|
||||
The Wazuh Manager container accepts the following environment variables, which can be set in the `docker-compose.yml` file under the `environment` section:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- INDEXER_USERNAME=admin
|
||||
- INDEXER_PASSWORD=SecretPassword
|
||||
- WAZUH_API_URL=https://wazuh.manager
|
||||
- DASHBOARD_USERNAME=kibanaserver
|
||||
- DASHBOARD_PASSWORD=kibanaserver
|
||||
- API_USERNAME=wazuh-wui
|
||||
- API_PASSWORD=MyS3cr37P450r.*-
|
||||
```
|
||||
|
||||
**Variable Descriptions:**
|
||||
|
||||
- `INDEXER_USERNAME` / `INDEXER_PASSWORD`: Credentials for accessing the Wazuh Indexer with `admin` user or a user with the same permissions.
|
||||
- `WAZUH_API_URL`: URL of the Wazuh API, used by other services for communication.
|
||||
- `DASHBOARD_USERNAME` / `DASHBOARD_PASSWORD`: Credentials for the Wazuh Dashboard to authenticate with the Indexer.
|
||||
- `API_USERNAME` / `API_PASSWORD`: Credentials for the Wazuh API user, utilized by the Dashboard for API interactions.
|
||||
|
||||
---
|
||||
|
||||
## Wazuh Indexer
|
||||
|
||||
The Wazuh Indexer services (`single-node` and `multi-node`) use the following environment variable:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- "OPENSEARCH_JAVA_OPTS=-Xms1g -Xmx1g"
|
||||
```
|
||||
|
||||
**Variable Descriptions:**
|
||||
|
||||
- `OPENSEARCH_JAVA_OPTS`: Sets JVM heap size and other Java options.
|
||||
|
||||
---
|
||||
|
||||
## Wazuh Dashboard
|
||||
|
||||
The Wazuh Dashboard container accepts the following environment variables, which should be set in the `docker-compose.yml` file:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- INDEXER_USERNAME=admin
|
||||
- INDEXER_PASSWORD=SecretPassword
|
||||
- WAZUH_API_URL=https://wazuh.manager
|
||||
- DASHBOARD_USERNAME=kibanaserver
|
||||
- DASHBOARD_PASSWORD=kibanaserver
|
||||
- API_USERNAME=wazuh-wui
|
||||
- API_PASSWORD=MyS3cr37P450r.*-
|
||||
```
|
||||
|
||||
**Variable Descriptions:**
|
||||
|
||||
- `INDEXER_USERNAME` / `INDEXER_PASSWORD`: Credentials used by the Dashboard to authenticate with the Wazuh Indexer.
|
||||
- `WAZUH_API_URL`: Base URL of the Wazuh API, used for querying and visualizing security data.
|
||||
- `DASHBOARD_USERNAME` / `DASHBOARD_PASSWORD`: User credentials for the Dashboard interface.
|
||||
- `API_USERNAME` / `API_PASSWORD`: API user credentials for authenticating Wazuh API requests initiated by the Dashboard.
|
||||
|
||||
These variables are critical for enabling communication between the Wazuh Dashboard, the Wazuh Indexer, and the Wazuh API.
|
||||
|
||||
---
|
||||
|
||||
## Wazuh Agent
|
||||
|
||||
The Wazuh Agent container uses the following environment variables to dynamically update the `ossec.conf` configuration file at runtime:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- WAZUH_MANAGER_SERVER=wazuh.manager
|
||||
- WAZUH_MANAGER_PORT=1514
|
||||
- WAZUH_REGISTRATION_SERVER=wazuh.manager
|
||||
- WAZUH_REGISTRATION_PORT=1515
|
||||
- WAZUH_AGENT_NAME=my-agent
|
||||
- WAZUH_REGISTRATION_PASSWORD=StrongPassword
|
||||
```
|
||||
|
||||
These variables are used by the `set_manager_conn()` function in the entrypoint script to replace placeholder values in `ossec.conf` and set the enrollment password.
|
||||
|
||||
---
|
||||
|
||||
## Overriding Configuration Files with Environment Variables
|
||||
|
||||
To override configuration values from files such as `opensearch.yml` and `opensearch_dashboards.yml` using environment variables:
|
||||
|
||||
1. Convert the configuration key to uppercase.
|
||||
2. Replace any dots (`.`) in the key with underscores (`_`).
|
||||
3. Assign the corresponding value.
|
||||
|
||||
### Examples:
|
||||
|
||||
| YAML Key | Environment Variable |
|
||||
|-----------------------------------------|--------------------------------------------|
|
||||
| `discovery.type: single-node` | `DISCOVERY_TYPE=single-node` |
|
||||
| `opensearch.hosts: https://url:9200` | `OPENSEARCH_HOSTS=https://url:9200` |
|
||||
| `server.port: 5601` | `SERVER_PORT=5601` |
|
||||
|
||||
This approach allows you to configure the services dynamically via Docker without modifying internal files.
|
||||
|
||||
---
|
||||
|
||||
@@ -1 +1,10 @@
|
||||
# Upgrade
|
||||
# Upgrading Wazuh in Docker
|
||||
|
||||
To upgrade your Wazuh deployment when using Docker, we recommend following the official Wazuh documentation. It contains the most accurate and up-to-date information for upgrading from previous versions to the current one.
|
||||
|
||||
> 📘 Please refer to the official guide:
|
||||
> [Upgrading Wazuh Docker](https://documentation.wazuh.com/current/deployment-options/docker/upgrading-wazuh-docker.html)
|
||||
|
||||
This external guide provides detailed upgrade instructions that cover multiple scenarios and configurations.
|
||||
|
||||
Following the official documentation ensures a smoother and safer upgrade process, with fewer risks of data loss or configuration issues.
|
||||
|
||||
Reference in New Issue
Block a user