Skip to content
This repository was archived by the owner on Oct 4, 2024. It is now read-only.

Commit 7214277

Browse files
committed
edits part 1 122920
1 parent 89eea9c commit 7214277

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/partner_editable/additional_info.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The architecture built by this Quick Start supports AWS best practices for secur
6161

6262
=== SSH Keys
6363

64-
This Quick Start deploys a private SSH key pair which is encrypted with an AWS KMS key and uploaded to Amazon S3. When invoked by the Lambda function, AWS CodeBuild decrypts the private SSH key and uses it to authenticate your Git service before cloning the repository.
64+
This Quick Start deploys a private SSH key pair which is encrypted with an AWS KMS key and uploaded to Amazon S3. When invoked by the Lambda function, CodeBuild decrypts the private SSH key and uses it to authenticate your Git service before cloning the repository.
6565

6666
We don’t recommend sharing SSH keys among multiple services, or launching another instance of this Quick Start for to clone and store another repository in Amazon S3. Each repository should use unique SSH keys.
6767

docs/partner_editable/architecture.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ As shown in <<architecture_diagram>>, this Quick Start sets up a serverless AWS
1313
* Amazon API Gateway to receive Git webhook requests and forward them to AWS Lambda.
1414
* An AWS Lambda function to process Git webhook requests from API Gateway and invoke an AWS CodeBuild project.
1515
* AWS Identity and Access Management (IAM) roles required by Lambda and API Gateway (not pictured).
16-
* A CodeBuild project to connect to your Git service, then retrieve, zip, and upload Git repository code to Amazon Simple Storage Service (Amazon S3).
17-
* An AWS Key Management Service (AWS KMS) key to encrypt and decrypt the SSH keys used by CodeBuild to connect to your Git repository using SSH (Secure Shell).
18-
* Two Amazon Simple Storage Service (S3) buckets: one for Git repository contents, and another for encrypted SSH keys.
19-
* Two Lambda-backed AWS CloudFormation custom resources (not pictured). One generates an SSH key pair, encrypts it using AWS KMS, and uploads it to Amazon S3. The second deletes the contents of the S3 buckets when you delete the CloudFormation stack. If you need backups, ensure that you copy S3 bucket contents before deleting the stack.
16+
* A CodeBuild project to connect to your Git service, then retrieve, zip, and upload the latest version of your Git repository to Amazon S3.
17+
* An AWS Key Management Service (AWS KMS) key to encrypt/decrypt the SSH (Secure Shell) keys used by CodeBuild to connect to your Git repository using SSH.
18+
* Two Amazon S3 buckets: one for Git repository contents, and another for encrypted SSH keys.
19+
* Two Lambda-backed AWS CloudFormation custom resources (not pictured). One generates an SSH key pair, encrypts it using AWS KMS, and uploads it to Amazon S3. The second deletes the contents of the S3 buckets when you delete the CloudFormation stack. If you need backups, ensure that you copy the S3 buckets before deleting the stack.
2020
2121
[NOTE]
2222
========
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Git webhooks enable event-driven integration between Git services and external applications. This Quick Start deploys the HTTPS endpoint and code you can use to configure webhooks linking your AWS and Git services. With this integration in place, each time a Git user pushes a commit, your repository is automatically retrieved, zipped, and uploaded to an Amazon Simple Storage Service (Amazon S3) bucket. You can then configure AWS services such as AWS CodePipeline, AWS CodeBuild, and AWS CodeDeploy to use the S3 bucket as a source. In this way, you can build a continuous integration and continuous delivery (CI/CD) pipeline on the foundation this Quick Start deploys.
1+
This Quick Start deploys the HTTPS endpoint and code you can use to configure webhooks linking your Git and AWS services. With this integration in place, each time a Git user pushes a commit, your repository is automatically retrieved, zipped, and uploaded to an Amazon Simple Storage Service (Amazon S3) bucket. You can then configure AWS services such as AWS CodePipeline, AWS CodeBuild, and AWS CodeDeploy to use the S3 bucket as a source. In this way, you can build a continuous integration and continuous delivery (CI/CD) pipeline on the foundation this Quick Start deploys.
22

33
This guide describes the components that are deployed by the Quick Start, and contains links to launch the AWS CloudFormation template that automates the deployment.
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

2-
After deploying this Quick Start and configuring a webhook in your Git service, when a Git user pushes changes to your repository, the Git service sends an HTTPS POST request to the HTTPS endpoint. The endpoint is a URL the Quick Start creates that you use to link:#_configuring_git_services[configure a webhook]. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push that invoked the webhook action. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The CodeBuild project retrieves the latest version of your repository, zips it, and uploads it to an Amazon S3 bucket.
2+
After deploying this Quick Start and configuring a webhook in your Git service, when a Git user pushes changes to your repository, the Git service sends an HTTPS POST request to the HTTPS endpoint. The HTTPS POST request contains JavaScript Object Notation (JSON) data about the push that invoked the webhook action. After the request is accepted by Amazon API Gateway, it is passed to an AWS Lambda function that triggers an AWS CodeBuild project. The CodeBuild project retrieves the latest version of your repository, zips it, and uploads it to an Amazon S3 bucket.
33

44
For more information about the components that this Quick Start deploys, see the link:#_architecture[Architecture] section later in this guide.

0 commit comments

Comments
 (0)