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 Wazuh as a custom source ASL integration #7310

Merged
merged 7 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
19 changes: 19 additions & 0 deletions source/_static/js/redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,21 @@ redirections.push(
'4.8': '/deployment-options/offline-installation.html',
'4.9': '/deployment-options/offline-installation/step-by-step.html',
},
{
'target': ['4.8=>4.9', '4.9=>4.8'],
'4.8': '/cloud-security/amazon/services/supported-services/security-lake.html',
'4.9': '/cloud-security/amazon/services/supported-services/index.html',
},
{
'target': ['4.9=>4.8'],
'4.8': '/cloud-security/amazon/services/supported-services/security-lake.html',
'4.9': '/cloud-security/amazon/services/supported-services/amazon-security-lake/security-lake-source.html',
},
{
'target': ['4.9=>4.8'],
'4.8': '/cloud-security/amazon/services/supported-services/security-lake.html',
'4.9': '/cloud-security/amazon/services/supported-services/amazon-security-lake/security-lake-subscriber.html',
},
);

/* Pages added in 4.9 */
Expand All @@ -88,12 +103,16 @@ newUrls['4.9'] = [
'/deployment-options/offline-installation/step-by-step.html',
'/deployment-options/offline-installation/installation-assistant.html',
'/development/coredump.html',
'/cloud-security/amazon/services/supported-services/amazon-security-lake/index.html',
'/cloud-security/amazon/services/supported-services/amazon-security-lake/security-lake-source.html',
'/cloud-security/amazon/services/supported-services/amazon-security-lake/security-lake-subscriber.html',
];

/* Pages no longer available in 4.9 */

removedUrls['4.9'] = [
'/deployment-options/offline-installation.html',
'/cloud-security/amazon/services/supported-services/security-lake.html'
];

/* *** RELEASE 4.8 ****/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. Copyright (C) 2024 Wazuh, Inc.

.. meta::
:description: Learn how to configure Amazon Security Lake.

.. _amazon_security_lake:

======================
javimed marked this conversation as resolved.
Show resolved Hide resolved
Amazon Security Lake
======================

Amazon Security Lake is a fully-managed security data lake service that consolidates data from multiple AWS and other services, optimizing storage costs and performance at scale. The following sections explain the different types of integrations available and how to configure them with Wazuh:

.. toctree::
:titlesonly:

Wazuh as a Custom Source<security-lake-source>
Wazuh as a Subscriber<security-lake-subscriber>
javimed marked this conversation as resolved.
Show resolved Hide resolved
javimed marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using code font style in tables for attribute names, attribute values, class names, data types, etc. For example ``200101``, ``type_uid``, ``Wazuh, Inc.``, ``time`` (if we mean a key, field, etc. named "time")

AlexRuiz7 marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can specify the prompt symbol. For example

   .. code-block:: console

      $ sudo /usr/share/logstash/bin/logstash-plugin install logstash-input-opensearch

Copy-to-clipboard discards leading $ and # so no worries about that.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,13 @@
.. meta::
:description: Learn how to configure Amazon Security Lake.

.. _amazon_security_lake:
.. _aws_lake_subscriber:

Amazon Security Lake
Wazuh as a Subscriber
=========================

.. versionadded:: 4.4.2


Amazon Security Lake is a fully-managed security data lake service that consolidates data from multiple AWS and other services, optimizing storage costs and performance at scale.

All logs in Amazon Security Lake use the Open Cybersecurity Schema Framework (OCSF) standard for formatting. You can use the Wazuh integration for Amazon Security Lake to ingest security events from AWS services.

These events are available as multi-event Apache Parquet objects in an S3 bucket. Each object has a corresponding SQS message, once it's ready for download.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The next table contains the most relevant information about configuring each ser
+--------------+----------------------------------------------------------+-----------------------+----------------+------------------------------------------------------------------------------------------------------------------+
| Amazon | :ref:`Amazon ECR Image scanning <amazon_image_scanning>` | service | cloudwatchlogs | |
+--------------+----------------------------------------------------------+-----------------------+----------------+------------------------------------------------------------------------------------------------------------------+
| Amazon | :ref:`Amazon Security Lake <amazon_security_lake>` | subscriber | security_lake | |
| Amazon | :ref:`Amazon Security Lake <aws_lake_subscriber>` | subscriber | security_lake | |
+--------------+----------------------------------------------------------+-----------------------+----------------+------------------------------------------------------------------------------------------------------------------+
| Amazon | :ref:`Custom Logs Buckets <amazon_custom_logs>` | subscriber | buckets | |
+--------------+----------------------------------------------------------+-----------------------+----------------+------------------------------------------------------------------------------------------------------------------+
Expand All @@ -78,6 +78,6 @@ The next table contains the most relevant information about configuring each ser
ecr-image-scanning
cisco-umbrella
elastic-load-balancing/index
security-lake
amazon-security-lake/index
custom-buckets
security-hub
Binary file added source/images/aws/asl-custom-source-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/aws/asl-custom-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/aws/asl-lambda-trigger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/aws/asl-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading