Skip to content

Commit 9040d92

Browse files
author
Drew Meyers
committed
chore: Update resource naming convention
1 parent 9fb03f3 commit 9040d92

File tree

13 files changed

+41
-59
lines changed

13 files changed

+41
-59
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -177,28 +177,28 @@ In this case, the router sees that the action is `submit_dag_by_id` and thus mak
177177

178178
## Contents
179179

180-
- [Features](#features)
181-
- [Contents](#contents)
182-
- [Quick Start](#quick-start)
183-
- [Requirements](#requirements)
184-
- [Setting Up the End-to-End Demo](#setting-up-the-end-to-end-demo)
185-
- [Deploying the Initiator](#deploying-the-initiator)
186-
- [Deploying an Example Evaluator (SNS topic-\>SQS queue-\>Lambda)](#deploying-an-example-evaluator-sns-topic-sqs-queue-lambda)
187-
- [Deploying an S3 Event Notification Trigger](#deploying-an-s3-event-notification-trigger)
188-
- [Verify End-to-End Functionality (part 1)](#verify-end-to-end-functionality-part-1)
189-
- [Deploying an EventBridge Scheduler Trigger](#deploying-an-eventbridge-scheduler-trigger)
190-
- [Verify End-to-End Functionality (part 2)](#verify-end-to-end-functionality-part-2)
191-
- [Deploying an EventBridge Scheduler Trigger for Periodic CMR Queries](#deploying-an-eventbridge-scheduler-trigger-for-periodic-cmr-queries)
192-
- [Verify End-to-End Functionality (part 3)](#verify-end-to-end-functionality-part-3)
193-
- [Tear Down](#tear-down)
194-
- [Setup Instructions for Development](#setup-instructions-for-development)
195-
- [Build Instructions](#build-instructions)
196-
- [Test Instructions](#test-instructions)
197-
- [Changelog](#changelog)
198-
- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
199-
- [Contributing](#contributing)
200-
- [License](#license)
201-
- [References](#references)
180+
* [Features](#features)
181+
* [Contents](#contents)
182+
* [Quick Start](#quick-start)
183+
* [Requirements](#requirements)
184+
* [Setting Up the End-to-End Demo](#setting-up-the-end-to-end-demo)
185+
* [Deploying the Initiator](#deploying-the-initiator)
186+
* [Deploying an Example Evaluator (SNS topic-\>SQS queue-\>Lambda)](#deploying-an-example-evaluator-sns-topic-sqs-queue-lambda)
187+
* [Deploying an S3 Event Notification Trigger](#deploying-an-s3-event-notification-trigger)
188+
* [Verify End-to-End Functionality (part 1)](#verify-end-to-end-functionality-part-1)
189+
* [Deploying an EventBridge Scheduler Trigger](#deploying-an-eventbridge-scheduler-trigger)
190+
* [Verify End-to-End Functionality (part 2)](#verify-end-to-end-functionality-part-2)
191+
* [Deploying an EventBridge Scheduler Trigger for Periodic CMR Queries](#deploying-an-eventbridge-scheduler-trigger-for-periodic-cmr-queries)
192+
* [Verify End-to-End Functionality (part 3)](#verify-end-to-end-functionality-part-3)
193+
* [Tear Down](#tear-down)
194+
* [Setup Instructions for Development](#setup-instructions-for-development)
195+
* [Build Instructions](#build-instructions)
196+
* [Test Instructions](#test-instructions)
197+
* [Changelog](#changelog)
198+
* [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
199+
* [Contributing](#contributing)
200+
* [License](#license)
201+
* [References](#references)
202202

203203
## Quick Start
204204

@@ -253,10 +253,10 @@ This guide provides a quick way to get started with our project. Please see our
253253
export CONFIG_BUCKET=<some S3 bucket name>
254254
```
255255

256-
1. Set a deployment name:
256+
1. Set a project name:
257257

258258
```
259-
export DEPLOYMENT_NAME=gmanipon-test
259+
export PROJECT=gmanipon-test
260260
```
261261

262262
1. Initialize terraform:
@@ -269,7 +269,7 @@ This guide provides a quick way to get started with our project. Please see our
269269

270270
```
271271
terraform apply \
272-
--var deployment_name=${DEPLOYMENT_NAME} \
272+
--var project=${PROJECT} \
273273
--var code_bucket=${CODE_BUCKET} \
274274
--var config_bucket=${CONFIG_BUCKET} \
275275
--var router_config=test_router.yaml \
@@ -400,11 +400,11 @@ This guide provides a quick way to get started with our project. Please see our
400400
terraform init
401401
```
402402

403-
1. Run terraform apply. Note the DEPLOYMENT_NAME and INITIATOR_TOPIC_ARN environment variables should have been set in the previous steps. If not set them again:
403+
1. Run terraform apply. Note the PROJECT and INITIATOR_TOPIC_ARN environment variables should have been set in the previous steps. If not set them again:
404404

405405
```
406406
terraform apply \
407-
--var deployment_name=${DEPLOYMENT_NAME} \
407+
--var project=${PROJECT} \
408408
--var initiator_topic_arn=${INITIATOR_TOPIC_ARN} \
409409
-auto-approve
410410
```
@@ -452,11 +452,11 @@ This guide provides a quick way to get started with our project. Please see our
452452
terraform init
453453
```
454454

455-
1. Run terraform apply. Note the DEPLOYMENT_NAME, CODE_BUCKET and INITIATOR_TOPIC_ARN environment variables should have been set in the previous steps. If not set them again:
455+
1. Run terraform apply. Note the PROJECT, CODE_BUCKET and INITIATOR_TOPIC_ARN environment variables should have been set in the previous steps. If not set them again:
456456

457457
```
458458
terraform apply \
459-
--var deployment_name=${DEPLOYMENT_NAME} \
459+
--var project=${PROJECT} \
460460
--var code_bucket=${CODE_BUCKET} \
461461
--var initiator_topic_arn=${INITIATOR_TOPIC_ARN} \
462462
--var provider_id=${PROVIDER_ID} \

terraform-unity/initiator/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ No modules.
5050
| Name | Description | Type | Default | Required |
5151
|------|-------------|------|---------|:--------:|
5252
| <a name="input_code_bucket"></a> [code\_bucket](#input\_code\_bucket) | The S3 bucket where lambda zip files will be stored and accessed | `string` | n/a | yes |
53-
| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | The deployment name | `string` | n/a | yes |
5453
| <a name="input_project"></a> [project](#input\_project) | The unity project its installed into | `string` | `"uod"` | no |
5554
| <a name="input_router_config"></a> [router\_config](#input\_router\_config) | The S3 URL to the router configuration file | `string` | n/a | yes |
5655
| <a name="input_venue"></a> [venue](#input\_venue) | The unity venue its installed into | `string` | `"dev"` | no |

terraform-unity/initiator/locals.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
locals {
2-
function_name = "${var.project}-${var.venue}-${var.deployment_name}-inititator"
2+
function_name = "${var.project}-${var.venue}-inititator"
33
tags = {
44
Venue = "dev"
55
ServiceArea = "cs"

terraform-unity/initiator/main.tf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ resource "aws_s3_object" "lambda_package" {
1919

2020
resource "aws_lambda_function" "initiator_lambda" {
2121
depends_on = [aws_s3_object.lambda_package, aws_cloudwatch_log_group.initiator_lambda]
22-
function_name = "${var.project}-${var.venue}-${var.deployment_name}-inititator"
22+
function_name = "${var.project}-${var.venue}-inititator"
2323
s3_bucket = var.code_bucket
2424
s3_key = "unity_initiator-${jsondecode(data.local_file.version.content).version}-lambda.zip"
2525
handler = "unity_initiator.cloud.lambda_handler.lambda_handler_initiator"
@@ -36,13 +36,13 @@ resource "aws_lambda_function" "initiator_lambda" {
3636
}
3737

3838
resource "aws_cloudwatch_log_group" "initiator_lambda" {
39-
name = "/aws/lambda/${var.project}-${var.venue}-${var.deployment_name}-inititator"
39+
name = "/aws/lambda/${var.project}-${var.venue}-inititator"
4040
retention_in_days = 14
4141
tags = local.tags
4242
}
4343

4444
resource "aws_iam_role" "initiator_lambda_iam_role" {
45-
name = "${var.project}-${var.venue}-${var.deployment_name}-initiator_lambda_iam_role"
45+
name = "${var.project}-${var.venue}-initiator_lambda_iam_role"
4646

4747
assume_role_policy = jsonencode({
4848
Version = "2012-10-17",
@@ -61,7 +61,7 @@ resource "aws_iam_role" "initiator_lambda_iam_role" {
6161
}
6262

6363
resource "aws_iam_policy" "initiator_lambda_policy" {
64-
name = "${var.project}-${var.venue}-${var.deployment_name}-initiator_lambda_policy"
64+
name = "${var.project}-${var.venue}-initiator_lambda_policy"
6565
description = "A policy for the initiator lambda function to access S3 and SQS"
6666

6767
policy = jsonencode({

terraform-unity/initiator/variables.tf

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
variable "deployment_name" {
2-
description = "The deployment name"
3-
type = string
4-
}
5-
61
variable "project" {
72
description = "The unity project its installed into"
83
type = string

terraform-unity/triggers/cmr_query/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
| Name | Version |
77
|------|---------|
8-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.4.6 |
8+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.8.2 |
99
| <a name="requirement_archive"></a> [archive](#requirement\_archive) | >=2.4.2 |
1010
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >=5.50.0 |
1111
| <a name="requirement_local"></a> [local](#requirement\_local) | >=2.5.1 |
@@ -52,7 +52,6 @@ No modules.
5252
|------|-------------|------|---------|:--------:|
5353
| <a name="input_code_bucket"></a> [code\_bucket](#input\_code\_bucket) | The S3 bucket where lambda zip files will be stored and accessed | `string` | n/a | yes |
5454
| <a name="input_concept_id"></a> [concept\_id](#input\_concept\_id) | The concept ID for the data collection: https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#granule-search-by-parameters | `string` | n/a | yes |
55-
| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | The deployment name | `string` | n/a | yes |
5655
| <a name="input_initiator_topic_arn"></a> [initiator\_topic\_arn](#input\_initiator\_topic\_arn) | The ARN of the initiator SNS topic to publish S3 events to | `string` | n/a | yes |
5756
| <a name="input_project"></a> [project](#input\_project) | The unity project its installed into | `string` | `"uod"` | no |
5857
| <a name="input_provider_id"></a> [provider\_id](#input\_provider\_id) | The short name for the data provider: https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#granule-search-by-parameters | `string` | n/a | yes |

terraform-unity/triggers/cmr_query/locals.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
locals {
2-
function_name = "${var.project}-${var.venue}-${var.deployment_name}-cmr_query"
2+
function_name = "${var.project}-${var.venue}-cmr_query"
33
tags = {
44
Venue = "dev"
55
ServiceArea = "cs"

terraform-unity/triggers/cmr_query/variables.tf

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
variable "deployment_name" {
2-
description = "The deployment name"
3-
type = string
4-
}
5-
61
variable "project" {
72
description = "The unity project its installed into"
83
type = string

terraform-unity/triggers/cmr_query/versions.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
terraform {
2-
required_version = "~> 1.4.6"
2+
required_version = "~> 1.8.2"
33

44
required_providers {
55
archive = {

terraform-unity/triggers/scheduled-task/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ No modules.
4242

4343
| Name | Description | Type | Default | Required |
4444
|------|-------------|------|---------|:--------:|
45-
| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | The deployment name | `string` | n/a | yes |
4645
| <a name="input_initiator_topic_arn"></a> [initiator\_topic\_arn](#input\_initiator\_topic\_arn) | The ARN of the initiator SNS topic to publish S3 events to | `string` | n/a | yes |
4746
| <a name="input_project"></a> [project](#input\_project) | The unity project its installed into | `string` | `"uod"` | no |
4847
| <a name="input_venue"></a> [venue](#input\_venue) | The unity venue its installed into | `string` | `"dev"` | no |

0 commit comments

Comments
 (0)