Class: Deployment

List of deployment objects describing each workload.

 classDiagram
    class Deployment
    click Deployment href "../Deployment/"
      Deployment : deploymentId

      Deployment : digest

      Deployment : sizeBytes

      Deployment : url

Attributes

Name	Cardinality and Range	Description	Inheritance
deploymentId	1 string	The UUID of the deployment	direct
digest	1 DigestType	Digest of the corresponding ApplicationDeployment YAML file	direct
sizeBytes	0..1 SizeBytesType	Optional unsigned 64-bit advisory estimate of the decoded payload length in b...	direct
url	1 UrlType	Content-addressable retrieval endpoint for the ApplicationDeployment YAML of ...	direct

Usages

used by	used in	type	used
DesiredStateManifest	deployments	range	Deployment

---

This section is only relevant for contributors of the specification

LinkML Source

Direct

Details

name: Deployment
description: List of deployment objects describing each workload.
from_schema: https://specification.margo.org/data-model
attributes:
  deploymentId:
    name: deploymentId
    description: The UUID of the deployment. MUST equal metadata.annotations.id in
      the ApplicationDeployment.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Deployment
    - DeploymentStatusManifest
    range: string
    required: true
  digest:
    name: digest
    description: "Digest of the corresponding ApplicationDeployment YAML file.\n MUST\
      \ equal the digest computed over the exact sequence of bytes in the individual\
      \ deployment endpoint's HTTP 200 OK response body.\n See Protocol - Digest for\
      \ further details."
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Bundle
    - Deployment
    range: DigestType
    required: true
  sizeBytes:
    name: sizeBytes
    description: Optional unsigned 64-bit advisory estimate of the decoded payload
      length in bytes for the ApplicationDeployment YAML. Provided for bandwidth estimation
      and update planning. MUST NOT be used for integrity verification.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Bundle
    - Deployment
    range: SizeBytesType
  url:
    name: url
    description: Content-addressable retrieval endpoint for the ApplicationDeployment
      YAML of the form /api/v1/clients/{clientId}/deployments/{deploymentId}/{digest}
      where {digest} equals deployments[].digest.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Bundle
    - Deployment
    range: UrlType
    required: true

Induced

Details

name: Deployment
description: List of deployment objects describing each workload.
from_schema: https://specification.margo.org/data-model
attributes:
  deploymentId:
    name: deploymentId
    description: The UUID of the deployment. MUST equal metadata.annotations.id in
      the ApplicationDeployment.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: deploymentId
    owner: Deployment
    domain_of:
    - Deployment
    - DeploymentStatusManifest
    range: string
    required: true
  digest:
    name: digest
    description: "Digest of the corresponding ApplicationDeployment YAML file.\n MUST\
      \ equal the digest computed over the exact sequence of bytes in the individual\
      \ deployment endpoint's HTTP 200 OK response body.\n See Protocol - Digest for\
      \ further details."
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: digest
    owner: Deployment
    domain_of:
    - Bundle
    - Deployment
    range: DigestType
    required: true
  sizeBytes:
    name: sizeBytes
    description: Optional unsigned 64-bit advisory estimate of the decoded payload
      length in bytes for the ApplicationDeployment YAML. Provided for bandwidth estimation
      and update planning. MUST NOT be used for integrity verification.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: sizeBytes
    owner: Deployment
    domain_of:
    - Bundle
    - Deployment
    range: SizeBytesType
  url:
    name: url
    description: Content-addressable retrieval endpoint for the ApplicationDeployment
      YAML of the form /api/v1/clients/{clientId}/deployments/{deploymentId}/{digest}
      where {digest} equals deployments[].digest.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: url
    owner: Deployment
    domain_of:
    - Bundle
    - Deployment
    range: UrlType
    required: true