You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The overview page mentions environments as a target for naming conventions, but there's no dedicated page covering them.
Additionally, kosli tag env (CLI reference) supports key-value tagging on environments, but there's no best-practice guidance on what to tag or why. Tagging complements naming -- names identify environments, tags classify them for filtering, policies, and reporting.
Originally tracked in kosli-dev/customer-success#59 (could not transfer due to private-to-public repo restriction).
What should environments.md cover
Following the pattern established by the existing naming convention pages:
Naming:
Physical environment naming -- convention for K8S, ECS, Lambda, S3, docker, server types
When to use tags vs encoding in the name -- tags for filterable metadata that may change; names for stable identity. E.g. don't put team=payments in the name if ownership changes; use a tag instead.
Tag naming conventions -- lowercase keys, consistent value formats, avoid redundancy with the environment name
Existing content to reference
overview.md -- general guidelines (delimiters, case styles, regex)
Description
The implementation guide already has naming convention pages for flows/trails and attestation types, but environments are missing:
The overview page mentions environments as a target for naming conventions, but there's no dedicated page covering them.
Additionally,
kosli tag env(CLI reference) supports key-value tagging on environments, but there's no best-practice guidance on what to tag or why. Tagging complements naming -- names identify environments, tags classify them for filtering, policies, and reporting.Originally tracked in kosli-dev/customer-success#59 (could not transfer due to private-to-public repo restriction).
What should
environments.mdcoverFollowing the pattern established by the existing naming convention pages:
Naming:
{stage}-{service}-{type}(e.g.prod-api-k8s,staging-web-ecs){org-unit}-{stage}-{type}depending on org structure{stage}or{stage}-{region}(e.g.production,staging-eu)flows_and_trails.mdandattestation_types.mdoverview.mdprod-eu-west-1-k8svsprod-us-east-1-ecsTagging best practices:
region-- AWS/GCP/Azure region (e.g.eu-west-1,us-east-1)team-- owning team (e.g.platform,payments)tier-- criticality level (e.g.production,staging,development)cloud-- provider (e.g.aws,gcp,azure,on-prem)cost-center-- for billing/chargebackteam=paymentsin the name if ownership changes; use a tag instead.Existing content to reference
kosli tag envexamplesTasks
implementation_guide/phase_2/plan_organizational_structure/naming_conventions/environments.mdflows_and_trails.md(convention, ParamField components, tabbed case examples, regex, accordion examples)docs.jsonnavigation under the naming conventions group