Merge pull request 'handbook_infra' (#1) from handbook_infra into modifications_2025-04-02

Reviewed-on: #1
This commit is contained in:
thhsh-local 2025-04-02 20:53:35 +00:00
commit ae4c2cce35
8 changed files with 62 additions and 1 deletions

View file

@ -1,4 +1,5 @@
title: Handbook
nav:
- index.md
- meta
- meta
- infrastructure

View file

@ -0,0 +1,5 @@
title: Infrastructure
nav:
- index.md
- providers
- naming_conventions.md

View file

@ -0,0 +1,2 @@
# Infrastructure
Various things related to the servers, systems, and services that power all StarCat creations.

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`)

View file

@ -0,0 +1,5 @@
title: Providers
nav:
- index.md
- hetzner.md
- mxroute.md

View file

@ -0,0 +1,25 @@
# 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
## Server Types
**VPS**: Typically we use `CAX` series servers when we can use an ARM processor. If we need an x86 processor, we usually use `CX` or `CPX` servies servers.
**Dedicated**: Server types vary depending on the use-case.
## Locations
**VPS**:
- Europe (preferred)
- Primary: `helsinki`
- Secondary: `nuremberg` or `falkenstein` (depending on use-case)
- USA
- Primary: `ashburn`
- Secondary: `hillsboro`
**Dedicated**: All Hetzner dedicated servers are in Europe, no particularly preferred datacenters.

View file

@ -0,0 +1 @@
# Infrastructure Providers

View file

@ -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.