Skip to content

Commit

Permalink
Added example usage to README (#5)
Browse files Browse the repository at this point in the history
Co-authored-by: John Dewey <[email protected]>
  • Loading branch information
retr0h and John Dewey authored Jun 6, 2024
1 parent 9899d14 commit 6862247
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,43 @@
# terraform-azure-enrichment

Terraform for Corelight's Azure Cloud Enrichment.

## Getting Started

Corelight's Azure Cloud Enrichment requires the deployment of an Azure Container App and its
supporting infrastructure to ensure the data in your Corelight cloud sensors are
always up-to-date with the latest state of your cloud resources.

### Deployment
## Usage

```terraform
module "enrichment" {
source = "github.com/corelight/terraform-azure-enrichment"
resource_group_name = "<Name of the resource group where resources will be deployed>"
enrichment_storage_account = "<storage account where enrichment data will be centralized>"
enrichment_storage_account_container = "<storage account container that will store the cloud resource data>"
event_grid_system_topic_name = "<name of the event grid system topic>"
location = "<Azure location where resources will be deployed>"
subscription_id = "the ID (UUID) of the Azure Subscription where resources will be deployed>"
tags = {
terraform : true,
example : true,
purpose : "Corelight"
}
}
```

## Deployment

The variables for this module all have default values that can be overwritten
to meet your naming and compliance standards.
to meet your naming and compliance standards.

Deployment examples can be found [here](examples)

## License

The project is licensed under the [MIT][] license.

[MIT]: LICENSE
[MIT]: LICENSE
4 changes: 2 additions & 2 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ variable "enrichment_role_definition_name" {
}

variable "tags" {
description = "Any tags that should be applied to resources deployed by the module"
description = "(optional) Any tags that should be applied to resources deployed by the module"
type = object({})
default = {}
}
}

0 comments on commit 6862247

Please sign in to comment.