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

Commit a534647

Browse files
author
Chandrashekar
committed
documentation update
1 parent bb814f0 commit a534647

File tree

6 files changed

+15
-6
lines changed

6 files changed

+15
-6
lines changed

docs/partner_editable/additional_info.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ image:../images/image7.png[Figure 4,width=648,height=198]
3232

3333
image:../images/image8.png[Figure 5,width=646,height=348]
3434

35-
*Figure 5: Checking for S3 bucket updates after a commit*
35+
*Figure 4: Checking for S3 bucket updates after a commit*
3636

3737
=== Best Practices
3838

docs/partner_editable/architecture.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ Deploying this Quick Start builds the following environment in the AWS Cloud.
77
[link=images/architecture_diagram.png]
88
image::../images/image3.png[Architecture,width=100%,height=100%]
99

10+
1011
*Figure 2: Webhook endpoint architecture on AWS*
1112

13+
1214
The Quick Start deployment sets up a serverless AWS Cloud environment that includes the following components.
1315

1416
* An API Gateway endpoint to accept the webhook requests from Git.

docs/partner_editable/deploy_steps.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ After you have successfully deployed the Quick Start, you can configure the serv
3030

3131
image:../images/image5.png[Figure 4,width=701,height=222]
3232

33-
*Figure 4: Outputs tab after deployment*
33+
34+
*Figure 3: Outputs tab after deployment*
35+
3436

3537
* *GitPullWebHookApi* is the webhook endpoint to use if you opt for the Git pull method described in the link:#webhook-endpoints[Webhook Endpoints] section of this guide.
36-
// * *ZipDownloadWebHookApi* is the webhook endpoint to use if you opt for the zip download method described in the link:#webhook-endpoints[Webhook Endpoints] section of this guide.
3738
* *PublicSSHKey* is the public SSH key that you use to connect to your repository if you’re using the Git pull endpoint. This key can be configured as a read-only machine user or as a deployment key in your Git service.
3839

3940
The exact process to set up webhooks differs from service to service. For step-by-step instructions, consult your Git service’s documentation.

docs/partner_editable/faq_troubleshooting.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ If your commits are not being pushed through to Amazon S3, check the following:
1717
* In your Git service’s webhooks configuration, check that your configured security parameters and the endpoint are correct. Consult the Git service documentation for detailed guidance on configuration.
1818
* Check the Lambda logs for errors. These are stored in Amazon CloudWatch Logs. To access the logs, open the endpoint’s Lambda function in the AWS console, navigate to the *Monitoring* tab, and then choose *View logs in CloudWatch*.
1919

20+
For additional information, see https://docs.aws.amazon.com/lambda/latest/dg/lambda-troubleshooting.html[Troubleshooting issues in AWS Lambda^] on the AWS website.
21+
22+
* Check the AWS CodeBuild project logs for errors. These are stored in Amazon CloudWatch Logs. To access the logs, open the endpoint’s CodeBuild Build Project in the AWS console, select a *Build run* and click on the hyperlink and navigate to the *Build logs* tab to see the build execution logs.
23+
24+
For additional information, see https://docs.aws.amazon.com/codebuild/latest/userguide/troubleshooting.html[Troubleshooting AWS CodeBuild^] on the AWS website.
25+
2026
== Additional Resources
2127

2228
=== AWS services
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The Quick Start provides an Amazon API Gateway endpoint and several Lambda functions to handle the download, zipping, and deployment of code to Amazon S3. AWS CodePipeline carries a cost for each active pipeline; see https://aws.amazon.com/codepipeline/pricing/[AWS CodePipeline pricing]. Depending on your configuration, the Quick Start may deploy an AWS Key Management Service (AWS KMS) key; for pricing, see https://aws.amazon.com/kms/pricing/[AWS Key Management Service pricing]. API Gateway, Amazon S3, and Lambda costs vary depending on how often you commit code to your repository; each commit triggers a request to the Lambda execution in API Gateway; for details, see the pricing pages for https://aws.amazon.com/api-gateway/pricing/[API Gateway], https://aws.amazon.com/s3/pricing/[Amazon S3], and https://aws.amazon.com/lambda/pricing/[Lambda].
1+
The Quick Start provides an Amazon API Gateway endpoint, several Lambda functions and an AWS CodeBuild project to handle the download, zipping, and deployment of code to Amazon S3. AWS CodePipeline carries a cost for each active pipeline; see https://aws.amazon.com/codepipeline/pricing/[AWS CodePipeline pricing]. Depending on your configuration, the Quick Start may deploy an AWS Key Management Service (AWS KMS) key; for pricing, see https://aws.amazon.com/kms/pricing/[AWS Key Management Service pricing]. API Gateway, Amazon S3, Lambda, and AWS CodeBuild costs vary depending on how often you commit code to your repository; each commit triggers a request to the Lambda execution in API Gateway; for details, see the pricing pages for https://aws.amazon.com/api-gateway/pricing/[API Gateway], https://aws.amazon.com/s3/pricing/[Amazon S3], https://aws.amazon.com/lambda/pricing/[Lambda] and https://aws.amazon.com/codebuild/pricing/[codebuild] .

docs/partner_editable/product_description.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ image:../images/image2.png[image,width=647,height=266]
55

66
*Figure 1: Using webhooks for code commits*
77

8-
This Quick Start implements the required code to trigger a Lambda function that zips up the code in your repository and places the .zip file in Amazon S3. When this function is triggered by a Git webhook, it provides a convenient way to bridge Git services with AWS services like AWS CodePipeline and AWS CodeBuild, so that builds and pipeline executions occur automatically when you commit your code to a Git repository. Linking your existing code repositories to the AWS Cloud in this way enables your code to be continuously integrated, tested, built, and deployed on the AWS Cloud with each change.
8+
This Quick Start implements the required code to trigger a Lambda function and an AWS CodeBuild project working together that zips up the code in your repository and places the .zip file in Amazon S3. When this function is triggered by a Git webhook, it provides a convenient way to bridge Git services with AWS services like AWS CodePipeline and AWS CodeBuild, so that builds and pipeline executions occur automatically when you commit your code to a Git repository. Linking your existing code repositories to the AWS Cloud in this way enables your code to be continuously integrated, tested, built, and deployed on the AWS Cloud with each change.
99

10-
NOTE: The Lambda functions that are deployed by this Quick Start must be able to communicate with your Git repository. For example, you can use a SaaS-based Git service that Lambda can reach through the internet.
10+
NOTE: The AWS CodeBuild Project deployed by this Quick Start must be able to communicate with your Git repository. For example, you can use a SaaS-based Git service that AWS CodeBuild can reach through the internet.

0 commit comments

Comments
 (0)