Skip to content

Commit 1e54b69

Browse files
SinghVikram97vbedi
andauthored
update docs for additional tags feature (#830)
Co-authored-by: vbedi <[email protected]>
1 parent 53e0b02 commit 1e54b69

File tree

3 files changed

+34
-8
lines changed

3 files changed

+34
-8
lines changed

config/iam/recommended-inline-policy.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
"tag:GetResources",
2121
"firehose:TagDeliveryStream",
2222
"s3:GetBucketPolicy",
23-
"s3:PutBucketPolicy"
23+
"s3:PutBucketPolicy",
24+
"tag:TagResources",
25+
"tag:UntagResources"
2426
],
2527
"Resource": "*"
2628
},

docs/guides/additional-tags.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ The AWS Gateway API Controller automatically applies some tags to resources it c
44

55
The `application-networking.k8s.aws/tags` annotation specifies additional tags that will be applied to AWS resources created.
66

7-
## Supported Resources
8-
9-
- **HTTPRoute** - Tags applied to VPC Lattice Services, Listeners, Rules, Target Groups, and Service Network Service Associations
10-
- **ServiceExport** - Tags applied to VPC Lattice Target Groups
11-
- **AccessLogPolicy** - Tags applied to VPC Lattice Access Log Subscriptions
12-
- **VpcAssociationPolicy** - Tags applied to VPC Lattice Service Network VPC Associations
13-
147
## Usage
158

169
Add comma separated key=value pairs to the annotation:
@@ -36,3 +29,33 @@ metadata:
3629
spec:
3730
# ... rest of spec
3831
```
32+
33+
## Required IAM Permissions
34+
35+
For the additional tags functionality to work properly, the IAM role linked to the controller's service account must also include these permissions:
36+
37+
```json
38+
{
39+
"Effect": "Allow",
40+
"Action": [
41+
"tag:TagResources",
42+
"tag:UntagResources"
43+
],
44+
"Resource": "*"
45+
}
46+
```
47+
48+
### How to Ensure You Have These Permissions
49+
50+
The `config/iam/recommended-inline-policy.json` file contains all the required permissions including these tagging permissions.
51+
52+
- **If you are setting up for the first time**: The recommended inline policy already includes all the required permissions.
53+
- **If you used the setup steps in the [deploy guide](https://www.gateway-api-controller.eks.aws.dev/latest/guides/deploy/#setup)**: You need to update the existing `VPCLatticeControllerIAMPolicy` to include the updated permissions.
54+
55+
56+
## Supported Resources
57+
58+
- **HTTPRoute** - Tags applied to VPC Lattice Services, Listeners, Rules, Target Groups, and Service Network Service Associations
59+
- **ServiceExport** - Tags applied to VPC Lattice Target Groups
60+
- **AccessLogPolicy** - Tags applied to VPC Lattice Access Log Subscriptions
61+
- **VpcAssociationPolicy** - Tags applied to VPC Lattice Service Network VPC Associations

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ nav:
2424
- TLS Passthrough: guides/tls-passthrough.md
2525
- Pod Readiness Gates: guides/pod-readiness-gates.md
2626
- Configuration: guides/environment.md
27+
- Additional Tags: guides/additional-tags.md
2728
- API Specification: api-reference.md
2829
- API Reference:
2930
- AccessLogPolicy: api-types/access-log-policy.md

0 commit comments

Comments
 (0)