feat: rename collection stack (#209)

For parity with terraform, let's rename the collection stack to simply "stack". This has the disadvantage of clashing with cloudformation nomenclature ("stack" is the instantiation of a template), but it matches how people refer to artefact ("install the Observe cloudformation stack").
observeinc · Mar 21, 2024 · c258f1c · c258f1c
1 parent f0955b2
commit c258f1c
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 33 deletions.
diff --git a/README.md b/README.md
diff --git a/apps/collection/README.md b/apps/collection/README.md
diff --git a/apps/stack/README.md b/apps/stack/README.md
@@ -0,0 +1,3 @@
+# AWS Stack
+
+[docs/stack.md](../docs/stack.md)
diff --git a/apps/collection/template.yaml → apps/stack/template.yaml b/apps/collection/template.yaml → apps/stack/template.yaml
@@ -2,7 +2,7 @@
 AWSTemplateFormatVersion: '2010-09-09'
 Transform: AWS::Serverless-2016-10-31
 Description: >
-  Collect AWS data towards Observe.
+  Collect resource, logs and metrics from AWS
 Metadata:
   AWS::ServerlessRepo::Application:
     Name: observe-aws-collection

diff --git a/docs/collection.md → docs/stack.md b/docs/collection.md → docs/stack.md
@@ -1,6 +1,6 @@
-# Observe AWS Data Collection
+# Observe AWS Stack
 
-The Observe AWS Collection stack is designed to aggregate and forward a wide range of AWS resource data, logs, and metrics to Observe, facilitating comprehensive observability of your AWS environment.
+The Observe AWS stack is designed to aggregate and forward a wide range of AWS resource data, logs, and metrics to Observe, facilitating comprehensive observability of your AWS environment.
 
 ## Overview
 
@@ -39,7 +39,7 @@ The stack provisions a range of AWS resources, including an SNS topic for notifi
 
 ## Deployment
 
-To deploy the Observe AWS Collection stack, provide the necessary parameters such as `DataAccessPointArn` and `DestinationUri`. Use the AWS SAM CLI or CloudFormation for deployment.
+To deploy the Observe Stack, provide the necessary parameters such as `DataAccessPointArn` and `DestinationUri`. Use the AWS SAM CLI or CloudFormation for deployment.
 
 ## Usage
 

diff --git a/generate_table.sh b/generate_table.sh
@@ -4,7 +4,7 @@
 regions=$(aws ec2 describe-regions --query "Regions[].RegionName" --output text | tr '\t' '\n')
 
 # Initialize the table with headers
-echo "| Collection | Config | Forwarder |"
+echo "| Stack | Config | Forwarder |"
 echo "|------------|--------|-----------|"
 
 # Generate rows for each region
@@ -16,10 +16,10 @@ for region in $regions; do
     badge_md="![Static Badge](https://img.shields.io/badge/$normalized_region-latest-blue?logo=amazonaws)"
 
     # Create CloudFormation console links
-    collection_link="https://$region.console.aws.amazon.com/cloudformation/home?region=$region#/stacks/create/review?templateURL=https://observeinc-$region.s3.amazonaws.com/apps/collection/latest/packaged.yaml"
+    stack_link="https://$region.console.aws.amazon.com/cloudformation/home?region=$region#/stacks/create/review?templateURL=https://observeinc-$region.s3.amazonaws.com/apps/stack/latest/packaged.yaml"
     config_link="https://$region.console.aws.amazon.com/cloudformation/home?region=$region#/stacks/create/review?templateURL=https://observeinc-$region.s3.amazonaws.com/apps/config/latest/packaged.yaml"
     forwarder_link="https://$region.console.aws.amazon.com/cloudformation/home?region=$region#/stacks/create/review?templateURL=https://observeinc-$region.s3.amazonaws.com/apps/forwarder/latest/packaged.yaml"
 
     # Generate table row with shield badges linking to CloudFormation console
-    echo "| [$badge_md]($collection_link) | [$badge_md]($config_link) | [$badge_md]($forwarder_link) |"
+    echo "| [$badge_md]($stack_link) | [$badge_md]($config_link) | [$badge_md]($forwarder_link) |"
 done
diff --git a/integration/tests/collection.tftest.hcl → integration/tests/stack.tftest.hcl b/integration/tests/collection.tftest.hcl → integration/tests/stack.tftest.hcl
@@ -149,10 +149,10 @@ run "create_bucket" {
   }
 }
 
-run "install_collection" {
+run "install" {
   variables {
     setup = run.setup
-    app   = "collection"
+    app   = "stack"
     parameters = {
       DataAccessPointArn   = run.create_bucket.access_point.arn
       DestinationUri       = "s3://${run.create_bucket.access_point.alias}"
@@ -175,7 +175,7 @@ run "check_sqs" {
   variables {
     command = "./scripts/check_object_diff"
     env_vars = {
-      SOURCE      = run.install_collection.stack.outputs["Bucket"]
+      SOURCE      = run.install.stack.outputs["Bucket"]
       DESTINATION = run.create_bucket.id
     }
   }