starcatsys/about_docs
starcatsys/about_docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
about_docs/docs/handbook/infrastructure/naming_conventions.md

977 B
Raw Blame History

Naming Conventions

To try and standardize things, aim to use the following naming conventions when assigning server hostnames, etc.

Hostnames

Hostnames are assigned as follows:

env-category-(subservice)-(subdomain)
  • env: the environment being hosted. Options are prod, stg, dev, test
  • category: what is being hosted. Options are pubinfra, intinfra, or a specific product (sourcecamp, casper, postline, etc.)
  • subservice: optional, used with pubinfra and intinfra. For shared infrastructure, what service(s) are being hosted. For example, auth, accounts, portal, etc.
  • subdomain: optional, used for specific products. Identifies the specific user's instance that is being hosted.

So, for the StarCat Systems :simple-forgejo: Git server, the hostname is prod-sourcecamp-starcatsys. (env=prod, category=sourcecamp, subservice=empty, subdomain=starcatsys)