This document defines attributes for software deployments.
Attributes:
| Key | Stability | Value Type | Description | Example Values |
|---|---|---|---|---|
deployment.environment.name |
string | Name of the deployment environment (aka deployment tier). [1] | staging; production |
|
deployment.id |
string | The id of the deployment. | 1208 |
|
deployment.name |
string | The name of the deployment. | deploy my app; deploy-frontend |
|
deployment.status |
string | The 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=productionservice.name=frontend,deployment.environment.name=staging.
deployment.environment.name 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.
| Value | Description | Stability |
|---|---|---|
development |
Development environment | |
production |
Production environment | |
staging |
Staging environment | |
test |
Testing environment |
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.
| Value | Description | Stability |
|---|---|---|
failed |
failed | |
succeeded |
succeeded |
Describes deprecated deployment attributes.
Attributes:
| Key | Stability | Value Type | Description | Example Values |
|---|---|---|---|---|
deployment.environment |
Replaced by deployment.environment.name. |
string | Deprecated, use deployment.environment.name instead. |
staging; production |