Class: Bundle

Describes an archive containing all referenced ApplicationDeployment YAMLs. If there are zero deployments (i.e., the deployments array is empty), this field MUST be present with the value null. An empty archive MUST NOT be served.

 classDiagram
    class Bundle
    click Bundle href "../Bundle/"
      Bundle : digest

      Bundle : mediaType

      Bundle : sizeBytes

      Bundle : url

Attributes

Name	Cardinality and Range	Description	Inheritance
mediaType	1 string	MUST be application/vnd	direct
digest	1 DigestType	Digest of the bundle archive	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 bundle of the form /api/v1/cli...	direct

Usages

used by	used in	type	used
DesiredStateManifest	bundle	range	Bundle

---

This section is only relevant for contributors of the specification

LinkML Source

Direct

Details

name: Bundle
description: Describes an archive containing all referenced ApplicationDeployment
  YAMLs. If there are zero deployments (i.e., the deployments array is empty), this
  field MUST be present with the value null. An empty archive MUST NOT be served.
from_schema: https://specification.margo.org/data-model
attributes:
  mediaType:
    name: mediaType
    description: MUST be application/vnd.margo.bundle.v1+tar+gzip, which denotes a
      gzip-compressed tar archive (commonly delivered as a .tar.gz) whose root contains
      one or more ApplicationDeployment YAML files. Servers MUST set the HTTP Content-Type
      to this media type. The archive MUST contain exactly the set of YAML files referenced
      by deployments.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Bundle
    range: string
    required: true
    equals_string: application/vnd.margo.bundle.v1+tar+gzip
  digest:
    name: digest
    description: Digest of the bundle archive. MUST equal the digest computed over
      the exact sequence of bytes in the bundle endpoint's HTTP 200 OK response body.
      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 bundle archive. 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 bundle of the form
      /api/v1/clients/{clientId}/bundles/{digest} where {digest} equals bundle.digest.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    domain_of:
    - Bundle
    - Deployment
    range: UrlType
    required: true

Induced

Details

name: Bundle
description: Describes an archive containing all referenced ApplicationDeployment
  YAMLs. If there are zero deployments (i.e., the deployments array is empty), this
  field MUST be present with the value null. An empty archive MUST NOT be served.
from_schema: https://specification.margo.org/data-model
attributes:
  mediaType:
    name: mediaType
    description: MUST be application/vnd.margo.bundle.v1+tar+gzip, which denotes a
      gzip-compressed tar archive (commonly delivered as a .tar.gz) whose root contains
      one or more ApplicationDeployment YAML files. Servers MUST set the HTTP Content-Type
      to this media type. The archive MUST contain exactly the set of YAML files referenced
      by deployments.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: mediaType
    owner: Bundle
    domain_of:
    - Bundle
    range: string
    required: true
    equals_string: application/vnd.margo.bundle.v1+tar+gzip
  digest:
    name: digest
    description: Digest of the bundle archive. MUST equal the digest computed over
      the exact sequence of bytes in the bundle endpoint's HTTP 200 OK response body.
      See Protocol - Digest for further details.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: digest
    owner: Bundle
    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 bundle archive. 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: Bundle
    domain_of:
    - Bundle
    - Deployment
    range: SizeBytesType
  url:
    name: url
    description: Content-addressable retrieval endpoint for the bundle of the form
      /api/v1/clients/{clientId}/bundles/{digest} where {digest} equals bundle.digest.
    from_schema: https://specification.margo.org/desired-state-manifest-schema
    alias: url
    owner: Bundle
    domain_of:
    - Bundle
    - Deployment
    range: UrlType
    required: true