Skip to content

Commit

Permalink
docs: explain deployment.environment impact on service identity
Browse files Browse the repository at this point in the history
# Why

To clarify a likely misconception about service identity in the case
of multiple environments.

# What

Explain that `deployment.environment` does not impact service identity.

# References

Fixes #119
  • Loading branch information
bripkens committed Nov 1, 2023
1 parent 1eb70c4 commit bd7d423
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions model/resource/deployment_environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,12 @@ groups:
brief: >
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier).
note: >
`deployment.environment` 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=production`
- `service.name=frontend`, `deployment.environment=staging`.
examples: ['staging', 'production']

0 comments on commit bd7d423

Please sign in to comment.