Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The system starts small and begins with a registration system.

Use a 2-3 letter convention to describe the host's main function. PRDRGH01WEB1H = Hardware = Physical Hardware or Hosting Site
PRDRGH01APP1
HostnameDescriptionNaming Convention

S1

Host system for Registration System.

As the purpose of the host can easily change we use a generic name, S1 for system 1.

PRD-RG-WEB1

Runs Apache Web Server.

PRD or UAT = Production or UAT
RG = Registration = Overarching Project Code

1 = The first virtual server with allowance for relation to a corresponding server, in this case just one application server
WEB or APP = Function
1 = The server designation in the series.

PRD-RG-APP1

Runs Tomcat Application Server and HypSQL Database Server.

This has both an application and database. Because the database is portable and more easier to move, we make the judgment call to name the system APP after the more primary long term function of the server.

The convention follows but notice the 1 in MGH1V1APP1.

The zero visually places this server with the correspond Web Server.


Phase 2

At this point the hostnames are not too bad. Their real value comes when the system needs to grow.

The system grows and requires a second application server to manage the load. Usually new applications are added first as they generate the most load. Here is how it will look in a sorted list,

PRDRGH01WEB1PRDRGH01APP1PRDRGH01APP2 PRDRGH01PRDRGH01
HostnameDescriptionNaming Convention

S1

Host system for Registration System.

Existing.

PRD-RG-WEB1

Runs Apache Web Server.

Existing.

PRD-RG-APP1

Runs Tomcat Application Server and HypSQL Database Server.

Existing.

PRD-RG-APP2

Runs Tomcat Application Server.

The first 01 in PRD-RG-APP2 shows that the server is related to the Web Server PRD-RG-WEB1. The last number, indicates this is the next application server in the series.

The convention naturally sorts well. If you are reading this article off of the Confluence system, click the Hostname title on the table to see the list sorted. Now let's add something new to the mix.

...

There is need for a new system for migrating users to tokens which we'll call MG for migration. Notice that we use a generic name rather than TM as the system could evolve to do other types of migrations. The system is low budget and considered temporary. As such, the customer wants to reuse the web server PRDRGH1X01WEB1.

PRDRGH01WEB1PRDRGH01APP1PRDRGH01APP2.Runs Tomcat Application Server 01 in PRDMGH01APP1 PRDRGH01WEB1
HostnameDescriptionNaming Convention

S1

Host system for Registration System.

Existing.

PRD-RG-WEB1

Runs Apache Web Server.

Existing.

PRD-RG-APP1

Runs Tomcat Application Server and HypSQL Database Server.

Existing.

PRD-MG-APP1

Runs Tomcat Application Server

Existing

PRDMGH01APP1

and HypSQL Database Server.

Again the 1 in PRD-MG-APP1 clearly shows that it is connected to PRD-RG-WEB1 and the MG indicates the systems primary function is for migrations

Next phase is where the naming convention really shines.

...

Over time the system becomes more critical and has grown in number of users. The client agrees to buy new hardware, introduce a load balancer and a second web and application server. Also, as with many systems the MG temporary TM system becomes permanent.

PRDRGH01WEB1PRDRGH01APP1PRDRGH01APP2PRDRGH02WEB1PRDRGH02APP1

Hostname

Description

Naming Convention

S1

Host system for Registration System.

Existing.

PRD-RG-WEB1

Runs Apache Web Server.

Existing

PRD-RG-APP1

Runs Tomcat Application Server and HypSQL Database Server.

Existing

PRD-MG-APP1Runs Tomcat Application Server and HypSQL Database Server.Existing
PRD-RG-WEB2Runs Apache Web Server. WEB2 is paired with APP2
PRD-RG-APP2Runs Tomcat Application Server 

If you are reading this article off of the Confluence system, click the Hostname title on the table to see the list sorted. Notice that sorted, it is very clear how the systems relate to each other.

...