Skip to content

Commit 8dc870d

Browse files
authored
clarify documentation (#9)
1 parent e7d63d4 commit 8dc870d

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,27 @@ convention (i.e. X.Y.Z). We typically start with `1.0.0` and increment as needed
2727
AWS org-sagebase-imagecentral account which will in turn trigger a build
2828
of the image which will generate an AMI.
2929
4. The AMI will be publicly shared to __ALL__ AWS accounts which
30-
means that it is searchable from any AWS accounts using either the
30+
means that it is searchable from any AWS account using either the
3131
AWS console EC2 Instances->AMIs or Image Builder->Images pages. The AMI is
3232
also searchable using the AWS CLI
3333
[describe-images command](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html).
3434

35+
Note: Due to an AWS bug, the AMI tags are not be copied from the source AMI
36+
to shared accounts as mentioned in the documentation
37+
[Share an AMI with specific AWS accounts - Amazon Elastic Compute Cloud](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-explicit.html)..
38+
```
39+
Tags – You can't share user-defined tags (tags that you attach to an AMI). When you share an AMI,
40+
your user-defined tags are not available to any AWS account that the AMI is shared with.
41+
```
3542

3643
### Updating Images
37-
To update an image we must first update aws-infra then this repo.
44+
Updating an image is a two step process:
45+
1. Update the cloudformation template in the aws-infra repo
46+
2. Update update Sceptre config in this repo.
3847

3948
Update the cloudformation template in aws-infra:
40-
1. Create a PR to update the ImageBuilder cloudformation template in the aws-infra repo
49+
1. Create a PR to update the
50+
[ImageBuilder cloudformation template](https://github.com/Sage-Bionetworks/aws-infra/tree/master/templates/ImageBuilder)
4151
2. Review, approve and Merge the PR
4252
3. Tag the repo with a version number
4353

0 commit comments

Comments
 (0)