Skip to content

Commit 7735ac8

Browse files
authored
Merge pull request #8906 from wazuh/enhancement/idr335-replace-with-version-variables
Fix package generation version references
2 parents 9d5f3ca + b34a639 commit 7735ac8

File tree

4 files changed

+25
-24
lines changed

4 files changed

+25
-24
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ All notable changes to this project will be documented in this file.
2525
- Updated the *Deployment on Docker* section. ([#8688](https://github.com/wazuh/wazuh-documentation/pull/8688))
2626
- Updated default values for `agents_disconnection_time` and `notify_time`. ([#8769](https://github.com/wazuh/wazuh-documentation/pull/8769))
2727
- Updated the default value of the `all` attribute in the `ports` Syscollector configuration option. ([#8840](https://github.com/wazuh/wazuh-documentation/pull/8840))
28+
- Replaced version references with replacement variables in Wazuh package generation. ([#8906](https://github.com/wazuh/wazuh-documentation/pull/8906))
2829

2930
## [v4.12.0]
3031

source/development/packaging/generate-agent-package.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,11 @@ The process of successfully generating the Windows Microsoft Software Installer
220220
Compiling the Windows package
221221
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
222222

223-
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository from GitHub and navigate to the ``windows/`` directory. Select the version, ``v4.12.0``.
223+
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository from GitHub and navigate to the ``windows/`` directory. Select the version, ``v|WAZUH_CURRENT|``.
224224

225225
.. code-block:: console
226226
227-
$ git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v4.12.0 && cd windows
227+
$ git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v|WAZUH_CURRENT| && cd windows
228228
229229
#. Execute the ``generate_compiled_windows_agent.sh`` script. This script will build a Docker image with all the necessary tools to compile and obtain the Windows agent compiled in a ZIP file.
230230

@@ -346,11 +346,11 @@ Creating the agent package
346346

347347
Follow the steps below to create a Solaris package:
348348

349-
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository from GitHub and select the version, ``v4.12.0``.
349+
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository from GitHub and select the version, ``v|WAZUH_CURRENT|``.
350350

351351
.. code-block:: console
352352
353-
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v4.12.0
353+
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v|WAZUH_CURRENT|
354354
355355
#. Choose the version of Solaris you want to build the package for and go to that directory. Make the ``generate_wazuh_packages.sh`` script executable and run it to build the package. Here you can see all the different parameters:
356356

@@ -399,7 +399,7 @@ Follow the steps below to build a Solaris package.
399399

400400
.. code-block:: console
401401
402-
$ ./generate_wazuh_packages.sh -b v4.12.0
402+
$ ./generate_wazuh_packages.sh -b v|WAZUH_CURRENT|
403403
404404
.. note::
405405

@@ -429,37 +429,37 @@ Follow the steps described below to build the Solaris package corresponding to y
429429

430430
.. code-block:: console
431431
432-
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v4.12.0
432+
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v|WAZUH_CURRENT|
433433
# cd solaris && cp -r solaris10 package_generation/src/ && cd package_generation
434434
435435
#. Build the Solaris package using Vagrant:
436436

437437
.. code-block:: console
438438
439-
# vagrant --branch-tag=v4.12.0 up solaris10_cmake
439+
# vagrant --branch-tag=v|WAZUH_CURRENT| up solaris10_cmake
440440
441441
.. group-tab:: Solaris 11
442442

443443
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository and switch to your target branch. Copy the source files for your Solaris 11 into ``wazuh/packages/solaris/package_generation/src``, then change to the ``wazuh/packages/solaris/package_generation`` directory.
444444

445445
.. code-block:: console
446446
447-
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v4.12.0
447+
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v|WAZUH_CURRENT|
448448
# cd solaris && cp -r solaris11 package_generation/src/ && cd package_generation
449449
450450
#. Build the Solaris package using Vagrant:
451451

452452
.. code-block:: console
453453
454-
# vagrant --branch-tag=v4.12.0 up solaris11_cmake
454+
# vagrant --branch-tag=v|WAZUH_CURRENT| up solaris11_cmake
455455
456456
.. note::
457457

458458
You can generate both packages in a single command as follows:
459459

460460
.. code-block:: console
461461
462-
# vagrant --branch-tag=v4.12.0 up solaris10_cmake solaris11_cmake
462+
# vagrant --branch-tag=v|WAZUH_CURRENT| up solaris10_cmake solaris11_cmake
463463
464464
The generated packages are stored in the ``wazuh/packages/solaris/package_generation/src/`` directory.
465465

@@ -494,11 +494,11 @@ Ensure that you meet the following requirements to continue.
494494
Initial steps
495495
^^^^^^^^^^^^^
496496

497-
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository and navigate to the ``wpk/`` directory. Select the version, ``v4.12.0``.
497+
#. Clone the `wazuh <https://github.com/wazuh/wazuh>`__ repository and navigate to the ``wpk/`` directory. Select the version, ``v|WAZUH_CURRENT|``.
498498

499499
.. code-block:: console
500500
501-
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v4.12.0 && cd wpk
501+
# git clone https://github.com/wazuh/wazuh && cd wazuh/packages && git checkout v|WAZUH_CURRENT| && cd wpk
502502
503503
#. Execute the ``generate_wpk_package.sh`` script:
504504

@@ -541,17 +541,17 @@ The following steps demonstrate the build process for Debian ``amd64``, but you
541541

542542
.. code-block:: console
543543
544-
# curl -O https://packages.wazuh.com/4.x/apt/pool/main/w/wazuh-agent/wazuh-agent_4.12.0-1_amd64.deb
544+
# curl -O https://packages.wazuh.com/4.x/apt/pool/main/w/wazuh-agent/wazuh-agent_|WAZUH_CURRENT|-|WAZUH_REVISION_DEB_AGENT_X86|_amd64.deb
545545
546546
#. Run the ``generate_wpk_package.sh`` script to build the Linux WPK package:
547547

548548
.. code-block:: console
549549
550-
# ./generate_wpk_package.sh -t linux -b v4.12.0 -d /tmp/wpk -k <PATH_TO_KEYS> -o LinuxAgent.wpk -pn Wazuh-agent_4.12.0-1_amd64.deb
550+
# ./generate_wpk_package.sh -t linux -b v|WAZUH_CURRENT| -d /tmp/wpk -k <PATH_TO_KEYS> -o LinuxAgent.wpk -pn Wazuh-agent_|WAZUH_CURRENT|-|WAZUH_REVISION_DEB_AGENT_X86|_amd64.deb
551551
552552
Replace ``<PATH_TO_KEYS>`` with the full path to where the X509 certificate and root CA are stored.
553553

554-
This script builds a Wazuh 4.12.0 Linux WPK package named ``LinuxAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
554+
This script builds a Wazuh |WAZUH_CURRENT| Linux WPK package named ``LinuxAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
555555

556556
If you use the ``-c`` or ``--checksum`` option, a file containing the SHA512 checksum is created in the same output path. This location is configurable, allowing you to indicate where you want to store it.
557557

@@ -566,17 +566,17 @@ The following steps demonstrate the build process for an intel64 architecture, b
566566

567567
.. code-block:: console
568568
569-
# curl -O https://packages.wazuh.com/4.x/macos/wazuh-agent-4.12.0-1.intel64.pkg
569+
# curl -O https://packages.wazuh.com/4.x/macos/wazuh-agent-|WAZUH_CURRENT|-|WAZUH_REVISION_OSX|.intel64.pkg
570570
571571
#. Run the ``generate_wpk_package.sh`` script to build the macOS WPK package:
572572

573573
.. code-block:: console
574574
575-
# ./generate_wpk_package.sh -t macos -b v4.12.0 -d /tmp/wpk -k /PATH/TO/KEYS -o macOSAgent.wpk -pn wazuh-agent-4.12.0-1.intel64.pkg
575+
# ./generate_wpk_package.sh -t macos -b v|WAZUH_CURRENT| -d /tmp/wpk -k /PATH/TO/KEYS -o macOSAgent.wpk -pn wazuh-agent-|WAZUH_CURRENT|-|WAZUH_REVISION_OSX|.intel64.pkg
576576
577577
Replace ``/PATH/TO/KEYS`` with the full path to where the X509 certificate and root CA are stored.
578578

579-
This script builds a Wazuh 4.12.1 macOS WPK package named ``macOSAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
579+
This script builds a Wazuh |WAZUH_CURRENT| macOS WPK package named ``macOSAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
580580

581581
If the ``-c`` or ``--checksum`` option is used, a file is created containing the SHA512 checksum in the same output path. This location is configurable, and you can indicate where you want to store it.
582582

@@ -589,17 +589,17 @@ To build a WPK for Windows, you need to first download an MSI package of the des
589589

590590
.. code-block:: console
591591
592-
# curl -O https://packages.wazuh.com/4.x/windows/wazuh-agent-4.12.0-1.msi
592+
# curl -O https://packages.wazuh.com/4.x/windows/wazuh-agent-|WAZUH_CURRENT|-|WAZUH_REVISION_WINDOWS|.msi
593593
594594
#. Run the ``generate_wpk_package.sh`` script to build the Windows WPK package:
595595

596596
.. code-block:: console
597597
598-
# ./generate_wpk_package.sh -t windows -b v4.12.0 -d /tmp/wpk -k /<PATH_TO_KEYS> -o WindowsAgent.wpk -pn /tmp/wazuh-agent-4.12.0-1.msi
598+
# ./generate_wpk_package.sh -t windows -b v|WAZUH_CURRENT| -d /tmp/wpk -k /<PATH_TO_KEYS> -o WindowsAgent.wpk -pn /tmp/wazuh-agent-|WAZUH_CURRENT|-1.msi
599599
600600
Replace ``<PATH_TO_KEYS>`` with the full path to where the X509 certificate and root CA are stored.
601601

602-
This script builds a Wazuh 4.12.0 Windows WPK package named ``WindowsAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
602+
This script builds a Wazuh |WAZUH_CURRENT| Windows WPK package named ``WindowsAgent.wpk`` and stores it in ``/tmp/wpk``. This action is done using the previously generated keys that are saved in ``/tmp/keys``.
603603

604604
If the ``-c`` or ``--checksum`` option is used, a file is created containing the SHA512 checksum in the same output path. This location is configurable, and you can indicate where you want to store it
605605

@@ -610,6 +610,6 @@ Run the command below to build a WPK with a checksum:
610610

611611
.. code-block:: console
612612
613-
# ./generate_wpk_package.sh -t linux -b v4.12.0 -d /tmp/wpk -k /<PATH_TO_KEYS> -o LinuxAgent.wpk -pn wazuh-agent_4.12.0-1_amd64.deb -c /tmp/wpk_checksum
613+
# ./generate_wpk_package.sh -t linux -b v|WAZUH_CURRENT| -d /tmp/wpk -k /<PATH_TO_KEYS> -o LinuxAgent.wpk -pn wazuh-agent_|WAZUH_CURRENT|-|WAZUH_REVISION_DEB_AGENT_X86|_amd64.deb -c /tmp/wpk_checksum
614614
615615
Replace ``<PATH_TO_KEYS>`` with the full path to where the X509 certificate and root CA are stored.

source/development/packaging/generate-dashboard-package.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,6 @@ Building the Wazuh dashboard package using Docker
272272

273273
.. code-block:: console
274274
275-
$ ./launcher.sh -v 4.12.0 -r 1 -p file:///wazuh-dashboard-4.11.1-1-linux-x64.tar.gz
275+
$ ./launcher.sh -v |WAZUH_CURRENT| -r |WAZUH_DASHBOARD_CURRENT_REV_DEB| -p file:///wazuh-dashboard-|WAZUH_CURRENT|-|WAZUH_DASHBOARD_CURRENT_REV_DEB|-linux-x64.tar.gz
276276
277277
The package will be generated in the ``output`` folder of the ``rpm`` or ``deb`` folder.

source/development/packaging/generate-indexer-package.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Prerequisites
2222

2323
.. code-block:: console
2424
25-
$ git clone https://github.com/wazuh/wazuh-indexer && cd wazuh-indexer && git checkout v4.12.0
25+
$ git clone https://github.com/wazuh/wazuh-indexer && cd wazuh-indexer && git checkout v|WAZUH_CURRENT|
2626
2727
Build stage
2828
-----------

0 commit comments

Comments
 (0)