Skip to content

Commit 186aafd

Browse files
authored
feat: prettier in READMEs (cloudposse/terraform-aws-components#998)
1 parent c5fa802 commit 186aafd

File tree

2 files changed

+22
-23
lines changed

2 files changed

+22
-23
lines changed

src/CHANGELOG.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
### Update IAM Policy and Change How it is Managed
44

5-
The ALB controller needs a lot of permissions and has a complex IAM policy.
6-
For this reason, the project releases a complete JSON policy document that is
7-
updated as needed.
5+
The ALB controller needs a lot of permissions and has a complex IAM policy. For this reason, the project releases a
6+
complete JSON policy document that is updated as needed.
87

98
In this release:
109

11-
1. We have updated the policy to the one distributed with version 2.6.0 of the ALB controller. This fixes an issue
12-
where the controller was not able to create the service-linked role for the Elastic Load Balancing service.
13-
2. To ease maintenance, we have moved the policy document to a separate file,
14-
`distributed-iam-policy.tf` and made it easy to update or override.
15-
10+
1. We have updated the policy to the one distributed with version 2.6.0 of the ALB controller. This fixes an issue where
11+
the controller was not able to create the service-linked role for the Elastic Load Balancing service.
12+
2. To ease maintenance, we have moved the policy document to a separate file, `distributed-iam-policy.tf` and made it
13+
easy to update or override.
1614

1715
#### Gov Cloud and China Regions
1816

19-
Actually, the project releases 3 policy documents, one for each of the
20-
three AWS partitions: `aws`, `aws-cn`, and `aws-us-gov`. For simplicity,
21-
this module only uses the `aws` partition policy. If you are in another
22-
partition, you can create a `distributed-iam-policy_override.tf` file in your
23-
directory and override the `overridable_distributed_iam_policy` local
24-
variable with the policy document for your partition.
17+
Actually, the project releases 3 policy documents, one for each of the three AWS partitions: `aws`, `aws-cn`, and
18+
`aws-us-gov`. For simplicity, this module only uses the `aws` partition policy. If you are in another partition, you can
19+
create a `distributed-iam-policy_override.tf` file in your directory and override the
20+
`overridable_distributed_iam_policy` local variable with the policy document for your partition.

src/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Component: `eks/alb-controller`
22

3-
This component creates a Helm release for [alb-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) on an EKS cluster.
3+
This component creates a Helm release for
4+
[alb-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) on an EKS cluster.
45

5-
[alb-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) is a Kubernetes addon that,
6-
in the context of AWS, provisions and manages ALBs and NLBs based on Service and Ingress annotations.
7-
This module also can (and is recommended to) provision a default IngressClass.
6+
[alb-controller](https://github.com/kubernetes-sigs/aws-load-balancer-controller) is a Kubernetes addon that, in the
7+
context of AWS, provisions and manages ALBs and NLBs based on Service and Ingress annotations. This module also can (and
8+
is recommended to) provision a default IngressClass.
89

910
### Special note about upgrading
1011

11-
When upgrading the chart version, check to see if the IAM policy for the service account needs to be updated.
12-
If it does, update the policy in the `distributed-iam-policy.tf` file.
13-
Probably the easiest way to check if it needs updating is to simply download the policy from
14-
https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/main/docs/install/iam_policy.json
15-
and compare it to the policy in `distributed-iam-policy.tf`.
12+
When upgrading the chart version, check to see if the IAM policy for the service account needs to be updated. If it
13+
does, update the policy in the `distributed-iam-policy.tf` file. Probably the easiest way to check if it needs updating
14+
is to simply download the policy from
15+
https://raw.githubusercontent.com/kubernetes-sigs/aws-load-balancer-controller/main/docs/install/iam_policy.json and
16+
compare it to the policy in `distributed-iam-policy.tf`.
1617

1718
## Usage
1819

@@ -57,6 +58,7 @@ components:
5758
chart_values: {}
5859
```
5960
61+
<!-- prettier-ignore-start -->
6062
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6163
## Requirements
6264
@@ -149,6 +151,7 @@ components:
149151
|------|-------------|
150152
| <a name="output_metadata"></a> [metadata](#output\_metadata) | Block status of the deployed release |
151153
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
154+
<!-- prettier-ignore-end -->
152155

153156
## References
154157

0 commit comments

Comments
 (0)