@runnable/hostname

v3.0.0
generate a runnable elastic or direct hostname from parts
runnable hostname url generate create host instance container

runnable-hostname

Build Status

util for generating an instance's elastic or direct hostname

Usage

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
npm i @runnable/hostname

Metadata

  • MIT
  • Whatever
  • Bryan Kendall
  • released 4/11/2016

Downloads