Skip to content

Commit

Permalink
refactoring documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
banderson0421 authored and banderson0421 committed Nov 15, 2023
1 parent d0b0ccb commit 7a7fd79
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 12 deletions.
2 changes: 1 addition & 1 deletion GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ HOSTNAME=registry.terraform.io
NAMESPACE=terraform-providers
PKG_NAME=dsfhub
BINARY=terraform-provider-${PKG_NAME}
VERSION=1.2.20
VERSION=1.2.21
OS_ARCH=darwin_amd64

default: install
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The DSF Agentless Gateway requires the following IAM permissions to access an [A
## Variable Reference

```
# Variables for the DSF Agentless-Gateway IAM permissions granting access to AWS Secrets Manager
variable "aws_secretsmanager_access_tokens_arn" {
description = "The email address to notify about this asset"
default = null
Expand Down
6 changes: 3 additions & 3 deletions website/docs/guides/module_aws_rds_mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ resource "dsfhub_log_aggregator" "rds-mysql-db-log-group" {
The [DSF Agentless Gateway](https://registry.terraform.io/modules/imperva/dsf-agentless-gw/aws/latest) is required to have [AWS IAM Role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) access to the AWS service the database is configured to publish logs to in order to consume audit.

<ul>
<li><a target="_blank" href="../guides/iam_aws_kinesis.md">AWS IAM Permissions for Kinesis Streams</a></li>
<li><a target="_blank" href="../guides/iam_aws_log_group.md">AWS IAM Permissions for CloudWatch Log Groups</a></li>
<li><a target="_blank" href="../guides/iam_aws_secrets.md">AWS IAM Permissions for Secret Manager</a></li>
<li><a target="_blank" href="aws_iam_kinesis.md">AWS IAM Permissions for Kinesis Streams</a></li>
<li><a target="_blank" href="aws_iam_log_group.md">AWS IAM Permissions for CloudWatch Log Groups</a></li>
<li><a target="_blank" href="aws_iam_secrets.md">AWS IAM Permissions for Secret Manager</a></li>
</ul>
28 changes: 20 additions & 8 deletions website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ The DSFHUB provider is used to interact with Data Security Fabric Hub resources

Use the navigation to the left to read about the available resources.

## Example Usage - Resources
## DSFHUB Provider Argument Reference

The following arguments are supported:

* `dsfhub_host` - (Required) The DSF host endpoint for [DSF HUB API](https://docs.imperva.com/bundle/v4.13-sonar-user-guide/page/84552.htm) operations. Example: 'https://1.2.3.4:8443'. Can be set via `TF_VAR_dsfhub_host` shell [environment variable](https://en.wikipedia.org/wiki/Environment_variable).
* `dsfhub_token` - (Required) The [DSF API Token](https://docs.imperva.com/bundle/v4.13-sonar-user-guide/page/84555.htm) for API operations. You can retrieve this from the DSF management hub console. Can be set via `TF_VAR_dsfhub_token` shell [environment variable](https://en.wikipedia.org/wiki/Environment_variable).
* `insecure_ssl` - (Optional) The boolean flag that instructs the provider to allow for insecure SSL API calls to a DSF Hub instance to support tests against instances with self-signed certificates.

```hcl
# Specify path for provider
Expand All @@ -30,7 +36,11 @@ provider "dsfhub" {
dsfhub_host = "${var.dsfhub_host}"
dsfhub_token = "${var.dsfhub_token}"
}
```

## Example Usage - dsfhub_cloud_account

```hcl
# Example generic variable reference:
variable "admin_email" {
default = "[email protected]"
Expand Down Expand Up @@ -64,6 +74,11 @@ resource "dsfhub_cloud_account" "example_aws_cloud_account" {
}
}
```

## Example Usage - dsfhub_data_source

```hcl
# Example dsfhub_data_source specific variables for AWS RDS MYSQL
variable "data_source_aws_rds_mysql_asset_display_name" {
default = "arn:partition:service:region:account-id"
Expand Down Expand Up @@ -97,7 +112,11 @@ resource "dsfhub_data_source" "aws_rds_mysql_password" {
username = var.data_source_aws_rds_mysql_username
}
}
```

## Example Usage - dsfhub_log_aggregator

```hcl
# Example dsfhub_log_aggregator specific variables for AWS LOG GROUP
variable "log_aggregator_aws_log_group_asset_display_name" {
default = "arn:partition:service:region:account-id"
Expand Down Expand Up @@ -129,10 +148,3 @@ resource "dsfhub_log_aggregator" "example_aws_log_group_default" {
}
```

## DSFHUB Provider Argument Reference

The following arguments are supported:

* `dsfhub_host` - (Required) The DSF host endpoint for [DSF HUB API](https://docs.imperva.com/bundle/v4.13-sonar-user-guide/page/84552.htm) operations. Example: 'https://1.2.3.4:8443'. Can be set via `TF_VAR_dsfhub_host` shell [environment variable](https://en.wikipedia.org/wiki/Environment_variable).
* `dsfhub_token` - (Required) The [DSF API Token](https://docs.imperva.com/bundle/v4.13-sonar-user-guide/page/84555.htm) for API operations. You can retrieve this from the DSF management hub console. Can be set via `TF_VAR_dsfhub_token` shell [environment variable](https://en.wikipedia.org/wiki/Environment_variable).
* `insecure_ssl` - (Optional) The boolean flag that instructs the provider to allow for insecure SSL API calls to a DSF Hub instance to support tests against instances with self-signed certificates.

0 comments on commit 7a7fd79

Please sign in to comment.