Skip to content

docs: ecrplugin readme #1482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jakobmoellerdev merged 3 commits into from
Jun 3, 2025
Merged

docs: ecrplugin readme #1482

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
808cece
ecrplugin readme
ikhandamirov May 23, 2025
0d8a753
ecrplugin readme
ikhandamirov May 23, 2025
96421a5
Merge branch 'main' into ecrplugin/readme
ikhandamirov Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions cmds/ecrplugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AWS Elastic Container Registry Repository Creation Plugin

The goal of the plugin is to assure the existence of required AWS Elastic Container Registry repositories, when used with OCM CLI.

## Usage

1. Install the latest version of the plugin with OCM CLI:

```console
ocm install plugin ghcr.io/open-component-model/ocm//ocm.software/plugins/ecrplugin
```

2. Configure an `ocmconfig`with credentials:

```yaml
configurations:
- type: credentials.config.ocm.software
consumers:
- identity:
type: AWS
credentials:
- type: Credentials
properties:
awsAccessKeyID: "xxx"
awsSecretAccessKey: "yyy"
```

3. Do `ocm transfer`. The plugin will be called automatically and make sure the target repository exists,
if the URL of the target repository fits to the pattern defined [here](https://github.com/open-component-model/ocm/blob/main/cmds/ecrplugin/actions/action.go#L110)
Loading