Add metadata packaging documentation #1030
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
| ```bash | ||
| oras push --config <path_to_empty_file>:application/vnd.microsoft.akri-connector.v1+json <container_registry>/<connector_name>-metadata:<connector_version> <connector_metadata_file> | ||
| ``` | ||
|
|
||
| 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](https://raw.githubusercontent.com/SchemaStore/schemastore/refs/heads/master/src/schemas/json/aio-connector-metadata-9.0-preview.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-metadata:1.0.0 ./minimal-example-connector-metadata.json | ||
| ``` | ||
|
|
||
| See [this doc](https://oras.land/docs/commands/oras_push/) for more options/details when using ORAS to push. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this be a
.mdfile?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, yes