Deployment

Deployment Attributes

This document defines attributes for software deployments.

AttributeTypeDescriptionExamplesStability
deployment.environment.namestringName of the deployment environment (aka deployment tier). [1]staging; productionExperimental
deployment.idstringThe id of the deployment.1208Experimental
deployment.namestringThe name of the deployment.deploy my app; deploy-frontendExperimental
deployment.statusstringThe status of the deployment.failed; succeededExperimental

[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
failedfailedExperimental
succeededsucceededExperimental

Deployment Deprecated Attributes

“Describes deprecated deployment attributes.”

AttributeTypeDescriptionExamplesStability
deployment.environmentstring‘Deprecated, use deployment.environment.name instead.’staging; productionDeprecated
Deprecated, use deployment.environment.name instead.