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

Add number to hostname naming convention

Browse source
This commit is contained in:
thhsh-local 2025-06-05 18:41:12 -04:00
parent 42a35ba855
commit f122c79de7
Signed by: thhsh-local
SSH key fingerprint: SHA256:bLOq3d7dN1v5+W5U6pQekP0rBm0YUtC9qvh3TDYyAsg
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/handbook/infrastructure/naming_conventions.md
View file

@ -5,12 +5,13 @@ To try and standardize things, aim to use the following naming conventions when
Hostnames are assigned as follows: Hostnames are assigned as follows:
``` ```
env-category-(subservice)-(subdomain) env-category-(subservice)-(subdomain)-(##)
``` ```
- `env`: the environment being hosted. Options are `prod`, `stg`, `dev`, `test` - `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.) - `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. - `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. - `subdomain`: optional, used for specific products. Identifies the specific user's instance that is being hosted.
- `##`: optional, typically used with `subservice`, when we might be running more than one server with the same category/criteria (for example, a monitoring server). To differentiate between servers, add a sequential number (starting at `01`) to each hostname. If the number is one digit, add a `0` buffer before.
So, for the StarCat Systems [:simple-forgejo: Git server](https://git.starcat.systems), the hostname is `prod-sourcecamp-starcatsys`. (`env`=`prod`, `category`=`sourcecamp`, `subservice`=empty, `subdomain`=`starcatsys`) So, for the StarCat Systems [:simple-forgejo: Git server](https://git.starcat.systems), the hostname is `prod-sourcecamp-starcatsys`. (`env`=`prod`, `category`=`sourcecamp`, `subservice`=empty, `subdomain`=`starcatsys`) Or, one of our monitoring servers is `prod-intinfra-monitoring-01`.