ApiClusterTemplate Data Model

Details of cluster template

Properties
name data type description
cdhVersion string CDH version
products array of ApiProductVersion All the parcels that needs to be deployed and activated
services array of ApiClusterTemplateService All the services that needs to be deployed
hostTemplates array of ApiClusterTemplateHostTemplate All host templates
displayName string Cluster display name
cmVersion string CM version for which the template
instantiator ApiClusterTemplateInstantiator A constructor listing all the variables and references that needs to be resolved for this template
repositories array of string List of all repositories registered with CM
clusterSpec ApiClusterTemplateClusterSpec Cluster specification.
tags array of ApiEntityTag Tags associated with the cluster

Example

{
  "cdhVersion" : "...",
  "products" : [ {
    "version" : "...",
    "product" : "..."
  }, {
    "version" : "...",
    "product" : "..."
  } ],
  "services" : [ {
    "refName" : "...",
    "serviceType" : "...",
    "serviceConfigs" : [ {
      "name" : "...",
      "value" : "...",
      "ref" : "...",
      "variable" : "...",
      "autoConfig" : true
    }, {
      "name" : "...",
      "value" : "...",
      "ref" : "...",
      "variable" : "...",
      "autoConfig" : true
    } ],
    "roleConfigGroups" : [ {
      "refName" : "...",
      "roleType" : "...",
      "base" : true,
      "displayName" : "...",
      "configs" : [ { }, { } ]
    }, {
      "refName" : "...",
      "roleType" : "...",
      "base" : true,
      "displayName" : "...",
      "configs" : [ { }, { } ]
    } ],
    "roles" : [ {
      "refName" : "...",
      "roleType" : "..."
    }, {
      "refName" : "...",
      "roleType" : "..."
    } ],
    "displayName" : "...",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  }, {
    "refName" : "...",
    "serviceType" : "...",
    "serviceConfigs" : [ {
      "name" : "...",
      "value" : "...",
      "ref" : "...",
      "variable" : "...",
      "autoConfig" : true
    }, {
      "name" : "...",
      "value" : "...",
      "ref" : "...",
      "variable" : "...",
      "autoConfig" : true
    } ],
    "roleConfigGroups" : [ {
      "refName" : "...",
      "roleType" : "...",
      "base" : true,
      "displayName" : "...",
      "configs" : [ { }, { } ]
    }, {
      "refName" : "...",
      "roleType" : "...",
      "base" : true,
      "displayName" : "...",
      "configs" : [ { }, { } ]
    } ],
    "roles" : [ {
      "refName" : "...",
      "roleType" : "..."
    }, {
      "refName" : "...",
      "roleType" : "..."
    } ],
    "displayName" : "...",
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  } ],
  "hostTemplates" : [ {
    "refName" : "...",
    "roleConfigGroupsRefNames" : [ "...", "..." ],
    "cardinality" : 12345,
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  }, {
    "refName" : "...",
    "roleConfigGroupsRefNames" : [ "...", "..." ],
    "cardinality" : 12345,
    "tags" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ]
  } ],
  "displayName" : "...",
  "cmVersion" : "...",
  "instantiator" : {
    "clusterName" : "...",
    "hosts" : [ {
      "hostName" : "...",
      "hostNameRange" : "...",
      "rackId" : "...",
      "hostTemplateRefName" : "...",
      "roleRefNames" : [ "...", "..." ]
    }, {
      "hostName" : "...",
      "hostNameRange" : "...",
      "rackId" : "...",
      "hostTemplateRefName" : "...",
      "roleRefNames" : [ "...", "..." ]
    } ],
    "variables" : [ {
      "name" : "...",
      "value" : "..."
    }, {
      "name" : "...",
      "value" : "..."
    } ],
    "roleConfigGroups" : [ {
      "rcgRefName" : "...",
      "name" : "..."
    }, {
      "rcgRefName" : "...",
      "name" : "..."
    } ],
    "clusterSpec" : {
      "dataContextRefs" : [ { }, { } ]
    },
    "keepHostTemplates" : true,
    "lenient" : true,
    "enableKerberos" : {
      "datanodeTransceiverPort" : 12345,
      "datanodeWebPort" : 12345
    }
  },
  "repositories" : [ "...", "..." ],
  "clusterSpec" : {
    "dataContextRefs" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ]
  },
  "tags" : [ {
    "name" : "...",
    "value" : "..."
  }, {
    "name" : "...",
    "value" : "..."
  } ]
}