Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tags to the README's usage #8

Merged
merged 1 commit into from
Jun 6, 2024
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
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,31 @@
<img src="docs/overview.svg" alt="overview">

## Usage
```terraform

```terraform
module "enrichment" {
source = "github.com/corelight/terraform-aws-enrichment"

corelight_cloud_enrichment_image = "123456789111.dkr.ecr.us-east-1.amazonaws.com/corelight-sensor-enrichment-aws"
corelight_cloud_enrichment_image_tag = "0.1.0"
enrichment_bucket_name = "corelight-enrichment"

tags = {
terraform : true,
example : true,
purpose : "Corelight"
}
}
```

## Preparation

Image based Lambdas must be deployed from a private Elastic Container Registry (ECR)
repository and therefore the data collection serverless container image provided by
Image based Lambdas must be deployed from a private Elastic Container Registry (ECR)
repository and therefore the data collection serverless container image provided by
Corelight must be copied from Dockerhub and pushed to your own ECR repository.

#### Copying the Corelight image

Log into the destination ECR

```bash
Expand Down Expand Up @@ -49,7 +56,7 @@ docker pull $SRC_IMAGE
# Copy Image to ECR
skopeo copy docker://$SRC_IMAGE docker://$DST_IMAGE --dest-tls-verify
```
If you would prefer not to use Skopeo then the image will need to be pulled, tagged, and pushed
If you would prefer not to use Skopeo then the image will need to be pulled, tagged, and pushed
to ECR manually.

```bash
Expand Down Expand Up @@ -85,4 +92,4 @@ Deployment examples can be found [here](examples)

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

[MIT]: LICENSE
[MIT]: LICENSE
4 changes: 2 additions & 2 deletions modules/secondary_event_rule/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ variable "cross_region_eventbridge_role_arn" {

### Variables with Defaults
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 = {}
}
}
4 changes: 2 additions & 2 deletions modules/sensor_iam/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ variable "corelight_sensor_policy_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 = {}
}
}
4 changes: 2 additions & 2 deletions variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ variable "scheduled_sync_regions" {
}

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 = {}
}
}