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.

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

Add HAProxy helper docs #7279

Open
wants to merge 12 commits into
base: 4.9.0
Choose a base branch
from

Conversation

nico-stefani
Copy link
Member

@nico-stefani nico-stefani commented Apr 30, 2024

Description

This PR closes #7232. Add documentation for the HAProxy helper feature. This includes:

  • Reference for the new ossec.conf configurations
  • New section about how to install and configure HAProxy
  • Removed references to NGINX
  • New section about how to enable the HAProxy Helper

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.

@nico-stefani nico-stefani self-assigned this Apr 30, 2024
@nico-stefani nico-stefani changed the base branch from master to 4.9.0 April 30, 2024 21:23
@nico-stefani nico-stefani marked this pull request as ready for review May 2, 2024 13:37
@nico-stefani
Copy link
Member Author

The diagrams are drafts, the final ones are currently developing by the marketing team.

@nico-stefani nico-stefani force-pushed the feature/7232-add-haproxy-helper-docs branch from b5dba3f to 3e5abaa Compare May 3, 2024 16:28
@nico-stefani
Copy link
Member Author

Updated with the final version of the diagrams.

@nico-stefani nico-stefani requested a review from GGP1 May 6, 2024 15:33
GGP1
GGP1 previously approved these changes May 6, 2024
Copy link
Member

@GGP1 GGP1 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@Selutario Selutario left a comment

Choose a reason for hiding this comment

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

This is a good starting point, congratulations! I have mentioned a few things to make it clearer below.

In my opinion (based on the initial requirements of the objective: Add pages about deploying and configuring HAProxy balancer through packages and docker images.) and taking into account that we intend to support only a specific HAProxy version, I would explain step-by-step how to install and configure it.

Regardless of whether you decide to do the latter, keep in mind that this will be announced as one of the highlights of 4.9 and many users will probably be interested in the helper, so it should be easy for them to configure (since broadly speaking and by its nature, it is a feature complex both to understand and use).

Try, from the point of view of a user who sees the Helper for the first time, to configure both HAProxy LB and the Helper following the documentation and using the resources provided (both the official haproxy docker image and the package). I think there are some places where adding additional information could save a lot of users headaches.

Copy link
Member

@Selutario Selutario left a comment

Choose a reason for hiding this comment

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

Very good work here @nico-stefani, this improved version is much easier to understand and follow. There are still some incorrect things, I explain them below:

Copy link
Member

@javimed javimed left a comment

Choose a reason for hiding this comment

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

(This review is partial.)


.. code-block:: console

# curl -sL https://github.com/haproxytech/dataplaneapi/releases/download/v2.8.X/dataplaneapi_2.8.X_linux_x86_64.tar.gz | tar xz && cp dataplaneapi /usr/local/bin/
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# curl -sL https://github.com/haproxytech/dataplaneapi/releases/download/v2.8.X/dataplaneapi_2.8.X_linux_x86_64.tar.gz | tar xz && cp dataplaneapi /usr/local/bin/
# curl -sL https://github.com/haproxytech/dataplaneapi/releases/download/v2.8.7/dataplaneapi_2.8.7_linux_x86_64.tar.gz | tar xz && cp dataplaneapi /usr/local/bin/

One last comment on my side: are these Xs intentional? If we don't want to include the patch in case they update it (which seems fine to me), we should at least tell the user where they can find the latest one:

Maybe something like

1. Download the binary file for the installed HAProxy version. You can find the available versions [here](https://github.com/haproxytech/dataplaneapi/releases/). 

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in 9edc180

nico-stefani and others added 2 commits May 22, 2024 14:08
Co-authored-by: Javier Medeot <javier.medeot@wazuh.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/enhancement Enhancement issue
Projects
Status: On hold
Development

Successfully merging this pull request may close these issues.

Add documentation for the HAProxy Helper
4 participants