Struct Metadata 

pub struct Metadata {

    pub id: String,
    pub name: String,
    pub version: Version,
    pub display_version: String,
    pub category: MultiLanguageItem,
    pub tagline: MultiLanguageItem,
    pub developers: BTreeMap<String, String>,
    pub description: MultiLanguageItem,
    pub dependencies: Vec<Dependency>,
    pub has_permissions: Vec<String>,
    pub exposes_permissions: Vec<Permission>,
    pub repos: BTreeMap<String, String>,
    pub support: String,
    pub gallery: Vec<String>,
    pub icon: Option<String>,
    pub path: Option<String>,
    pub default_username: Option<String>,
    pub default_password: Option<String>,
    pub implements: Option<String>,
    pub release_notes: BTreeMap<String, BTreeMap<String, String>>,
    pub license: String,
    pub settings: BTreeMap<String, SettingsDeclaration>,
    pub volumes: HashMap<String, Volume>,
    pub ports: Vec<u16>,
    pub exported_data: Option<HashMap<String, HashMap<String, Value>>>,
    pub runtime: Runtime,
    pub type: AppType,
    pub store_plugins: Vec<StorePlugin>,
    pub ui_module: Option<UiModule>,
    pub supports_ingress: bool,
    pub allow_all_internal_ingress: bool,
    pub allow_ingress_from_ns: Vec<String>,
    pub can_be_protected: bool,
}

Fields

id: String

The app id

name: String

The name of the app

version: Version

The version of the app

display_version: String

The version of the app to display

category: MultiLanguageItem

The category for the app

tagline: MultiLanguageItem

A short tagline for the app

developers: BTreeMap<String, String>

Developer name -> their website

description: MultiLanguageItem

A description of the app

dependencies: Vec<Dependency>

Dependencies the app requires

has_permissions: Vec<String>

Permissions the app has If a permission is from an app that is not listed in the dependencies, it is considered optional

exposes_permissions: Vec<Permission>

Permissions this app exposes

repos: BTreeMap<String, String>

App repository name -> repo URL

support: String

A support link for the app

gallery: Vec<String>

A list of promo images for the apps

icon: Option<String>

The URL to the app icon

path: Option<String>

The path the “Open” link on the dashboard should lead to

default_username: Option<String>

The app’s default username

default_password: Option<String>

The app’s default password.

implements: Option<String>

For “virtual” apps, the service the app implements

release_notes: BTreeMap<String, BTreeMap<String, String>>

license: String

The SPDX identifier of the app license

settings: BTreeMap<String, SettingsDeclaration>

Available settings for this app, directly copied from settings.json

volumes: HashMap<String, Volume>

Volumes this app exposes

ports: Vec<u16>

Ports this app uses Before installing, app-manager clients need to check if any of these ports are already in use by other apps If so, the user needs to be notified

exported_data: Option<HashMap<String, HashMap<String, Value>>>

Exported data shared with plugins (Map plugin -> data)

runtime: Runtime

The runtime this app uses

type: AppType

The type of this app (app/library) - Library is anything that does not have a frontend

store_plugins: Vec<StorePlugin>

ui_module: Option<UiModule>

supports_ingress: bool

Whether the app supports ingress This is declared by app-manager based on whether an app’s ingress vec is empty, setting it during generation has no effect

allow_all_internal_ingress: bool

Whether to allow all cluster-internal ingress to this app

allow_ingress_from_ns: Vec<String>

can_be_protected: bool

Whether this app can be protected Please note: If the app type is not “App”, this field is ignored and will be treated as if it were false

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Metadata

impl StructuralPartialEq for Metadata