Skip to content

Add metadata packaging documentation #1030

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add metadata packaging documentation #1030

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
71674a4
Add metadata packaging documentation
timtay-microsoft Sep 23, 2025
454b68b
Update doc/akri_connector/packaging-metadata-with-connector
timtay-microsoft Sep 23, 2025
af5801a
Update doc/akri_connector/packaging-metadata-with-connector
timtay-microsoft Sep 23, 2025
3f64c7d
Merge branch 'main' into timtay/oci
timtay-microsoft Sep 25, 2025
dd3e74d
media type
timtay-microsoft Sep 25, 2025
18907d8
Merge branch 'main' into timtay/oci
timtay-microsoft Sep 26, 2025
e77d027
latest
timtay-microsoft Sep 29, 2025
de7da83
Merge branch 'main' into timtay/oci
timtay-microsoft Oct 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
10 changes: 10 additions & 0 deletions doc/akri_connector/packaging-metadata-with-connector
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# How to package connector metadata with connector images

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

Check warning on line 4 in doc/akri_connector/packaging-metadata-with-connector

View workflow job for this annotation

GitHub Actions / CI-spelling 

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

```bash
oras attach <container_registry>/<container_name>:<version> <connector_metadata_file> --artifact-type application/json

Check warning on line 7 in doc/akri_connector/packaging-metadata-with-connector

View workflow job for this annotation

GitHub Actions / CI-spelling 

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

where the connector metadata file is a JSON file that adheres to the schema defined [here](/doc/akri_connector/connector-metadata-schema.json).
Loading