starcatsys/about
starcatsys/about
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Infra providers and naming conventions

Browse source
This commit is contained in:
thhsh-local 2025-04-02 16:52:16 -04:00
parent 70f183392a
commit 4b01178677
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
8 changed files with 45 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/handbook/infrastructure/naming_conventions.md Normal file
View file

@ -0,0 +1,16 @@
# 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](https://git.starcat.systems/starcatsys/about_docs), the hostname is `prod-sourcecamp-starcatsys`. (`env`=`prod`, `category`=`sourcecamp`, `subservice`=empty, `subdomain`=`starcatsys`)