org.apache.ambari.server.topology

Interface ClusterTopology

All Known Implementing Classes:

ClusterTopologyImpl

public interface ClusterTopology

Represents a full cluster topology including all instance information as well as the associated blueprint which provides all abstract topology information.

Method Summary

Modifier and Type	Method and Description
void	addHostToTopology(String hostGroupName, String host) Add a new host to the topology.
Map<String,AdvisedConfiguration>	getAdvisedConfigurations()
Set<String>	getAllHosts()
AmbariContext	getAmbariContext()
Blueprint	getBlueprint() Get the blueprint associated with the cluster.
Long	getClusterId() Get the id of the cluster.
ConfigRecommendationStrategy	getConfigRecommendationStrategy()
Configuration	getConfiguration() Get the cluster scoped configuration for the cluster.
String	getDefaultPassword()
Collection<String>	getHostAssignmentsForComponent(String component) Get all hosts which are mapped to a host group which contains the specified component.
String	getHostGroupForHost(String hostname) Get the name of the host group which is mapped to the specified host.
Map<String,HostGroupInfo>	getHostGroupInfo() Get host group information.
Collection<String>	getHostGroupsForComponent(String component) Get the names of all of host groups which contain the specified component.
ProvisionAction	getProvisionAction()
boolean	hasHadoopCompatibleService()
RequestStatusResponse	installHost(String hostName, boolean skipInstallTaskCreate, boolean skipFailure) Install the specified host.
boolean	isClusterKerberosEnabled() Determine if the cluster is kerberos enabled.
boolean	isNameNodeHAEnabled() Determine if NameNode HA is enabled.
boolean	isYarnResourceManagerHAEnabled() Determine if Yarn ResourceManager HA is enabled.
void	removeHost(String hostname) Removes host from stateful ClusterTopology
void	setClusterId(Long clusterId) Set the id of the cluster.
void	setConfigRecommendationStrategy(ConfigRecommendationStrategy strategy)
void	setProvisionAction(ProvisionAction provisionAction) Set request provision action : INSTALL vs INSTALL_AND_START
RequestStatusResponse	startHost(String hostName, boolean skipFailure) Start the specified host.
void	update(TopologyRequest topologyRequest) Update the existing topology based on the provided topology request.

Method Detail

getClusterId

Long getClusterId()

Get the id of the cluster.

Returns:

cluster id

setClusterId

void setClusterId(Long clusterId)

Set the id of the cluster.

Parameters:

clusterId - cluster id

getBlueprint

Blueprint getBlueprint()

Get the blueprint associated with the cluster.

Returns:

assocaited blueprint

getConfiguration

Configuration getConfiguration()

Get the cluster scoped configuration for the cluster. This configuration has the blueprint cluster scoped configuration set as it's parent.

Returns:

cluster scoped configuration

getHostGroupInfo

Map<String,HostGroupInfo> getHostGroupInfo()

Get host group information.

Returns:

map of host group name to host group information

getAllHosts

Set<String> getAllHosts()

Returns:

all hosts in the topology

getHostGroupsForComponent

Collection<String> getHostGroupsForComponent(String component)

Get the names of all of host groups which contain the specified component.

Parameters:

component - component name

Returns:

collection of host group names which contain the specified component

getHostGroupForHost

String getHostGroupForHost(String hostname)

Get the name of the host group which is mapped to the specified host.

Parameters:

hostname - host name

Returns:

name of the host group which is mapped to the specified host or null if no group is mapped to the host

getHostAssignmentsForComponent

Collection<String> getHostAssignmentsForComponent(String component)

Get all hosts which are mapped to a host group which contains the specified component. The host need only to be mapped to the hostgroup, not actually provisioned.

Parameters:

component - component name

Returns:

collection of hosts for the specified component; will not return null

update

void update(TopologyRequest topologyRequest)
     throws InvalidTopologyException

Update the existing topology based on the provided topology request.

Parameters:

topologyRequest - request modifying the topology

Throws:

InvalidTopologyException - if the request specified invalid topology information or if making the requested changes would result in an invalid topology

addHostToTopology

void addHostToTopology(String hostGroupName,
                       String host)
                throws InvalidTopologyException,
                       NoSuchHostGroupException

Add a new host to the topology.

Parameters:

hostGroupName - name of associated host group

host - name of host

Throws:

InvalidTopologyException - if the host being added is already registered to a different host group

NoSuchHostGroupException - if the specified host group is invalid

isNameNodeHAEnabled

boolean isNameNodeHAEnabled()

Determine if NameNode HA is enabled.

Returns:

true if NameNode HA is enabled; false otherwise

isYarnResourceManagerHAEnabled

boolean isYarnResourceManagerHAEnabled()

Determine if Yarn ResourceManager HA is enabled.

Returns:

true if Yarn ResourceManager HA is enabled; false otherwise

isClusterKerberosEnabled

boolean isClusterKerberosEnabled()

Determine if the cluster is kerberos enabled.

Returns:

true if the cluster is kerberos enabled; false otherwise

installHost

RequestStatusResponse installHost(String hostName,
                                  boolean skipInstallTaskCreate,
                                  boolean skipFailure)

Install the specified host.

Parameters:

hostName - host name

skipInstallTaskCreate -

Returns:

install response

startHost

RequestStatusResponse startHost(String hostName,
                                boolean skipFailure)

Start the specified host.

Parameters:

hostName - host name

Returns:

start response

setConfigRecommendationStrategy

void setConfigRecommendationStrategy(ConfigRecommendationStrategy strategy)

getConfigRecommendationStrategy

ConfigRecommendationStrategy getConfigRecommendationStrategy()

setProvisionAction

void setProvisionAction(ProvisionAction provisionAction)

Set request provision action : INSTALL vs INSTALL_AND_START

Parameters:

provisionAction - @ProvisionAction

getProvisionAction

ProvisionAction getProvisionAction()

getAdvisedConfigurations

Map<String,AdvisedConfiguration> getAdvisedConfigurations()

getAmbariContext

AmbariContext getAmbariContext()

removeHost

void removeHost(String hostname)

Removes host from stateful ClusterTopology

Parameters:

hostname -

getDefaultPassword

String getDefaultPassword()

hasHadoopCompatibleService

boolean hasHadoopCompatibleService()

Returns:

true if the topology contains any service with HCFS tag