Merge pull request #7 from aws4embeddedlinux/2023-11-22_doc

README.md: add description how to deploy specific examples

Author: thomas-roos

README.md

@@ -3,7 +3,7 @@
 ## Getting Started
 This repository shows ways to use the [aws4embeddedlinux-ci](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci.git) library.
 
-In order to use these examples, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including 
+In order to use these examples, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
 installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.
 
 ### Clone and Setup NPM Project
@@ -14,7 +14,7 @@ npm install .
 npm run build
 ```
 
-Note that while the CDK projects often do not require that you invoke the build command separately, doing so will ensure various assets 
+Note that while the CDK projects often do not require that you invoke the build command separately, doing so will ensure various assets
 in the library are packaged correctly.
 
 ### Deploying
@@ -25,12 +25,21 @@ To deploy _all_ the pipeline examples, you can use the CDK deploy command:
 cdk deploy --all
 ```
 
-The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created 
-pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other 
+Alternatively to deploy just a specific pipeline example, you can use the CDK deploy command:
+
+EXAMPLE can be one or more of those: PokyPipeline, QemuEmbeddedLinuxPipeline, PokyAmiPipeline, KasPipeline, RenesasPipeline, NxpImxPipeline
+
+```bash
+cdk deploy <EXAMPLE>
+```
+
+The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created
+pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other
 pipelines will work correctly. Once it is complete, the EmbeddedLinuxPipeline in the CodePipeline console page is ready to run.
 
 ### Removing Pipelines
 The `cdk destroy` command can be used to remove individual pipelines and their related resources. This can also be done in the CloudFormation Console Page.
+**Do not delete stacks while a CodePipeline is running, this can lead to unexpected failures!**
 
 To remove all the resources associated with this application:
 ```bash
@@ -43,31 +52,37 @@ Several example pipelines are provided. Each one demonstrates a different aspect
 ### A Simple Poky Based Pipeline
 This example will build the `core-image-minimal` image from Poky using the repo tool to manage layers. CVE checking is also enabled in the buildspec file.
 
-The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-` 
-followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, the CodeBuild Project (with build logs), 
+The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-`
+followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, the CodeBuild Project (with build logs),
 and the S3 bucket that the image is uploaded to, at the end.
 
+Example stack name: PokyPipeline
+
 #### Using Kas
-The Kas example shows how to use a [Kas Config](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci/blob/main/source-repo/kas/kas.yml) to manage 
+The Kas example shows how to use a [Kas Config](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci/blob/main/source-repo/kas/kas.yml) to manage
 layers. This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
 
 See the AWS CodeBuild pipeline: KasPipeline-EmbeddedLinuxPipeline*
 
+Example stack name: KasPipeline
+
 #### A slightly modified version building a qemu pipeline:
-This example builds a Qemu based image using [meta-aws-demos](https://github.com/aws4embeddedlinux/meta-aws-demos). The Qemu image can be run in 
-the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing) 
+This example builds a Qemu based image using [meta-aws-demos](https://github.com/aws4embeddedlinux/meta-aws-demos). The Qemu image can be run in
+the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing)
 such as ptest can be run in the pipeline.
 
 See the AWS CodeBuild pipeline: QemuEmbeddedLinuxPipeline-EmbeddedLinuxPipeline*
 
 ### A Poky Based EC2 AMI Pipeline
-Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using 
+Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using
 the [VM Import/Export Service](https://docs.aws.amazon.com/vm-import/latest/userguide/what-is-vmimport.html).
 
 The pipeline name starts with `PokyAmiPipeline-` in the CodePipeline page.
 
+Example stack name: PokyAmiPipeline
+
 ### A NXP / IMX Pipeline
-This example will build an image for 
+This example will build an image for
 the [i.MX 6ULL EVK](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/evaluation-kit-for-the-i-mx-6ull-and-6ulz-applications-processor:MCIMX6ULL-EVK) board.
 
 Accepting the EULA is required. For this you need to uncomment the
@@ -78,9 +93,11 @@ Accepting the EULA is required. For this you need to uncomment the
 
 The pipeline name starts with `NxpImxPipeline-` in the CodePipeline page.
 
+Example stack name: NxpImxPipeline
+
 ### Using pre-built, proprietary artifacts in a Pipeline
 
-This example is based on this [work](https://elinux.org/R-Car/Boards/Yocto-Gen3/v5.9.0) to build an image for Renesas R-Car-H3 Starter Kit 
+This example is based on this [work](https://elinux.org/R-Car/Boards/Yocto-Gen3/v5.9.0) to build an image for Renesas R-Car-H3 Starter Kit
 Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.
 
 Download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):
@@ -95,12 +112,14 @@ Graphic drivers are required for Wayland. Multimedia drivers are optional.
 
 #### Steps to build the image
 
-1. Create a folder named `proprietary` in the root of the source repo, and put those two downloaded files into this folder. 
+1. Create a folder named `proprietary` in the root of the source repo, and put those two downloaded files into this folder.
 1. Deploy the build pipeline and uncomment the `#TODO` in the build.sh file.
 1. A build should automatically start. Once it succeeds you will get an image containing the proprietary graphics and multimedia drivers.
 
 See the AWS CodeBuild pipeline: RenesasPipeline-EmbeddedLinuxPipeline*
 
+Example stack name: RenesasPipeline
+
 ---
 
 ## Useful NPM and CDK commands

bin/app.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 import * as cdk from "aws-cdk-lib";
+import { addDependency } from "aws-cdk-lib/core/lib/deps";
 import {
   EmbeddedLinuxPipelineStack,
   BuildImageDataStack,
@@ -40,7 +41,7 @@ const buildImageRepo = new BuildImageRepoStack(app, "BuildImageRepo", {
   ...defaultProps,
 });
 
-new BuildImagePipelineStack(app, "BuildImagePipeline", {
+const buildImagePipeline = new BuildImagePipelineStack(app, "BuildImagePipeline", {
   ...defaultProps,
   dataBucket: buildImageData.bucket,
   repository: buildImageRepo.repository,
@@ -57,69 +58,75 @@ const vpc = new PipelineNetworkStack(app, {
 /**
  * Create a poky distribution pipeline.
  */
-new EmbeddedLinuxPipelineStack(app, "PokyPipeline", {
+const pokyPipeline = new EmbeddedLinuxPipelineStack(app, "PokyPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
 });
+pokyPipeline.addDependency(buildImagePipeline)
 
 /**
  * Create a meta-aws-demos pipeline for the Qemu example.
  */
-new EmbeddedLinuxPipelineStack(app, "QemuEmbeddedLinuxPipeline", {
+const qemuEmbeddedLinuxPipeline = new EmbeddedLinuxPipelineStack(app, "QemuEmbeddedLinuxPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
   layerRepoName: "qemu-demo-layer-repo",
   projectKind: ProjectKind.MetaAwsDemo,
 });
+qemuEmbeddedLinuxPipeline.addDependency(buildImagePipeline)
 
 /**
  * Create an AMI based on Poky.
  */
-new EmbeddedLinuxPipelineStack(app, "PokyAmiPipeline", {
+const pokyAmiPipeline = new EmbeddedLinuxPipelineStack(app, "PokyAmiPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
   layerRepoName: "ec2-ami-poky-layer-repo",
   projectKind: ProjectKind.PokyAmi,
 });
+pokyAmiPipeline.addDependency(buildImagePipeline)
 
 /**
  * Create an kas based image.
  */
-new EmbeddedLinuxPipelineStack(app, "KasPipeline", {
+const kasPipeline = new EmbeddedLinuxPipelineStack(app, "KasPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
   layerRepoName: "biga-kas-layer-repo",
   projectKind: ProjectKind.Kas,
 });
+kasPipeline.addDependency(buildImagePipeline)
 
 /**
  * Create an renesas image.
  */
-new EmbeddedLinuxPipelineStack(app, "RenesasPipeline", {
+const renesasPipeline = new EmbeddedLinuxPipelineStack(app, "RenesasPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
   layerRepoName: "renesas-layer-repo",
   projectKind: ProjectKind.Renesas,
 });
+renesasPipeline.addDependency(buildImagePipeline)
 
 /**
  * Create an nxp image.
  */
-new EmbeddedLinuxPipelineStack(app, "NxpImxPipeline", {
+const nxpImxPipeline = new EmbeddedLinuxPipelineStack(app, "NxpImxPipeline", {
   ...defaultProps,
   imageRepo: buildImageRepo.repository,
   imageTag: ImageKind.Ubuntu22_04,
   vpc: vpc.vpc,
   layerRepoName: "nxp-imx-layer-repo",
   projectKind: ProjectKind.NxpImx,
 });
+nxpImxPipeline.addDependency(buildImagePipeline)