From 8d9a3a9b7b845458686c6792162fe1692c460c24 Mon Sep 17 00:00:00 2001 From: Erica Pescio Date: Mon, 7 Jul 2025 11:18:07 +0200 Subject: [PATCH 1/2] docs:added links to examples dirs --- docs/ConfigureHEC/index.md | 6 +++++- docs/ConfigureKinesis/index.md | 6 +++++- docs/ConfigureS3/index.md | 6 +++++- docs/GenesysCloudTopics/index.md | 4 ++-- docs/Troubleshooting/index.md | 2 +- docs/UseCasesOverview/index.md | 1 + 6 files changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/ConfigureHEC/index.md b/docs/ConfigureHEC/index.md index 5e73977..d6247d1 100644 --- a/docs/ConfigureHEC/index.md +++ b/docs/ConfigureHEC/index.md @@ -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 @@ -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" { diff --git a/docs/ConfigureKinesis/index.md b/docs/ConfigureKinesis/index.md index 5447048..de19b8b 100644 --- a/docs/ConfigureKinesis/index.md +++ b/docs/ConfigureKinesis/index.md @@ -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 @@ -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" { diff --git a/docs/ConfigureS3/index.md b/docs/ConfigureS3/index.md index dd8845c..a15ca6c 100644 --- a/docs/ConfigureS3/index.md +++ b/docs/ConfigureS3/index.md @@ -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 @@ -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" { diff --git a/docs/GenesysCloudTopics/index.md b/docs/GenesysCloudTopics/index.md index b65bb31..90c26ce 100644 --- a/docs/GenesysCloudTopics/index.md +++ b/docs/GenesysCloudTopics/index.md @@ -25,13 +25,13 @@ By default this module configures Genesys Cloud to monitor the following list of | `v2.detail.events.conversation.{id}.user.start` | Topic for analytics detail event type: `UserStartEvent`. | | `v2.detail.events.conversation.{id}.voicemail.end` | Topic for analytics detail event type: `VoicemailEndEvent`. | | `v2.detail.events.conversation.{id}.voicemail.start` | Topic for analytics detail event type: `VoicemailStartEvent`. | -| `v2.detail.events.conversation.{id}.wrapup` | Topic for analytics detail event type: `WrapupEvent` containing system wrapups. | +| `v2.detail.events.conversation.{id}.wrapup |` Topic for analytics detail event type: `WrapupEvent` containing system wrapups. | 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//main.tf` as shown below. diff --git a/docs/Troubleshooting/index.md b/docs/Troubleshooting/index.md index 7b3ab63..a3c970a 100644 --- a/docs/Troubleshooting/index.md +++ b/docs/Troubleshooting/index.md @@ -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 diff --git a/docs/UseCasesOverview/index.md b/docs/UseCasesOverview/index.md index 8223380..ee50b5f 100644 --- a/docs/UseCasesOverview/index.md +++ b/docs/UseCasesOverview/index.md @@ -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 From c5d1a219849c31fdff1bce5a8b5045455e4e93db Mon Sep 17 00:00:00 2001 From: Erica Pescio Date: Mon, 7 Jul 2025 11:22:45 +0200 Subject: [PATCH 2/2] doc(fix):minor fix --- docs/GenesysCloudTopics/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/GenesysCloudTopics/index.md b/docs/GenesysCloudTopics/index.md index 90c26ce..94f5841 100644 --- a/docs/GenesysCloudTopics/index.md +++ b/docs/GenesysCloudTopics/index.md @@ -25,7 +25,7 @@ By default this module configures Genesys Cloud to monitor the following list of | `v2.detail.events.conversation.{id}.user.start` | Topic for analytics detail event type: `UserStartEvent`. | | `v2.detail.events.conversation.{id}.voicemail.end` | Topic for analytics detail event type: `VoicemailEndEvent`. | | `v2.detail.events.conversation.{id}.voicemail.start` | Topic for analytics detail event type: `VoicemailStartEvent`. | -| `v2.detail.events.conversation.{id}.wrapup |` Topic for analytics detail event type: `WrapupEvent` containing system wrapups. | +| `v2.detail.events.conversation.{id}.wrapup` | Topic for analytics detail event type: `WrapupEvent` containing system wrapups. | 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.