Skip to content

Instantly share code, notes, and snippets.

@janicez
Last active December 5, 2017 02:20
Show Gist options
  • Save janicez/01d8b05046cdd2e42411d5f9885efe2d to your computer and use it in GitHub Desktop.
Save janicez/01d8b05046cdd2e42411d5f9885efe2d to your computer and use it in GitHub Desktop.
Server naming scheme for Umbrellix

Umbrellix Server Naming Scheme

Copyright

Copyright 2017 Ellenor Malik

Permission is hereby granted, free of charge, to any person obtaining a copy of this document (the "Document"), to deal in the Document without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Document, and to permit persons to whom the Document is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Document.

THE DOCUMENT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE DOCUMENT OR THE USE OR OTHER DEALINGS IN THE DOCUMENT.

Definitions

word definition
sovereignty/sov ccTLD or 3-numeral code, as desired. Location of machine, by sovereign entity, or non-sovereign self-governing colony if desired and applicable
state or province/loc state, province, three letter city code, or other location code as desired. e.g. Roubaix is written as rbx, London is written as ldn, London City is written as lcy, Washington State is written as 'wa'. Location of machine.
type whether the machine is 'portable' (laptop, phone, tablet, battery desktop), 'h' (cjdns IP in AAAA), 'auto' (self-propelled computer on wheels), '4' (only A record), '46' (A & clearnet/local AAAA record for this machine), '6' (only clearnet AAAA record), or a 'srv' (datacentre machine). In the DNS, types are conjoined using dashes, with machine type first and record type second - srv-46 is a hostname for a server that has both ipv4 and clearnet ipv6. srv-4 can be the same server but with only the ipv4 record, or a different server with only ipv4 stored. In hostnames, the record type is omitted.
domain top level domain
serial machine number, two or more digits as required
name Word, or "m" as desired

Format

Datacentre machines

Machines in datacentres will have FQDNs of ${name}.${loc}.${sov}.${domain} or optionally will fit the universal format ${name}.${loc}.${sov}.${type}.${domain}. Names will be your pick of a word, or a serial number preceded by the letter 'm'.

For example, Invictus (the main server of Umbrellix IRC) is named "invictus.wa.us.umbrellix.net". A server in Puerto Rico named "Wepa" could be "wepa.pr.us.example.com", "wepa.pr.pr.example.com", "wepa.pr.us.srv.example.com" et alia.

Non-datacentre machines

My laptop is named in the datacentre format, with the type (portable because it's a battery desktop (used to be a laptop til the keyboard broke)) in the name field. Its hostname is schoenefeld.portable.bc.ca.umbrellix.net. Its hostname should be schoenefeld.bc.ca.portable.umbrellix.net in the "universal" format this document describes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment