Skip to content

Commit 4fd34c8

Browse files
smiller171smiller171
committed
update example versions
1 parent 7590bf3 commit 4fd34c8

File tree

3 files changed

+37
-36
lines changed

3 files changed

+37
-36
lines changed

‎README.md‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Terraform module for creating EC2 Image Builder Pipelines from Cloudformation
55
Here's what using the module will look like
66
```hcl
77
module "test_pipeline" {
8-
source = "rhythmictech/imagebuilder-recipe/aws"
9-
version = "~> 0.2.0"
8+
source = "rhythmictech/imagebuilder-pipeline/aws"
9+
version = "~> 0.3.0"
1010
1111
description = "Testing pipeline"
1212
name = "test-pipeline"
@@ -22,47 +22,47 @@ Allows the creation of EC2 Image Builder Pipelines with Cloudformation until nat
2222
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2323
## Requirements
2424

25-
| Name | Version |
26-
|------|---------|
25+
| Name | Version |
26+
|-----------|-----------|
2727
| terraform | >= 0.12.2 |
28-
| aws | ~> 2.44 |
28+
| aws | ~> 2.44 |
2929

3030
## Providers
3131

3232
| Name | Version |
3333
|------|---------|
34-
| aws | ~> 2.44 |
34+
| aws | ~> 2.44 |
3535

3636
## Inputs
3737

38-
| Name | Description | Type | Default | Required |
39-
|------|-------------|------|---------|:--------:|
40-
| name | name to use for component | `string` | n/a | yes |
41-
| recipe\_arn | ARN of the recipe to use. Must change with Recipe version | `string` | n/a | yes |
42-
| additional\_iam\_policy\_arns | List of ARN policies for addional builder permissions | `list(string)` | `[]` | no |
43-
| cloudformation\_timeout | How long to wait (in minutes) for CFN to apply before giving up | `number` | `10` | no |
44-
| description | description of component | `string` | `null` | no |
45-
| enabled | Whether pipeline is ENABLED or DISABLED | `bool` | `true` | no |
46-
| instance\_types | Instance types to create images from. It's unclear why this is a list. Possibly because different types can result in different images (like ARM instances) | `list(string)` | <pre>[<br> "t3.medium"<br>]</pre> | no |
47-
| key\_pair | EC2 key pair to add to the default user on the builder | `string` | `null` | no |
48-
| license\_config\_arns | If you're using License Manager, your ARNs go here | `list(string)` | `null` | no |
49-
| log\_bucket | Bucket to store logs in. If this is ommited logs will not be stored | `string` | `null` | no |
50-
| log\_prefix | S3 prefix to store logs at. Recommended if sharing bucket with other pipelines | `string` | `null` | no |
51-
| public | Whether resulting AMI should be public | `bool` | `false` | no |
52-
| regions | Regions that AMIs will be available in | `list(string)` | <pre>[<br> "us-east-1",<br> "us-east-2",<br> "us-west-1",<br> "us-west-2",<br> "ca-central-1"<br>]</pre> | no |
53-
| schedule | Schedule expression for when pipeline should run automatically https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html | <pre>object({<br> PipelineExecutionStartCondition = string<br> ScheduleExpression = string<br> })</pre> | <pre>{<br> "PipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE",<br> "ScheduleExpression": "cron(0 0 * * mon)"<br>}</pre> | no |
54-
| security\_group\_ids | Security group IDs for the Image Builder | `list(string)` | `null` | no |
55-
| shared\_account\_ids | AWS accounts to share AMIs with. If this is left null AMIs will be public | `list(string)` | `[]` | no |
56-
| sns\_topic\_arn | SNS topic to notify when new images are created | `string` | `null` | no |
57-
| subnet | Subnet ID to use for builder | `string` | `null` | no |
58-
| tags | map of tags to use for CFN stack and component | `map(string)` | `{}` | no |
59-
| terminate\_on\_failure | Change to false if you want to ssh into a builder for debugging after failure | `bool` | `true` | no |
60-
| test\_config | Whether to run tests during image creation and maximum time to allow tests to run | <pre>object({<br> ImageTestsEnabled = bool<br> TimeoutMinutes = number<br> })</pre> | <pre>{<br> "ImageTestsEnabled": true,<br> "TimeoutMinutes": 60<br>}</pre> | no |
38+
| Name | Description | Type | Default | Required |
39+
|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|
40+
| name | name to use for component | `string` | n/a | yes |
41+
| recipe\_arn | ARN of the recipe to use. Must change with Recipe version | `string` | n/a | yes |
42+
| additional\_iam\_policy\_arns | List of ARN policies for addional builder permissions | `list(string)` | `[]` | no |
43+
| cloudformation\_timeout | How long to wait (in minutes) for CFN to apply before giving up | `number` | `10` | no |
44+
| description | description of component | `string` | `null` | no |
45+
| enabled | Whether pipeline is ENABLED or DISABLED | `bool` | `true` | no |
46+
| instance\_types | Instance types to create images from. It's unclear why this is a list. Possibly because different types can result in different images (like ARM instances) | `list(string)` | <pre>[<br> "t3.medium"<br>]</pre> | no |
47+
| key\_pair | EC2 key pair to add to the default user on the builder | `string` | `null` | no |
48+
| license\_config\_arns | If you're using License Manager, your ARNs go here | `list(string)` | `null` | no |
49+
| log\_bucket | Bucket to store logs in. If this is ommited logs will not be stored | `string` | `null` | no |
50+
| log\_prefix | S3 prefix to store logs at. Recommended if sharing bucket with other pipelines | `string` | `null` | no |
51+
| public | Whether resulting AMI should be public | `bool` | `false` | no |
52+
| regions | Regions that AMIs will be available in | `list(string)` | <pre>[<br> "us-east-1",<br> "us-east-2",<br> "us-west-1",<br> "us-west-2",<br> "ca-central-1"<br>]</pre> | no |
53+
| schedule | Schedule expression for when pipeline should run automatically https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-schedule.html | <pre>object({<br> PipelineExecutionStartCondition = string<br> ScheduleExpression = string<br> })</pre> | <pre>{<br> "PipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE",<br> "ScheduleExpression": "cron(0 0 * * mon)"<br>}</pre> | no |
54+
| security\_group\_ids | Security group IDs for the Image Builder | `list(string)` | `null` | no |
55+
| shared\_account\_ids | AWS accounts to share AMIs with. If this is left null AMIs will be public | `list(string)` | `[]` | no |
56+
| sns\_topic\_arn | SNS topic to notify when new images are created | `string` | `null` | no |
57+
| subnet | Subnet ID to use for builder | `string` | `null` | no |
58+
| tags | map of tags to use for CFN stack and component | `map(string)` | `{}` | no |
59+
| terminate\_on\_failure | Change to false if you want to ssh into a builder for debugging after failure | `bool` | `true` | no |
60+
| test\_config | Whether to run tests during image creation and maximum time to allow tests to run | <pre>object({<br> ImageTestsEnabled = bool<br> TimeoutMinutes = number<br> })</pre> | <pre>{<br> "ImageTestsEnabled": true,<br> "TimeoutMinutes": 60<br>}</pre> | no |
6161

6262
## Outputs
6363

64-
| Name | Description |
65-
|------|-------------|
64+
| Name | Description |
65+
|---------------|-----------------------------------|
6666
| pipeline\_arn | ARN of EC2 Image Builder Pipeline |
6767

6868
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/basic/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ A basic example for this repository
44
## Code
55
```hcl
66
module "test_pipeline" {
7-
source = "rhythmictech/imagebuilder-recipe/aws"
8-
version = "~> 0.2.0"
7+
source = "rhythmictech/imagebuilder-pipeline/aws"
8+
version = "~> 0.3.0"
99
1010
description = "Testing pipeline"
1111
name = "test-pipeline"

‎examples/basic/main.tf‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module "tags" {
2424

2525
module "test_component" {
2626
source = "rhythmictech/imagebuilder-component-ansible/aws"
27-
version = "~> 0.1.0"
27+
version = "~> 0.2.0"
2828

2929
component_version = "1.0.0"
3030
description = "Testing component"
@@ -36,7 +36,7 @@ module "test_component" {
3636

3737
module "test_recipe" {
3838
source = "rhythmictech/imagebuilder-recipe/aws"
39-
version = "~> 0.1.0"
39+
version = "~> 0.2.0"
4040

4141
description = "Testing recipe"
4242
name = "test-recipe"
@@ -53,7 +53,8 @@ module "test_recipe" {
5353
}
5454

5555
module "test_pipeline" {
56-
source = "../../"
56+
source = "rhythmictech/imagebuilder-pipeline/aws"
57+
version = "~> 0.3.0"
5758

5859
description = "Testing pipeline"
5960
name = "test-pipeline"

0 commit comments

Comments
 (0)