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

Added documentation to include user .aws/config file as default config #6005

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Find an example of running the module on a manager using the ``--reparse`` optio

The ``--debug 2`` parameter gets a verbose output. This is useful to show the script is working, specially when handling a large amount of data.


Connection configuration for retries
------------------------------------

Expand Down Expand Up @@ -89,6 +88,49 @@ The following example of a ``~/.aws/config`` file sets retry parameters for the
max_attempts=5
retry_mode=standard

Additional configuration
~~~~~~~~~~~~~~~~~~~~~~~~

Wazuh supports additional configuration options found in the ``.aws/config file``. The supported keys are the primary keys stated in the `boto3 configuration <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html>`_. Supported keys are:

- region_name.
- signature_version.
- s3
- proxies
- proxies_config
- retries

The following example of a ``~/.aws/config`` file sets the supported configuration for the *dev* profile:

.. code-block:: ini

[dev]
region = us-east-1
output = json
dev.s3.max_concurrent_requests = 10
dev.s3.max_queue_size = 1000
dev.s3.multipart_threshold = 64MB
dev.s3.multipart_chunksize = 16MB
dev.s3.max_bandwidth = 50MB/s
dev.s3.use_accelerate_endpoint = true
dev.s3.addressing_style = virtual

dev.proxy.host = proxy.example.com
dev.proxy.port = 8080
dev.proxy.username = your-proxy-username
dev.proxy.password = your-proxy-password

dev.proxy.ca_bundle = /path/to/ca_bundle.pem
dev.proxy.client_cert = /path/to/client_cert.pem
dev.proxy.use_forwarding_for_https = true

dev.signature_version = s3v4
max_attempts = 5
retry_mode = standard

.. note::
To configure multiple profiles for the integration, declare each profile in the ``~/.aws/config`` file using the same pattern as before.
If no profile is declared in the module configuration, the *default* profile is used.

Configuring multiple services
-----------------------------
Expand Down Expand Up @@ -156,7 +198,6 @@ Below there is an example of different services configuration:

</wodle>


Using non-default AWS endpoints
-------------------------------

Expand Down Expand Up @@ -221,4 +262,4 @@ The following is an example of a valid configuration.
<service_endpoint>logs-fips.us-east-2.amazonaws.com</service_endpoint>
</service>

</wodle>
</wodle>