From a2116bea007418dfe7e385060e8339e7be193e00 Mon Sep 17 00:00:00 2001 From: Thomas Roos Date: Wed, 15 Nov 2023 14:39:37 +0100 Subject: [PATCH 1/3] README.md: add architecture diagram --- README.md | 21 +++++++++++++++------ architecture.drawio.svg | 5 +++++ 2 files changed, 20 insertions(+), 6 deletions(-) create mode 100644 architecture.drawio.svg diff --git a/README.md b/README.md index ec8dd3c..3bc3e5e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ -## My Project +## aws4embeddedlinux-ci -TODO: Fill this README out! +This [cdk](https://github.com/aws/aws-cdk) IaC library help you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project. +### Architecture +![architecture overview](architecture.drawio.svg "Architecture") -### Development Setup +### Quickstart +Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo. -You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a checked out copy of this repo. +### Development Setup +You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a local copy of this repo. +#### In this library repo: ```bash -# In this library repo: $ npm link $ cd your-project +``` + +#### In your-project folder: +```bash $ npm link aws4embeddedlinux-ci ``` This will link through the system `node_modules` install. When using a system node install on Linux, this can require sudo access. To avoid this, use a [node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm) or [set a node prefix](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). + ## Security See [SECURITY](SECURITY.md) for more information about reporting issues with this project. @@ -67,4 +76,4 @@ See [CONTRIBUTING](CONTRIBUTING.md) for more information. ## License -This library is licensed under the MIT-0 License. See the LICENSE file. +This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file. diff --git a/architecture.drawio.svg b/architecture.drawio.svg new file mode 100644 index 0000000..86be036 --- /dev/null +++ b/architecture.drawio.svg @@ -0,0 +1,5 @@ + + + +
AWS Account
AWS Account
CodePipeline
CodePipeline
Build Artifacts
Build Artifacts
Build and Download Cache
Build and Download Cache
CodeBuild
CodeBuild
Update Config
Update Config
Builder
Build...
CodeCommit
Repository
CodeCommit...
Download Sources
Download Sources
Upstream Package Sources
Upstream Package Sourc...
S3
S3
EFS
EFS
Download Metadata
Download Metadata
Upstream Layers
Upstream LayersText is not SVG - cannot display + From 2c4f0d307871a269e9f4197f92b4a5c302a73107 Mon Sep 17 00:00:00 2001 From: Thomas Roos Date: Wed, 15 Nov 2023 14:49:01 +0100 Subject: [PATCH 2/3] build-image-data.ts: PolicyDocument import not used --- lib/build-image-data.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/build-image-data.ts b/lib/build-image-data.ts index 46343e1..78a40a8 100644 --- a/lib/build-image-data.ts +++ b/lib/build-image-data.ts @@ -7,7 +7,6 @@ import * as iam from 'aws-cdk-lib/aws-iam'; import * as path from 'path'; import * as kms from 'aws-cdk-lib/aws-kms'; import { RemovalPolicy } from 'aws-cdk-lib'; -import { PolicyDocument } from 'aws-cdk-lib/aws-iam'; /** * Select options for the BuildImageDataStack. From bc9cd399f85003070780c95a7b546b185a1cc35e Mon Sep 17 00:00:00 2001 From: Thomas Roos Date: Wed, 15 Nov 2023 15:07:04 +0100 Subject: [PATCH 3/3] fix architecuture.drawio.svg --- architecture.drawio.svg | 1 - 1 file changed, 1 deletion(-) diff --git a/architecture.drawio.svg b/architecture.drawio.svg index 86be036..212e576 100644 --- a/architecture.drawio.svg +++ b/architecture.drawio.svg @@ -2,4 +2,3 @@
AWS Account
AWS Account
CodePipeline
CodePipeline
Build Artifacts
Build Artifacts
Build and Download Cache
Build and Download Cache
CodeBuild
CodeBuild
Update Config
Update Config
Builder
Build...
CodeCommit
Repository
CodeCommit...
Download Sources
Download Sources
Upstream Package Sources
Upstream Package Sourc...
S3
S3
EFS
EFS
Download Metadata
Download Metadata
Upstream Layers
Upstream LayersText is not SVG - cannot display -