Skip to content

Commit

Permalink
chore(docs): Add notes about when S3 PutObjectTagging permission is n…
Browse files Browse the repository at this point in the history
…eeded for the IAM policy

Signed-off-by: chrisRedwine <[email protected]>
  • Loading branch information
chrisRedwine committed Sep 17, 2024
1 parent a8feda4 commit 14796b7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ For more information, see [the AWS documentation on IAM users][10].

If you'll be using Velero to backup multiple clusters with multiple S3 buckets, it may be desirable to create a unique username per cluster rather than the default `velero`.
2. Attach policies to give `velero` the necessary permissions:
2. Attach policies to give `velero` the necessary permissions (note that `s3:PutObjectTagging` is only needed
if you make use of the `config.tagging` field in the `BackupStorageLocation` spec):
```
cat > velero-policy.json <<EOF
Expand Down Expand Up @@ -200,7 +201,8 @@ It can be set up for Velero by creating a role that will have required permissio
aws iam create-role --role-name velero --assume-role-policy-document file://./velero-trust-policy.json
```
3. Attach policies to give `velero` the necessary permissions:
3. Attach policies to give `velero` the necessary permissions (note that `s3:PutObjectTagging` is only needed
if you make use of the `config.tagging` field in the `BackupStorageLocation` spec):
```
BUCKET=<YOUR_BUCKET>
Expand Down
3 changes: 2 additions & 1 deletion backupstoragelocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ spec:
enableSharedConfig: "true"

# Tags that need to be placed on AWS S3 objects.
# For example "Key1=Value1&Key2=Value2"
# For example, "Key1=Value1&Key2=Value2".
# This requires the IAM policy to have the "s3:PutObjectTagging" permission on the S3 bucket.
#
# Optional (defaults to empty "")
tagging: ""
Expand Down

0 comments on commit 14796b7

Please sign in to comment.