@epilot360/icons 0.0.1 → 0.0.2

package/iac/node_modules/aws-cdk-lib/aws-ecr/README.md

@@ -0,0 +1,110 @@
+# Amazon ECR Construct Library
+
+
+This package contains constructs for working with Amazon Elastic Container Registry.
+
+## Repositories
+
+Define a repository by creating a new instance of `Repository`. A repository
+holds multiple verions of a single container image.
+
+```ts
+const repository = new ecr.Repository(this, 'Repository');
+```
+
+## Image scanning
+
+Amazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable `imageScanOnPush` in the properties
+
+```ts
+const repository = new ecr.Repository(this, 'Repo', {
+  imageScanOnPush: true,
+});
+```
+
+To create an `onImageScanCompleted` event rule and trigger the event target
+
+```ts
+declare const repository: ecr.Repository;
+declare const target: SomeTarget;
+
+repository.onImageScanCompleted('ImageScanComplete')
+  .addTarget(target);
+```
+
+### Authorization Token
+
+Besides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull
+images from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and
+additional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests.
+More information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth).
+
+A Docker authorization token can be obtained using the `GetAuthorizationToken` ECR API. The following code snippets
+grants an IAM user access to call this API.
+
+```ts
+const user = new iam.User(this, 'User');
+ecr.AuthorizationToken.grantRead(user);
+```
+
+If you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from
+higher rate and bandwidth limits.
+
+> See `Pricing` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html).
+
+The following code snippet grants an IAM user access to retrieve an authorization token for the public gallery.
+
+```ts
+const user = new iam.User(this, 'User');
+ecr.PublicGalleryAuthorizationToken.grantRead(user);
+```
+
+This user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth).
+
+### Image tag immutability
+
+You can set tag immutability on images in our repository using the `imageTagMutability` construct prop.
+
+```ts
+new ecr.Repository(this, 'Repo', { imageTagMutability: ecr.TagMutability.IMMUTABLE });
+```
+
+### Encryption
+
+By default, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. For more control over the encryption for your Amazon ECR repositories, you can use server-side encryption with KMS keys stored in AWS Key Management Service (AWS KMS). Read more about this feature in the [ECR Developer Guide](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html).
+
+When you use AWS KMS to encrypt your data, you can either use the default AWS managed key, which is managed by Amazon ECR, by specifying `RepositoryEncryption.KMS` in the `encryption` property. Or specify your own customer managed KMS key, by specifying the `encryptionKey` property. 
+
+When `encryptionKey` is set, the `encryption` property must be `KMS` or empty.
+
+In the case `encryption` is set to `KMS` but no `encryptionKey` is set, an AWS managed KMS key is used.
+
+```ts
+new ecr.Repository(this, 'Repo', {
+  encryption: ecr.RepositoryEncryption.KMS
+});
+```
+
+Otherwise, a customer-managed KMS key is used if `encryptionKey` was set and `encryption` was optionally set to `KMS`.
+
+```ts
+import * as kms from 'aws-cdk-lib/aws-kms';
+
+new ecr.Repository(this, 'Repo', {
+  encryptionKey: new kms.Key(this, 'Key'),
+});
+```
+
+## Automatically clean up repositories
+
+You can set life cycle rules to automatically clean up old images from your
+repository. The first life cycle rule that matches an image will be applied
+against that image. For example, the following deletes images older than
+30 days, while keeping all images tagged with prod (note that the order
+is important here):
+
+```ts
+declare const repository: ecr.Repository;
+repository.addLifecycleRule({ tagPrefixList: ['prod'], maxImageCount: 9999 });
+repository.addLifecycleRule({ maxImageAge: Duration.days(30) });
+```

package/iac/node_modules/aws-cdk-lib/aws-ecr-assets/README.md

@@ -0,0 +1,167 @@
+# AWS CDK Docker Image Assets
+
+
+This module allows bundling Docker images as assets.
+
+## Images from Dockerfile
+
+Images are built from a local Docker context directory (with a `Dockerfile`),
+uploaded to Amazon Elastic Container Registry (ECR) by the CDK toolkit
+and/or your app's CI/CD pipeline, and can be naturally referenced in your CDK app.
+
+```ts
+import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new DockerImageAsset(this, 'MyBuildImage', {
+  directory: path.join(__dirname, 'my-image'),
+});
+```
+
+The directory `my-image` must include a `Dockerfile`.
+
+This will instruct the toolkit to build a Docker image from `my-image`, push it
+to an Amazon ECR repository and wire the name of the repository as CloudFormation
+parameters to your stack.
+
+By default, all files in the given directory will be copied into the docker
+*build context*. If there is a large directory that you know you definitely
+don't need in the build context you can improve the performance by adding the
+names of files and directories to ignore to a file called `.dockerignore`, or
+pass them via the `exclude` property. If both are available, the patterns
+found in `exclude` are appended to the patterns found in `.dockerignore`.
+
+The `ignoreMode` property controls how the set of ignore patterns is
+interpreted. The recommended setting for Docker image assets is
+`IgnoreMode.DOCKER`. If the context flag
+`@aws-cdk/aws-ecr-assets:dockerIgnoreSupport` is set to `true` in your
+`cdk.json` (this is by default for new projects, but must be set manually for
+old projects) then `IgnoreMode.DOCKER` is the default and you don't need to
+configure it on the asset itself.
+
+Use `asset.imageUri` to reference the image. It includes both the ECR image URL
+and tag.
+
+Use `asset.imageTag` to reference only the image tag.
+
+You can optionally pass build args to the `docker build` command by specifying
+the `buildArgs` property. It is recommended to skip hashing of `buildArgs` for
+values that can change between different machines to maintain a consistent
+asset hash.
+
+```ts
+import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new DockerImageAsset(this, 'MyBuildImage', {
+  directory: path.join(__dirname, 'my-image'),
+  buildArgs: {
+    HTTP_PROXY: 'http://10.20.30.2:1234',
+  },
+  invalidation: {
+    buildArgs: false,
+  },
+});
+```
+
+You can optionally pass a target to the `docker build` command by specifying
+the `target` property:
+
+```ts
+import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new DockerImageAsset(this, 'MyBuildImage', {
+  directory: path.join(__dirname, 'my-image'),
+  target: 'a-target',
+});
+```
+
+You can optionally pass networking mode to the `docker build` command by specifying
+the `networkMode` property:
+
+```ts
+import { DockerImageAsset, NetworkMode } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new DockerImageAsset(this, 'MyBuildImage', {
+  directory: path.join(__dirname, 'my-image'),
+  networkMode: NetworkMode.HOST,
+})
+```
+
+You can optionally pass an alternate platform to the `docker build` command by specifying
+the `platform` property:
+
+```ts
+import { DockerImageAsset, Platform } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new DockerImageAsset(this, 'MyBuildImage', {
+  directory: path.join(__dirname, 'my-image'),
+  platform: Platform.LINUX_ARM64,
+})
+```
+
+## Images from Tarball
+
+Images are loaded from a local tarball, uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be
+naturally referenced in your CDK app.
+
+```ts
+import { TarballImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
+
+const asset = new TarballImageAsset(this, 'MyBuildImage', {
+  tarballFile: 'local-image.tar',
+});
+```
+
+This will instruct the toolkit to add the tarball as a file asset. During deployment it will load the container image
+from `local-image.tar`, push it to an Amazon ECR repository and wire the name of the repository as CloudFormation parameters
+to your stack.
+
+## Publishing images to ECR repositories
+
+`DockerImageAsset` is designed for seamless build & consumption of image assets by CDK code deployed to multiple environments
+through the CDK CLI or through CI/CD workflows. To that end, the ECR repository behind this construct is controlled by the AWS CDK.
+The mechanics of where these images are published and how are intentionally kept as an implementation detail, and the construct
+does not support customizations such as specifying the ECR repository name or tags.
+
+If you are looking for a way to _publish_ image assets to an ECR repository in your control, you should consider using
+[cdklabs/cdk-ecr-deployment], which is able to replicate an image asset from the CDK-controlled ECR repository to a repository of
+your choice.
+
+Here an example from the [cdklabs/cdk-ecr-deployment] project:
+
+```text
+// This example available in TypeScript only
+
+import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
+import * as ecrdeploy from 'cdk-ecr-deployment';
+
+const image = new DockerImageAsset(this, 'CDKDockerImage', {
+  directory: path.join(__dirname, 'docker'),
+});
+
+new ecrdeploy.ECRDeployment(this, 'DeployDockerImage', {
+  src: new ecrdeploy.DockerImageName(image.imageUri),
+  dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/test:nginx`),
+});
+```
+
+⚠️ Please note that this is a 3rd-party construct library and is not officially supported by AWS.
+You are welcome to +1 [this GitHub issue](https://github.com/aws/aws-cdk/issues/12597) if you would like to see
+native support for this use-case in the AWS CDK.
+
+[cdklabs/cdk-ecr-deployment]: https://github.com/cdklabs/cdk-ecr-deployment
+
+## Pull Permissions
+
+Depending on the consumer of your image asset, you will need to make sure
+the principal has permissions to pull the image.
+
+In most cases, you should use the `asset.repository.grantPull(principal)`
+method. This will modify the IAM policy of the principal to allow it to
+pull images from this repository.
+
+If the pulling principal is not in the same account or is an AWS service that
+doesn't assume a role in your account (e.g. AWS CodeBuild), pull permissions
+must be granted on the __resource policy__ (and not on the principal's policy).
+To do that, you can use `asset.repository.addToResourcePolicy(statement)` to
+grant the desired principal the following permissions: "ecr:GetDownloadUrlForLayer",
+"ecr:BatchGetImage" and "ecr:BatchCheckLayerAvailability".