From f122c79de7db6547cbcd3df5da3cf4e7ded6c4e4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 5 Jun 2025 18:41:12 -0400 Subject: [PATCH] Add number to hostname naming convention --- docs/handbook/infrastructure/naming_conventions.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/handbook/infrastructure/naming_conventions.md b/docs/handbook/infrastructure/naming_conventions.md index 576f430..0de59c7 100644 --- a/docs/handbook/infrastructure/naming_conventions.md +++ b/docs/handbook/infrastructure/naming_conventions.md @@ -5,12 +5,13 @@ To try and standardize things, aim to use the following naming conventions when Hostnames are assigned as follows: ``` -env-category-(subservice)-(subdomain) +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. +- `##`: 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`) \ No newline at end of file +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`. \ No newline at end of file