Class: ComposeDeploymentProfileDescription

 classDiagram
    class ComposeDeploymentProfileDescription
    click ComposeDeploymentProfileDescription href "../ComposeDeploymentProfileDescription/"
      DeploymentProfileDescription <|-- ComposeDeploymentProfileDescription
        click DeploymentProfileDescription href "../DeploymentProfileDescription/"

      ComposeDeploymentProfileDescription : components





        ComposeDeploymentProfileDescription --> "1..*" ComposeComponent : components
        click ComposeComponent href "../ComposeComponent/"



      ComposeDeploymentProfileDescription : description

      ComposeDeploymentProfileDescription : id

      ComposeDeploymentProfileDescription : requiredResources





        ComposeDeploymentProfileDescription --> "0..1" Resources : requiredResources
        click Resources href "../Resources/"



      ComposeDeploymentProfileDescription : type

Inheritance

• DeploymentProfile
  • DeploymentProfileDescription
    • ComposeDeploymentProfileDescription

Attributes

Name	Cardinality and Range	Description	Inheritance
id	1 string	An identifier for the deployment profile, given by the application developer,...	DeploymentProfileDescription
description	0..1 string	This human-readable description of a deployment profile allows for providing ...	DeploymentProfileDescription
requiredResources	0..1 Resources	Required resources element specifying the resources required to install the a...	DeploymentProfileDescription
type	1 string	Defines the type of this deployment configuration for the application	DeploymentProfile
components	1..* ComposeComponent	Component element indicating the components to deploy when installing the app...	DeploymentProfile

---

This section is only relevant for contributors of the specification

LinkML Source

Direct

Details

name: ComposeDeploymentProfileDescription
from_schema: https://specification.margo.org/data-model
is_a: DeploymentProfileDescription
slot_usage:
  type:
    name: type
    equals_string: compose
  components:
    name: components
    range: ComposeComponent

Induced

Details

name: ComposeDeploymentProfileDescription
from_schema: https://specification.margo.org/data-model
is_a: DeploymentProfileDescription
slot_usage:
  type:
    name: type
    equals_string: compose
  components:
    name: components
    range: ComposeComponent
attributes:
  id:
    name: id
    description: An identifier for the deployment profile, given by the application
      developer, used to uniquely identify this deployment profile from others within
      this application description's scope.
    from_schema: https://specification.margo.org/application-schema
    alias: id
    owner: ComposeDeploymentProfileDescription
    domain_of:
    - DeploymentAnnotations
    - ApplicationMetadata
    - DeploymentProfileDescription
    - Properties
    range: string
    required: true
  description:
    name: description
    description: This human-readable description of a deployment profile allows for
      providing additional context about the deployment profile. E.g., the application
      developer can use this to describe the deployment profile's purpose, such as
      the intended use case. Additionally, the application developer can use this
      to provide further details about the resources, peripherals, and interfaces
      required to run the application.
    from_schema: https://specification.margo.org/application-schema
    alias: description
    owner: ComposeDeploymentProfileDescription
    domain_of:
    - ApplicationMetadata
    - DeploymentProfileDescription
    - Setting
    range: string
    required: false
  requiredResources:
    name: requiredResources
    description: Required resources element specifying the resources required to install
      the application. See the [Required Resources](#requiredresources-attributes)
      section below. The consequences (e.g., aborting / blocking the installation
      or execution of the application) of not meeting these required resources are
      not defined (yet) by margo.
    from_schema: https://specification.margo.org/application-schema
    alias: requiredResources
    owner: ComposeDeploymentProfileDescription
    domain_of:
    - DeploymentProfileDescription
    range: Resources
    required: false
  type:
    name: type
    description: Defines the type of this deployment configuration for the application.  The
      allowed values are `helm.v3`, to indicate the deployment profile's format is
      Helm version 3,  and `compose` to indicate the deployment profile's format is
      a Compose file.  When installing the application on a device supporting the
      Kubernetes platform, all `helm.v3` components,  and only `helm.v3` components,
      will be provided to the device in same order they are listed in the application
      description file.  When installing the application on a device supporting Compose,
      all `compose` components,  and only `compose` components, will be provided to
      the device in the same order they are listed in the application description
      file.  The device will install the components in the same order they are listed
      in the application description file.
    from_schema: https://specification.margo.org/data-model
    alias: type
    owner: ComposeDeploymentProfileDescription
    domain_of:
    - DeploymentProfile
    - Peripheral
    - CommunicationInterface
    range: string
    required: true
    pattern: ^(helm\.v3|compose)$
    equals_string: compose
  components:
    name: components
    description: Component element indicating the components to deploy when installing
      the application.  See the [Component](#component-attributes) section below.
    from_schema: https://specification.margo.org/data-model
    alias: components
    owner: ComposeDeploymentProfileDescription
    domain_of:
    - DeploymentProfile
    - Target
    - DeploymentStatusManifest
    range: ComposeComponent
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true