Page History

Introduction

Ambari Blueprints are a declarative definition of a cluster. With a Blueprint, you specify a Stack, the Component layout and the Configurations to materialize a Hadoop cluster instance (via a REST API) without having to use the Ambari Cluster Install Wizard.

...

{
  "configurations" : [
    {
      "configuration-type" : {
          "property-name"  : "property-value",
          "property-name2" : "property-value"
      }
    },
    {
      "configuration-type2" : {
          "property-name" : "property-value"
      }
    }
    ...
  ],
  "host_groups" : [
    {
      "name" : "host-group-name",
      "components" : [
        {
          "name" : "component-name"
        },
        {
          "name" : "component-name2",
          "provision_action" : "(INSTALL_AND_START | INSTALL_ONLY)"
        }
        ...
      ],
      "configurations" : [
	    {
          "configuration-type" : {
            "property-name" : "property-value"
          }
        }
        ...
      ],
      "cardinality" : "1"
    }
  ],
  "Blueprintssettings" : {[
    "stackdeployment_namesettings" : "HDP",[
      {"stackskip_versionfailure" : "2.1"true"}
    ],
    "security" :repository_settings":[
      {
         "type" : "(NONE | KERBEROS)"override_strategy":"ALWAYS_APPLY",
        "operating_system":"redhat7",
         "kerberosrepo_descriptorid" :"HDP",
 {
       "base_url":"http://myserver/hdp"
      ...
},
      {
      }
  "override_strategy":"APPLY_WHEN_MISSING",
        }
  }
}

Blueprint Field Descriptions

• configurations : A list of configuration maps keyed by configuration type. An example of a configuration type is "core-site".  When specified at the top level, configurations are applied at cluster scope and override default values for the cluster.  When specified within a "host_groups" element, configurations are applied at the host level for all hosts mapped to the host group.  Host scoped configurations override cluster scoped configuration for all hosts mapped to the host group.  The configurations element is optional at both levels.
• host_groups : A list of host groups which define topology (components) and configuration for all hosts which are mapped to the host group.  At least one host group must be specified.
  • name : The name of the host group.  Mandatory field which is referred to in the cluster creation body when mapping physical hosts to host groups.
  • components : A list of components which will run on all hosts that are mapped to the host group.  At least one component must be specified for each host group.
  • cardinality : This field is optional and intended to provide a hint to the deployer as to how many instances of a particular host_group can be instantiated; it has no bearing on how the cluster is deployed. When a blueprint is exported for an existing cluster, this field will indicate the number of hosts that correspond the the host group in that cluster.
• Blueprints : Blueprint and stack information
  • stack_name : The name of the stack.  All stacks currently shipped with Ambari have the name "HDP".  This is a required field.
  • stack_version : The version of the stack.  For example: "1.3.2" or "2.1".  This is a required field.  When deploying a cluster using a blueprint, the stack definition identified in the blueprint must be available to the Ambari instance in the new cluster.
  • blueprint_name : Optional field which specifies that name of the blueprint.  Typically the name of the blueprint is specified in the URL of the REST invocation.  The only reason to specify the name in the blueprint is when creating multiple blueprints via a single REST invocation.
  • security : Optional block to specify security settings for blueprint. Supported security types are NONE and KERBEROS. In case of KERBEROS, users have the option to embed a valid kerberos descriptor - to override default values defined for HDP stack - in field kerberos_descriptor or as an alternative they may reference a previously saved kerberos descriptor using kerberos_descriptor_reference field. 
    In case of selecting KERBEROS as security_type it's mandatory to add kerberos-env and krb5-conf config types. (Checkout configurations section in Blueprint example with KERBEROS on this page)
    Automated Kerberization page describes structure of kerberos_descriptor.

Cluster Creation Template Structure

A Cluster Creation Template is in JSON format and has the following structure:

{
  "blueprint" : "blueprint-name",
  "default_password" : "super-secret-password",
  "configurations" : [
    {
      "configuration-type" : {
        "property-name" : "property-value"
      }
    }
"operating_system":"redhat7",
        "repo_id":"HDP-UTIL-1.1",
        "base_url":"http://myserver/hdp-util"
      }
	],
    "recovery_settings":[
      {"recovery_enabled":"true"}
    ],
    "service_settings":[
      {
        "name":"SERVICE_ONE",
        "recovery_enabled":"true"
      },
      {
        "name":"SERVICE_TWO",
        "recovery_enabled":"true"
      }
    ],
    "component_settings":[
      {
        "name":"COMPONENT_A_OF_SERVICE_ONE"
        "recover_enabled":"true"
      },
      {
        "name":"COMPONENT_B_OF_SERVICE_TWO",
        "recover_enabled":"true"
      }
    ]
  ],
  "Blueprints" : {
    "stack_name" : "HDP",
    "stack_version" : "2.1",
    "security" : {
         "type" : "(NONE | KERBEROS)",
         "kerberos_descriptor" : {
             ...
  ],     
  "host_groups" :[ }
    { }
      "name" : "host-group-name",  
      "configurations" : [
        {
          "configuration-type" : {
            "property-name" : "property-value"
          }
        }
      ],     
      "hosts" : [          
        { 
          "fqdn" : "host.domain.com"
        },
        { 
          "fqdn" : "host2.domain.com"
        }
        ...
      ]
    }
    ...
  ],
  "credentials" : [
      {
        "alias" : "kdc.admin.credential",
        "principal" : "{PRINCIPAL}",
        "key" : "{KEY}",
        "type" : "(TEMPORARY | PERSISTENT)"
      }
  ], 
  "security" : {
         "type" : "(NONE | KERBEROS)",
         "kerberos_descriptor" : {
             ...
          }
  }
}

{
  "name" : "group-using-host-count",
  "host_count" : 5,
  "host_predicate" : "Hosts/os_type=centos6&Hosts/cpu_count=2"
} 

{
  "blueprint" : "blueprint-name",
  "config_recommendation_strategy" : "ONLY_STACK_DEFAULTS_APPLY",
  ...
} 

Cluster Creation Template Structure: Host Mappings and Configuration Field Descriptions

• blueprint : Name of the blueprint that defines the cluster to be deployed.  Blueprint must already exist.  Required field.
• default_password : Optional field which specifies a default password for all required passwords which are not specified in the blueprint or cluster creation template configurations.
• configurations : A list of configuration maps keyed by configuration type. An example of a configuration type is "core-site".  When specified at the top level, configurations are applied at cluster scope and override default values for the cluster.  When specified within a "host_groups" element, configurations are applied at the host level for all hosts mapped to the host group.  Host scoped configurations override cluster scoped configuration for all hosts mapped to the host group.  All cluster scoped and host group scoped configurations specified here override configurations specified in the corresponding blueprint.  The configurations element is optional at both levels. 
• config_recommendation_strategy : Optional field which specifies strategy for how configuration recommendations may be applied to a cluster’s configuration. Recommended configurations gathered by the response of the stack advisor. Available from Ambari 2.1.3. 
  
  • NEVER_APPLY :  Configuration recommendations are ignored with this option. (This is the default)
  • ONLY_STACK_DEFAULTS_APPLY : Applies only on the default configurations for all included services.
  • ALWAYS_APPLY : Applies on all configuration properties.
• host_groups : A list of host groups being deployed to the cluster.  At least one host group must be specified.
  • name : Required field which must correspond to a name of a host group in the associated blueprint.
  • hosts : List of host mapping information
    • fqdn : Fully qualified domain name for each host that is being mapped to the host group.  At least one host must be specified
  • host_count : The number of hosts that should be mapped to this host group. This can be specified instead of concrete host names.  If no host_predicate is specified, any host that isn't explicitly mapped to another host group is available to be mapped to this host group.  Available as of Ambari 2.1.0. 
  • host_predicate : Optional field which is used together with host_count to control which hosts are mapped to the host group.  This is useful in supporting host 'flavors' where different host groups require different host types.  The default predicate matches all hosts which aren't explicitly mapped to another host group.  The syntax of the predicate is the standard Ambari API query syntax applied against the "api/v1/hosts" endpoint.  Available as of Ambari 2.1.0.
• credentials : Optional block to create credentials, kdc.admin.credential is required in case of setting up KERBEROS security. Store type could be PERSISTENT or TEMPORARY. Temporary admin credentials are valid 90 minutes or until server restart. 
• security : Optional block to override security settings defined in Blueprint. Supported security types are NONE and KERBEROS. In case of KERBEROS, users have the option to embed a valid kerberos descriptor - to override default values defined for HDP stack - in field kerberos_descriptor or as an alternative they may reference a previously saved kerberos descriptor using kerberos_descriptor_reference field. Security settings defined here will override Blueprint settings, however overriding security type used in Blueprint to a less secure mode is not possible (ex. set security.type=NONE in cluster template having security.type=KERBEROS in Blueprint). In case of selecting KERBEROS as security_type it's mandatory to add kerberos-env and krb5-conf config types. (Checkout configurations section in Blueprint example with KERBEROS on this page)
  Automated Kerberization page describes structure of kerberos_descriptor.

Configurations

Default Values and Overrides

• Stack Defaults: Each Stack provides configurations for all included services which serve as defaults for all clusters deployed via Blueprints. 
• Blueprint Cluster Scoped: Configurations provided at the top level of a Blueprint override the corresponding default values for the entire cluster.
• Blueprint Host Group Scoped: Configurations provided within a host_group element of a Blueprint override both the corresponding default values and blueprint cluster scoped values only for hosts mapped to the host group.
• Cluster Creation Template Cluster Scoped: Configurations provided at the top level of the Cluster Creation Template override both the corresponding default and blueprint cluster scoped values for the entire cluster.
• Cluster Creation Template Host Group Scoped: Configurations provided within a host_group element of a Cluster Creation Template override all other values for hosts mapped to the host group.

Required Configurations

• Not all configuration properties have valid defaults
• Required properties must be specified by the Blueprint user
• Come in two categories, passwords and non passwords
• Non password required properties are validated at Blueprint creation time
• Required password properties are validated at cluster creation time
• For required password properties, they may be explicitly set in either the Blueprint or Cluster Creation Template configurations or a default password may be specified in the Cluster Creation Template which will be applied to all passwords which have not been explicitly set
  • "default_password" : "super-secret-password"
• If required configuration validation fails, a 400 response is returned indicating which properties must be specified

Blueprint Examples

Blueprint Example: Single-Node HDP 2.0 Cluster

• Single-node cluster (c6401.ambari.apache.org)
• HDP 2.0 Stack
• Install Core Hadoop Services (HDFS, YARN, MapReduce2, ZooKeeper) + Ganglia (metrics) and Nagios (alerts)

Example Blueprint

}
}

Blueprint Field Descriptions

• configurations : A list of configuration maps keyed by configuration type. An example of a configuration type is "core-site".  When specified at the top level, configurations are applied at cluster scope and override default values for the cluster.  When specified within a "host_groups" element, configurations are applied at the host level for all hosts mapped to the host group.  Host scoped configurations override cluster scoped configuration for all hosts mapped to the host group.  The configurations element is optional at both levels.
• host_groups : A list of host groups which define topology (components) and configuration for all hosts which are mapped to the host group.  At least one host group must be specified.
  • name : The name of the host group.  Mandatory field which is referred to in the cluster creation body when mapping physical hosts to host groups.
  • components : A list of components which will run on all hosts that are mapped to the host group.  At least one component must be specified for each host group.
  • provision_action : Cluster wide provision action can be specified in Cluster Creation Template (see below), but optionally this can be overwritten on component level, by specifying a different provision_action here. The default provision_action is INSTALL_AND_START.
  • cardinality : This field is optional and intended to provide a hint to the deployer as to how many instances of a particular host_group can be instantiated; it has no bearing on how the cluster is deployed. When a blueprint is exported for an existing cluster, this field will indicate the number of hosts that correspond the the host group in that cluster.
• Blueprints : Blueprint and stack information
  • stack_name : The name of the stack.  All stacks currently shipped with Ambari have the name "HDP".  This is a required field.
  • stack_version : The version of the stack.  For example: "1.3.2" or "2.1".  This is a required field.  When deploying a cluster using a blueprint, the stack definition identified in the blueprint must be available to the Ambari instance in the new cluster.
  • blueprint_name : Optional field which specifies that name of the blueprint.  Typically the name of the blueprint is specified in the URL of the REST invocation.  The only reason to specify the name in the blueprint is when creating multiple blueprints via a single REST invocation. Be aware that the name specified in this field will override the name specified in the URL.
  • security : Optional block to specify security settings for blueprint. Supported security types are NONE and KERBEROS. In case of KERBEROS, users have the option to embed a valid kerberos descriptor - to override default values defined for HDP stack - in field kerberos_descriptor or as an alternative they may reference a previously saved kerberos descriptor using kerberos_descriptor_reference field. 
    In case of selecting KERBEROS as security_type it's mandatory to add kerberos-env and krb5-conf config types. (Checkout configurations section in Blueprint example with KERBEROS on this page)
    Be aware that, Kerberos client packages needs to be installed on the host running Ambari server and krb5.conf needs to be configured properly to contain your realm (admin_server and kdc). 
    Automated Kerberization page describes structure of kerberos_descriptor.

• settings: An optional section to provide additional configuration for cluster behavior during and after the blueprint deployment. You can provide configurations for the following properties:

  • recovery_settings: A section to specify if all services (globally) should be set with auto restart once the cluster is deployed. To configure it, specify "recover_enabled" property to either "true" (auto restart), or "false" (do not auto restart). 

    For example: 
    "settings": [
      "recovery_settings":[
        {
          "recovery_enabled":"true"
        }
      ]
    ],

  • service_settings: A section to specify if services should be set with auto restart once the cluster is deployed. To configure it, specify "recover_enabled" property to either "true" (auto restart), or "false" (do not auto restart). 
    For example:
    "settings": [
      "service_settings":[
        {
          "name":"HDFS",
          "recovery_enabled":"true"
        },
        {
          "name":"ZOOKEEPER",
          "recovery_enabled":"true"
        }
      ]
    ],
  • component_settings: A section to specify if components should be set with auto restart once the cluster is deployed. To configure it, specify "recover_enabled" property to either "true" (auto restart), or "false" (do not auto restart).
    For example:
    "settings": [
      "component_settings":[
        {
          "name":"KAFKA_CLIENT"
          "recover_enabled":"true"
        },
        {
          "name":"METRICS_MONITOR",
          "recover_enabled":"true"
        }
      ]
    ],
  • deployment_settings: A section to specify if the blueprint deployment should auto skip install and start failures. To configure this behavior, specify "skip_failure" property to either "true" (auto skip failures), or "false" (do not auto skip failures). Blueprint deployment will fail on the very first deployment failure if the blueprint file does not contain the "deployment_settings" section.
    For example:
    "settings": [
      "recovery_settings":[
        {
          "recovery_enabled":"true"
        }
      ]
    ],

  • repository_settings: A section to specify custom repository URLs for the blueprint deployment. This section allows you to provide custom URLs to override the default ones. Without this section, you will need to update the repository URLs via REST API before deploying the cluster with the blueprint. "override_strategy" can be "ALWAYS_APPLY" ( always override the default one), or "APPLY_WHEN_MISSING" (only add it if no repository exists with the specific operating system and the repository id information). Repository URLs stored in the Ambari server database will be used if the blueprint does not have the "repository_settings" section.
    For example:
    settings: [
      "repository_settings":[
        {
          "override_strategy":"ALWAYS_APPLY"
          "operating_system":"redhat7",
          "repo_id":"HDP",
          "base_url":"http://myserver/hdp"
        },
        {
          "override_strategy":"APPLY_WHEN_MISSING",
          "operating_system":"redhat7",
          "repo_id":"HDP-UTIL-1.1",
          "base_url":"http://myserver/hdp-util"
        }
      ]
    ]

Cluster Creation Template Structure

A Cluster Creation Template is in JSON format and has the following structure:

{
  "blueprint" : "blueprint-name",
  "default_password" : "super-secret-password",
  "provision_action" : "(INSTALL_AND_START | INSTALL_ONLY)"

{
  "configurations" : [
    {
      "nagiosconfiguration-envtype" : {
        "nagios_contact"property-name" : "me@my-awesome-domain.exampleproperty-value"
      }
    }
    ...
  ],     
  "host_groups" : [
    { 
      "name" : "host_-group_1-name",      
      "componentsconfigurations" : [
        {
          "configuration-type" : {
            "property-name" : "NAMENODEproperty-value"
          },
        {}
      ],     "name"
 : "SECONDARY_NAMENODE"
    "hosts" : [  },        
        { 
          "namefqdn" : "DATANODEhost.domain.com"
        },
        { 
          "namefqdn" : "HDFS_CLIENThost2.domain.com"
        },
        {...
      ]
    }
    ...
  ],
  "credentials" : [
      {
        "alias" : "kdc.admin.credential",
        "principal" : "{PRINCIPAL}",
        "key" : "{KEY}",
        "type" : "(TEMPORARY | PERSISTED)"
      }
  ], 
  "security" : {
         "type" : "(NONE | KERBEROS)",
         "kerberos_descriptor" : {
             ...
          }
  }
}

{
  "name" : "group-using-host-count",
  "host_count" : 5,
  "host_predicate" : "Hosts/os_type=centos6&Hosts/cpu_count=2"
} 

{
  "blueprint" : "blueprint-name",
  "config_recommendation_strategy" : "ONLY_STACK_DEFAULTS_APPLY",
  ...
} 

"hosts" : [         
        {
          "fqdn" : "amb2.service.consul",
          "rack_info": "/dc1/rack1"
        }
      ]

Cluster Creation Template Structure: Host Mappings and Configuration Field Descriptions

• blueprint : Name of the blueprint that defines the cluster to be deployed.  Blueprint must already exist.  Required field.
• default_password : Optional field which specifies a default password for all required passwords which are not specified in the blueprint or cluster creation template configurations.
• provision_action : Default provision_action is INSTALL_AND_START, optionally this can be overwritten on component level, by specifying a different provision_action for a given component. 
• configurations : A list of configuration maps keyed by configuration type. An example of a configuration type is "core-site".  When specified at the top level, configurations are applied at cluster scope and override default values for the cluster.  When specified within a "host_groups" element, configurations are applied at the host level for all hosts mapped to the host group.  Host scoped configurations override cluster scoped configuration for all hosts mapped to the host group.  All cluster scoped and host group scoped configurations specified here override configurations specified in the corresponding blueprint.  The configurations element is optional at both levels. 
• config_recommendation_strategy : Optional field which specifies the strategy of applying configuration recommendations to a cluster. Recommended configurations gathered by the response of the stack advisor, they may override partly/totally user defined custom configurations depending on selected strategy. A property value is considered as custom configuration in case it has a value other then stack default. Available from Ambari 2.2.0. 
  
  • NEVER_APPLY :  Configuration recommendations are ignored with this option. (This is the default)
  • ONLY_STACK_DEFAULTS_APPLY : Configuration recommendations are applied only for properties defined in HDP stack by default. 
  • ALWAYS_APPLY : All configuration recommendations are applied, they may override custom configurations provided by the user in the Blueprint and/or Cluster Creation Template.
  • ALWAYS_APPLY_DONT_OVERRIDE_CUSTOM_VALUES :  All configuration recommendations are applied, however custom configurations defined by the user in the Blueprint and/or Cluster Creation Template are not overridden by recommended configuration values.  Available as of Ambari 2.4.0. 
• host_groups : A list of host groups being deployed to the cluster.  At least one host group must be specified.
  • name : Required field which must correspond to a name of a host group in the associated blueprint.
  • hosts : List of host mapping information
    • fqdn : Fully qualified domain name for each host that is being mapped to the host group.  At least one host must be specified
  • host_count : The number of hosts that should be mapped to this host group. This can be specified instead of concrete host names.  If no host_predicate is specified, any host that isn't explicitly mapped to another host group is available to be mapped to this host group.  Available as of Ambari 2.1.0. 
  • host_predicate : Optional field which is used together with host_count to control which hosts are mapped to the host group.  This is useful in supporting host 'flavors' where different host groups require different host types.  The default predicate matches all hosts which aren't explicitly mapped to another host group.  The syntax of the predicate is the standard Ambari API query syntax applied against the "api/v1/hosts" endpoint.  Available as of Ambari 2.1.0.
• credentials : Optional block to create credentials, kdc.admin.credential is required in case of setting up KERBEROS security. Store type could be PERSISTED
   or TEMPORARY. Temporary admin credentials are valid 90 minutes or until server restart. 
• security : Optional block to override security settings defined in Blueprint. Supported security types are NONE and KERBEROS. In case of KERBEROS, users have the option to embed a valid kerberos descriptor - to override default values defined for HDP stack - in field kerberos_descriptor or as an alternative they may reference a previously saved kerberos descriptor using kerberos_descriptor_reference field. Security settings defined here will override Blueprint settings, however overriding security type used in Blueprint to a less secure mode is not possible (ex. set security.type=NONE in cluster template having security.type=KERBEROS in Blueprint). In case of selecting KERBEROS as security_type it's mandatory to add kerberos-env and krb5-conf config types. (Checkout configurations section in Blueprint example with KERBEROS on this page)
  Automated Kerberization page describes structure of kerberos_descriptor.

Configurations

Default Values and Overrides

• Stack Defaults: Each Stack provides configurations for all included services which serve as defaults for all clusters deployed via Blueprints. 
• Blueprint Cluster Scoped: Configurations provided at the top level of a Blueprint override the corresponding default values for the entire cluster.
• Blueprint Host Group Scoped: Configurations provided within a host_group element of a Blueprint override both the corresponding default values and blueprint cluster scoped values only for hosts mapped to the host group.
• Cluster Creation Template Cluster Scoped: Configurations provided at the top level of the Cluster Creation Template override both the corresponding default and blueprint cluster scoped values for the entire cluster.
• Cluster Creation Template Host Group Scoped: Configurations provided within a host_group element of a Cluster Creation Template override all other values for hosts mapped to the host group.

Required Configurations

• Not all configuration properties have valid defaults
• Required properties must be specified by the Blueprint user
• Come in two categories, passwords and non passwords
• Non password required properties are validated at Blueprint creation time
• Required password properties are validated at cluster creation time
• For required password properties, they may be explicitly set in either the Blueprint or Cluster Creation Template configurations or a default password may be specified in the Cluster Creation Template which will be applied to all passwords which have not been explicitly set
  • "default_password" : "super-secret-password"
• If required configuration validation fails, a 400 response is returned indicating which properties must be specified

Blueprint Examples

Blueprint Example: Single-Node HDP 2.4 Cluster

• Single-node cluster (c6401.ambari.apache.org)
• HDP 2.4 Stack
• Install Core Hadoop Services (HDFS, YARN, MapReduce2, ZooKeeper)

Example Blueprint

{
          "name" : "YARN_CLIENT"
    

    },
      

 {
          "

name" : "

HISTORYSERVER"
        },
    

{
  "host_groups" : [
    {
      "name" : "host_group_1",      
      "components" : [      "name" : "RESOURCEMANAGER"
        },
        {
          "name" : "NODEMANAGER"
        },
        {
          "name" : "YARN_CLIENT"
        },
        {
          "name" : "HISTORYSERVERNAMENODE"
        },
        {
          "name" : "MAPREDUCE2SECONDARY_CLIENTNAMENODE"
        },
        {
          "name" : "ZOOKEEPER_SERVER"
        },
        {
          "name" : "ZOOKEEPER_CLIENTDATANODE"
        },
        {
          "name" : "GANGLIAHDFS_SERVERCLIENT"
        },
        {
          "name" : "NAGIOS_SERVERRESOURCEMANAGER"
        },
        ],{
          "cardinalityname" : "1NODEMANAGER"
    }
    ]},
  "Blueprints" : {
    "stack_name" : "HDP",
    "stack_version" : "2.0"
  }
}

Register blueprint with Ambari Server

Post the blueprint to the "single-node-hdfs-yarn" resource to the Ambari Server.

POST /api/v1/blueprints/single-node-hdfs-yarn
 
... 
[ Request Body is the example blueprint defined above ]
...

201 - Created

Example Cluster Creation Template

We are performing a single-node install and the blueprint above has one host group. Therefore, for our cluster instance, we define one host in host_group_1 and reference the single-node-hdfs-yarn blueprint.

Explicit Host Name Example

{
  "blueprint" : "single-node-hdfs-yarn",
  "default_password" : "my-super-secret-password",
  "host_groups" :[
    { 
 {
          "name" : "MAPREDUCE2_CLIENT"
        },
        {
          "name" : "ZOOKEEPER_SERVER"
        },
        {
          "name" : "hostZOOKEEPER_group_1",CLIENT"
        }
      "hosts" : [],
      "cardinality" : "1"
    }
  ],
  "Blueprints" : {
    "blueprint_name" { : "single-node-hdfs-yarn",
    "stack_name" : "HDP",
     "fqdnstack_version" : "c6401.ambari.apache.org2.4"
  }
}

Register blueprint with Ambari Server

Post the blueprint to the "single-node-hdfs-yarn" resource to the Ambari Server.

POST      }
      ]
    }
  ]
}

Create Cluster Instance

Post the cluster to the Ambari Server to provision the cluster.

POST /api/v1/clusters/MySingleNodeCluster

...
[ Request Body is above Cluster Creation Template ]
...

202 - Accepted
{
  "href" : "http://c6401.ambari.apache.org:8080/api/v1/clusters/MyCluster/requests/1",
  "Requests" : {
    "id" : 1,
    "status" : "InProgress"
  }
}

Blueprint Example: Multi-Node HDP 2.0 Cluster

Example Blueprint

The blueprint ("multi-node-hdfs-yarn") below defines with two host groups (a "master" and the "slaves") which hosts the various Service components (masters, slaves and clients).

/api/v1/blueprints/single-node-hdfs-yarn
 
... 
[ Request Body is the example blueprint defined above ]
...

201 - Created

Example Cluster Creation Template

We are performing a single-node install and the blueprint above has one host group. Therefore, for our cluster instance, we define one host in host_group_1 and reference the single-node-hdfs-yarn blueprint.

Explicit Host Name Example

{
  "blueprint" : "single-node-hdfs-yarn",
  "host_groups" :[
    { 
      "name" : "host_group_1",  
      "hosts" : [          
        { 
          "fqdn" : "c6401.ambari.apache.org"
        }
      ]
    }
  ]
}

Create Cluster Instance

Post the cluster to the Ambari Server to provision the cluster.

POST /api/v1/clusters/MySingleNodeCluster

...
[ Request Body is above Cluster Creation Template ]
...

202 - Accepted
{
  "href" : "http://c6401.ambari.apache.org:8080/api/v1/clusters/MyCluster/requests/1",
  "Requests

{
  "host_groups" : [
    {
      "name" : "master",
      "configurations" : [
        {
          "nagios-env" : {
    "id" :   1,
    "nagios_contactstatus" : "me@my-awesome-domain.exampleInProgress"
          }
}

Blueprint Example: Multi-Node HDP 2.4 Cluster

Example Blueprint

The blueprint ("multi-node-hdfs-yarn") below defines with two host groups (a "master" and the "slaves") which hosts the various Service components (masters, slaves and clients).

{
  "host_groups" : [
            }
      ],
      "components" : [
        {
          "name" : "NAMENODE"
        },
        {
          "name" : "SECONDARY_NAMENODEmaster",
      "components"  },        : [
        {
          "name" : "RESOURCEMANAGERNAMENODE"
        },
        {
          "name" : "HISTORYSERVERSECONDARY_NAMENODE"
        },        
        {
          "name" : "NAGIOS_SERVERRESOURCEMANAGER"
        },
        {
          "name" : "GANGLIA_SERVERHISTORYSERVER"
        },
        {
          "name" : "ZOOKEEPER_SERVER"
        }
      ],
      "cardinality" : "1"
    },
    {
      "name" : "slaves",
      "components" : [
        {
          "name" : "DATANODE"
        },
        {
          "name" : "HDFS_CLIENT"
        },
        {
          "name" : "NODEMANAGER"
        },
        {
          "name" : "YARN_CLIENT"
        },
        {
          "name" : "MAPREDUCE2_CLIENT"
        },
        {
          "name" : "ZOOKEEPER_CLIENT"
        }
      ],
      "cardinality" : "1+"
    }
  ],
  "Blueprints" : {
    "blueprint_name" : "multi-node-hdfs-yarn",
    "stack_name" : "HDP",
    "stack_version" : "2.04"
  }
}

Register blueprint with Ambari Server

...

The blueprint below could be used to setup a cluster containing three host groups with KERBEROS security. Overriding default kerberos descriptor is not necessary however specifying a few Kerberos specific properties in kerberos-env and krb5-conf is a must to setup services to use Kerberos.  Note: prior to Ambari 2.4.0 use "kdc_host" instead of "kdc_hosts".

{
  "configurations" : [
    {
      "kerberos-env": {
        "properties_attributes" : { },
        "properties" : {
          "realm" : "AMBARI.APACHE.ORG",
          "kdc_type" : "mit-kdc",
          "kdc_hosthosts" : "(kerberos_server_name)",
          "admin_server_host" : "(kerberos_server_name)"
        }
      }
    },
    {
      "krb5-conf": {
        "properties_attributes" : { },
        "properties" : {
          "domains" : "AMBARI.APACHE.ORG",
          "manage_krb5_conf" : "true"
        }
      }
    }
  ],
  "host_groups" : [
    {
      "name" : "host_group_1",
      "configurations" : [ ],
      "components" : [
        {
          "name" : "ZOOKEEPER_CLIENT"
        },
        {
          "name" : "ZOOKEEPER_SERVER"
        },
        {
          "name" : "NAMENODE"
        },
        {
          "name" : "HDFS_CLIENT"
        },
        {
          "name" : "DATANODE"
        }
      ],
      "cardinality" : "1"
    },
    {
      "name" : "host_group_2",
      "configurations" : [ ],
      "components" : [
        {
          "name" : "ZOOKEEPER_SERVER"
        },
        {
          "name" : "KERBEROS_CLIENT"
        },
        {
          "name" : "SECONDARY_NAMENODE"
        },
        {
          "name" : "DATANODE"
        }
      ],
      "cardinality" : "1"
    },
    {
      "name" : "host_group_3",
      "configurations" : [ ],
      "components" : [
        {
          "name" : "ZOOKEEPER_CLIENT"
        },
        {
          "name" : "ZOOKEEPER_SERVER"
        },
        {
          "name" : "KERBEROS_CLIENT"
        },
        {
          "name" : "HDFS_CLIENT"
        },
        {
          "name" : "DATANODE"
        }
      ],
      "cardinality" : "1"
    }
  ],
  "Blueprints" : {
    "stack_name" : "HDP",
    "stack_version" : "2.3",
    "security" : {
         "type" : "KERBEROS"
    }
  }
}

...