com.cloudera.api.v9
Interface ClustersResourceV9

All Superinterfaces:

ClustersResource, ClustersResourceV2, ClustersResourceV3, ClustersResourceV4, ClustersResourceV5, ClustersResourceV6, ClustersResourceV7, ClustersResourceV8

All Known Subinterfaces:

ClustersResourceV10, ClustersResourceV11, ClustersResourceV12, ClustersResourceV13, ClustersResourceV14, ClustersResourceV15, ClustersResourceV16, ClustersResourceV17, ClustersResourceV18

public interface ClustersResourceV9
extends ClustersResourceV8

Method Summary

ApiCommand

upgradeCdhCommand(String clusterName, ApiCdhUpgradeArgs args) Perform CDH upgrade to the specified version.

Methods inherited from interface com.cloudera.api.v8.ClustersResourceV8

getServicesResource, inspectHostsCommand

Methods inherited from interface com.cloudera.api.v7.ClustersResourceV7

deployClusterClientConfig, firstRun, getClientConfig

Methods inherited from interface com.cloudera.api.v6.ClustersResourceV6

autoAssignRoles, autoConfigure, listServiceTypes, poolsRefresh, refresh, restartCommand, updateCluster

Methods inherited from interface com.cloudera.api.v5.ClustersResourceV5

getParcelsResource

Methods inherited from interface com.cloudera.api.v4.ClustersResourceV4

rollingRestart

Methods inherited from interface com.cloudera.api.v3.ClustersResourceV3

addHosts, getHostTemplatesResource, listHosts, removeAllHosts, removeHost

Methods inherited from interface com.cloudera.api.v2.ClustersResourceV2

deployClientConfig, enterMaintenanceMode, exitMaintenanceMode

Methods inherited from interface com.cloudera.api.v1.ClustersResource

createClusters, deleteCluster, listActiveCommands, readCluster, readClusters, restartCommand, startCommand, stopCommand, upgradeServicesCommand

Method Detail

upgradeCdhCommand

@Path(value="/{clusterName}/commands/upgradeCdh")
ApiCommand upgradeCdhCommand(String clusterName,
                                  ApiCdhUpgradeArgs args)

Perform CDH upgrade to the specified version.

Allows the following upgrades:

• Major upgrades from any CDH 4 to any CDH 5
• Minor upgrades from any CDH 5 to any CDH 5
• Maintenance upgrades or downgrades (a.b.x to a.b.y)

If using packages, CDH packages on all hosts of the cluster must be manually upgraded before this command is issued.

The command will upgrade the services and their configuration to the version available in the CDH5 distribution.

Unless rolling upgrade options are provided, the entire cluster will experience downtime. If rolling upgrade options are provided, command will do a "best-effort" rolling upgrade of the given cluster, i.e. it does plain upgrade of services that cannot be rolling upgraded, followed by first rolling upgrading non-slaves and then rolling restarting the slave roles of services that can be rolling restarted. The slave restarts are done host-by-host.

Available since v9. Rolling upgrade is only available with Cloudera Manager Enterprise Edition. A more limited upgrade variant available since v6.

Specified by:

upgradeCdhCommand in interface ClustersResourceV6

Parameters:

clusterName - The name of the cluster.

args - Arguments for the command. See ApiCdhUpgradeArgs.

Returns:

Information about the submitted command.