Skip to content

Commit fa4bdde

Browse files
authored
Merge pull request #6 from aws-samples/readme
readme update
2 parents 93b59da + ef8c14b commit fa4bdde

1 file changed

Lines changed: 5 additions & 14 deletions

File tree

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
## aws-terraform-codeCommit-s3-backups
22

3-
Backup your AWS CodeCommit repositories to Amazon S3.
3+
Backup AWS CodeCommit repositories to Amazon S3.
44

55
(or risk discovering that [deleting an AWS CodeCommit repository is a one-way operation](https://aws.amazon.com/codecommit/faqs/))
66

77
## Module Inputs
88

9-
This module is designed for a [GitHub source type](https://developer.hashicorp.com/terraform/language/modules/sources#github) but it could be cloned and deployed locally, or from a private registry.
10-
119
```hcl
1210
module "codecommit-s3-backups" {
1311
source = "aws-samples/codecommit-s3-backups/aws"
1412
version = "2.2.2"
1513
name = "codecommit-s3-backup"
1614
}
1715
```
18-
The `name` will be used in the resource names.
16+
The `name` is used in the resource names (AWS CodeBuild project, IAM Roles, etc).
1917

2018
### Optional Inputs
2119

@@ -27,28 +25,22 @@ module "codecommit_s3_backup" {
2725
}
2826
```
2927

30-
`kms_key` is the arn of an existing AWS KMS key. It encrypts the Amazon S3 bucket and Amazon CloudWatch Log group. Your AWS KMS key policy will need to follow [CloudWatch Logs guidance for AWS KMS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) and [CodeBuild guidance for AWS KMS](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up-kms.html).
28+
`kms_key` is the arn of an existing AWS KMS key. It encrypts the Amazon S3 bucket and Amazon CloudWatch Log group. The AWS KMS key policy will need to follow [CloudWatch Logs guidance for AWS KMS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) and [CodeBuild guidance for AWS KMS](https://docs.aws.amazon.com/codebuild/latest/userguide/setting-up-kms.html).
3129

32-
`access_logging_bucket` is the arn of your Amazon S3 access logging bucket.
30+
`access_logging_bucket` is the arn of an Amazon S3 access logging bucket.
3331

3432

3533
## Architecture
3634
<div align="center">
3735
<img alt="architecture" width="600" src="./img/architecture.png" />
3836
</div>
39-
37+
A
4038
1. Users push code to a repository in CodeCommit.
4139
2. Amazon EventBridge monitors for changes to any repository.
4240
3. EventBridge invokes AWS CodeBuild and sends it information about the repository.
4341
4. CodeBuild clones the repository and packages it into a .zip file.
4442
5. CodeBuild uploads the .zip file to an S3 bucket.
4543

46-
## Troubleshooting
47-
48-
| Issue | Fix |
49-
|---|---|
50-
| Errors containing `NO_ARTIFACTS` or `NO_SOURCE` | Run a destroy and then a fresh apply. CodeBuild projects with no artifacts and defined source may generate errors when they are being edited (rather than built fresh). |
51-
5244
## Related Resources
5345

5446
- [Automate event-driven backups from CodeCommit to Amazon S3 using CodeBuild and CloudWatch Events](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/automate-event-driven-backups-from-codecommit-to-amazon-s3-using-codebuild-and-cloudwatch-events.html)
@@ -61,4 +53,3 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
6153
## License
6254

6355
This library is licensed under the MIT-0 License. See the LICENSE file.
64-

0 commit comments

Comments
 (0)