Skip to content

Commit 808cece

Browse files
committed
ecrplugin readme
1 parent 0f4f602 commit 808cece

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

cmds/ecrplugin/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AWS ECR Repository Creation Plugin
2+
3+
The goal of the plugin is to assure the existence of required AWS Elastic Container Registry repositories, when used with OCM CLI.
4+
5+
## Usage
6+
7+
1. Install the latest version of the plugin with OCM CLI:
8+
9+
```console
10+
ocm install plugin ghcr.io/open-component-model/ocm//ocm.software/plugins/ecrplugin
11+
```
12+
13+
2. Configure an `ocmconfig`with credentials:
14+
15+
```yaml
16+
configurations:
17+
- type: credentials.config.ocm.software
18+
consumers:
19+
- identity:
20+
type: AWS
21+
credentials:
22+
- type: Credentials
23+
properties:
24+
awsAccessKeyID: "xxx"
25+
awsSecretAccessKey: "yyy"
26+
```
27+
28+
3. Do `ocm transfer`. The plugin will be called automatically and make sure the target repository exists,
29+
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)

0 commit comments

Comments
 (0)