Skip to content
Open
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions doc/akri_connector/packaging-metadata-for-connector
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# How to package connector metadata for connector images

In order for the user of a connector to access the metadata associated with it, the publisher of a connector must push the metadata using ORAS like:

Check warning on line 3 in doc/akri_connector/packaging-metadata-for-connector

View workflow job for this annotation

GitHub Actions / CI-spelling

Unknown word (ORAS) Suggestions: (oars, okas, oral, oran, orbs)

```bash
oras push --config <path_to_empty_file>:application/vnd.microsoft.akri-connector.v1+json <container_registry>/<connector_name>:<connector_version>-metadata <connector_metadata_file>

Check warning on line 6 in doc/akri_connector/packaging-metadata-for-connector

View workflow job for this annotation

GitHub Actions / CI-spelling

Unknown word (oras) Suggestions: (oars, okas, oral, oran, orbs)
```

where:
- <path_to_empty_file> can be any file ("/dev/null" is a good choice for linux) as the contents won't be checked
- The connector metadata file is a JSON file that adheres to the schema defined [here](/doc/akri_connector/connector-metadata-schema.json) such as the examples in this folder.


for example:

```bash
oras push --config /dev/null:application/vnd.microsoft.akri-connector.v1+json someAcr.azurecr.io/akri-connectors/minimal-example-connector:1.0.0-metadata ./minimal-example-connector-metadata.json

Check warning on line 17 in doc/akri_connector/packaging-metadata-for-connector

View workflow job for this annotation

GitHub Actions / CI-spelling

Unknown word (oras) Suggestions: (oars, okas, oral, oran, orbs)
```

See [this doc](https://oras.land/docs/commands/oras_push/) for more options/details when using ORAS to push.

Check warning on line 20 in doc/akri_connector/packaging-metadata-for-connector

View workflow job for this annotation

GitHub Actions / CI-spelling

Unknown word (ORAS) Suggestions: (oars, okas, oral, oran, orbs)
Loading