| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.ambari.server.checks; |
| |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| import org.apache.ambari.server.state.stack.PrereqCheckType; |
| |
| /** |
| * Enum that wraps the various type, text and failure messages for the checks |
| * done for Stack Upgrades. |
| */ |
| @SuppressWarnings("serial") |
| public enum CheckDescription { |
| |
| CLIENT_RETRY(PrereqCheckType.SERVICE, |
| "Client Retry Properties", |
| new HashMap<String, String>() {{ |
| put(ClientRetryPropertyCheck.HIVE_CLIENT_RETRY_MISSING_KEY, |
| "The hive-site.xml property hive.metastore.failure.retries should be set to a positive value."); |
| put(ClientRetryPropertyCheck.OOZIE_CLIENT_RETRY_MISSING_KEY, |
| "The oozie-env.sh script must contain a retry count such as export OOZIE_CLIENT_OPTS=\"${OOZIE_CLIENT_OPTS} -Doozie.connection.retry.count=5\""); |
| }}), |
| |
| HOSTS_HEARTBEAT(PrereqCheckType.HOST, |
| "All hosts must be communicating with Ambari. Hosts which are not reachable should be placed in Maintenance Mode.", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "There are hosts which are not communicating with Ambari."); |
| }}), |
| |
| HOSTS_MAINTENANCE_MODE(PrereqCheckType.HOST, |
| "Hosts in Maintenance Mode will be excluded from the upgrade.", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "There are hosts in Maintenance Mode which excludes them from being upgraded."); |
| }}), |
| |
| HOSTS_MASTER_MAINTENANCE(PrereqCheckType.HOST, |
| "Hosts in Maintenance Mode must not have any master components", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following hosts must not be in in Maintenance Mode since they host Master components: {{fails}}."); |
| put(HostsMasterMaintenanceCheck.KEY_NO_UPGRADE_NAME, |
| "Could not find suitable upgrade pack for %s %s to version {{version}}."); |
| put(HostsMasterMaintenanceCheck.KEY_NO_UPGRADE_PACK, |
| "Could not find upgrade pack named %s."); |
| }}), |
| |
| HOSTS_REPOSITORY_VERSION(PrereqCheckType.HOST, |
| "All hosts should have target version installed", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following hosts must have version {{version}} installed: {{fails}}."); |
| put(HostsRepositoryVersionCheck.KEY_NO_REPO_VERSION, |
| "Repository version {{version}} does not exist."); |
| }}), |
| |
| SECONDARY_NAMENODE_MUST_BE_DELETED(PrereqCheckType.SERVICE, |
| "The SNameNode component must be deleted from all hosts", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, "The SNameNode component must be deleted from host: {{fails}}."); |
| }}), |
| |
| STORM_REST_API_MUST_BE_DELETED(PrereqCheckType.SERVICE, |
| "The STORM_REST_API component will no longer be available and must be deleted from the cluster before upgrading. The same functionality is now provided by STORM_UI_SERVER. First, stop the entire Storm service. Next, delete STORM_REST_API using the API, e.g., curl -u $user:$password -X DELETE -H 'X-Requested-By:admin' http://$server:8080/api/v1/clusters/$name/services/STORM/components/STORM_REST_API . Finally, start Storm service.", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, "The following component must be deleted from the cluster: {{fails}}."); |
| }}), |
| |
| SERVICES_HIVE_MULTIPLE_METASTORES(PrereqCheckType.SERVICE, |
| "Hive Metastore Availability", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "Multiple Hive Metastore instances are recommended for Rolling Upgrade. This ensures that there is at least one Metastore running during the upgrade process."); |
| }}), |
| |
| SERVICES_MAINTENANCE_MODE(PrereqCheckType.SERVICE, |
| "No services can be in Maintenance Mode", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following Services must not be in Maintenance Mode: {{fails}}."); |
| }}), |
| |
| SERVICES_MR_DISTRIBUTED_CACHE(PrereqCheckType.SERVICE, |
| "MapReduce should reference Hadoop libraries from the distributed cache in HDFS", |
| new HashMap<String, String>() {{ |
| put(ServicesMapReduceDistributedCacheCheck.KEY_APP_CLASSPATH, |
| "The mapred-site.xml property mapreduce.application.classpath should be set."); |
| put(ServicesMapReduceDistributedCacheCheck.KEY_FRAMEWORK_PATH, |
| "The mapred-site.xml property mapreduce.application.framework.path should be set."); |
| put(ServicesMapReduceDistributedCacheCheck.KEY_NOT_DFS, |
| "The mapred-site.xml property mapreduce.application.framework.path or the core-site.xml property fs.defaultFS should point to *dfs:/ url."); |
| }}), |
| |
| SERVICES_NAMENODE_HA(PrereqCheckType.SERVICE, |
| "NameNode High Availability must be enabled", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "NameNode High Availability is not enabled. Verify that dfs.nameservices property is present in hdfs-site.xml."); |
| }}), |
| |
| SERVICES_NAMENODE_TRUNCATE(PrereqCheckType.SERVICE, |
| "NameNode Truncate must not be allowed", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "NameNode Truncate is allowed. Verify that dfs.allow.truncate is set to 'false' in hdfs-site.xml."); |
| }}), |
| |
| SERVICES_TEZ_DISTRIBUTED_CACHE(PrereqCheckType.SERVICE, |
| "Tez should reference Hadoop libraries from the distributed cache in HDFS", |
| new HashMap<String, String>() {{ |
| put(ServicesTezDistributedCacheCheck.KEY_LIB_URI_MISSING, |
| "The tez-site.xml property tez.lib.uris should be set."); |
| put(ServicesTezDistributedCacheCheck.KEY_USE_HADOOP_LIBS, |
| "The tez-site.xml property tez.use.cluster-hadoop-libs should be set."); |
| put(ServicesTezDistributedCacheCheck.KEY_LIB_NOT_DFS, |
| "The tez-site.xml property tez.lib.uris or the core-site.xml property fs.defaultFS should point to *dfs:/ url."); |
| put(ServicesTezDistributedCacheCheck.KEY_LIB_NOT_TARGZ, |
| "The tez-site.xml property tez.lib.uris should point to tar.gz file."); |
| put(ServicesTezDistributedCacheCheck.KEY_USE_HADOOP_LIBS_FALSE, |
| "The tez-site.xml property tez.use.cluster.hadoop-libs should be set to false."); |
| }}), |
| |
| SERVICES_UP(PrereqCheckType.SERVICE, |
| "All services must be started", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following Services must be started: {{fails}}. Try to do a Stop & Start in case they were started outside of Ambari."); |
| }}), |
| |
| COMPONENTS_INSTALLATION(PrereqCheckType.SERVICE, |
| "All service components must be installed", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following Services must be reinstalled: {{fails}}. Try to reinstall the service components in INSTALL_FAILED state."); |
| }}), |
| |
| INSTALL_PACKAGES_CHECK(PrereqCheckType.CLUSTER, |
| "Install packages must be re-run", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "Re-run Install Packages before starting upgrade"); |
| }}), |
| |
| SERVICES_YARN_WP(PrereqCheckType.SERVICE, |
| "YARN work preserving restart should be enabled", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "YARN should have work preserving restart enabled. The yarn-site.xml property yarn.resourcemanager.work-preserving-recovery.enabled property should be set to true."); |
| }}), |
| |
| SERVICES_YARN_RM_HA(PrereqCheckType.SERVICE, |
| "YARN ResourceManager High Availability is not enabled.", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "YARN ResourceManager HA should be enabled to prevent a disruption in service during the upgrade"); |
| }}), |
| |
| SERVICES_YARN_TIMELINE_ST(PrereqCheckType.SERVICE, |
| "YARN Timeline state preserving restart should be enabled", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "YARN should have state preserving restart enabled for the Timeline server. The yarn-site.xml property yarn.timeline-service.recovery.enabled should be set to true."); |
| }}), |
| |
| SERVICES_MR2_JOBHISTORY_ST(PrereqCheckType.SERVICE, |
| "MapReduce2 JobHistory recovery should be enabled", |
| new HashMap<String, String>() {{ |
| put(MapReduce2JobHistoryStatePreservingCheck.MAPREDUCE2_JOBHISTORY_RECOVERY_ENABLE_KEY, |
| "MapReduce2 should have recovery enabled for the JobHistory server. The mapred-site.xml property mapreduce.jobhistory.recovery.enable should be set to true."); |
| put(MapReduce2JobHistoryStatePreservingCheck.MAPREDUCE2_JOBHISTORY_RECOVERY_STORE_KEY, |
| "MapReduce2 should have recovery enabled for the JobHistory server. The mapred-site.xml property mapreduce.jobhistory.recovery.store.class should be set to org.apache.hadoop.mapreduce.v2.hs.HistoryServerLeveldbStateStoreService."); |
| put(MapReduce2JobHistoryStatePreservingCheck.MAPREDUCE2_JOBHISTORY_RECOVERY_STORE_LEVELDB_PATH_KEY, |
| "MapReduce2 should have recovery enabled for the JobHistory server. The mapred-site.xml property mapreduce.jobhistory.recovery.store.leveldb.path should be set. Please note that \"mapreduce.jobhistory.recovery.store.leveldb.path\" should be on a mount with ~3 GB of free space."); |
| }}), |
| |
| SERVICES_HIVE_DYNAMIC_SERVICE_DISCOVERY(PrereqCheckType.SERVICE, |
| "Hive Dynamic Service Discovery", |
| new HashMap<String, String>() {{ |
| put(HiveDynamicServiceDiscoveryCheck.HIVE_DYNAMIC_SERVICE_DISCOVERY_ENABLED_KEY, |
| "The hive-site.xml property hive.server2.support.dynamic.service.discovery should be set to true."); |
| put(HiveDynamicServiceDiscoveryCheck.HIVE_DYNAMIC_SERVICE_ZK_QUORUM_KEY, |
| "The hive-site.xml property hive.zookeeper.quorum should be set to a comma-separate list of ZooKeeper hosts:port pairs."); |
| put(HiveDynamicServiceDiscoveryCheck.HIVE_DYNAMIC_SERVICE_ZK_NAMESPACE_KEY, |
| "The hive-site.xml property hive.server2.zookeeper.namespace should be set to the value for the root namespace on ZooKeeper."); |
| }}), |
| |
| CONFIG_MERGE(PrereqCheckType.CLUSTER, |
| "Configuration Merge Check", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "The following config types will have values overwritten: %s"); |
| }}), |
| |
| SERVICES_RANGER_PASSWORD_VERIFY(PrereqCheckType.SERVICE, |
| "Verify Ambari and Ranger Password Synchronization", |
| new HashMap<String, String>() {{ |
| put(AbstractCheckDescriptor.DEFAULT, |
| "There was a problem verifying Ranger and Ambari users"); |
| put(RangerPasswordCheck.KEY_RANGER_PASSWORD_MISMATCH, |
| "Credentials for user '%s' in Ambari do not match Ranger."); |
| put(RangerPasswordCheck.KEY_RANGER_UNKNOWN_RESPONSE, |
| "Could not verify credentials for user '%s'. Response code %s received from %s"); |
| put(RangerPasswordCheck.KEY_RANGER_COULD_NOT_ACCESS, |
| "Could not access Ranger to verify user '%s' against %s. %s"); |
| put(RangerPasswordCheck.KEY_RANGER_USERS_ELEMENT_MISSING, |
| "The response from Ranger received, but there is no users element. Request: %s"); |
| put(RangerPasswordCheck.KEY_RANGER_OTHER_ISSUE, |
| "The response from Ranger was malformed. %s. Request: %s"); |
| put(RangerPasswordCheck.KEY_RANGER_CONFIG_MISSING, |
| "Could not check credentials. Missing property %s/%s"); |
| }}); |
| |
| |
| private PrereqCheckType m_type; |
| private String m_description; |
| private Map<String, String> m_fails; |
| private CheckDescription(PrereqCheckType type, String description, |
| Map<String, String> fails) { |
| m_type = type; |
| m_description = description; |
| m_fails = fails; |
| } |
| |
| /** |
| * @return the type of check |
| */ |
| public PrereqCheckType getType() { |
| return m_type; |
| } |
| |
| /** |
| * @return the text associated with the description |
| */ |
| public String getText() { |
| return m_description; |
| } |
| |
| /** |
| * @param key the failure text key |
| * @return the fail text template. Never {@code null} |
| */ |
| public String getFail(String key) { |
| return m_fails.containsKey(key) ? m_fails.get(key) : ""; |
| } |
| } |
