Skip to content
Merged
Show file tree
Hide file tree
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
6 changes: 5 additions & 1 deletion docs/ConfigureHEC/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
To avoid losing data, the Splunk HTTP Event Collector (HEC) shall be already configured and ready to receive data.

## Set the Environment Variables
Clone the [repository](https://github.com/splunk/terraform-genesyscloud-aws) and execute:

```bash
$~ cd examples/hec
$~ cp .env-example .env
Expand All @@ -13,8 +15,10 @@ $~ vi .env
$~ source .env
```

:books: [Clone a GitHub Repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)

## Configure the Deployment
Edit `examples/hec/main.tf` as explained below
Edit [examples/hec/main.tf](https://github.com/splunk/terraform-genesyscloud-aws/tree/main/examples/hec/main.tf) as explained below

```hcl
module "main" {
Expand Down
6 changes: 5 additions & 1 deletion docs/ConfigureKinesis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
![Configure Kinesis](../static/configure-kinesis.png)

## Set the Environment Variables
Clone the [repository](https://github.com/splunk/terraform-genesyscloud-aws) and execute:

```bash
$~ cd examples/kinesis
$~ cp .env-example .env
Expand All @@ -11,8 +13,10 @@ $~ vi .env
$~ source .env
```

:books: [Clone a GitHub Repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)

## Configure the Integration
Edit `examples/kinesis/main.tf` as explained below
Edit [examples/kinesis/main.tf](https://github.com/splunk/terraform-genesyscloud-aws/tree/main/examples/kinesis/main.tf) as explained below

```hcl
module "main" {
Expand Down
6 changes: 5 additions & 1 deletion docs/ConfigureS3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
![Configure S3](../static/configure-s3.png)

## Set the Environment Variables
Clone the [repository](https://github.com/splunk/terraform-genesyscloud-aws) and execute:

```bash
$~ cd examples/s3
$~ cp .env-example .env
Expand All @@ -11,8 +13,10 @@ $~ vi .env
$~ source .env
```

:books: [Clone a GitHub Repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)

## Configure the Integration
Edit `examples/s3/main.tf` as explained below
Edit [examples/s3/main.tf](https://github.com/splunk/terraform-genesyscloud-aws/tree/main/examples/s3/main.tf) as explained below

```hcl
module "main" {
Expand Down
2 changes: 1 addition & 1 deletion docs/GenesysCloudTopics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ By default this module configures Genesys Cloud to monitor the following list of
A full list of available topics can be found [here](https://developer.genesys.cloud/notificationsalerts/notifications/available-topics). Please select the `Event Bridge` checkbox to filter the supported topics.

## Advanced Configuration
To add / remove topics from the configuration, please edit the variable `topic_filters` in `variables.tf`. This configuration will be applied to all use case scenarios.
To add / remove topics from the configuration, please edit the variable `topic_filters` in [variables.tf](https://github.com/splunk/terraform-genesyscloud-aws/tree/main/variables.tf). This configuration will be applied to all use case scenarios.

To configure **only a specific use case**, edit the `examples/<your_use_case>/main.tf` as shown below.

Expand Down
2 changes: 1 addition & 1 deletion docs/Troubleshooting/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Troubleshooting

* `409` error (`BucketAlreadyExists`)
* the name of the bucket terraform is trying to create is not unique within your AWS region :point_right: set a different s3_bucket_name in `variables.tf`
* the name of the bucket terraform is trying to create is not unique within your AWS region :point_right: set a different s3_bucket_name in `variables.tf`

* The script is stuck or you get a `403`
* there is a permission issue :point_right: make sure you have set the environment variables by running `source .env` and that you have the required permissions to create the required resources in AWS
1 change: 1 addition & 0 deletions docs/UseCasesOverview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Each scenario has pros and cons, please decide the deployment depending on your
Excluding AWS from the solution is (apparently) viable but consider that:

* Splunk and Genesys Cloud instances should be in close proximity i.e. running in the same continent. Otherwise you may experience latency, retransmissions, higher package loss

> AWS EventBridge retransmits events in case of failures..

* Splunk must be adequately sized to handle events spikes that could increase the load on the instance
Loading