org.apache.ambari.server.stack.upgrade.orchestrate

Class UpgradeContext

java.lang.Object

org.apache.ambari.server.stack.upgrade.orchestrate.UpgradeContext

public class UpgradeContext
extends Object

The UpgradeContext is used to hold all information pertaining to an upgrade. It is initialized directly from an existing UpgradeEntity or from a request to create an upgrade/downgrade.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_PARAM_CLUSTER_NAME
static String	COMMAND_PARAM_DIRECTION
static String	COMMAND_PARAM_REQUEST_ID
static String	COMMAND_PARAM_STRUCT_OUT
static String	COMMAND_PARAM_TASKS
static String	COMMAND_PARAM_UPGRADE_PACK
static String	COMMAND_PARAM_UPGRADE_TYPE

Constructor Summary

Constructors

Constructor and Description
UpgradeContext(Cluster cluster, Map<String,Object> upgradeRequestMap, com.google.gson.Gson gson, UpgradeHelper upgradeHelper, UpgradeDAO upgradeDAO, RepositoryVersionDAO repoVersionDAO, ConfigHelper configHelper, AmbariMetaInfo metaInfo)
UpgradeContext(Cluster cluster, UpgradeEntity upgradeEntity, AmbariMetaInfo ambariMetaInfo, ConfigHelper configHelper) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addUnhealthy(List<ServiceComponentHost> unhealthy)
org.apache.ambari.spi.upgrade.UpgradeInformation	buildUpgradeInformation() Builds a UpgradeInformation instance from a Cluster where there is an upgrade in progress.
AmbariMetaInfo	getAmbariMetaInfo()
Cluster	getCluster() Gets the cluster that the upgrade is for.
String	getComponentDisplay(String service, String component)
int	getDefaultMaxDegreeOfParallelism()
Direction	getDirection()
HostRoleCommandFactory	getHostRoleCommandFactory() Gets the injected instance of a HostRoleCommandFactory.
Map<String,String>	getInitializedCommandParameters() Gets a map initialized with parameters required for upgrades to work.
KerberosDetails	getKerberosDetails() Gets Kerberos information about a cluster.
org.apache.ambari.spi.upgrade.OrchestrationOptions	getOrchestrationOptions()
org.apache.ambari.spi.RepositoryType	getOrchestrationType() Gets the repository type to determine if this upgrade is a complete upgrade or a service/patch.
long	getPatchRevertUpgradeId()
RepositoryVersionEntity	getRepositoryVersion() Gets the single repository version for the upgrade depending on the direction.
MasterHostResolver	getResolver()
RoleGraphFactory	getRoleGraphFactory() Gets the injected instance of a RoleGraphFactory.
String	getServiceDisplay(String service)
RepositoryVersionEntity	getSourceRepositoryVersion(String serviceName) Gets the version that service is being considered to be "coming from".
StackId	getSourceStack() Gets the single source stack for the upgrade depending on the direction.
String	getSourceVersion(String serviceName) Gets the version that service is being considered to be "coming from".
Map<String,RepositoryVersionEntity>	getSourceVersions() Gets the version that components are being considered to be "coming from".
StackId	getStackIdFromVersions(Map<String,RepositoryVersionEntity> version) Getting stackId from the set of versions.
Set<String>	getSupportedServices() Gets the services participating in the upgrade.
RepositoryVersionEntity	getTargetRepositoryVersion(String serviceName) Gets the repository being upgraded to or downgraded to for the given service.
StackId	getTargetStack() Gets the single target stack for the upgrade.
String	getTargetVersion(String serviceName) Gets the version being upgraded to or downgraded to for the given service.
Map<String,RepositoryVersionEntity>	getTargetVersions() Gets the version being upgraded to or downgraded to for all services participating.
org.apache.ambari.spi.upgrade.UpgradeType	getType()
UpgradePack	getUpgradePack() Gets the upgrade pack for this upgrade.
UpgradeSummary	getUpgradeSummary() Gets a POJO of the upgrade suitable to serialize.
boolean	isComponentFailureAutoSkipped() Gets whether skippable components that failed are automatically skipped.
boolean	isDowngradeAllowed() Gets whether a downgrade is allowed for this upgrade.
boolean	isManualVerificationAutoSkipped() Gets whether manual verification tasks can be automatically skipped.
boolean	isPatchRevert()
boolean	isScoped(UpgradeScope scope)
boolean	isServiceCheckFailureAutoSkipped() Gets whether skippable service checks that failed are automatically skipped.
boolean	isServiceSupported(String serviceName) Gets if a service is supported.
void	setComponentDisplay(String service, String component, String displayName)
void	setServiceDisplay(String service, String displayName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMAND_PARAM_CLUSTER_NAME

public static final String COMMAND_PARAM_CLUSTER_NAME

See Also:

Constant Field Values

COMMAND_PARAM_DIRECTION

public static final String COMMAND_PARAM_DIRECTION

See Also:

Constant Field Values

COMMAND_PARAM_UPGRADE_PACK

public static final String COMMAND_PARAM_UPGRADE_PACK

See Also:

Constant Field Values

COMMAND_PARAM_REQUEST_ID

public static final String COMMAND_PARAM_REQUEST_ID

See Also:

Constant Field Values

COMMAND_PARAM_UPGRADE_TYPE

public static final String COMMAND_PARAM_UPGRADE_TYPE

See Also:

Constant Field Values

COMMAND_PARAM_TASKS

public static final String COMMAND_PARAM_TASKS

See Also:

Constant Field Values

COMMAND_PARAM_STRUCT_OUT

public static final String COMMAND_PARAM_STRUCT_OUT

See Also:

Constant Field Values

Constructor Detail

UpgradeContext

public UpgradeContext(Cluster cluster,
                      Map<String,Object> upgradeRequestMap,
                      com.google.gson.Gson gson,
                      UpgradeHelper upgradeHelper,
                      UpgradeDAO upgradeDAO,
                      RepositoryVersionDAO repoVersionDAO,
                      ConfigHelper configHelper,
                      AmbariMetaInfo metaInfo)
               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

UpgradeContext

public UpgradeContext(Cluster cluster,
                      UpgradeEntity upgradeEntity,
                      AmbariMetaInfo ambariMetaInfo,
                      ConfigHelper configHelper)

Constructor.

Parameters:

cluster - the cluster that the upgrade is for

upgradeEntity - the upgrade entity

Method Detail

getStackIdFromVersions

public StackId getStackIdFromVersions(Map<String,RepositoryVersionEntity> version)

Getting stackId from the set of versions. Is is possible until we upgrading components on the same stack. Note: Function should be modified for cross-stack upgrade.

Parameters:

version - Set of services repository versions

Returns:

StackId based on provided versions

getUpgradePack

public UpgradePack getUpgradePack()

Gets the upgrade pack for this upgrade.

Returns:

the upgrade pack

getCluster

public Cluster getCluster()

Gets the cluster that the upgrade is for.

Returns:

the cluster (never null).

getSourceVersions

public Map<String,RepositoryVersionEntity> getSourceVersions()

Gets the version that components are being considered to be "coming from".

With a Direction.UPGRADE, this value represent the services' desired repository. However, Direction.DOWNGRADE will use the same value for all services which is the version that the downgrade is coming from.

Returns:

the source version for the upgrade

getSourceRepositoryVersion

public RepositoryVersionEntity getSourceRepositoryVersion(String serviceName)

Gets the version that service is being considered to be "coming from".

With a Direction.UPGRADE, this value represent the services' desired repository. However, Direction.DOWNGRADE will use the same value for all services which is the version that the downgrade is coming from.

Returns:

the source repository for the upgrade

getSourceVersion

public String getSourceVersion(String serviceName)

Gets the version that service is being considered to be "coming from".

With a Direction.UPGRADE, this value represent the services' desired repository. However, Direction.DOWNGRADE will use the same value for all services which is the version that the downgrade is coming from.

Returns:

the source repository for the upgrade

See Also:

getSourceRepositoryVersion(String)

getTargetVersions

public Map<String,RepositoryVersionEntity> getTargetVersions()

Gets the version being upgraded to or downgraded to for all services participating. This is the version that the service will be on if the upgrade or downgrade succeeds.

With a Direction.UPGRADE, all services should be targetting the same repository version. However, Direction.DOWNGRADE will target the original repository that the service was on.

Returns:

the target version for the upgrade

getTargetRepositoryVersion

public RepositoryVersionEntity getTargetRepositoryVersion(String serviceName)

Gets the repository being upgraded to or downgraded to for the given service. This is the version that the service will be on if the upgrade or downgrade succeeds.

With a Direction.UPGRADE, all services should be targeting the same repository version. However, Direction.DOWNGRADE will target the original repository that the service was on.

Returns:

the target repository for the upgrade

getTargetVersion

public String getTargetVersion(String serviceName)

Gets the version being upgraded to or downgraded to for the given service. This is the version that the service will be on if the upgrade or downgrade succeeds.

With a Direction.UPGRADE, all services should be targetting the same repository version. However, Direction.DOWNGRADE will target the original repository that the service was on.

Returns:

the target version for the upgrade

See Also:

getTargetRepositoryVersion(String)

getDirection

public Direction getDirection()

Returns:

the direction of the upgrade

getType

public org.apache.ambari.spi.upgrade.UpgradeType getType()

Returns:

the type of upgrade.

getResolver

public MasterHostResolver getResolver()

Returns:

the resolver

getAmbariMetaInfo

public AmbariMetaInfo getAmbariMetaInfo()

Returns:

the metainfo for access to service definitions

addUnhealthy

public void addUnhealthy(List<ServiceComponentHost> unhealthy)

Parameters:

unhealthy - a list of unhealthy host components

getRepositoryVersion

public RepositoryVersionEntity getRepositoryVersion()

Gets the single repository version for the upgrade depending on the direction.

If the direction is Direction.UPGRADE then this will return the target repository which every service will be on if the upgrade is finalized.

If the direction is Direction.DOWNGRADE then this will return the repository from which the downgrade is coming from.

Returns:

the target repository version for this upgrade (never null).

getServiceDisplay

public String getServiceDisplay(String service)

Returns:

the service display name, or the service name if not set

getComponentDisplay

public String getComponentDisplay(String service,
                                  String component)

Returns:

the component display name, or the component name if not set

setServiceDisplay

public void setServiceDisplay(String service,
                              String displayName)

Parameters:

service - the service name

displayName - the display name for the service

setComponentDisplay

public void setComponentDisplay(String service,
                                String component,
                                String displayName)

Parameters:

service - the service name that owns the component

component - the component name

displayName - the display name for the component

isComponentFailureAutoSkipped

public boolean isComponentFailureAutoSkipped()

Gets whether skippable components that failed are automatically skipped.

Returns:

the skipComponentFailures

isServiceCheckFailureAutoSkipped

public boolean isServiceCheckFailureAutoSkipped()

Gets whether skippable service checks that failed are automatically skipped.

Returns:

the skipServiceCheckFailures

isManualVerificationAutoSkipped

public boolean isManualVerificationAutoSkipped()

Gets whether manual verification tasks can be automatically skipped.

Returns:

the skipManualVerification

getSupportedServices

public Set<String> getSupportedServices()

Gets the services participating in the upgrade.

Returns:

the set of supported services. This collection should never be empty.

isServiceSupported

public boolean isServiceSupported(String serviceName)

Gets if a service is supported.

Parameters:

serviceName - the service name to check.

Returns:

true when the service is supported

isScoped

public boolean isScoped(UpgradeScope scope)

getRoleGraphFactory

public RoleGraphFactory getRoleGraphFactory()

Gets the injected instance of a RoleGraphFactory.

Returns:

a RoleGraphFactory instance (never null).

getHostRoleCommandFactory

public HostRoleCommandFactory getHostRoleCommandFactory()

Gets the injected instance of a HostRoleCommandFactory.

Returns:

a HostRoleCommandFactory instance (never null).

getOrchestrationType

public org.apache.ambari.spi.RepositoryType getOrchestrationType()

Gets the repository type to determine if this upgrade is a complete upgrade or a service/patch. This value is not always the same as the repository version. In the case of a revert of a patch, the target repository may be of type STANDARD, but orchestration must be "like a patch".

Returns:

the orchestration type.

getInitializedCommandParameters

public Map<String,String> getInitializedCommandParameters()

Gets a map initialized with parameters required for upgrades to work. The following properties are already set:

• COMMAND_PARAM_CLUSTER_NAME
• COMMAND_PARAM_DIRECTION
• COMMAND_PARAM_UPGRADE_TYPE
• KeyNames#REFRESH_CONFIG_TAGS_BEFORE_EXECUTION - necessary in order to have the commands contain the correct configurations. Otherwise, they will contain the configurations that were available at the time the command was created. For upgrades, this is problematic since the commands are all created ahead of time, but the upgrade may change configs as part of the upgrade pack.

Returns:

the initialized parameter map.

toString

public String toString()

Overrides:

toString in class Object

isDowngradeAllowed

public boolean isDowngradeAllowed()

Gets whether a downgrade is allowed for this upgrade. If the direction is Direction.DOWNGRADE, then this method always returns false. Otherwise it will consule UpgradePack.isDowngradeAllowed().

Returns:

true of a downgrade is allowed for this upgrade, false otherwise.

isPatchRevert

public boolean isPatchRevert()

Returns:

getPatchRevertUpgradeId

public long getPatchRevertUpgradeId()

getDefaultMaxDegreeOfParallelism

public int getDefaultMaxDegreeOfParallelism()

Returns:

default value of number of tasks to run in parallel during upgrades

getUpgradeSummary

public UpgradeSummary getUpgradeSummary()

Gets a POJO of the upgrade suitable to serialize.

Returns:

the upgrade summary as a POJO.

getTargetStack

public StackId getTargetStack()

Gets the single target stack for the upgrade. By definition, ALL the targets, despite the versions, should have the same stack. The source stacks may be different from the target, but all the source stacks must also be the same.

Returns:

the target stack for this upgrade (never null).

getSourceStack

public StackId getSourceStack()

Gets the single source stack for the upgrade depending on the direction. By definition, ALL the source stacks, despite the versions, should have the same stack. The target stacks may be different from the source, but all the target stacks must also be the same.

Returns:

the source stack for this upgrade (never null).

getKerberosDetails

public KerberosDetails getKerberosDetails()
                                   throws KerberosInvalidConfigurationException,
                                          org.apache.ambari.server.AmbariException

Gets Kerberos information about a cluster. It should only be invoked if the cluster's security type is set to SecurityType.KERBEROS, otherwise it will throw an AmbariException.

Returns:

the Kerberos related details of a cluster.

Throws:

KerberosInvalidConfigurationException - if the kerberos-env or krb5-conf} configurations can't be parsed.

org.apache.ambari.server.AmbariException - if the cluster is not Kerberized.

getOrchestrationOptions

public org.apache.ambari.spi.upgrade.OrchestrationOptions getOrchestrationOptions()

Returns:

the orchestration options, or null if not defined

buildUpgradeInformation

public org.apache.ambari.spi.upgrade.UpgradeInformation buildUpgradeInformation()

Builds a UpgradeInformation instance from a Cluster where there is an upgrade in progress.

Returns:

the UpgradeInformation instance comprised of simple POJOs and SPI classes.