-
Notifications
You must be signed in to change notification settings - Fork 363
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
Add HAProxy helper docs #7279
Conversation
The diagrams are drafts, the final ones are currently developing by the marketing team. |
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
b5dba3f
to
3e5abaa
Compare
Updated with the final version of the diagrams. |
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this 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.
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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:
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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.)
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
source/user-manual/manager/configuring-cluster/advanced-settings.rst
Outdated
Show resolved
Hide resolved
|
||
.. 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/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# 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/).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 9edc180
Co-authored-by: Javier Medeot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job @nico-stefani!
Description
This PR closes #7232. Add documentation for the HAProxy helper feature. This includes:
ossec.conf
configurationsChecks
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.