Skip to content

Commit bf79cbe

Browse files
tmknomtmknom
authored
Merge pull request tmknom#29 from tmknom/update-readme
Update README
2 parents 4101ece + f3b4400 commit bf79cbe

File tree

1 file changed

+58
-39
lines changed

1 file changed

+58
-39
lines changed

‎README.md‎

Lines changed: 58 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# terraform-aws-session-manager
22

3-
[![CircleCI](https://circleci.com/gh/tmknom/terraform-aws-session-manager.svg?style=svg)](https://circleci.com/gh/tmknom/terraform-aws-session-manager)
3+
[![Terraform Actions Status](https://github.com/tmknom/terraform-aws-session-manager/workflows/Terraform/badge.svg)](https://github.com/tmknom/terraform-aws-session-manager/actions?query=workflow%3ATerraform)
4+
[![Markdown Actions Status](https://github.com/tmknom/terraform-aws-session-manager/workflows/Markdown/badge.svg)](https://github.com/tmknom/terraform-aws-session-manager/actions?query=workflow%3AMarkdown)
5+
[![YAML Actions Status](https://github.com/tmknom/terraform-aws-session-manager/workflows/YAML/badge.svg)](https://github.com/tmknom/terraform-aws-session-manager/actions?query=workflow%3AYAML)
6+
[![JSON Actions Status](https://github.com/tmknom/terraform-aws-session-manager/workflows/JSON/badge.svg)](https://github.com/tmknom/terraform-aws-session-manager/actions?query=workflow%3AJSON)
47
[![GitHub tag](https://img.shields.io/github/tag/tmknom/terraform-aws-session-manager.svg)](https://registry.terraform.io/modules/tmknom/session-manager/aws)
58
[![License](https://img.shields.io/github/license/tmknom/terraform-aws-session-manager.svg)](https://opensource.org/licenses/Apache-2.0)
69

@@ -23,33 +26,33 @@ This module provides recommended settings:
2326

2427
```hcl
2528
module "session_manager" {
26-
source = "git::https://github.com/tmknom/terraform-aws-session-manager.git?ref=tags/1.2.0"
29+
source = "git::https://github.com/tmknom/terraform-aws-session-manager.git?ref=tags/2.0.0"
2730
name = "example"
2831
instance_type = "t2.micro"
29-
subnet_id = "${var.subnet_id}"
30-
vpc_id = "${var.vpc_id}"
32+
subnet_id = var.subnet_id
33+
vpc_id = var.vpc_id
3134
}
3235
```
3336

3437
### Complete
3538

3639
```hcl
3740
module "session_manager" {
38-
source = "git::https://github.com/tmknom/terraform-aws-session-manager.git?ref=tags/1.2.0"
41+
source = "git::https://github.com/tmknom/terraform-aws-session-manager.git?ref=tags/2.0.0"
3942
name = "example"
4043
instance_type = "t2.micro"
41-
subnet_id = "${var.subnet_id}"
42-
vpc_id = "${var.vpc_id}"
44+
subnet_id = var.subnet_id
45+
vpc_id = var.vpc_id
4346
4447
ssm_document_name = "SSM-SessionManagerRunShell-for-example"
45-
s3_bucket_name = "${var.s3_bucket_name}"
48+
s3_bucket_name = var.s3_bucket_name
4649
s3_key_prefix = "prefix"
4750
s3_encryption_enabled = false
48-
cloudwatch_log_group_name = "${var.cloudwatch_log_group_name}"
51+
cloudwatch_log_group_name = var.cloudwatch_log_group_name
4952
cloudwatch_encryption_enabled = false
50-
ami = "${var.ami}"
51-
vpc_security_group_ids = ["${var.vpc_security_group_ids}"]
52-
iam_policy = "${var.iam_policy}"
53+
ami = var.ami
54+
vpc_security_group_ids = var.vpc_security_group_ids
55+
iam_policy = var.iam_policy
5356
iam_path = "/service-role/"
5457
description = "This is example"
5558
@@ -64,27 +67,41 @@ module "session_manager" {
6467
- [Minimal](https://github.com/tmknom/terraform-aws-session-manager/tree/master/examples/minimal)
6568
- [Complete](https://github.com/tmknom/terraform-aws-session-manager/tree/master/examples/complete)
6669

70+
<!-- BEGINNING OF GENERATED BY TERRAFORM-DOCS -->
71+
72+
## Requirements
73+
74+
| Name | Version |
75+
| --------- | ------- |
76+
| terraform | >= 0.12 |
77+
78+
## Providers
79+
80+
| Name | Version |
81+
| ---- | ------- |
82+
| aws | n/a |
83+
6784
## Inputs
6885

69-
| Name | Description | Type | Default | Required |
70-
| ----------------------------- | --------------------------------------------------------------------- | :----: | :--------------------------: | :------: |
71-
| instance_type | The type of instance to start. | string | - | yes |
72-
| name | The name of the Session Manager. | string | - | yes |
73-
| subnet_id | The VPC Subnet ID to launch in. | string | - | yes |
74-
| vpc_id | The VPC ID. | string | - | yes |
75-
| ami | The AMI to use for the instance. | string | `` | no |
76-
| cloudwatch_encryption_enabled | Specify true to indicate that encryption for CloudWatch Logs enabled. | string | `true` | no |
77-
| cloudwatch_log_group_name | The name of the log group. | string | `` | no |
78-
| description | The description of the all resources. | string | `Managed by Terraform` | no |
79-
| iam_path | Path in which to create the IAM Role and the IAM Policy. | string | `/` | no |
80-
| iam_policy | The policy document. This is a JSON formatted string. | string | `` | no |
81-
| s3_bucket_name | The name of the bucket. | string | `` | no |
82-
| s3_encryption_enabled | Specify true to indicate that encryption for S3 Bucket enabled. | string | `true` | no |
83-
| s3_key_prefix | The prefix for the specified S3 bucket. | string | `` | no |
84-
| ssm_document_name | The name of the document. | string | `SSM-SessionManagerRunShell` | no |
85-
| tags | A mapping of tags to assign to all resources. | map | `{}` | no |
86-
| user_data | The user data to provide when launching the instance. | string | `` | no |
87-
| vpc_security_group_ids | A list of security group IDs to associate with. | list | `[]` | no |
86+
| Name | Description | Type | Default | Required |
87+
| ----------------------------- | --------------------------------------------------------------------- | -------------- | ------------------------------ | :------: |
88+
| instance_type | The type of instance to start. | `string` | n/a | yes |
89+
| name | The name of the Session Manager. | `string` | n/a | yes |
90+
| subnet_id | The VPC Subnet ID to launch in. | `string` | n/a | yes |
91+
| vpc_id | The VPC ID. | `string` | n/a | yes |
92+
| ami | The AMI to use for the instance. | `string` | `""` | no |
93+
| cloudwatch_encryption_enabled | Specify true to indicate that encryption for CloudWatch Logs enabled. | `bool` | `true` | no |
94+
| cloudwatch_log_group_name | The name of the log group. | `string` | `""` | no |
95+
| description | The description of the all resources. | `string` | `"Managed by Terraform"` | no |
96+
| iam_path | Path in which to create the IAM Role and the IAM Policy. | `string` | `"/"` | no |
97+
| iam_policy | The policy document. This is a JSON formatted string. | `string` | `""` | no |
98+
| s3_bucket_name | The name of the bucket. | `string` | `""` | no |
99+
| s3_encryption_enabled | Specify true to indicate that encryption for S3 Bucket enabled. | `bool` | `true` | no |
100+
| s3_key_prefix | The prefix for the specified S3 bucket. | `string` | `""` | no |
101+
| ssm_document_name | The name of the document. | `string` | `"SSM-SessionManagerRunShell"` | no |
102+
| tags | A mapping of tags to assign to all resources. | `map(string)` | `{}` | no |
103+
| user_data | The user data to provide when launching the instance. | `string` | `""` | no |
104+
| vpc_security_group_ids | A list of security group IDs to associate with. | `list(string)` | `[]` | no |
88105

89106
## Outputs
90107

@@ -137,9 +154,11 @@ module "session_manager" {
137154
| ssm_document_schema_version | The schema version of the document. |
138155
| ssm_document_status | The current status of the document. |
139156

157+
<!-- END OF GENERATED BY TERRAFORM-DOCS -->
158+
140159
## Development
141160

142-
### Requirements
161+
### Development Requirements
143162

144163
- [Docker](https://www.docker.com/)
145164

@@ -162,22 +181,22 @@ make install
162181
### Makefile targets
163182

164183
```text
184+
apply-complete Run terraform apply examples/complete
185+
apply-minimal Run terraform apply examples/minimal
165186
check-format Check format code
166-
cibuild Execute CI build
167187
clean Clean .terraform
188+
destroy-complete Run terraform destroy examples/complete
189+
destroy-minimal Run terraform destroy examples/minimal
190+
diff Word diff
168191
docs Generate docs
169192
format Format code
170193
help Show help
171194
install Install requirements
172195
lint Lint code
196+
plan-complete Run terraform plan examples/complete
197+
plan-minimal Run terraform plan examples/minimal
173198
release Release GitHub and Terraform Module Registry
174199
start-session Start session to example
175-
terraform-apply-complete Run terraform apply examples/complete
176-
terraform-apply-minimal Run terraform apply examples/minimal
177-
terraform-destroy-complete Run terraform destroy examples/complete
178-
terraform-destroy-minimal Run terraform destroy examples/minimal
179-
terraform-plan-complete Run terraform plan examples/complete
180-
terraform-plan-minimal Run terraform plan examples/minimal
181200
upgrade Upgrade makefile
182201
```
183202

0 commit comments

Comments
 (0)