Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make syscollector capable to fetch the PYPI and node packages #6346

Merged
merged 9 commits into from
Aug 24, 2023
Merged

Make syscollector capable to fetch the PYPI and node packages #6346

merged 9 commits into from
Aug 24, 2023

Conversation

GabrielEValenzuela
Copy link
Member

Description

This PR closes #6342 by adding documentation about new package scanner support of syscollector (wazuh/wazuh#5443).

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@GabrielEValenzuela GabrielEValenzuela linked an issue Aug 15, 2023 that may be closed by this pull request
Make syscollector capable to fetch the PYPI and node packages from the machine - Documentation changes #6342
Closed
4 tasks
@GabrielEValenzuela GabrielEValenzuela marked this pull request as ready for review August 15, 2023 14:36
@GabrielEValenzuela GabrielEValenzuela self-assigned this Aug 15, 2023
pereyra-m
pereyra-m reviewed Aug 15, 2023
View reviewed changes
Copy link
Member

@pereyra-m pereyra-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gj!

source/user-manual/capabilities/system-inventory/compatibility-matrix.rst Outdated Show resolved Hide resolved
@GabrielEValenzuela
Add macOS in matrix.
a215ef8 
Fix link PyPI
MiguelazoDS
MiguelazoDS reviewed Aug 16, 2023
View reviewed changes
source/user-manual/capabilities/system-inventory/compatibility-matrix.rst Outdated
+------------------------+----------------------+-----------------+
| macOS | √ | √ |
+------------------------+----------------------+-----------------+
| FreeBSD | ✗ | ✗ |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sure that freebsd and solaris do not have support for those package managers?

@javimed
Copy link
Member

javimed commented Aug 16, 2023 •
edited
Loading

Some questions and comments:

Why a limited list of package formats? Why not having the full list of packages including already supported plus these newly supported formats?

The specific table for the package scan could simply be a two-columns table: First column listing supported operating systems and second column with an enumeration of supported package formats such as deb, rpm, pacman, npm, pypi for Linux, pkg, npm, pypi for macOS, and .pkg for Solaris or whatever the case. Or perhaps using the very compatibility table but instead of using the generic √ and ✗ marks we would fill those cells with the package enumeration...

What about updating the Available inventory fields?

imagen

I think we have to update the enumerated formats there too because this version has a broader reach. We could even enumerate here once again all the supported packages, if this were possible.

What do you think about providing a list of all the supported package formats everywhere where it's required?

matias-braida
matias-braida reviewed Aug 18, 2023
View reviewed changes
Copy link
Member

@matias-braida matias-braida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GJ

@GabrielEValenzuela
Change matrix and show packages and their corresponding OS support.
c2f5d16 
Add packages support in available-inventory-fields.
MiguelazoDS
MiguelazoDS reviewed Aug 18, 2023
View reviewed changes
source/user-manual/capabilities/system-inventory/compatibility-matrix.rst Outdated

The Syscollector module now supports scan packages from `NPM (Node Package Manager) <https://www.npmjs.com/>`_ and `PyPI (Python Package Index) <https://pypi.org/>`_, **the support is only for the default paths of those packages' installation**.

The following table shows the new feature that are compatible with various operating systems.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are talking about "the new feature" I think it should be "...is compatible..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree :)

MiguelazoDS
MiguelazoDS reviewed Aug 18, 2023
View reviewed changes
source/user-manual/capabilities/system-inventory/compatibility-matrix.rst Outdated
Comment on lines 38 to 51
| | NPM | PyPI | rpm | deb | pacman | pkg | .pkg |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| Windows | √ | √ | – | – | – | – | – |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| Linux | √ | √ | √ | √ | √ | √ | – |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| macOS | √ | √ | – | – | – | – | – |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| FreeBSD | √ | √ | – | – | – | – | – |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| OpenBSD | √ | √ | – | – | – | – | – |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
| Solaris | √ | √ | – | – | – | – | √ |
+------------------------+----------------------+-----------------+-----------------+------------------+------------------+-----------------+-----------------+
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why ".pkg" and FreeBSD also uses pkg package manager, Although I think they are different package manager that share the same name.
image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch ! Fix it !

MiguelazoDS
MiguelazoDS reviewed Aug 18, 2023
View reviewed changes
Copy link
Member

@MiguelazoDS MiguelazoDS left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some concerns

pereyra-m
pereyra-m approved these changes Aug 18, 2023
View reviewed changes
Copy link
Member

@pereyra-m pereyra-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@javimed javimed self-requested a review August 22, 2023 15:38
@Dwordcito Dwordcito merged commit c55ceb0 into 4.7.0 Aug 24, 2023
@Dwordcito Dwordcito deleted the dev-6342-add-documentation-npm-pipy branch August 24, 2023 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MiguelazoDS MiguelazoDS MiguelazoDS approved these changes

@Dwordcito Dwordcito Dwordcito approved these changes

@javimed javimed javimed approved these changes

@pereyra-m pereyra-m pereyra-m approved these changes

@matias-braida matias-braida matias-braida approved these changes

Assignees

@GabrielEValenzuela GabrielEValenzuela

Labels
Documentation improvements Documentation improvements level/subtask Subtask issue module/syscollector type/enhancement Enhancement issue
Projects
No open projects
Release 4.7.0
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make syscollector capable to fetch the PYPI and node packages from the machine - Documentation changes
6 participants
@GabrielEValenzuela @javimed @MiguelazoDS @Dwordcito @pereyra-m @matias-braida