-
Notifications
You must be signed in to change notification settings - Fork 360
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve wazuh indexer package generation guide #7988
Draft
f-galland
wants to merge
2
commits into
master
Choose a base branch
from
enhancement/419-improve-wazuh-indexer-package-generation-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Improve wazuh indexer package generation guide #7988
f-galland
wants to merge
2
commits into
master
from
enhancement/419-improve-wazuh-indexer-package-generation-guide
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Based on the changes proposed on the PR wazuh/wazuh-indexer#560, the package generation guide could be updated with something like this .. Copyright (C) 2015, Wazuh, Inc.
.. meta::
:description: Wazuh provides an automated way of building packages for the Wazuh components. Learn how to build your own Wazuh indexer package in this section of our documentation.
=============
Wazuh indexer
=============
Local packages generation
#########################
While official ``Wazuh Indexer`` packages are generated in a GitHub Actions pipeline, packages can also be compiled using a docker container.
.. contents:: Table of contents:
:depth: 2
:local:
.. raw:: html
<div class="accordion-section open">
Pre-requisistes
===============
1. Clone the ``Wazuh Indexer`` GitHub repository and switch to the ``v|WAZUH_CURRENT|`` tag:
.. code:: console
git clone https://github.com/wazuh/wazuh-indexer/
git checkout v|WAZUH_CURRENT|
2. Bring the docker environment up:
.. code:: console
cd wazuh-indexer/docker/builder
docker build -t wazuh-indexer-builder .
cd ../..
Build the wazuh-indexer package
=======================
A basic package including only the ``Wazuh Indexer`` engine without extra plugin is generated first.
1. Run the package build process:
.. code:: console
docker run --rm -v ./artifacts/dist:/home/indexer/artifacts wazuh-indexer-builder
Environment Variables
=====================
You can customize the build process by setting the following environment variables:
- ``INDEXER_BRANCH``: The branch to use for the Wazuh Indexer (default: ``master``).
- ``INDEXER_PLUGINS_BRANCH``: The branch to use for the Wazuh Indexer plugins (default: ``master``).
- ``INDEXER_REPORTING_BRANCH``: The branch to use for the Wazuh Indexer reporting (default: ``master``).
- ``REVISION``: The revision number for the build (default: ``0``).
- ``IS_STAGE``: Whether the build is a staging build (default: ``false``).
- ``DISTRIBUTION``: The distribution format for the package (default: ``tar``).
- ``ARCHITECTURE``: The architecture for the package (default: ``x64``).
Example usage with custom environment variables
.. code:: console
docker run --rm -e INDEXER_BRANCH="5.0.0" -e INDEXER_PLUGINS_BRANCH="5.0.0" -e INDEXER_REPORTING_BRANCH="5.0.0" -v ./artifacts/dist:/home/indexer/artifacts wazuh-indexer-builder |
7 tasks
7 tasks
AlexRuiz7
added
Documentation improvements
Documentation improvements
level/task
Task issue
type/enhancement
Enhancement issue
labels
Nov 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Documentation improvements
Documentation improvements
level/task
Task issue
type/enhancement
Enhancement issue
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR intends to make the Indexer's package generation guide more concise and easier to follow, by providing simple instructions and commands with a clearer format.
Checks
Docs building
Code formatting and web optimization
redirects.js
script if necessary (check this guide).Writing style
code
font for Bash commands, file names, REST paths, and code.