Skip to content

Commit

Permalink
update example READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattJsonar committed Jul 11, 2024
1 parent f35e361 commit 908107f
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 1 deletion.
2 changes: 1 addition & 1 deletion examples/onboard-aws-neptune-slow-query/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Onboard Amazon Neptune Slowquery example
# Onboard Amazon Neptune with Slow Query example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/Amazon-Neptune-Onboarding-Steps_48367003.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
Expand Down
11 changes: 11 additions & 0 deletions examples/onboard-aws-rds-mariadb/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Onboard Amazon RDS for MariaDB example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/Amazon-RDS-for-MariaDB-Onboarding-Steps_48367019.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
- [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
- [dsfhub](https://registry.terraform.io/providers/imperva/dsfhub/latest/docs)

## Prerequisites
### Account Asset Permissions
An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group.

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down
11 changes: 11 additions & 0 deletions examples/onboard-aws-rds-mysql-slow-query/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Onboard Amazon RDS for MySQL with Slow Query example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/Amazon-RDS-for-MySQL-Onboarding-Steps_48367035.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
- [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
- [dsfhub](https://registry.terraform.io/providers/imperva/dsfhub/latest/docs)

## Prerequisites
### Account Asset Permissions
An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group.

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down
11 changes: 11 additions & 0 deletions examples/onboard-aws-rds-mysql/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Onboard Amazon RDS for MySQL example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/Amazon-RDS-for-MySQL-Onboarding-Steps_48367035.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
- [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
- [dsfhub](https://registry.terraform.io/providers/imperva/dsfhub/latest/docs)

## Prerequisites
### Account Asset Permissions
An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group.

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down
16 changes: 16 additions & 0 deletions examples/onboard-aws-rds-oracle-standard/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Onboard Amazon RDS for Oracle (Standard Audit via CloudWatch) example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/48367051.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
- [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
- [dsfhub](https://registry.terraform.io/providers/imperva/dsfhub/latest/docs)

## Prerequisites
### Account Asset Permissions
An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group.

### Database Configuration
Part of the onboarding process involves connecting to your RDS Oracle instance and running SQL commands to create an audit policy. This module includes an example for how to connect to the instance from your local machine and create this.

**Note:** This example requires the ``sqlplus`` client to be installed, as well as for the newly created RDS instance to be accessible from your local machine.

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down
13 changes: 13 additions & 0 deletions examples/onboard-aws-rds-oracle-unified/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Onboard Amazon RDS for Oracle (Standard Audit via CloudWatch) example
This example includes additional prerequisites that will need to be completed to fully utilize the module. More details can be found in the [onboarding documentation](https://docs.imperva.com/bundle/onboarding-databases-to-sonar-reference-guide/page/48367067.html).

This example creates both 'aws' and 'dsfhub' resources. More information regarding authentication to each can be found in the relevant provider documentation:
- [aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs)
- [dsfhub](https://registry.terraform.io/providers/imperva/dsfhub/latest/docs)

## Prerequisites
### Database Configuration
Part of the onboarding process involves connecting to your RDS Oracle instance and running SQL commands to create an audit pull user, as well as an audit policy. This module includes an example for how to connect to the instance from your local machine and create both of these.

**Note:** This example requires the ``sqlplus`` client to be installed, as well as for the newly created RDS instance to be accessible from your local machine.

<!-- BEGIN_TF_DOCS -->
## Requirements

Expand Down

0 comments on commit 908107f

Please sign in to comment.