npm package: @runnable/hostname
Description: generate a runnable elastic or direct hostname from parts
Author: Bryan Kendall
Latest version: 3.0.0

# runnable-hostname

[![Build Status](https://travis-ci.org/Runnable/hostname.svg?branch=master)](https://travis-ci.org/Runnable/hostname)

util for generating an instance's elastic or direct hostname

# Usage
```js
var hostname = require('runnable-hostname');

// Non-master Pod Instance

hostname.direct({
  shortHash: 'abcdef',
  // non-masterPod instance has branch in name, so branch is required
  instanceName: 'branch-instanceName',
  branch: 'branch',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  userContentDomain: 'runnableapp.com'
});
// abcdef-instanceName-staging-ownerUsername.runnableapp.com
hostname.elastic({
  shortHash: 'abcdef',
  instanceName: 'branch-instanceName',
  branch: 'branch',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  userContentDomain: 'runnableapp.com'
});
// instanceName-staging-ownerUsername.runnableapp.com

// Master Pod Instance

hostname.direct({
  shortHash: 'abcdef',
  // masterPod instance has does NOT have branch in name, so branch is not required
  instanceName: 'instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: true,
  userContentDomain: 'runnableapp.com'
});
// abcdef-instanceName-staging-ownerUsername.runnableapp.com
hostname.elastic({
  shortHash: 'abcdef',
  instanceName: 'instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: true,
  userContentDomain: 'runnableapp.com'
});
// instanceName-staging-ownerUsername.runnableapp.com

// Isolated Master Instance

hostname.direct({
  shortHash: 'abcdef',
  branch: 'branch',
  instanceName: 'branch-instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// abcdef-instanceName-staging-ownerUsername.runnableapp.com
hostname.elastic({
  shortHash: 'abcdef',
  branch: 'branch',
  instanceName: 'branch-instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// instanceName-staging-ownerUsername.runnableapp.com           

// Isolated Container (not master) Instance
Master instance shortHash = '343gh1'

hostname.direct({
  shortHash: 'abcdef',
  branch: 'branch',
  instanceName: 'branch-instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// 343gh1--instanceName-staging-ownerUsername.runnableapp.com
hostname.elastic({
  shortHash: 'abcdef',
  branch: 'branch',
  instanceName: 'branch-instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// instanceName-staging-ownerUsername.runnableapp.com

// Non-repo
hostname.direct({
  shortHash: 'abcdef',
  instanceName: 'instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// 343gh1--instanceName-staging-ownerUsername.runnableapp.com
hostname.elastic({
  shortHash: 'abcdef',
  instanceName: 'instanceName',
  ownerUsername: 'ownerUsername',
  masterPod: false,
  isolated: 'asd76sdasg2341324',
  isIsolationGroupMaster: true,
  userContentDomain: 'runnableapp.com'
});
// instanceName-staging-ownerUsername.runnableapp.com
```