Skip to content

Commit db2fd96

Browse files
chore: improve documentation for id_ssm_parameter_arn
1 parent bd83946 commit db2fd96

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

docs/configuration.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ This module also allows you to run agents from a prebuilt AMI to gain faster sta
171171

172172
## AMI Configuration
173173

174+
> **Note:** By default, a runner AMI update requires a re-apply of the terraform configuration, as the runner AMI ID is looked up by a terraform data source. To avoid this, you can use or `ami.id_ssm_parameter_arn` to have the scale-up lambda dynamically lookup the runner AMI ID from an SSM parameter at instance launch time. Said SSM parameter is managed outside of this module (e.g. by a runner AMI build workflow).
175+
174176
By default, the module will automatically select appropriate AMI images:
175177

176178
- For Linux x64: Amazon Linux 2023 x86_64
@@ -203,8 +205,7 @@ ami = {
203205
}
204206
```
205207

206-
> **Note:** The old way of configuring AMIs using individual variables (`ami_filter`, `ami_owners`, `ami_kms_key_arn`) is deprecated and will be removed in a future version. It is recommended to migrate to the new consolidated `ami` object.
207-
208+
> **Note:** The old way of configuring AMIs using individual variables (`ami_filter`, `ami_owners`, `ami_kms_key_arn`, `ami_id_ssm_parameter_arn`, `ami_id_ssm_parameter_name`) is deprecated and will be removed in a future version. It is recommended to migrate to the new consolidated `ami` object. Support for `ami_id_ssm_parameter_name` will be dropped, please specify an arn via `ami.id_ssm_parameter_arn` instead.
208209
209210
## Logging
210211

@@ -399,5 +400,3 @@ resource "aws_iam_role_policy" "event_rule_firehose_role" {
399400
policy = data.aws_iam_policy_document.firehose_stream.json
400401
}
401402
```
402-
403-
NOTE: By default, a runner AMI update requires a re-apply of this terraform config (the runner AMI ID is looked up by a terraform data source). To avoid this, you can use `ami_id_ssm_parameter_name` to have the scale-up lambda dynamically lookup the runner AMI ID from an SSM parameter at instance launch time. Said SSM parameter is managed outside of this module (e.g. by a runner AMI build workflow).

variables.tf

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,6 @@ AMI configuration for the action runner instances. This object allows you to spe
373373
Parameters:
374374
- `filter`: Map of lists to filter AMIs by various criteria (e.g., { name = ["ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-*"], state = ["available"] })
375375
- `owners`: List of AMI owners to limit the search. Common values: ["amazon"], ["self"], or specific AWS account IDs
376-
- `id_ssm_parameter_name`: Name of an SSM parameter containing the AMI ID. If specified, this overrides the AMI filter
377376
- `id_ssm_parameter_arn`: ARN of an SSM parameter containing the AMI ID. If specified, this overrides both AMI filter and parameter name
378377
- `kms_key_arn`: Optional KMS key ARN if the AMI is encrypted with a customer managed key
379378
@@ -406,7 +405,7 @@ variable "ami_owners" {
406405
}
407406

408407
variable "ami_id_ssm_parameter_name" {
409-
description = "[DEPRECATED: Use ami.id_ssm_parameter_name] String used to construct the SSM parameter name used to resolve the latest AMI ID for the runner instances. The SSM parameter should be of type String and contain a valid AMI ID. The default behavior is to use the latest Ubuntu 22.04 AMI."
408+
description = "[DEPRECATED: Use ami.id_ssm_parameter_arn] String used to construct the SSM parameter name used to resolve the latest AMI ID for the runner instances. The SSM parameter should be of type String and contain a valid AMI ID. The default behavior is to use the latest Ubuntu 22.04 AMI."
410409
type = string
411410
default = null
412411
}

0 commit comments

Comments
 (0)