cloudcomponents.cdk-container-registry


Namecloudcomponents.cdk-container-registry JSON
Version 2.4.0 PyPI version JSON
download
home_pagehttps://github.com/cloudcomponents/cdk-constructs
SummaryRegistry for container images
upload_time2024-05-16 19:33:25
maintainerNone
docs_urlNone
authorhupe1980
requires_python~=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)

# @cloudcomponents/cdk-container-registry

[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)
[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-container-registry)
[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-container-registry/)

> Registry for container images

## Install

TypeScript/JavaScript:

```bash
npm i @cloudcomponents/cdk-container-registry
```

Python:

```bash
pip install cloudcomponents.cdk-container-registry
```

## How to use

```python
import { ImageRepository, Severity } from '@cloudcomponents/cdk-container-registry';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Topic } from 'aws-cdk-lib/aws-sns';
import { EmailSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';
import { Construct } from 'constructs';

export class ImageRepositoryStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const alarmTopic = new Topic(this, 'Topic');

    alarmTopic.addSubscription(
      new EmailSubscription(process.env.DEVSECOPS_TEAM_EMAIL as string),
    );

    const imageRepository = new ImageRepository(this, 'ImageRepository', {
      forceDelete: true, //Only for tests
      imageScanOnPush: true,
    });

    imageRepository.onFinding('finding', {
      severity: Severity.HIGH,
      alarmTopic,
    });
  }
}
```

## API Reference

See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-container-registry/API.md).

## Example

See more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).

## License

[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-container-registry/LICENSE)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cloudcomponents/cdk-constructs",
    "name": "cloudcomponents.cdk-container-registry",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "hupe1980",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/cb/44/b4c045989a45dc9e510fc85ec5d0b2ad414c483d829c8216c07d14f49582/cloudcomponents.cdk-container-registry-2.4.0.tar.gz",
    "platform": null,
    "description": "[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-container-registry\n\n[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)\n[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-container-registry)\n[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-container-registry/)\n\n> Registry for container images\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-container-registry\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-container-registry\n```\n\n## How to use\n\n```python\nimport { ImageRepository, Severity } from '@cloudcomponents/cdk-container-registry';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Topic } from 'aws-cdk-lib/aws-sns';\nimport { EmailSubscription } from 'aws-cdk-lib/aws-sns-subscriptions';\nimport { Construct } from 'constructs';\n\nexport class ImageRepositoryStack extends Stack {\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n\n    const alarmTopic = new Topic(this, 'Topic');\n\n    alarmTopic.addSubscription(\n      new EmailSubscription(process.env.DEVSECOPS_TEAM_EMAIL as string),\n    );\n\n    const imageRepository = new ImageRepository(this, 'ImageRepository', {\n      forceDelete: true, //Only for tests\n      imageScanOnPush: true,\n    });\n\n    imageRepository.onFinding('finding', {\n      severity: Severity.HIGH,\n      alarmTopic,\n    });\n  }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-container-registry/API.md).\n\n## Example\n\nSee more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).\n\n## License\n\n[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-container-registry/LICENSE)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Registry for container images",
    "version": "2.4.0",
    "project_urls": {
        "Homepage": "https://github.com/cloudcomponents/cdk-constructs",
        "Source": "https://github.com/cloudcomponents/cdk-constructs.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9c9251cd9ecf39e2fc671638c7523dae99fb47f347e30eb0d43277786e5da3d2",
                "md5": "25dc2f1026fa9a774d470f8279b2defe",
                "sha256": "ae2b1b1d3452f614e71f5506b173dc5a59c416c8b01ae5a05a2e4f0921d2c720"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk_container_registry-2.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "25dc2f1026fa9a774d470f8279b2defe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 138974,
            "upload_time": "2024-05-16T19:33:05",
            "upload_time_iso_8601": "2024-05-16T19:33:05.153921Z",
            "url": "https://files.pythonhosted.org/packages/9c/92/51cd9ecf39e2fc671638c7523dae99fb47f347e30eb0d43277786e5da3d2/cloudcomponents.cdk_container_registry-2.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cb44b4c045989a45dc9e510fc85ec5d0b2ad414c483d829c8216c07d14f49582",
                "md5": "9bc0eb347b01781e3ebe4916bcb60270",
                "sha256": "b66fa1469b06a99de34da3b05579eef0e4d1f34040d47577c80e330e43f57f7e"
            },
            "downloads": -1,
            "filename": "cloudcomponents.cdk-container-registry-2.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9bc0eb347b01781e3ebe4916bcb60270",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 140064,
            "upload_time": "2024-05-16T19:33:25",
            "upload_time_iso_8601": "2024-05-16T19:33:25.944420Z",
            "url": "https://files.pythonhosted.org/packages/cb/44/b4c045989a45dc9e510fc85ec5d0b2ad414c483d829c8216c07d14f49582/cloudcomponents.cdk-container-registry-2.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-16 19:33:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cloudcomponents",
    "github_project": "cdk-constructs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cloudcomponents.cdk-container-registry"
}
hupe1980
Elapsed time: 4.21859s