rename: cloudwatch_{logs_,}group

Author: ryan-williams

.github/workflows/runner.yml

@@ -24,7 +24,7 @@ on:
         description: "AWS AMI ID to use (required - must be provided via input or vars.EC2_IMAGE_ID)"
         required: false
         type: string
-      cloudwatch_logs_group:
+      cloudwatch_group:
         description: "CloudWatch Logs group name for streaming runner logs (leave empty to disable)"
         required: false
         type: string
@@ -171,7 +171,7 @@ jobs:
         uses: ./
         with:
           ami: ${{ inputs.ami || vars.EC2_IMAGE_ID }}
-          cloudwatch_logs_group: ${{ inputs.cloudwatch_logs_group || vars.CLOUDWATCH_LOGS_GROUP }}
+          cloudwatch_group: ${{ inputs.cloudwatch_group || vars.CLOUDWATCH_LOGS_GROUP }}
           debug: ${{ inputs.debug }}
           homedir: ${{ inputs.homedir || vars.EC2_HOME_DIR }}
           instance_count: ${{ inputs.instance_count }}

action.yml

@@ -7,7 +7,7 @@ inputs:
   ami:
     description: "AWS AMI ID to use (required - must be provided via input or vars.EC2_IMAGE_ID)"
     required: false
-  cloudwatch_logs_group:
+  cloudwatch_group:
     description: "CloudWatch Logs group name for streaming runner logs (leave empty to disable)"
     required: false
   debug:

src/ec2_gha/__main__.py

@@ -32,7 +32,7 @@ def main():
     builder = (
         EnvVarBuilder(env)
         .update_state("INPUT_AMI", "image_id")
-        .update_state("INPUT_CLOUDWATCH_LOGS_GROUP", "cloudwatch_logs_group")
+        .update_state("INPUT_CLOUDWATCH_GROUP", "cloudwatch_group")
         .update_state("INPUT_DEBUG", "debug")
         .update_state("INPUT_EXTRA_GH_LABELS", "labels")
         .update_state("INPUT_HOMEDIR", "home_dir")

src/ec2_gha/start.py

@@ -28,7 +28,7 @@ class StartAWS(CreateCloudInstance):
         The name of the region to use.
     repo : str
         The repository to use.
-    cloudwatch_logs_group : str
+    cloudwatch_group : str
         CloudWatch Logs group name for streaming runner logs. Defaults to an empty string.
     debug : str
         Enable debug output in runner setup script. Defaults to an empty string.
@@ -81,7 +81,7 @@ class StartAWS(CreateCloudInstance):
     region_name: str
     repo: str
     # Optional fields with defaults (alphabetized)
-    cloudwatch_logs_group: str = ""
+    cloudwatch_group: str = ""
     debug: str = ""
     gh_runner_tokens: list[str] = field(default_factory=list)
     grouped_runner_tokens: list[list[str]] = field(default_factory=list)
@@ -400,7 +400,7 @@ def create_instances(self) -> dict[str, str]:
             instance_name_value = name_template.safe_substitute(**template_vars)
 
             user_data_params = {
-                "cloudwatch_logs_group": self.cloudwatch_logs_group,
+                "cloudwatch_group": self.cloudwatch_group,
                 "debug": self.debug,
                 "github_run_id": environ.get("GITHUB_RUN_ID", ""),
                 "github_run_number": environ.get("GITHUB_RUN_NUMBER", ""),

src/ec2_gha/templates/user-script.sh.templ

@@ -119,7 +119,7 @@ log "Setting up maximum lifetime timeout: $${MAX_LIFETIME_MINUTES} minutes"
 nohup bash -c "sleep $${MAX_LIFETIME_MINUTES}m && echo '[$$(date)] Maximum lifetime reached' && shutdown -h now" > /var/log/max-lifetime.log 2>&1 &
 
 # Configure CloudWatch Logs if a log group is specified
-if [ "$cloudwatch_logs_group" != "" ]; then
+if [ "$cloudwatch_group" != "" ]; then
   log "Installing CloudWatch agent"
   # Use a subshell to prevent CloudWatch failures from stopping the entire script
   (
@@ -142,7 +142,7 @@ if [ "$cloudwatch_logs_group" != "" ]; then
     fi
     # Build CloudWatch config with factored strings
     P='"file_path":'
-    G=',"log_group_name":"$cloudwatch_logs_group","log_stream_name":"{instance_id}/'
+    G=',"log_group_name":"$cloudwatch_group","log_stream_name":"{instance_id}/'
     Z='","timezone":"UTC"}'
     H="$$homedir"
     cat > /opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json << EOF

tests/test_start.py

@@ -33,7 +33,7 @@ def aws(base_aws_params):
 def aws_params_user_data():
     """User data params for AWS params tests"""
     return {
-        "cloudwatch_logs_group": "",  # Empty = disabled
+        "cloudwatch_group": "",  # Empty = disabled
         "debug": "",  # Empty = disabled
         "github_run_id": "16725250800",
         "github_run_number": "42",
@@ -64,7 +64,7 @@ def test_build_user_data(aws, aws_params_user_data, snapshot):
 def test_build_user_data_with_cloudwatch(aws, aws_params_user_data, snapshot):
     """Test user data with CloudWatch Logs enabled using snapshot testing"""
     params = aws_params_user_data | {
-        "cloudwatch_logs_group": "/aws/ec2/github-runners",
+        "cloudwatch_group": "/aws/ec2/github-runners",
         "runner_grace_period": "61",
         "runner_initial_grace_period": "181",
         "runner_poll_interval": "11",
@@ -82,7 +82,7 @@ def test_build_user_data_missing_params(aws):
         "repo": "omsf-eco-infra/awsinfratesting",
         "script": "echo 'Hello, World!'",
         "token": "test",
-        "cloudwatch_logs_group": "",
+        "cloudwatch_group": "",
         # Missing: labels, runner_release
     }
     with pytest.raises(Exception):