mirror of
https://github.com/wazuh/wazuh-indexer-plugins.git
synced 2025-12-10 14:32:28 -06:00
b601b9ec62
* Fix on push workflow and rename the workflows * Fix error with the new name * Add changelog entry and fix documentation
70 lines
2.5 KiB
Markdown
70 lines
2.5 KiB
Markdown
# How to generate a container image
|
|
|
|
This guide includes instructions to generate distribution packages locally using Docker.
|
|
|
|
Wazuh Indexer supports any of these combinations:
|
|
|
|
- distributions: `['tar', 'deb', 'rpm']`
|
|
- architectures: `['x64', 'arm64']`
|
|
|
|
Windows is currently not supported.
|
|
|
|
> For more information navigate to the [compatibility section](/ref/compatibility.html).
|
|
|
|
Before you get started, make sure to clean your environment by running `./gradlew clean` on the **root level** of the `wazuh-indexer` repository.
|
|
|
|
## Pre-requisites
|
|
|
|
The process to build packages requires Docker and Docker Compose.
|
|
|
|
- [Install Docker](https://docs.docker.com/engine/install/)
|
|
- [Install Docker Compose](https://docs.docker.com/compose/install/linux/)
|
|
|
|
Your workstation must meet the minimum hardware requirements (the more resources the better ☺):
|
|
|
|
- 8 GB of RAM (minimum)
|
|
- 4 cores
|
|
|
|
The tools and source code to generate a package of Wazuh Indexer are hosted in the [wazuh-indexer](https://github.com/wazuh/wazuh-indexer) repository, so clone it if you haven't done already.
|
|
|
|
## Building `wazuh-indexer` Docker images
|
|
|
|
The `wazuh-indexer/build-scripts/docker` folder contains the code to build Docker images. Below there is an example of the command needed to build the image. Set the build arguments and the image tag accordingly.
|
|
|
|
The Docker image is built from a wazuh-indexer tarball (tar.gz), which must be present in the same folder as the Dockerfile in `wazuh-indexer/build-scripts/docker`.
|
|
|
|
```bash
|
|
docker build \
|
|
--build-arg="VERSION=6.0.0" \
|
|
--build-arg="INDEXER_TAR_NAME=wazuh-indexer_6.0.0-0_linux-x64.tar.gz" \
|
|
--tag=wazuh-indexer:6.0.0-0 \
|
|
--progress=plain \
|
|
--no-cache .
|
|
```
|
|
|
|
Then, start a container with:
|
|
|
|
```bash
|
|
docker run -p 9200:9200 -it --rm wazuh-indexer:6.0.0-0
|
|
```
|
|
|
|
The `build-and-push-docker-image.sh` script automates the process to build and push Wazuh Indexer Docker images to our repository in quay.io. The script takes several parameters. Use the `-h` option to display them.
|
|
|
|
To push images, credentials must be set at environment level:
|
|
|
|
- QUAY_USERNAME
|
|
- QUAY_TOKEN
|
|
|
|
```bash
|
|
Usage: build-scripts/build-and-push-docker-image.sh [args]
|
|
|
|
Arguments:
|
|
-n NAME [required] Tarball name.
|
|
-r REVISION [Optional] Revision qualifier, default is 0.
|
|
-h help
|
|
```
|
|
|
|
The script will stop if the credentials are not set, or if any of the required parameters are not provided.
|
|
|
|
This script is used in the `6_builderpackage_docker.yml` **GitHub Workflow**, which is used to automate the process even more. When possible, **prefer this method**.
|