From 71674a4487532cfbf92bab3c1390650011bda6ed Mon Sep 17 00:00:00 2001 From: timtay-microsoft Date: Tue, 23 Sep 2025 11:39:26 -0700 Subject: [PATCH 1/5] Add metadata packaging documentation --- doc/akri_connector/packaging-metadata-with-connector | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 doc/akri_connector/packaging-metadata-with-connector diff --git a/doc/akri_connector/packaging-metadata-with-connector b/doc/akri_connector/packaging-metadata-with-connector new file mode 100644 index 000000000..1feadd7d1 --- /dev/null +++ b/doc/akri_connector/packaging-metadata-with-connector @@ -0,0 +1,10 @@ +# How to package connector metadata with + +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: + +```bash +oras attach /: --artifact-type application/json +``` + +where the connector metadata file is a JSON file that adheres to the schema defined [here](connector-metadata-schema.json). \ No newline at end of file From 454b68b87961de82bdde09d62fc3af51adee7b30 Mon Sep 17 00:00:00 2001 From: Tim Taylor Date: Tue, 23 Sep 2025 11:58:14 -0700 Subject: [PATCH 2/5] Update doc/akri_connector/packaging-metadata-with-connector Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- doc/akri_connector/packaging-metadata-with-connector | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/akri_connector/packaging-metadata-with-connector b/doc/akri_connector/packaging-metadata-with-connector index 1feadd7d1..b06d652b8 100644 --- a/doc/akri_connector/packaging-metadata-with-connector +++ b/doc/akri_connector/packaging-metadata-with-connector @@ -1,4 +1,4 @@ -# How to package connector metadata with +# 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: From af5801a3719181ed80faae9067766576b7821aa0 Mon Sep 17 00:00:00 2001 From: Tim Taylor Date: Tue, 23 Sep 2025 11:58:23 -0700 Subject: [PATCH 3/5] Update doc/akri_connector/packaging-metadata-with-connector Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- doc/akri_connector/packaging-metadata-with-connector | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/akri_connector/packaging-metadata-with-connector b/doc/akri_connector/packaging-metadata-with-connector index b06d652b8..4dbb95b22 100644 --- a/doc/akri_connector/packaging-metadata-with-connector +++ b/doc/akri_connector/packaging-metadata-with-connector @@ -7,4 +7,4 @@ attach the metadata using ORAS like: oras attach /: --artifact-type application/json ``` -where the connector metadata file is a JSON file that adheres to the schema defined [here](connector-metadata-schema.json). \ No newline at end of file +where the connector metadata file is a JSON file that adheres to the schema defined [here](/doc/akri_connector/connector-metadata-schema.json). \ No newline at end of file From dd3e74d7becefda5cf32362776b7a5bdd3c31468 Mon Sep 17 00:00:00 2001 From: timtay-microsoft Date: Thu, 25 Sep 2025 12:27:35 -0700 Subject: [PATCH 4/5] media type --- doc/akri_connector/packaging-metadata-with-connector | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/akri_connector/packaging-metadata-with-connector b/doc/akri_connector/packaging-metadata-with-connector index 4dbb95b22..cd1c2ba0c 100644 --- a/doc/akri_connector/packaging-metadata-with-connector +++ b/doc/akri_connector/packaging-metadata-with-connector @@ -4,7 +4,7 @@ In order for the user of a connector to access the metadata associated with it, attach the metadata using ORAS like: ```bash -oras attach /: --artifact-type application/json +oras attach /: :application/vnd.microsoft.akri-connector.v1+json --artifact-type application/json ``` where the connector metadata file is a JSON file that adheres to the schema defined [here](/doc/akri_connector/connector-metadata-schema.json). \ No newline at end of file From e77d02716d07e0cd0e108d0f374fb18eb1475375 Mon Sep 17 00:00:00 2001 From: timtay-microsoft Date: Mon, 29 Sep 2025 11:09:37 -0700 Subject: [PATCH 5/5] latest --- .../packaging-metadata-for-connector | 20 +++++++++++++++++++ .../packaging-metadata-with-connector | 10 ---------- 2 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 doc/akri_connector/packaging-metadata-for-connector delete mode 100644 doc/akri_connector/packaging-metadata-with-connector 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 diff --git a/doc/akri_connector/packaging-metadata-with-connector b/doc/akri_connector/packaging-metadata-with-connector deleted file mode 100644 index cd1c2ba0c..000000000 --- a/doc/akri_connector/packaging-metadata-with-connector +++ /dev/null @@ -1,10 +0,0 @@ -# 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: - -```bash -oras attach /: :application/vnd.microsoft.akri-connector.v1+json --artifact-type application/json -``` - -where the connector metadata file is a JSON file that adheres to the schema defined [here](/doc/akri_connector/connector-metadata-schema.json). \ No newline at end of file