Skip to content

Commit 25ddc6c

Browse files
authored
Merge pull request #8938 from wazuh/enhancement/idr353-AMI-rework
update wazuh AMI setup documentation
2 parents 4d22f08 + a127eb4 commit 25ddc6c

File tree

2 files changed

+44
-31
lines changed

2 files changed

+44
-31
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ All notable changes to this project will be documented in this file.
77

88
- **Post-release**: Updated curl commands in the Upgrade guide. ([#8934](https://github.com/wazuh/wazuh-documentation/pull/8934))
99

10+
### Added
11+
12+
- **Post-release**: Updated the Wazuh Amazon Machine Images (AMI) documentation. ([#8938](https://github.com/wazuh/wazuh-documentation/pull/8938))
13+
1014
## [v4.13.0]
1115

1216
### Added

source/deployment-options/amazon-machine-images/amazon-machine-images.rst

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Packages list
2929
Deployment alternatives
3030
-----------------------
3131

32-
There are two alternatives for deploying a Wazuh instance. You can launch the `Wazuh All-In-One Deployment AMI <https://aws.amazon.com/marketplace/pp/B09J56274H>`_ directly from the AWS Marketplace or you can configure and deploy an instance using the AWS Management Console.
32+
You can deploy a Wazuh instance in two ways. Launch the `Wazuh All-In-One Deployment AMI <https://aws.amazon.com/marketplace/pp/B09J56274H>`_ directly from the AWS Marketplace or configure and deploy an instance using the AWS Management Console.
3333

3434
- `Launch an instance from the AWS Marketplace`_
3535
- `Deploy an instance using the AWS Management Console`_
@@ -41,17 +41,21 @@ There are two alternatives for deploying a Wazuh instance. You can launch the `W
4141
Launch an instance from the AWS Marketplace
4242
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4343

44-
#. Go to `Wazuh All-In-One Deployment <https://aws.amazon.com/marketplace/pp/prodview-eju4flv5eqmgq?ref=hmpg_recommendations_widget>`_ in the AWS Marketplace, then click **Continue to Subscribe**.
44+
#. Go to `Wazuh All-In-One Deployment <https://aws.amazon.com/marketplace/pp/prodview-eju4flv5eqmgq?ref=hmpg_recommendations_widget>`_ in the AWS Marketplace, then click **View purchase options**.
4545

46-
#. Review the information and accept the terms for the software. Click **Continue to Configuration** to confirm subscribing to our Server product.
46+
#. Review the information and the terms for the software. Click **Subscribe** to confirm subscribing to our product. You will receive an email notification that your offer has been accepted.
4747

48-
#. Select a **Software Version** and the **Region** where the instance is going to be deployed. Then, click **Continue to Launch**.
48+
#. Click **Launch your software** to continue your setup.
4949

50-
#. Review your configuration, making sure that all settings are correct before launching the software. Adapt the default configuration values to your needs.
50+
#. Select the service **Amazon EC2**, **Launch from EC2 console**, and a **Region**.
5151

52-
#. When selecting the **EC2 Instance Type**, we recommend that you use an instance type ``c5a.xlarge``.
52+
#. Click **Launch from EC2** to take you to the AWS Management Console.
5353

54-
#. When selecting the **Security Group**, it must be one with the appropriate :ref:`settings for your Wazuh instance <default_ports>` to guarantee the correct operation. You can create a new security group by choosing **Create new based on seller settings**. This new group will have the appropriate settings by default.
54+
#. Review your configuration, ensuring all settings are correct, before launching the software. Adapt the default configuration to your needs.
55+
56+
#. When selecting the **EC2 Instance Type**, we recommend ``c5a.xlarge`` because it offers an ideal balance of high compute performance and cost-efficiency.
57+
58+
#. To guarantee the correct operation, the **Security Group** must have the appropriate :ref:`settings for your Wazuh instance <default_ports>`. You can create a new security group by choosing **Create security group**. This new group will have the appropriate settings by default.
5559

5660
#. Click **Launch** to generate the instance.
5761

@@ -61,35 +65,39 @@ Once your instance is successfully launched and a few minutes have elapsed, you
6165
Deploy an instance using the AWS Management Console
6266
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6367

64-
#. Select **Launch instance** from your `AWS Management Console <https://aws.amazon.com/console/>`_ dashboard.
68+
#. Select **EC2** from your `AWS Management Console <https://aws.amazon.com/console/>`_ dashboard.
69+
70+
#. Click **Launch instance**.
6571

66-
#. Find Wazuh All-In-One Deployment by Wazuh Inc., and click **Select** to subscribe.
72+
#. Click on **Browse more AMIs**.
6773

68-
#. Review the Server product characteristics, then click **Continue**. This allows subscribing to our Server product.
74+
#. Search **Wazuh All-In-One Deployment** by Wazuh Inc under the **AWS Marketplace AMIs** tab, and click **Select**. This brings up a description of the Wazuh All-In-One Deployment with the option to either **Subscribe on instance launch** or **Subscribe now**.
6975

70-
#. Select the instance type according to your needs, then click **Next: Configure Instance Details**. We recommend that you use an instance type ``c5a.xlarge``.
76+
#. Select the instance type that best fits your needs. We recommend ``c5a.xlarge``.
7177

72-
#. Configure your instance as needed, then click **Next: Add Storage**.
78+
You can use either of these three configuration alternatives available regarding the key pair settings:
7379

74-
#. Set the storage capacity of your instance under the **Size (GiB)** column, then click **Next: Add Tags**. We recommend 100 GiB GP3 or more.
80+
- **Choose an existing key pair**
7581

76-
#. Add as many tags as you need, then click **Next: Configure Security Group**.
82+
- **Create a new key pair**
7783

78-
#. Check that the ports and protocols are the :ref:`ports and protocols <default_ports>` for Wazuh. Check the security measures for your instance. This will establish the Security Group (SG). Then, click **Review and Launch**.
84+
- **Proceed without a key pair** (Not recommended)
7985

80-
#. Review the instance configuration and click **Launch**.
86+
You need to choose an existing key pair or create a new one to access the instance with SSH.
8187

82-
#. Select one of three configuration alternatives available regarding the key pair settings: **Choose an existing key pair**, **Create a new key pair**, **Proceed without a key pair**. You need to choose an existing key pair or create a new one to access the instance with SSH.
88+
#. When selecting the **Security Group**, ensure it has the appropriate :ref:`settings for your Wazuh instance <default_ports>` to guarantee correct operation. You can create a new security group by choosing **Create security group**. This new group will have the appropriate settings by default. Check that the ports and protocols are the :ref:`ports and protocols <default_ports>` for Wazuh. Check the security measures for your instance. This will establish the Security Group (SG).
8389

84-
#. Click **Launch instances** to complete the process and deploy your instance.
90+
#. Under the **Size (GiB)** column, set your instance's storage capacity, then click **Next: Add Tags**. We recommend 100 GiB gp3 or more.
8591

86-
Once your instance is fully configured and ready after a few minutes since launch, you can :ref:`access the Wazuh dashboard <ami_wazuh_ui>`.
92+
#. Review the instance configuration and click **Launch instance**.
93+
94+
After a few minutes, the instance will be ready. You can :ref:`access the Wazuh dashboard <ami_wazuh_ui>`.
8795

8896

8997
Configuration files
9098
-------------------
9199

92-
All components included in this AMI are configured to work out-of-the-box without the need to modify any settings. However, all components can be fully customized. The configuration files locations are the following.
100+
All components included in this AMI are configured to work out-of-the-box without the need to modify any settings. However, all components can be fully customized. These are the configuration file locations:
93101

94102
- Wazuh manager: ``/var/ossec/etc/ossec.conf``
95103
- Wazuh indexer: ``/etc/wazuh-indexer/opensearch.yml``
@@ -106,34 +114,35 @@ To learn more about configuring Wazuh, see the :doc:`User manual </user-manual/i
106114
Access the Wazuh dashboard
107115
--------------------------
108116

109-
When the instance is launched, the user passwords are automatically changed to the instance ID with the first letter capitalized. For example: ``I-07f25f6afe4789342``. This ensures that only the creator has access to the interface. This process can take an average of five minutes, depending on the type of instance. During this time, both SSH access and access to the Wazuh dashboard are disabled.
117+
When the instance is launched, the user passwords are automatically changed to the instance ID with the first letter capitalized. For example: ``I-07f25f6afe4789342``. This ensures that only the creator has access to the interface. This process can take an average of five minutes, depending on the type of instance. During this time, SSH access and Wazuh dashboard access are disabled.
110118

111-
Once the instance is running and the process to initialize passwords is complete, you can access the Wazuh dashboard with your credentials.
119+
Once the instance runs and the process to initialize passwords is complete, you can access the Wazuh dashboard with your credentials.
112120

113-
- URL: *https://<YOUR_INSTANCE_IP>*
114-
- **Username**: *admin*
115-
- **Password**: *<YOUR_INSTANCE_ID>*
121+
- URL: ``https://<YOUR_INSTANCE_IP>``
122+
- Username: ``admin``
123+
- Password: ``<YOUR_INSTANCE_ID>``
116124

117125
.. note::
118126
:class: not-long
119127

120-
The password is the instance ID with the first letter capitalized. For example: ``I-07f25f6afe4789342``.
128+
The password is the instance ID with the first letter capitalized. For example, if the instance ID is: ``i-07f25f6afe4789342``, the default password will be ``I-07f25f6afe4789342``.
121129

122130
.. warning::
123131

124-
The password for the server API users ``wazuh`` and ``wazuh-wui`` is the same as the ``admin`` user's password. We highly recommend to change the default passwords in the first SSH access. To perform this action, refer to the :doc:`/user-manual/user-administration/password-management` section.
132+
The passwords for the Wazuh server API users ``wazuh`` and ``wazuh-wui`` are the same as those for the ``admin`` user. We highly recommend changing the default passwords on the first SSH access. To perform this action, refer to the :doc:`/user-manual/user-administration/password-management` section.
125133

126134
Security considerations about SSH
127135
---------------------------------
128136

129-
- The ``root`` user cannot be identified by SSH and the instance can only be accessed through the user: ``wazuh-user``.
130-
- SSH authentication through passwords is disabled and the instance can only be accessed through a key pair. This means that only the user with the key pair has access to the instance.
131-
- To access the instance with a key pair, you need to download the key generated or stored in AWS. Then, run the following command to connect with the instance.
137+
- The ``root`` user cannot be identified by SSH, and the instance can only be accessed through the user: ``wazuh-user``.
138+
- The instance can only be accessed through a key pair, which is provided to the user with the key pair.
139+
- You must download the key generated or stored in AWS to access the instance with a key pair. Then, run the following command to connect with the instance.
132140

133141
.. code-block:: console
134142
135143
# ssh -i "<KEY_PAIR_NAME>" wazuh-user@<YOUR_INSTANCE_IP>
136-
- Access during the initial password change process is disabled to prevent potential problems. This process may take a few minutes to complete. Any access attempt before completion will show ``wazuh-user@<INSTANCE_IP>: Permission denied (publickey,gssapi-keyex,gssapi-with-mic)``.
144+
145+
- Access during the initial password change is disabled to prevent potential problems. This process might take a few minutes to complete. Any access attempt before completion shows: ``wazuh-user@<INSTANCE_IP>: Permission denied (publickey,gssapi-keyex,gssapi-with-mic)``.
137146

138147

139148
Next steps

0 commit comments

Comments
 (0)