From 4ab0a4dcdee373267f60e2217a241bdb9d8f2a1a Mon Sep 17 00:00:00 2001 From: Jesus Linares Date: Tue, 9 Jan 2024 17:43:13 +0100 Subject: [PATCH] Fix notes and EPS setting description --- .../account-billing/manage-billing-details.rst | 10 +++++----- .../cloud-service/account-billing/update-billing.rst | 6 +++--- source/cloud-service/apis/authentication.rst | 4 ++-- source/cloud-service/archived-data/access.rst | 4 ++-- .../cloud-service/getting-started/access-wazuh-wui.rst | 2 +- source/cloud-service/getting-started/enroll-agents.rst | 4 ++-- .../cloud-service/your-environment/configure-email.rst | 4 ++-- source/cloud-service/your-environment/manage-auth.rst | 6 +++--- source/cloud-service/your-environment/settings.rst | 8 ++++---- 9 files changed, 24 insertions(+), 24 deletions(-) diff --git a/source/cloud-service/account-billing/manage-billing-details.rst b/source/cloud-service/account-billing/manage-billing-details.rst index a2d08b5a84..1255bbf7a5 100644 --- a/source/cloud-service/account-billing/manage-billing-details.rst +++ b/source/cloud-service/account-billing/manage-billing-details.rst @@ -10,9 +10,9 @@ Manage your billing details If you want to continue using your environment beyond the trial period, you need to add credit card details to your Wazuh Cloud account. Your credit card information is sent securely to our billing provider and stored with them. -.. note:: + .. note:: - A trial environment is converted to a paid environment when the trial expires. If you do not add your credit card information before the expiration date, your environment is deleted, and all data is permanently erased. Make sure to add your credit card before the end of the trial period. + A trial environment is converted to a paid environment when the trial expires. If you do not add your credit card information before the expiration date, your environment is deleted, and all data is permanently erased. Make sure to add your credit card before the end of the trial period. Add your billing details ------------------------ @@ -31,9 +31,9 @@ To add the billing details: You can stop upcoming charges by :ref:`canceling your environments `. -.. note:: - - Please take into account that the cancellation cannot be undone once you do it and that all your data will be completely deleted. + .. note:: + + Please take into account that the cancellation cannot be undone once you do it and that all your data will be completely deleted. Remove your billing details --------------------------- diff --git a/source/cloud-service/account-billing/update-billing.rst b/source/cloud-service/account-billing/update-billing.rst index 31366ae11c..b00a057b83 100644 --- a/source/cloud-service/account-billing/update-billing.rst +++ b/source/cloud-service/account-billing/update-billing.rst @@ -10,9 +10,9 @@ Update billing and operational contacts You can specify billing and operational contacts in addition to the primary email address of your account. -.. note:: - - Billing and operational contacts are only for notification purposes, they cannot be used to log in to the Wazuh Cloud Console. To access the Wazuh Cloud Console, you must use the primary email address for your account. + .. note:: + + Billing and operational contacts are only for notification purposes, they cannot be used to log in to the Wazuh Cloud Console. To access the Wazuh Cloud Console, you must use the primary email address for your account. To update billing and operational contacts: diff --git a/source/cloud-service/apis/authentication.rst b/source/cloud-service/apis/authentication.rst index d66c7c09cd..89605f5b07 100644 --- a/source/cloud-service/apis/authentication.rst +++ b/source/cloud-service/apis/authentication.rst @@ -25,9 +25,9 @@ To obtain an API key: 5. Copy the generated API key and store it in a safe place. -.. note:: + .. note:: - The API key has no expiration date, so it can be used indefinitely. You might also have multiple API keys for different purposes, and you can revoke them when you no longer need them. + The API key has no expiration date, so it can be used indefinitely. You might also have multiple API keys for different purposes, and you can revoke them when you no longer need them. To revoke an API key: diff --git a/source/cloud-service/archived-data/access.rst b/source/cloud-service/archived-data/access.rst index 5378ae5e9a..dd850bd288 100644 --- a/source/cloud-service/archived-data/access.rst +++ b/source/cloud-service/archived-data/access.rst @@ -10,8 +10,8 @@ Access To access your archived data, you need an AWS token that grants permission on the AWS S3 bucket of your environment. This token can be generated using the Wazuh Cloud API. -.. note:: - See the :doc:`Wazuh Cloud CLI ` section to learn how to list and download your archived data automatically. + .. note:: + See the :doc:`Wazuh Cloud CLI ` section to learn how to list and download your archived data automatically. The following example describes the steps to follow to list the files of your archived data: diff --git a/source/cloud-service/getting-started/access-wazuh-wui.rst b/source/cloud-service/getting-started/access-wazuh-wui.rst index febf356a8c..30922c6c7b 100644 --- a/source/cloud-service/getting-started/access-wazuh-wui.rst +++ b/source/cloud-service/getting-started/access-wazuh-wui.rst @@ -22,7 +22,7 @@ Follow these steps to access Wazuh WUI: It is highly recommended for security reasons to change the default password and create your own users. -.. note:: You can access the Wazuh WUI directly using the URL *https://.cloud.wazuh.com*, where ```` is the Cloud ID of your environment. + .. note:: You can access the Wazuh WUI directly using the URL *https://.cloud.wazuh.com*, where ```` is the Cloud ID of your environment. If you have any questions about the Wazuh Cloud, see the :doc:`Cloud service FAQ `. diff --git a/source/cloud-service/getting-started/enroll-agents.rst b/source/cloud-service/getting-started/enroll-agents.rst index 131a552a92..10e169af5f 100644 --- a/source/cloud-service/getting-started/enroll-agents.rst +++ b/source/cloud-service/getting-started/enroll-agents.rst @@ -19,8 +19,8 @@ Follow these steps to enroll an agent: #. Follow the steps described on the **Deploy a new agent** page. -.. note:: + .. note:: - Wazuh agents use TCP to communicate with your environment. + Wazuh agents use TCP to communicate with your environment. If you have any questions about the Wazuh Cloud, see the :doc:`Cloud service FAQ `. diff --git a/source/cloud-service/your-environment/configure-email.rst b/source/cloud-service/your-environment/configure-email.rst index 3047194cff..caaeeca8eb 100644 --- a/source/cloud-service/your-environment/configure-email.rst +++ b/source/cloud-service/your-environment/configure-email.rst @@ -12,9 +12,9 @@ Wazuh can be :ref:`configured to send email alerts ` to one This configuration requires an SMTP and you can use your own SMTP or the Wazuh Cloud SMTP. -.. note:: + .. note:: - If your SMTP requires authentication, you need to open a ticket through the **Help** section of your Wazuh Cloud Console to configure it. + If your SMTP requires authentication, you need to open a ticket through the **Help** section of your Wazuh Cloud Console to configure it. The Wazuh Cloud SMTP is limited to 100 emails per hour, regardless of the ``email_maxperhour`` setting. To enable the Wazuh Cloud SMTP, configure the following settings: diff --git a/source/cloud-service/your-environment/manage-auth.rst b/source/cloud-service/your-environment/manage-auth.rst index dc511fbc23..8cb7751bd9 100644 --- a/source/cloud-service/your-environment/manage-auth.rst +++ b/source/cloud-service/your-environment/manage-auth.rst @@ -10,9 +10,9 @@ Authentication and authorization You can use the native support for managing and authenticating users or integrate with external user management systems. -.. note:: - - You cannot log in to the Wazuh WUI of your environment with your Wazuh Cloud account credentials. To log in to Wazuh WUI, use the default credentials from the Wazuh Cloud Console page or the credentials of any user you already created in Wazuh WUI. + .. note:: + + You cannot log in to the Wazuh WUI of your environment with your Wazuh Cloud account credentials. To log in to Wazuh WUI, use the default credentials from the Wazuh Cloud Console page or the credentials of any user you already created in Wazuh WUI. Native support for users and roles diff --git a/source/cloud-service/your-environment/settings.rst b/source/cloud-service/your-environment/settings.rst index 58ae3bd7be..4c772f4a1e 100644 --- a/source/cloud-service/your-environment/settings.rst +++ b/source/cloud-service/your-environment/settings.rst @@ -64,16 +64,16 @@ This setting indicates whether the support level is premium or standard. Average/Peak EPS ^^^^^^^^^^^^^^^^^^^ -It represents the maximum number of events per second (EPS) that the environment can analyze. This is an advanced setting, and the interface provides a suggestion when selecting the Active agents setting. +It represents the average and the maximum number of events per second (EPS) that the environment can analyze. This is an advanced setting, and the interface provides a suggestion when selecting the Active agents setting. -If the ingestion rate is exceeded, events will start to queue. However, if the queue becomes full, the incoming events will be discarded, which may lead to potential event loss. The queuing mechanism is automatically managed by the cloud service, ensuring optimal resource utilization. +If the ingestion rate is exceeding the peak EPS, events will start to queue. However, if the queue becomes full, the incoming events will be discarded, which may lead to potential event loss. The queuing mechanism is automatically managed by the cloud service, ensuring optimal resource utilization. The environment will be configured with the `limits eps option `_ using the following parameters: - timeframe = 1 seconds -- maximum = Average/Peak EPS setting / number of server nodes +- maximum = Peak EPS / number of server nodes -The number of server nodes is automatically determined by the cloud service based on the workload. For instance, if the Average/Peak EPS setting is 900 EPS and there is a cluster of 2 nodes at the current time, each node can process up to 450 events per second. +The number of server nodes is automatically determined by the cloud service based on the workload. For instance, if the Average/Peak EPS setting is 100/500 EPS and there is a cluster of 2 nodes at the current time, each node can process up to 250 events per second (500 peak EPS / 2 server nodes). .. _cloud_settings_adjust: