Skip to content

Commit

Permalink
Change references in README.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
f-galland committed Jul 4, 2024
1 parent c0ab9b0 commit d85285a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions integrations/amazon-security-lake/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Wazuh to Amazon Security Lake Integration Development Guide
#/ Wazuh to Amazon Security Lake Integration Development Guide

## Deployment guide on Docker

A demo of the integration can be started using the content of this folder and Docker. Open a terminal in the `wazuh-indexer/integrations` folder and start the environment.

```console
docker compose -f ./docker/amazon-security-lake.yml up -d
docker compose -f ./docker/compose.amazon-security-lake.yml up -d
```

This Docker Compose project will bring up these services:
Expand Down Expand Up @@ -39,7 +39,7 @@ Processed data will be uploaded to http://localhost:9444/ui/wazuh-aws-security-l
parquet-tools show <parquet-file>
```

If the `S3_BUCKET_OCSF` variable is set in the container running the AWS Lambda function, intermediate data in OCSF and JSON format will be written to a dedicated bucket. This is enabled by default, writing to the `wazuh-aws-security-lake-ocsf` bucket. Bucket names and additional environment variables can be configured editing the [amazon-security-lake.yml](./docker/amazon-security-lake.yml) file.
If the `S3_BUCKET_OCSF` variable is set in the container running the AWS Lambda function, intermediate data in OCSF and JSON format will be written to a dedicated bucket. This is enabled by default, writing to the `wazuh-aws-security-lake-ocsf` bucket. Bucket names and additional environment variables can be configured editing the [compose.amazon-security-lake.yml](./docker/compose.amazon-security-lake.yml) file.

For development or debugging purposes, you may want to enable hot-reload, test or debug on these files, by using the `--config.reload.automatic`, `--config.test_and_exit` or `--debug` flags, respectively.

Expand Down
8 changes: 4 additions & 4 deletions integrations/elastic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ This document describes how to prepare a Docker Compose environment to test the
1. Clone the Wazuh repository and navigate to the `integrations/` folder.
2. Run the following command to start the environment:
```bash
docker compose -f ./docker/elastic.yml up -d
docker compose -f ./docker/compose.indexer-elastic.yml up -d
```
3. If you prefer, you can start the integration with the Wazuh Manager as data source:
```bash
docker compose -f ./docker/manager-elastic.yml up -d
docker compose -f ./docker/compose.manager-elastic.yml up -d
```

The Docker Compose project will bring up the following services:
Expand All @@ -29,12 +29,12 @@ The Docker Compose project will bring up the following services:

For custom configurations, you may need to modify these files:

- [docker/elastic.yml](../docker/elastic.yml): Docker Compose file.
- [docker/compose.indexer-elastic.yml](../docker/compose.indexer-elastic.yml): Docker Compose file.
- [docker/.env](../docker/.env): Environment variables file.
- [elastic/logstash/pipeline/indexer-to-elastic.conf](./logstash/pipeline/indexer-to-elastic.conf): Logstash Pipeline configuration file.

If you opted to start the integration with the Wazuh Manager, you can modify the following files:
- [docker/manager-elastic.yml](../docker/manager-elastic.yml): Docker Compose file.
- [docker/compose.manager-elastic.yml](../docker/compose.manager-elastic.yml): Docker Compose file.
- [elastic/logstash/pipeline/manager-to-elastic.conf](./logstash/pipeline/manager-to-elastic.conf): Logstash Pipeline configuration file.

Check the files above for **credentials**, ports, and other configurations.
Expand Down
8 changes: 4 additions & 4 deletions integrations/opensearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ This document describes how to prepare a Docker Compose environment to test the
1. Clone the Wazuh repository and navigate to the `integrations/` folder.
2. Run the following command to start the environment:
```bash
docker compose -f ./docker/opensearch.yml up -d
docker compose -f ./docker/compose.indexer-opensearch.yml up -d
```
3. If you prefer, you can start the integration with the Wazuh Manager as data source:
```bash
docker compose -f ./docker/manager-opensearch.yml up -d
docker compose -f ./docker/compose.manager-opensearch.yml up -d
```

The Docker Compose project will bring up the following services:
Expand All @@ -29,12 +29,12 @@ The Docker Compose project will bring up the following services:

For custom configurations, you may need to modify these files:

- [docker/opensearch.yml](../docker/opensearch.yml): Docker Compose file.
- [docker/compose.indexer-opensearch.yml](../docker/compose.indexer-opensearch.yml): Docker Compose file.
- [docker/.env](../docker/.env): Environment variables file.
- [opensearch/logstash/pipeline/indexer-to-opensearch.conf](./logstash/pipeline/indexer-to-opensearch.conf): Logstash Pipeline configuration file.

If you opted to start the integration with the Wazuh Manager, you can modify the following files:
- [docker/manager-opensearch.yml](../docker/manager-opensearch.yml): Docker Compose file.
- [docker/compose.manager-opensearch.yml](../docker/compose.manager-opensearch.yml): Docker Compose file.
- [opensearch/logstash/pipeline/manager-to-opensearch.conf](./logstash/pipeline/manager-to-opensearch.conf): Logstash Pipeline configuration file.

Check the files above for **credentials**, ports, and other configurations.
Expand Down
8 changes: 4 additions & 4 deletions integrations/splunk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ This document describes how to prepare a Docker Compose environment to test the
1. Clone the Wazuh repository and navigate to the `integrations/` folder.
2. Run the following command to start the environment:
```bash
docker compose -f ./docker/splunk.yml up -d
docker compose -f ./docker/compose.indexer-splunk.yml up -d
```
3. If you prefer, you can start the integration with the Wazuh Manager as data source:
```bash
docker compose -f ./docker/manager-splunk.yml up -d
docker compose -f ./docker/compose.manager-splunk.yml up -d
```

The Docker Compose project will bring up the following services:
Expand All @@ -28,12 +28,12 @@ The Docker Compose project will bring up the following services:

For custom configurations, you may need to modify these files:

- [docker/splunk.yml](../docker/splunk.yml): Docker Compose file.
- [docker/compose.indexer-splunk.yml](../docker/compose.indexer-splunk.yml): Docker Compose file.
- [docker/.env](../docker/.env): Environment variables file.
- [splunk/logstash/pipeline/indexer-to-splunk.conf](./logstash/pipeline/indexer-to-splunk.conf): Logstash Pipeline configuration file.

If you opted to start the integration with the Wazuh Manager, you can modify the following files:
- [docker/manager-splunk.yml](../docker/manager-splunk.yml): Docker Compose file.
- [docker/compose.manager-splunk.yml](../docker/compose.manager-splunk.yml): Docker Compose file.
- [splunk/logstash/pipeline/manager-to-splunk.conf](./logstash/pipeline/manager-to-splunk.conf): Logstash Pipeline configuration file.

Check the files above for **credentials**, ports, and other configurations.
Expand Down

0 comments on commit d85285a

Please sign in to comment.