diff --git a/doc/akri_connector/packaging-metadata-for-connector b/doc/akri_connector/packaging-metadata-for-connector new file mode 100644 index 000000000..0ca597125 --- /dev/null +++ b/doc/akri_connector/packaging-metadata-for-connector @@ -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 :application/vnd.microsoft.akri-connector.v1+json /:-metadata +``` + +where: + - 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 +``` + +See [this doc](https://oras.land/docs/commands/oras_push/) for more options/details when using ORAS to push. \ No newline at end of file