Research the necessary migration from wazuh-packages to Agent repository

[vikman90]

Objective
wazuh/wazuh-packages#2904

Description

The code related to the Wazuh agent package generation must be migrated from the repository wazuh-packages to its new repository, this issue aims to analyze and document what must be migrated.

Tasks

• Research the wazuh-packages repository for agent package-related code
• Define and document the content desired to migrate

[mjcr99]

Update

(09/07/2024) Reviewing migrated code and its requirements.

(10/07/2024) Migration requirements analysis:

Folder	Notes	Decision
/wazuh-packages/.github/workflows	This folder contains workflows and issue templates related stuff. Issue templates are not required to be migrated since they are pretty basic. Regarding workflow files, the functionalities that these files implement were migrated in their majority to the wazuh/wazuh repository, we should decide if the agents' package generation mechanism wants to be migrated again from the wazuh/wazuh repository to this new one.	Pending
/wazuh-packages/aix	This folder contains the scripts for AIX agents building, if we want to keep this agents available in 4.10.0 this folder should be migrated.	Migrate
/wazuh-packages/alpine	This folder contains the scripts for alpine agents building, if we want to keep this agents available in 4.10.0 this folder should be migrated.	Migrate
/wazuh-packages/arch	This folder contains the scripts for ARCH agents building. This kind of package seems to not be currently offered in our package list. We may not need to migrate it.	Pending
/wazuh-packages/debs	This folder contains the scripts for DEB agents building. These scripts have already been migrated to the wazuh/wazuh, no migration from wazuh-packages is required, but we would need to consider if migration from wazuh/wazuh is desired.	Don't migrate
/wazuh-packages/documentation-templates	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/hp-ux	This folder contains the scripts for HP-ux agents building, if we want to keep this agents available in 4.10.0 this folder should be migrated.	Migrate
/wazuh-packages/maco	This folder contains the scripts for macos agents building. These scripts have already been migrated to the wazuh/wazuh, no migration from wazuh-packages is required, but we would need to consider if migration from wazuh/wazuh is desired.	Don't migrate
/wazuh-packages/ova	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/puppet_module	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/rpms	This folder contains the scripts for RPM agents building. These scripts have already been migrated to the wazuh/wazuh, no migration from wazuh-packages is required, but we would need to consider if migration from wazuh/wazuh is desired.	Don't migrate
/wazuh-packages/solaris	This folder contains the scripts for Solaris agents building, if we want to keep this agents available in 4.10.0 this folder should be migrated.	Migrate
/wazuh-packages/splunkapp	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/stack	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/test/unattended_installer	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/wazuhapp	This folder is not related to the agents' package generation	Don't migrate
/wazuh-packages/windows	This folder contains the scripts for Windows agents building. These scripts have already been migrated to the wazuh/wazuh, no migration from wazuh-packages is required, but we would need to consider if migration from wazuh/wazuh is desired.	Don't migrate
/wazuh-packages/wpk	This folder is not related to the agents' package generation	Don't migrate

(11/07/2024) Reviewed @MarcelKemp feedback, additional conclusions:

Regarding /wazuh-packages/.github/workflows packages generation workflows, there is a testing mechanism that has not been implemented in the migration and we may consider it.

In the wazuh-packages repository, every time a change took place in a packages generation related file, testing packages were created to verify the changes did not break the structure and let the code ready to keep building packages with the new changes. As long as it should not be mandatory to migrate this mechanism, we should consider implementing it, keeping in mind our new structure, as a good CI practice.

[MarcelKemp]

Review

Folder	Decision	Comment
/wazuh-packages/.github/workflows	Pending	It would be necessary to remove the workflows that are already migrated in wazuh/wazuh, and make a list of those that have not been merged (such as package testing), to verify that we cover those cases.
/wazuh-packages/aix	Don't migrate	It is explicitly stated in the issue that we do not migrate it: wazuh/wazuh-packages#2904 (comment)
/wazuh-packages/alpine	Don't migrate	It is explicitly stated in the issue that we do not migrate it: wazuh/wazuh-packages#2904 (comment)
/wazuh-packages/arch	Don't migrate	Although not listed, this OS is also not listed in the compatibility table.
/wazuh-packages/debs	Don't migrate + Clean up	Migrated in wazuh/wazuh. For 5.0 it will be migrated to this repository, however for this objective it is not necessary.
/wazuh-packages/documentation-templates	Don't migrate + Clean up (filebeat)	Remove the contents of Filebeat or notify the relevant team to remove this directory.
/wazuh-packages/hp-ux	Don't migrate	It is explicitly stated in the issue that we do not migrate it: wazuh/wazuh-packages#2904 (comment)
/wazuh-packages/macos	Don't migrate + Clean up	Migrated in wazuh/wazuh. For 5.0 it will be migrated to this repository, however for this objective it is not necessary.
/wazuh-packages/ova	Don't migrate	👍
/wazuh-packages/puppet_module	Don't migrate	👍
/wazuh-packages/rpms	Don't migrate + Clean up	Migrated in wazuh/wazuh. For 5.0 it will be migrated to this repository, however for this objective it is not necessary.
/wazuh-packages/solaris	Don't migrate	It is explicitly stated in the issue that we do not migrate it: wazuh/wazuh-packages#2904 (comment)
/wazuh-packages/splunkapp	Don't migrate	👍
/wazuh-packages/stack	Don't migrate	👍
/wazuh-packages/test/unattended_installer	Don't migrate + Clean up (filebeat)	Remove the contents of Filebeat or notify the relevant team to remove this directory.
/wazuh-packages/wazuhapp	Don't migrate	👍
/wazuh-packages/windows	Don't migrate + Clean up	Migrated in wazuh/wazuh. For 5.0 it will be migrated to this repository, however for this objective it is not necessary.
/wazuh-packages/wpk	Don't migrate + Clean up	Migrated in wazuh/wazuh. For 5.0 it will be migrated to this repository, however for this objective it is not necessary.

[MarcelKemp]

Review

Workflows:

These are workflows to simply test the installation of the generated packages on an array of OSes from different distributions and architectures that support the package:

• Test install .deb
• Test install .rpm
  • Both run the same script: install_component.sh. Where the check is simply: $sys_type install -y "/packages/$1".

This check to install the package is already done in the same workflow, although it is tested only on the same machine used to generate the package:

• https://github.com/wazuh/wazuh-agent-packages/blob/8168cb4ac57c366ba8fc76f4ed93d7339eaee0de/.github/workflows/packages-build-linux-agent-amd.yml#L159-L172

Folder	Decision	Comment
/wazuh-packages/.github/workflows	Don't migrate + Clean up	I consider that with the current smoke tests, we already perform the same check, although limited based on the test matrix. However, I believe that this matrix will be tested with additional tests (such as DTT), so there is no need to migrate it.

[MarcelKemp]

Conclusion

Folder	Decision
/wazuh-packages/.github/workflows	Don't migrate + Clean up
/wazuh-packages/aix	Don't migrate
/wazuh-packages/alpine	Don't migrate -> Clean up
/wazuh-packages/arch	Don't migrate -> Clean up
/wazuh-packages/debs	Clean up
/wazuh-packages/documentation-templates	Clean up (filebeat)
/wazuh-packages/hp-ux	Don't migrate
/wazuh-packages/macos	Clean up
/wazuh-packages/ova	Do nothing
/wazuh-packages/puppet_module	Do nothing
/wazuh-packages/rpms	Clean up
/wazuh-packages/solaris	Don't migrate
/wazuh-packages/splunkapp	Do nothing
/wazuh-packages/stack	Do nothing
/wazuh-packages/test/unattended_installer	Clean up (filebeat)
/wazuh-packages/wazuhapp	Do nothing
/wazuh-packages/windows	Clean up
/wazuh-packages/wpk	Clean up

Update July 15

• Approved by @vikman90.