More information on how CDK Pipelines utilizes CodeBuild and CFN

Open
#420 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws, docker

Research direction

Start with the CDK Pipelines guide linked in the issue and investigate how its CodeBuild phase and CloudFormation deployment work. Update the documentation with relevant explanations or links, including the Docker daemon and PrivilegedMode context, so beginners understand why CodeBuild is involved and how to resolve the reported error.

Written by the indexing model from the issue text.

Description

Would it be possible to add a few points or links to how CodeBuild and CFN works under the hood of CDK.

For example, when following the steps in this doc to deploy codepipeline via CDK:
https://docs.aws.amazon.com/cdk/v2/guide/cdk_pipeline.html

The following error occurred: "Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running"
This error occurs at the CodeBuild phase to which after enabling PrivilegeMode helped resolved the issue, however in the doc nothing mentions the use of CodeBuild anywhere.

From personal experience, a CDK beginner was confused as to why CodeBuild was being used as they did not interact with the service directly.

Dominant language
Perl
Stars
360
Forks
230
Avg merge
3d 23h
Merged PRs (30d)
1

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from awsdocs/aws-cdk-guide

All issues in awsdocs/aws-cdk-guide

Similar issues

More Perl issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.