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 documentation for the HAProxy Helper #7232

Open
nico-stefani opened this issue Apr 23, 2024 · 4 comments · May be fixed by #7279
Open

Add documentation for the HAProxy Helper #7232

nico-stefani opened this issue Apr 23, 2024 · 4 comments · May be fixed by #7279
Assignees
Labels
framework level/subtask Subtask issue type/enhancement Enhancement issue

Comments

@nico-stefani
Copy link
Member

nico-stefani commented Apr 23, 2024

Branch
feature/7232-add-haproxy-helper-docs

This issue aims to write documentation for the new HAProxy Helper feature.

Is needed to add sections about the operation and configuration of the HAProxy helper.

  • For the cluster configuration in source/user-manual/reference/ossec-conf/cluster.rst.
  • For the operation description the recommended place will be source/user-manual/manager/configuring-cluster/advanced-settings.rst.

Also, we need to add a section about deploying and configuring the HAProxy balancer through packages and docker images. For this item, the recommended place also will be source/user-manual/manager/configuring-cluster/advanced-settings.rst.

With this new configuration, we will remove the references to NGINX as the default load balancer method.

@nico-stefani
Copy link
Member Author

Update

  • Added reference for the new sub-section options in source/user-manual/reference/ossec-conf/cluster.rst.

@nico-stefani
Copy link
Member Author

Update

I've been designing the base structure to include in the Advanced Settings page. Also, writing the explanation about the helper and how to enable it.

@nico-stefani
Copy link
Member Author

Update

I've been working on the diagrams to include in the documentation. Also, writing the explanation about how to install HAProxy.

@nico-stefani nico-stefani linked a pull request Apr 30, 2024 that will close this issue
7 tasks
@nico-stefani
Copy link
Member Author

Update

I've been validating the installation flow for both methods, packages, and docker.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
framework level/subtask Subtask issue type/enhancement Enhancement issue
Projects
Status: On hold
Development

Successfully merging a pull request may close this issue.

1 participant