Deployment

Deployment Attributes

This document defines attributes for software deployments.

Attributes:

KeyStabilityValue TypeDescriptionExample Values
deployment.environment.nameDevelopmentstringName of the deployment environment (aka deployment tier). [1]staging; production
deployment.idDevelopmentstringThe id of the deployment.1208
deployment.nameDevelopmentstringThe name of the deployment.deploy my app; deploy-frontend
deployment.statusDevelopmentstringThe status of the deployment.failed; succeeded

[1] deployment.environment.name: deployment.environment.name does not affect the uniqueness constraints defined through the service.namespace, service.name and service.instance.id resource attributes. This implies that resources carrying the following attribute combinations MUST be considered to be identifying the same service:

  • service.name=frontend, deployment.environment.name=production
  • service.name=frontend, deployment.environment.name=staging.

deployment.status has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
failedfailedDevelopment
succeededsucceededDevelopment

Deployment Deprecated Attributes

Describes deprecated deployment attributes.

Attributes:

KeyStabilityValue TypeDescriptionExample Values
deployment.environmentDeprecated
Replaced by deployment.environment.name.
stringDeprecated, use deployment.environment.name instead.staging; production