Merge pull request #2254 from rgl/add-registry-push-oci-image-manigest-annotations

feat: add support for setting the pushed oci image manifest annotations

Author: itowlson

crates/oci/src/client.rs

@@ -1,6 +1,6 @@
 //! Spin's client for distributing applications via OCI registries
 
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::path::{Path, PathBuf};
 
 use anyhow::{bail, Context, Result};
@@ -103,6 +103,7 @@ impl Client {
         &mut self,
         manifest_path: &Path,
         reference: impl AsRef<str>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Result<Option<String>> {
         let reference: Reference = reference
             .as_ref()
@@ -121,7 +122,8 @@ impl Client {
         )
         .await?;
 
-        self.push_locked_core(locked, auth, reference).await
+        self.push_locked_core(locked, auth, reference, annotations)
+            .await
     }
 
     /// Push a Spin application to an OCI registry and return the digest (or None
@@ -130,14 +132,16 @@ impl Client {
         &mut self,
         locked: LockedApp,
         reference: impl AsRef<str>,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Result<Option<String>> {
         let reference: Reference = reference
             .as_ref()
             .parse()
             .with_context(|| format!("cannot parse reference {}", reference.as_ref()))?;
         let auth = Self::auth(&reference).await?;
 
-        self.push_locked_core(locked, auth, reference).await
+        self.push_locked_core(locked, auth, reference, annotations)
+            .await
     }
 
     /// Push a Spin application to an OCI registry and return the digest (or None
@@ -147,6 +151,7 @@ impl Client {
         locked: LockedApp,
         auth: RegistryAuth,
         reference: Reference,
+        annotations: Option<BTreeMap<String, String>>,
     ) -> Result<Option<String>> {
         let mut locked_app = locked.clone();
         let mut layers = self
@@ -199,7 +204,7 @@ impl Client {
         };
         let oci_config =
             oci_distribution::client::Config::oci_v1_from_config_file(oci_config_file, None)?;
-        let manifest = OciImageManifest::build(&layers, &oci_config, None);
+        let manifest = OciImageManifest::build(&layers, &oci_config, annotations);
 
         let response = self
             .oci

src/commands/registry.rs

@@ -2,6 +2,7 @@ use crate::opts::*;
 use anyhow::{Context, Result};
 use clap::{Parser, Subcommand};
 use indicatif::{ProgressBar, ProgressStyle};
+use spin_common::arg_parser::parse_kv;
 use spin_oci::Client;
 use std::{io::Read, path::PathBuf, time::Duration};
 
@@ -61,6 +62,11 @@ pub struct Push {
     /// Cache directory for downloaded registry data.
     #[clap(long)]
     pub cache_dir: Option<PathBuf>,
+
+    /// Specifies the OCI image manifest annotations (in key=value format).
+    /// Any existing value will be overwritten. Can be used multiple times.
+    #[clap(long = "annotation", parse(try_from_str = parse_kv))]
+    pub annotations: Vec<(String, String)>,
 }
 
 impl Push {
@@ -70,11 +76,17 @@ impl Push {
             spin_build::build(&app_file, &[]).await?;
         }
 
+        let annotations = if self.annotations.is_empty() {
+            None
+        } else {
+            Some(self.annotations.iter().cloned().collect())
+        };
+
         let mut client = spin_oci::Client::new(self.insecure, self.cache_dir.clone()).await?;
 
         let _spinner = create_dotted_spinner(2000, "Pushing app to the Registry".to_owned());
 
-        let digest = client.push(&app_file, &self.reference).await?;
+        let digest = client.push(&app_file, &self.reference, annotations).await?;
         match digest {
             Some(digest) => println!("Pushed with digest {digest}"),
             None => println!("Pushed; the registry did not return the digest"),