2023 11 21 doc + rename EmbeddedLinuxPipeline

README.md

@@ -24,7 +24,7 @@ cdk init app --language typescript
 ```
 2. Add the cdk library with `npm install aws4embeddedlinux/aws4embeddedlinux-ci`
 3. Create your application using the library. Refer to the [API Documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci) and the [Examples](github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) for more details.
-4. Deploy your application using `cdk deploy`.
+4. Deploy your application using `cdk deploy --require-approval never`.
 5. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for building Yocto. This container is used by the other pipelines. If the other pipelines are run before this container is created and pushed to [ECR](https://aws.amazon.com/ecr/), they will fail. This Build Image Pipeline will run weekly by default to keep this container patched.
 6. Now the application pipeline is able to be run. This will push contents of the Yocto deploy directory into S3.
 
@@ -33,18 +33,19 @@ You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to de
 
 ### In this library repo:
 ```bash
-$ npm link
-$ cd your-project
+npm install
 ```
 
 ### In your-project folder:
 ```bash
-$ npm link aws4embeddedlinux-ci
+npm install
+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).
 
-
+## Known issues
+- Windows is not supported currently
 
 ## Security
 

lib/demo-pipeline.ts → lib/embedded-linux-pipeline.ts

@@ -37,7 +37,7 @@ import { RemovalPolicy } from 'aws-cdk-lib';
 /**
  * Properties to allow customizing the build.
  */
-export interface DemoPipelineProps extends cdk.StackProps {
+export interface EmbeddedLinuxPipelineProps extends cdk.StackProps {
   /** ECR Repository where the Build Host Image resides. */
   readonly imageRepo: IRepository;
   /** Tag for the Build Host Image */
@@ -53,8 +53,8 @@ export interface DemoPipelineProps extends cdk.StackProps {
 /**
  * The stack demonstrating how to build a pipeline for meta-aws-demos
  */
-export class DemoPipelineStack extends cdk.Stack {
-  constructor(scope: Construct, id: string, props: DemoPipelineProps) {
+export class EmbeddedLinuxPipelineStack extends cdk.Stack {
+  constructor(scope: Construct, id: string, props: EmbeddedLinuxPipelineProps) {
     super(scope, id, props);
 
     /** Set up networking access and EFS FileSystems. */
@@ -96,7 +96,7 @@ export class DemoPipelineStack extends cdk.Stack {
         }
       );
 
-      outputBucket = new VMImportBucket(this, 'DemoArtifact', {
+      outputBucket = new VMImportBucket(this, 'PipelineOutput', {
         versioned: true,
         enforceSSL: true,
         encryptionKey: outputBucketEncryptionKey,
@@ -157,7 +157,7 @@ export class DemoPipelineStack extends cdk.Stack {
       codeBuildCloneOutput: true,
     });
 
-    const project = new PipelineProject(this, 'DemoBuildProject', {
+    const project = new PipelineProject(this, 'EmbeddedLinuxBuildProject', {
       buildSpec: BuildSpec.fromSourceFilename('build.buildspec.yml'),
       environment: {
         computeType: ComputeType.X2_LARGE,
@@ -223,13 +223,13 @@ export class DemoPipelineStack extends cdk.Stack {
     const buildOutput = new codepipeline.Artifact();
     const buildAction = new codepipeline_actions.CodeBuildAction({
       input: sourceOutput,
-      actionName: 'Demo-Build',
+      actionName: 'Build',
       outputs: [buildOutput],
       project,
     });
 
     const artifactAction = new codepipeline_actions.S3DeployAction({
-      actionName: 'Demo-Artifact',
+      actionName: 'Artifact',
       input: buildOutput,
       bucket: outputBucket,
     });
@@ -284,7 +284,7 @@ def handler(event, context):
     );
 
     /** Now create the actual Pipeline */
-    const pipeline = new codepipeline.Pipeline(this, 'DemoPipeline', {
+    const pipeline = new codepipeline.Pipeline(this, 'EmbeddedLinuxPipeline', {
       artifactBucket,
       restartExecutionOnUpdate: true,
       stages: [
@@ -338,7 +338,7 @@ def handler(event, context):
     vpc: IVpc,
     securityGroup: ISecurityGroup
   ): string {
-    const fs = new efs.FileSystem(this, `DemoPipeline${name}Filesystem`, {
+    const fs = new efs.FileSystem(this, `EmbeddedLinuxPipeline${name}Filesystem`, {
       vpc,
       removalPolicy: cdk.RemovalPolicy.DESTROY,
     });

lib/index.ts

@@ -2,5 +2,5 @@ export * from './network';
 export * from './build-image-data';
 export * from './build-image-repo';
 export * from './build-image-pipeline';
-export * from './demo-pipeline';
+export * from './embedded-linux-pipeline';
 export * from './constructs/source-repo';