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

Ansible installation documentation update #7295

Open
adavinchi opened this issue May 7, 2024 · 2 comments · May be fixed by #7447
Open

Ansible installation documentation update #7295

adavinchi opened this issue May 7, 2024 · 2 comments · May be fixed by #7447
Assignees
Labels
level/task Task issue type/bug Bug issue

Comments

@adavinchi
Copy link
Member

The Wazuh documentation for installation via Ansible is not very clear and there are steps that can be improved.

  1. The Windows endpoints subsection is not consistent with similar subsections making it seem like it is a different step rather than an optional step
  2. The Remote Connection section includes the command cat ~/.ssh/id_rsa.pub | ssh [email protected] "cat >> ~/.ssh/authorized_keys" this command fails because the Ansible server does not yet have access to the remote server. this steps is supposed to created the access. It also does not clearly state that some values are placeholders that should be replaced eg centos
  3. The guide does not clearly separate all-in-one installation from cluster installation.
  4. The cluster installation section does not clearly guide the user on how to modify the /etc/ansible/roles/wazuh-ansible/playbooks/wazuh-production-ready.yml file
@teddytpc1
Copy link
Member

Hi, @adavinchi.
Could you update the issue description with links to the documentation and screenshots related to each item, please?
We need it to have a better understanding of what you mean.

@adavinchi
Copy link
Member Author

  1. The Windows endpoints subsection: This section is found at Installation alternatives > Deployment with Ansible > Installation Guide > Install Ansible. This section provides multiple methods for installing Ansible: Centos/rhel/fedora, Debian/ubuntu.

As seen in the image below, the Windows endpoints is under the Installation guide, this is confusing and makes it seem like it is a configuration that is required for installing Ansible. I think it is better suited under the Remote Connection section so the user understands that this is only related to deploying on Windows agents with Ansible.
image

  1. Remote Connection: There is a step to run command cat ~/.ssh/id_rsa.pub | ssh [email protected] "cat >> ~/.ssh/authorized_keys" in step 3 here

This commands attempts to use ssh to write the ssh key to the remote server. The document contains an actual IP and user instead of a placeholder and we do not notify the user that the remote user needs to have required permissions on the remote machine. it should be clearer to the user that they need to replace those values.

  1. all-in-one installation and cluster installation not clearly separated: As seen in the below image, the single node and cluster installation is not clearly separated like in other documentation, for example in Deployment with puppet
image
  1. Cluster installation section does not clearly guide the user on how to modify the /etc/ansible/roles/wazuh-ansible/playbooks/wazuh-production-ready.yml file: The default configuration contains 2 Wazuh nodes, 3 Wazuh indexer nodes, and a Wazuh dashboard node. In a case where the user needs a different architecture, the document does not guide the user on how to modify this document like in other installation document, for example as seen in the puppet documentation:
image

@vcerenu vcerenu linked a pull request Jun 24, 2024 that will close this issue
7 tasks
@teddytpc1 teddytpc1 linked a pull request Jun 25, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
Status: Pending review
Development

Successfully merging a pull request may close this issue.

4 participants