Skip to content

Commit 8730d0a

Browse files
committed
README.md: add description how to deploy specific examples
1 parent ce1225e commit 8730d0a

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

README.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Getting Started
44
This repository shows ways to use the [aws4embeddedlinux-ci](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci.git) library.
55

6-
In order to use these examples, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
6+
In order to use these examples, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
77
installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.
88

99
### Clone and Setup NPM Project
@@ -14,7 +14,7 @@ npm install .
1414
npm run build
1515
```
1616

17-
Note that while the CDK projects often do not require that you invoke the build command separately, doing so will ensure various assets
17+
Note that while the CDK projects often do not require that you invoke the build command separately, doing so will ensure various assets
1818
in the library are packaged correctly.
1919

2020
### Deploying
@@ -25,9 +25,17 @@ To deploy _all_ the pipeline examples, you can use the CDK deploy command:
2525
cdk deploy --all
2626
```
2727

28-
The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created
29-
pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other
30-
pipelines will work correctly. Once it is complete, the EmbeddedLinuxPipeline in the CodePipeline console page is ready to run.
28+
Alternatively to deploy just a specific pipeline example, you can use the CDK deploy command:
29+
30+
EXAMPLE can be one or more of those: QemuEmbeddedLinuxPipeline, PokyAmiPipeline, KasPipeline, RenesasPipeline, NxpImxPipeline
31+
32+
```bash
33+
cdk deploy BuildImagePipeline <EXAMPLE>
34+
```
35+
36+
The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created
37+
pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other
38+
pipelines will work correctly. Once it is complete, the EmbeddedLinuxPipeline in the CodePipeline console page is ready to run. Thus `BuildImagePipeline` must always be part of the deployment if you deploy just a specific example.
3139

3240
### Removing Pipelines
3341
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.
@@ -43,31 +51,35 @@ Several example pipelines are provided. Each one demonstrates a different aspect
4351
### A Simple Poky Based Pipeline
4452
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.
4553

46-
The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-`
47-
followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, the CodeBuild Project (with build logs),
54+
The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-`
55+
followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, the CodeBuild Project (with build logs),
4856
and the S3 bucket that the image is uploaded to, at the end.
4957

5058
#### Using Kas
51-
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
59+
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
5260
layers. This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
5361

5462
See the AWS CodeBuild pipeline: KasPipeline-EmbeddedLinuxPipeline*
5563

64+
Example stack name: KasPipeline
65+
5666
#### A slightly modified version building a qemu pipeline:
57-
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
58-
the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing)
67+
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
68+
the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing)
5969
such as ptest can be run in the pipeline.
6070

6171
See the AWS CodeBuild pipeline: QemuEmbeddedLinuxPipeline-EmbeddedLinuxPipeline*
6272

6373
### A Poky Based EC2 AMI Pipeline
64-
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
74+
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
6575
the [VM Import/Export Service](https://docs.aws.amazon.com/vm-import/latest/userguide/what-is-vmimport.html).
6676

6777
The pipeline name starts with `PokyAmiPipeline-` in the CodePipeline page.
6878

79+
Example stack name: PokyAmiPipeline
80+
6981
### A NXP / IMX Pipeline
70-
This example will build an image for
82+
This example will build an image for
7183
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.
7284

7385
Accepting the EULA is required. For this you need to uncomment the
@@ -78,9 +90,11 @@ Accepting the EULA is required. For this you need to uncomment the
7890

7991
The pipeline name starts with `NxpImxPipeline-` in the CodePipeline page.
8092

93+
Example stack name: NxpImxPipeline
94+
8195
### Using pre-built, proprietary artifacts in a Pipeline
8296

83-
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
97+
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
8498
Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.
8599

86100
Download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):
@@ -95,12 +109,14 @@ Graphic drivers are required for Wayland. Multimedia drivers are optional.
95109

96110
#### Steps to build the image
97111

98-
1. Create a folder named `proprietary` in the root of the source repo, and put those two downloaded files into this folder.
112+
1. Create a folder named `proprietary` in the root of the source repo, and put those two downloaded files into this folder.
99113
1. Deploy the build pipeline and uncomment the `#TODO` in the build.sh file.
100114
1. A build should automatically start. Once it succeeds you will get an image containing the proprietary graphics and multimedia drivers.
101115

102116
See the AWS CodeBuild pipeline: RenesasPipeline-EmbeddedLinuxPipeline*
103117

118+
Example stack name: RenesasPipeline
119+
104120
---
105121

106122
## Useful NPM and CDK commands

0 commit comments

Comments
 (0)