From 4b01178677542d1ef7e5c81f4668f7e8326c1ce3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 2 Apr 2025 16:52:16 -0400 Subject: [PATCH] Infra providers and naming conventions --- docs/handbook/.nav.yml | 3 ++- docs/handbook/infrastructure/.nav.yml | 5 +++++ docs/handbook/infrastructure/index.md | 2 ++ .../infrastructure/naming_conventions.md | 16 ++++++++++++++++ docs/handbook/infrastructure/providers/.nav.yml | 5 +++++ .../handbook/infrastructure/providers/hetzner.md | 8 ++++++++ docs/handbook/infrastructure/providers/index.md | 1 + .../handbook/infrastructure/providers/mxroute.md | 6 ++++++ 8 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/infrastructure/.nav.yml create mode 100644 docs/handbook/infrastructure/index.md create mode 100644 docs/handbook/infrastructure/naming_conventions.md create mode 100644 docs/handbook/infrastructure/providers/.nav.yml create mode 100644 docs/handbook/infrastructure/providers/hetzner.md create mode 100644 docs/handbook/infrastructure/providers/index.md create mode 100644 docs/handbook/infrastructure/providers/mxroute.md diff --git a/docs/handbook/.nav.yml b/docs/handbook/.nav.yml index 72fdf54..e47379d 100644 --- a/docs/handbook/.nav.yml +++ b/docs/handbook/.nav.yml @@ -1,4 +1,5 @@ title: Handbook nav: - index.md - - meta \ No newline at end of file + - meta + - infrastructure \ No newline at end of file diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml new file mode 100644 index 0000000..940cb1d --- /dev/null +++ b/docs/handbook/infrastructure/.nav.yml @@ -0,0 +1,5 @@ +title: Infrastructure +nav: + - index.md + - providers + - naming_conventions.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/index.md b/docs/handbook/infrastructure/index.md new file mode 100644 index 0000000..90c21fe --- /dev/null +++ b/docs/handbook/infrastructure/index.md @@ -0,0 +1,2 @@ +# Infrastructure +Various things related to the servers, systems, and services that power all StarCat creations. \ No newline at end of file diff --git a/docs/handbook/infrastructure/naming_conventions.md b/docs/handbook/infrastructure/naming_conventions.md new file mode 100644 index 0000000..b80a594 --- /dev/null +++ b/docs/handbook/infrastructure/naming_conventions.md @@ -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`) \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/.nav.yml b/docs/handbook/infrastructure/providers/.nav.yml new file mode 100644 index 0000000..332c48e --- /dev/null +++ b/docs/handbook/infrastructure/providers/.nav.yml @@ -0,0 +1,5 @@ +title: Providers +nav: + - index.md + - hetzner.md + - mxroute.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/hetzner.md b/docs/handbook/infrastructure/providers/hetzner.md new file mode 100644 index 0000000..4740550 --- /dev/null +++ b/docs/handbook/infrastructure/providers/hetzner.md @@ -0,0 +1,8 @@ +# Hetzner + +[:simple-hetzner: Hetzner](https://www.hetzner.com/) hosts the majority of our servers, both virtual and physical. + +## Quick Links +[:octicons-link-external-24: Cloud console login](https://console.hetzner.cloud/) - VPS management +[:octicons-link-external-24: Robot console login](https://robot.hetzner.com/) - dedicated server management +[:octicons-link-external-24: Billing console login](https://accounts.hetzner.com/invoice) - billing and invoice information \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/index.md b/docs/handbook/infrastructure/providers/index.md new file mode 100644 index 0000000..64708b7 --- /dev/null +++ b/docs/handbook/infrastructure/providers/index.md @@ -0,0 +1 @@ +# Infrastructure Providers \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/mxroute.md b/docs/handbook/infrastructure/providers/mxroute.md new file mode 100644 index 0000000..99d476c --- /dev/null +++ b/docs/handbook/infrastructure/providers/mxroute.md @@ -0,0 +1,6 @@ +# MXroute + +[:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. + +## Connection Information +Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal wiki for connection and access information. \ No newline at end of file