Skip to content

Commit c04653a

Browse files
committed
ecrplugin readme
1 parent 0f4f602 commit c04653a

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

cmds/ecrplugin/README.md

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

0 commit comments

Comments
 (0)