com.cloudera.api.v8
Interface ServicesResourceV8

All Superinterfaces:
ServicesResource, ServicesResourceV2, ServicesResourceV3, ServicesResourceV4, ServicesResourceV6, ServicesResourceV7
All Known Subinterfaces:
ServicesResourceV10, ServicesResourceV11, ServicesResourceV13, ServicesResourceV14, ServicesResourceV15, ServicesResourceV16, ServicesResourceV17, ServicesResourceV18

public interface ServicesResourceV8
extends ServicesResourceV7


Method Summary
 ApiCommand collectYarnApplicationDiagnostics(String serviceName, ApiYarnApplicationDiagnosticsCollectionArgs args)
          Collect the Diagnostics data for Yarn applications
 ApiCommand disableLlamaHaCommand(String serviceName, ApiDisableLlamaHaArguments args)
          Disable high availability (HA) for an Impala Llama ApplicationMaster.
 ApiCommand disableLlamaRmCommand(String serviceName)
          Disable Llama-based resource management for Impala.
 ApiCommand enableLlamaHaCommand(String serviceName, ApiEnableLlamaHaArguments args)
          Enable high availability (HA) for an Impala Llama ApplicationMaster.
 ApiCommand enableLlamaRmCommand(String serviceName, ApiEnableLlamaRmArguments args)
          Enable Llama-based resource management for Impala.
 RoleCommandsResourceV8 getRoleCommandsResource(String serviceName)
           
 RolesResourceV8 getRolesResource(String serviceName)
           
 ApiCommand hdfsFinalizeRollingUpgrade(String serviceName)
          Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version.
 ApiCommand sentryUpgradeDatabaseTablesCommand(String serviceName)
          Upgrade the Sentry Server Database tables.
 ApiCommand yarnFormatStateStore(String serviceName)
          Formats the state store in ZooKeeper used for Resource Manager High Availability.
 
Methods inherited from interface com.cloudera.api.v7.ServicesResourceV7
firstRun, sentryCreateDatabaseCommand, sentryCreateDatabaseTablesCommand
 
Methods inherited from interface com.cloudera.api.v6.ServicesResourceV6
createImpalaUserDirCommand, createYarnJobHistoryDirCommand, createYarnNodeManagerRemoteAppLogDirCommand, disableOozieHaCommand, disableRmHaCommand, enableOozieHaCommand, enableRmHaCommand, getImpalaQueriesResource, getSnapshotsResource, getYarnApplicationsResource, hbaseUpgradeCommand, hdfsDisableNnHaCommand, hdfsEnableNnHaCommand, hdfsUpgradeMetadataCommand, hiveUpgradeMetastoreCommand, impalaCreateCatalogDatabaseCommand, impalaCreateCatalogDatabaseTablesCommand, importMrConfigsIntoYarn, listServiceCommands, oozieUpgradeDbCommand, serviceCommandByName, sqoopUpgradeDbCommand, switchToMr2
 
Methods inherited from interface com.cloudera.api.v4.ServicesResourceV4
createHiveUserDirCommand, createSolrHdfsHomeDirCommand, createSqoopUserDirCommand, disableJtHaCommand, enableJtHaCommand, getHdfsUsageReport, getMrUsageReport, getReplicationsResource, hiveCreateMetastoreDatabaseCommand, hiveUpdateMetastoreNamenodesCommand, initSolrCommand
 
Methods inherited from interface com.cloudera.api.v3.ServicesResourceV3
createHiveWarehouseCommand, getRoleConfigGroupsResource, hdfsRollEditsCommand, hiveCreateMetastoreDatabaseTablesCommand, installOozieShareLib, rollingRestart, updateService
 
Methods inherited from interface com.cloudera.api.v2.ServicesResourceV2
createOozieDb, enterMaintenanceMode, exitMaintenanceMode, getClientConfig, hdfsCreateTmpDir, recommissionCommand
 
Methods inherited from interface com.cloudera.api.v1.ServicesResource
createBeeswaxWarehouseCommand, createHBaseRootCommand, createServices, decommissionCommand, deleteService, deployClientConfigCommand, getActivitiesResource, getMetrics, getNameservicesResource, hdfsDisableAutoFailoverCommand, hdfsDisableHaCommand, hdfsEnableAutoFailoverCommand, hdfsEnableHaCommand, hdfsFailoverCommand, listActiveCommands, listRoleTypes, readService, readServiceConfig, readServices, restartCommand, startCommand, stopCommand, updateServiceConfig, zooKeeperCleanupCommand, zooKeeperInitCommand
 

Method Detail

getRolesResource

RolesResourceV8 getRolesResource(String serviceName)
Specified by:
getRolesResource in interface ServicesResource
Specified by:
getRolesResource in interface ServicesResourceV2
Specified by:
getRolesResource in interface ServicesResourceV4
Specified by:
getRolesResource in interface ServicesResourceV6
Returns:
The roles resource handler.

getRoleCommandsResource

@Path(value="/{serviceName}/roleCommands")
RoleCommandsResourceV8 getRoleCommandsResource(String serviceName)
Specified by:
getRoleCommandsResource in interface ServicesResource
Specified by:
getRoleCommandsResource in interface ServicesResourceV3
Specified by:
getRoleCommandsResource in interface ServicesResourceV4
Specified by:
getRoleCommandsResource in interface ServicesResourceV6
Returns:
The role command resource handler.

sentryUpgradeDatabaseTablesCommand

@Path(value="/{serviceName}/commands/sentryUpgradeDatabaseTables")
ApiCommand sentryUpgradeDatabaseTablesCommand(String serviceName)
Upgrade the Sentry Server Database tables.

This command is to be run whenever Sentry requires an upgrade to its database tables.

Available since API v8.

Parameters:
serviceName - Name of the Sentry service on which to run the command.
Returns:
Information about the submitted command

enableLlamaRmCommand

@Path(value="/{serviceName}/commands/impalaEnableLlamaRm")
ApiCommand enableLlamaRmCommand(String serviceName,
                                     ApiEnableLlamaRmArguments args)
Enable Llama-based resource management for Impala.

This command only applies to CDH 5.1+ Impala services.

This command configures YARN and Impala for Llama resource management, and then creates one or two Llama roles, as specified by the arguments. When two Llama roles are created, they are configured as an active/standby pair. Auto-failover from active to standby Llama will be enabled using ZooKeeper.

If an optional role name(s) are supplied, the new Llama role(s) will be named accordingly; otherwise, role name(s) will be automatically generated.

By default, YARN, Impala, and any dependent services will be restarted, and client configuration will be re-deployed across the cluster. These default actions may be suppressed via setSkipRestart().

In order to enable Llama resource management, a YARN service must be present in the cluster, and Cgroup-based resource management must be enabled for all hosts with NodeManager roles. If these preconditions are not met, the command will fail.

Available since API v8.

Parameters:
serviceName - The Impala service name.
args - Arguments for the command.
Returns:
Information about the submitted command.

disableLlamaRmCommand

@Path(value="/{serviceName}/commands/impalaDisableLlamaRm")
ApiCommand disableLlamaRmCommand(String serviceName)
Disable Llama-based resource management for Impala.

This command only applies to CDH 5.1+ Impala services.

This command disables resource management for Impala by removing all Llama roles present in the Impala service. Any services that depend on the Impala service being modified are restarted by the command, and client configuration is deployed for all services of the cluster.

Note that any configuration changes made to YARN and Impala when enabling resource management are not reverted by this command.

Available since API v8.

Parameters:
serviceName - The Impala service name.
Returns:
Information about the submitted command.

yarnFormatStateStore

@Path(value="/{serviceName}/commands/yarnFormatStateStore")
ApiCommand yarnFormatStateStore(String serviceName)
Formats the state store in ZooKeeper used for Resource Manager High Availability. Typically used while moving from non-secure to secure cluster or vice-versa.

Available since API v8.

Parameters:
serviceName - The YARN service name.
Returns:
Information about the submitted command.

hdfsFinalizeRollingUpgrade

@Path(value="/{serviceName}/commands/hdfsFinalizeRollingUpgrade")
ApiCommand hdfsFinalizeRollingUpgrade(String serviceName)
Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version. Should be done after doing a rolling upgrade to a CDH version >= 5.2.0.

Available since API v8.

Parameters:
serviceName - The HDFS service name.
Returns:
Information about the submitted command.

enableLlamaHaCommand

@Path(value="/{serviceName}/commands/impalaEnableLlamaHa")
ApiCommand enableLlamaHaCommand(String serviceName,
                                     ApiEnableLlamaHaArguments args)
Enable high availability (HA) for an Impala Llama ApplicationMaster.

This command only applies to CDH 5.1+ Impala services.

The command will create a new Llama role on the specified host, and then create an active/standby pair with the existing Llama role. Autofailover will be enabled using ZooKeeper.

If an optional role name is supplied, the new Llama role will be named accordingly; otherwise, a role name will be automatically generated.

As part of enabling HA, any services that depend on the Impala service being modified will be stopped. The command will redeploy the client configurations for services of the cluster after HA has been enabled.

Available since API v8.

Parameters:
serviceName - The Impala service name.
args - Arguments for the command.
Returns:
Information about the submitted command.

disableLlamaHaCommand

@Path(value="/{serviceName}/commands/impalaDisableLlamaHa")
ApiCommand disableLlamaHaCommand(String serviceName,
                                      ApiDisableLlamaHaArguments args)
Disable high availability (HA) for an Impala Llama ApplicationMaster.

This command only applies to CDH 5.1+ Impala services.

The command argument specifies the name of the Llama role to be retained. The other Llama role in the HA pair will be removed. As part of disabling HA, any services that depend on the Impala service being modified will be stopped. The command will redeploy the client configurations for all services of the cluster after HA has been disabled.

Available since API v8.

Parameters:
serviceName - The Impala service name.
args - Arguments for the command.
Returns:
Information about the submitted command.

collectYarnApplicationDiagnostics

@Path(value="/{serviceName}/commands/yarnApplicationDiagnosticsCollection")
ApiCommand collectYarnApplicationDiagnostics(String serviceName,
                                                  ApiYarnApplicationDiagnosticsCollectionArgs args)
Collect the Diagnostics data for Yarn applications

Available since API v8.

Parameters:
serviceName - Name of the YARN service on which to run the command.
args - Arguments used for collecting diagnostics data for Yarn applications
Returns:
Information about the submitted command


Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.