From ecf194309a987621f83b098b4e3b69bae65f4ebb Mon Sep 17 00:00:00 2001 From: thomas-roos Date: Thu, 23 Nov 2023 17:43:54 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20aws4embe?= =?UTF-8?q?ddedlinux/aws4embeddedlinux-ci@21e981b6b500c45f25c34cfa4e808858?= =?UTF-8?q?2a709426=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BuildImageDataStack.html | 8 ++++---- classes/BuildImagePipelineStack.html | 4 ++-- classes/BuildImageRepoStack.html | 6 +++--- classes/EmbeddedLinuxPipelineStack.html | 16 ++++++++-------- classes/PipelineNetworkStack.html | 6 +++--- classes/SourceRepo.html | 6 +++--- enums/ImageKind.html | 4 ++-- enums/ProjectKind.html | 14 +++++++------- index.html | 9 ++++++++- interfaces/BuildImageDataProps.html | 4 ++-- interfaces/BuildImagePipelineProps.html | 8 ++++---- interfaces/EmbeddedLinuxPipelineProps.html | 12 ++++++------ interfaces/SourceRepoProps.html | 6 +++--- 13 files changed, 55 insertions(+), 48 deletions(-) diff --git a/classes/BuildImageDataStack.html b/classes/BuildImageDataStack.html index e6b512e..bcad197 100644 --- a/classes/BuildImageDataStack.html +++ b/classes/BuildImageDataStack.html @@ -26,7 +26,7 @@

Hierarchy

+
  • Defined in lib/build-image-data.ts:22
    • @@ -116,7 +116,7 @@
    props: Returns BuildImageDataStack
    +
  • Defined in lib/build-image-data.ts:26

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-data.ts:24

    • Readonly tags

    tags: TagManager
    @@ -486,7 +486,7 @@
    bucketName: Returns IBucket
    +
  • Defined in lib/build-image-data.ts:38

    • Static isStack

    +
  • Defined in lib/build-image-pipeline.ts:40
    • @@ -116,7 +116,7 @@
    props: Returns BuildImagePipelineStack
    +
  • Defined in lib/build-image-pipeline.ts:41

    • Properties

    diff --git a/classes/BuildImageRepoStack.html b/classes/BuildImageRepoStack.html index faae0f0..0c89479 100644 --- a/classes/BuildImageRepoStack.html +++ b/classes/BuildImageRepoStack.html @@ -27,7 +27,7 @@

    Hierarchy

    • BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:10
    • @@ -116,7 +116,7 @@
    Optional Returns BuildImageRepoStack
    +
  • Defined in lib/build-image-repo.ts:14

    • Properties

    @@ -126,7 +126,7 @@

    Readonly

    +
  • Defined in lib/build-image-repo.ts:12

    • Readonly tags

    tags: TagManager
    diff --git a/classes/EmbeddedLinuxPipelineStack.html b/classes/EmbeddedLinuxPipelineStack.html index f83f63c..83895e3 100644 --- a/classes/EmbeddedLinuxPipelineStack.html +++ b/classes/EmbeddedLinuxPipelineStack.html @@ -27,7 +27,7 @@

    Hierarchy

    +
  • Defined in lib/embedded-linux-pipeline.ts:58
    • @@ -121,7 +121,7 @@
    props: Returns EmbeddedLinuxPipelineStack
    +
  • Defined in lib/embedded-linux-pipeline.ts:59

    • Properties

    @@ -494,7 +494,7 @@

    Returns string

    +
  • Defined in lib/embedded-linux-pipeline.ts:338

    • Private addVMExportPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:355

    • Private addAMIS3BackupPolicy

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:370

    • Private addAMIEBSBackupPolicy

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:382

    • Private addAMIBackupPolicy

    +
  • Defined in lib/embedded-linux-pipeline.ts:395

    • Private addAMIEC2EBSBackupPolicy

    Returns PolicyStatement

    +
  • Defined in lib/embedded-linux-pipeline.ts:402

    • Static isStack

    +
  • Defined in lib/network.ts:12
    • @@ -115,7 +115,7 @@
    Optional Returns PipelineNetworkStack
    +
  • Defined in lib/network.ts:16

    • Properties

    @@ -125,7 +125,7 @@

    Readonly

    +
  • Defined in lib/network.ts:14

    • Readonly tags

    tags: TagManager
    diff --git a/classes/SourceRepo.html b/classes/SourceRepo.html index 3879c92..6fd9442 100644 --- a/classes/SourceRepo.html +++ b/classes/SourceRepo.html @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in lib/constructs/source-repo.ts:38
    • @@ -67,7 +67,7 @@
    props: Returns SourceRepo
    +
  • Defined in lib/constructs/source-repo.ts:42

    • Properties

    @@ -77,7 +77,7 @@

    Readonly

    +
  • Defined in lib/constructs/source-repo.ts:40

    • Readonly node

    node: Node
    diff --git a/enums/ImageKind.html b/enums/ImageKind.html index 36ea68f..c1397df 100644 --- a/enums/ImageKind.html +++ b/enums/ImageKind.html @@ -20,7 +20,7 @@

    Enumeration ImageKind

    +
  • Defined in lib/build-image-pipeline.ts:17
    • @@ -39,7 +39,7 @@

    Ubuntu22_04

    +
  • Defined in lib/build-image-pipeline.ts:19
    • diff --git a/enums/ProjectKind.html b/enums/ProjectKind.html index 0fb9776..beda325 100644 --- a/enums/ProjectKind.html +++ b/enums/ProjectKind.html @@ -20,7 +20,7 @@

    Enumeration ProjectKind

    +
  • Defined in lib/constructs/source-repo.ts:10
    • @@ -44,7 +44,7 @@

    Poky

    +
  • Defined in lib/constructs/source-repo.ts:12

    • MetaAwsDemo

    MetaAwsDemo: "meta-aws-demo"
    @@ -52,7 +52,7 @@

    MetaAwsDemo

    +
  • Defined in lib/constructs/source-repo.ts:14

    • PokyAmi

    PokyAmi: "poky-ami"
    @@ -60,7 +60,7 @@

    PokyAmi

    +
  • Defined in lib/constructs/source-repo.ts:16

    • Kas

    Kas: "kas"
    @@ -68,7 +68,7 @@

    Kas

    +
  • Defined in lib/constructs/source-repo.ts:18

    • Renesas

    Renesas: "renesas"
    @@ -76,7 +76,7 @@

    Renesas

    +
  • Defined in lib/constructs/source-repo.ts:20

    • NxpImx

    NxpImx: "nxp-imx"
    @@ -84,7 +84,7 @@

    NxpImx

    +
  • Defined in lib/constructs/source-repo.ts:22
    • diff --git a/index.html b/index.html index fc3da41..67e697c 100644 --- a/index.html +++ b/index.html @@ -15,7 +15,14 @@

    aws4embeddedlinux-cdk-lib

    aws4embeddedlinux-ci

    This cdk IaC library helps you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.

    Architecture

    architecture overview

    API documentation

    API documentation generated by npm run doc

    -

    Setting Up

    Quickstart

    Use the examples in our examples repo.

    +

    Setting Up

    In order to use this library, you must set up the CDK, including +installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have Node installed.

    +
    +

    [!NOTE] +This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend +using NVM to install a compatible version

    +
    +

    Quickstart

    Use the examples in our examples repo.

    Setting Up A New Project

    1. Create a CDK project. More details can be found in the CDK Getting Started Documentation.
      mkdir my-project
      cd my-project
      cdk init app --language typescript
      diff --git a/interfaces/BuildImageDataProps.html b/interfaces/BuildImageDataProps.html index 450f6a8..599721a 100644 --- a/interfaces/BuildImageDataProps.html +++ b/interfaces/BuildImageDataProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImageDataProps
      2. +
    2. Defined in lib/build-image-data.ts:14
      3. @@ -55,7 +55,7 @@

      Readonly

      +
    3. Defined in lib/build-image-data.ts:16

      4. Optional Readonly description

      description?: string
      diff --git a/interfaces/BuildImagePipelineProps.html b/interfaces/BuildImagePipelineProps.html index 3a9b5f3..f45527c 100644 --- a/interfaces/BuildImagePipelineProps.html +++ b/interfaces/BuildImagePipelineProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • BuildImagePipelineProps
      +
    4. Defined in lib/build-image-pipeline.ts:25
      5. @@ -57,7 +57,7 @@

      Readonly

      +
    5. Defined in lib/build-image-pipeline.ts:27

      6. Readonly dataBucket

      dataBucket: IBucket
      @@ -65,7 +65,7 @@

      Readonly

      +
    6. Defined in lib/build-image-pipeline.ts:29

      7. Readonly repository

      repository: IRepository
      @@ -73,7 +73,7 @@

      Readonly

      +
    7. Defined in lib/build-image-pipeline.ts:31

      8. Optional Readonly description

      description?: string
      diff --git a/interfaces/EmbeddedLinuxPipelineProps.html b/interfaces/EmbeddedLinuxPipelineProps.html index 47a7250..623f671 100644 --- a/interfaces/EmbeddedLinuxPipelineProps.html +++ b/interfaces/EmbeddedLinuxPipelineProps.html @@ -26,7 +26,7 @@

      Hierarchy

      • EmbeddedLinuxPipelineProps
      +
    8. Defined in lib/embedded-linux-pipeline.ts:40
      9. @@ -59,7 +59,7 @@

      Readonly

      +
    9. Defined in lib/embedded-linux-pipeline.ts:42

      10. Optional Readonly imageTag

      imageTag?: string
      @@ -67,7 +67,7 @@

      Optional

      +
    10. Defined in lib/embedded-linux-pipeline.ts:44

      11. Readonly vpc

      vpc: IVpc
      @@ -75,7 +75,7 @@

      Readonly

      +
    11. Defined in lib/embedded-linux-pipeline.ts:46

      12. Optional Readonly projectKind

      projectKind?: ProjectKind
      @@ -83,7 +83,7 @@

      Optional

      +
    12. Defined in lib/embedded-linux-pipeline.ts:48

      13. Optional Readonly layerRepoName

      layerRepoName?: string
      @@ -91,7 +91,7 @@

      Optional

      +
    13. Defined in lib/embedded-linux-pipeline.ts:50

      14. Optional Readonly description

      description?: string
      diff --git a/interfaces/SourceRepoProps.html b/interfaces/SourceRepoProps.html index 9dff7f0..1dd7369 100644 --- a/interfaces/SourceRepoProps.html +++ b/interfaces/SourceRepoProps.html @@ -22,7 +22,7 @@

      Hierarchy

      • SourceRepoProps
      +
    14. Defined in lib/constructs/source-repo.ts:25
      15. @@ -52,7 +52,7 @@

      Readonly

      +
    15. Defined in lib/constructs/source-repo.ts:27

      16. Readonly kind

      kind: ProjectKind
      @@ -60,7 +60,7 @@

      Readonly

      +
    16. Defined in lib/constructs/source-repo.ts:29

      17. Optional Readonly description

      description?: string