Skip to content

Class: ApplicationDeployment

A class representing the desired state of an entity.

 classDiagram
    class ApplicationDeployment
    click ApplicationDeployment href "../ApplicationDeployment/"
      ApplicationDeployment : apiVersion

      ApplicationDeployment : kind

      ApplicationDeployment : metadata





        ApplicationDeployment --> "1" DeploymentMetadata : metadata
        click DeploymentMetadata href "../DeploymentMetadata/"



      ApplicationDeployment : spec





        ApplicationDeployment --> "1" Spec : spec
        click Spec href "../Spec/"

Attributes

Name Cardinality and Range Description Inheritance
apiVersion 1
string		 Identifier of the version of the API the object definition follows direct
kind 1
string		 Must be ApplicationDeployment direct
metadata 1
DeploymentMetadata		 Metadata element specifying characteristics about the application deployment direct
spec 1
Spec		 Spec element that defines deployment profile and parameters associated with t... direct

Examples

Following examples have been automatically validated against the schema of this class.

ApplicationDeployment-helm 
apiVersion: application.margo.org/v1alpha1
kind: ApplicationDeployment
metadata:
    annotations:
        applicationId: com-northstartida-digitron-orchestrator
        id: a3e2f5dc-912e-494f-8395-52cf3769bc06
    name: com-northstartida-digitron-orchestrator-deployment
    namespace: margo-poc
spec:
    deploymentProfile:
        type: helm.v3
        components:
            - name: database-services
              properties:
                repository: oci://quay.io/charts/realtime-database-services
                revision: 2.3.7
                timeout: 8m30s
                wait: true
            - name: digitron-orchestrator
              properties:
                repository: oci://northstarida.azurecr.io/charts/northstarida-digitron-orchestrator
                revision: 1.0.9
                wait: true
    parameters:
        adminName:
            value: Some One
            targets:
                - pointer: administrator.name
                  components:
                    - digitron-orchestrator
        adminPrincipalName:
            value: someone@somewhere.com
            targets:
                - pointer: administrator.userPrincipalName
                  components:
                    - digitron-orchestrator
        cpuLimit:
            value: "4"
            targets:
                - pointer: settings.limits.cpu
                  components:
                    - digitron-orchestrator
        idpClientId:
            value: 123-ABC
            targets:
                - pointer: idp.clientId
                  components:
                    - digitron-orchestrator
        idpName:
            value: Azure AD
            targets:
                - pointer: idp.name
                  components:
                    - digitron-orchestrator
        idpProvider:
            value: aad
            targets:
                - pointer: idp.provider
                  components:
                    - digitron-orchestrator
        idpUrl:
            value: https://123-abc.com
            targets:
                - pointer: idp.providerUrl
                  components:
                    - digitron-orchestrator
                - pointer: idp.providerMetadata
                  components:
                    - digitron-orchestrator
        memoryLimit:
            value: "16384"
            targets:
                - pointer: settings.limits.memory
                  components:
                    - digitron-orchestrator
        pollFrequency:
            value: "120"
            targets:
                - pointer: settings.pollFrequency
                  components:
                    - digitron-orchestrator
                    - database-services
        siteId:
            value: SID-123-ABC
            targets:
                - pointer: settings.siteId
                  components:
                    - digitron-orchestrator
                    - database-services
ApplicationDeployment-compose 
apiVersion: application.margo.org/v1alpha1
kind: ApplicationDeployment
metadata:
    annotations:
        applicationId: com-northstartida-digitron-orchestrator
        id: ad9b614e-8912-45f4-a523-372358765def
    name: com-northstartida-digitron-orchestrator-deployment
    namespace: margo-poc
spec:
    deploymentProfile:
        type: compose
        components:
            - name: digitron-orchestrator-docker
              properties:
                keyLocation: https://northsitarida.com/digitron/docker/public-key.asc
                packageLocation: https://northsitarida.com/digitron/docker/digitron-orchestrator.tar.gz
    parameters:
        adminName:
            value: Some One
            targets:
                - pointer: ENV.ADMIN_NAME
                  components:
                    - digitron-orchestrator-docker
        adminPrincipalName:
            value: someone@somewhere.com
            targets:
                - pointer: ENV.ADMIN_PRINCIPALNAME
                  components:
                    - digitron-orchestrator-docker
        idpClientId:
            value: 123-ABC
            targets:
                - pointer: ENV.IDP_CLIENT_ID
                  components:
                    - digitron-orchestrator-docker
        idpName:
            value: Azure AD
            targets:
                - pointer: ENV.IDP_NAME
                  components:
                    - digitron-orchestrator-docker
        idpProvider:
            value: aad
            targets:
                - pointer: ENV.IDP_PROVIDER
                  components:
                    - digitron-orchestrator-docker
        idpUrl:
            value: https://123-abc.com
            targets:
                - pointer: ENV.IDP_URL
                  components:
                    - digitron-orchestrator-docker
        pollFrequency:
            value: "120"
            targets:
                - pointer: ENV.POLL_FREQUENCY
                  components:
                    - digitron-orchestrator-docker
        siteId:
            value: SID-123-ABC
            targets:
                - pointer: ENV.SITE_ID
                  components:
                    - digitron-orchestrator-docker
This section is only relevant for contributors of the specification

LinkML Source

Direct

Details 
name: ApplicationDeployment
description: A class representing the desired state of an entity.
from_schema: https://specification.margo.org/data-model
attributes:
  apiVersion:
    name: apiVersion
    description: Identifier of the version of the API the object definition follows.
    from_schema: https://specification.margo.org/application_deployment_schema
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    - DeviceCapabilitiesManifest
    - DeploymentStatusManifest
    range: string
    required: true
  kind:
    name: kind
    description: Must be `ApplicationDeployment`.
    from_schema: https://specification.margo.org/application_deployment_schema
    designates_type: true
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    - DeviceCapabilitiesManifest
    - DeploymentStatusManifest
    range: string
    required: true
    equals_string: ApplicationDeployment
  metadata:
    name: metadata
    description: Metadata element specifying characteristics about the application
      deployment. See the [Metadata Attributes](#metadata-attributes) section below.
    from_schema: https://specification.margo.org/application_deployment_schema
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    range: DeploymentMetadata
    required: true
  spec:
    name: spec
    description: Spec element that defines deployment profile and parameters associated
      with the application deployment. See the [Spec Attributes](#spec-attributes)
      section below.
    from_schema: https://specification.margo.org/application_deployment_schema
    domain_of:
    - ApplicationDeployment
    range: Spec
    required: true

Induced

Details 
name: ApplicationDeployment
description: A class representing the desired state of an entity.
from_schema: https://specification.margo.org/data-model
attributes:
  apiVersion:
    name: apiVersion
    description: Identifier of the version of the API the object definition follows.
    from_schema: https://specification.margo.org/application_deployment_schema
    alias: apiVersion
    owner: ApplicationDeployment
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    - DeviceCapabilitiesManifest
    - DeploymentStatusManifest
    range: string
    required: true
  kind:
    name: kind
    description: Must be `ApplicationDeployment`.
    from_schema: https://specification.margo.org/application_deployment_schema
    designates_type: true
    alias: kind
    owner: ApplicationDeployment
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    - DeviceCapabilitiesManifest
    - DeploymentStatusManifest
    range: string
    required: true
    equals_string: ApplicationDeployment
  metadata:
    name: metadata
    description: Metadata element specifying characteristics about the application
      deployment. See the [Metadata Attributes](#metadata-attributes) section below.
    from_schema: https://specification.margo.org/application_deployment_schema
    alias: metadata
    owner: ApplicationDeployment
    domain_of:
    - ApplicationDeployment
    - ApplicationDescription
    range: DeploymentMetadata
    required: true
  spec:
    name: spec
    description: Spec element that defines deployment profile and parameters associated
      with the application deployment. See the [Spec Attributes](#spec-attributes)
      section below.
    from_schema: https://specification.margo.org/application_deployment_schema
    alias: spec
    owner: ApplicationDeployment
    domain_of:
    - ApplicationDeployment
    range: Spec
    required: true