def restore_collection(env):
"""
Restore collections using replication API (as Solr Cloud Backup API is not available in Solr 5)
"""
import params, command_commons
env.set_params(command_commons)
collection_available = command_commons.is_collection_available_on_host()
if command_commons.check_hosts and not collection_available:
Logger.info(format("No any '{collection}' replica is used on {params.hostname} host"))
return
Logger.info(format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
Logger.info(format("Restore Solr Collection {collection} from {index_location}"))
solr_request_path = format("{collection}/replication?command=RESTORE&location={index_location}&name={backup_name}&wt=json")
restore_api_cmd = command_commons.create_solr_api_request_command(solr_request_path)
Execute(restore_api_cmd, user=params.infra_solr_user, logoutput=True)
if command_commons.request_async is False:
Logger.info("Sleep 5 seconds to wait until the restore request is executed.")
time.sleep(5)
Logger.info("Check restore status ...")
solr_status_request_path = format("{collection}/replication?command=restorestatus&wt=json")
status_check_json_output = format("{index_location}/restore_status.json")
status_check_cmd = command_commons.create_solr_api_request_command(solr_status_request_path, status_check_json_output)
command_commons.snapshot_status_check(status_check_cmd, status_check_json_output, command_commons.backup_name, False,
log_output=command_commons.log_output, tries=command_commons.request_tries, time_interval=command_commons.request_time_interval)
def migrate_index(env):
"""
Migrate lucene index in the background.
"""
import params, command_commons
env.set_params(command_commons)
index_migrate_cmd = format(
"{index_helper_script} upgrade-index -d {index_location} -v {index_version}"
)
if command_commons.force is True:
index_migrate_cmd += " -f"
if command_commons.backup_mode is True:
index_migrate_cmd += " -b"
if command_commons.debug is True:
index_migrate_cmd += " -g"
if command_commons.core_filter is not None:
index_migrate_cmd += format(" -c {core_filter}")
deleted_write_locks = []
if command_commons.delete_lock_on_start:
Logger.info(
format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(
format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
deleted_write_locks.append(write_lock_file)
else:
Logger.info("Skip removing write.lock files")
Logger.info(format("Migrate index at location: {index_location}"))
# It can generate a write.lock file
Execute(
index_migrate_cmd,
user=params.infra_solr_user,
environment={'JAVA_HOME': params.java64_home},
logoutput=command_commons.log_output)
if command_commons.delete_lock_on_start:
for write_lock_file in deleted_write_locks:
Logger.info(format("Put '{write_lock_file}' file back"))
File(
write_lock_file,
action="create",
mode=0644,
owner=params.infra_solr_user,
group=params.user_group,
not_if=format("test -f {write_lock_file}"))
def migrate_index(env):
"""
Migrate lucene index in the background.
"""
import params, command_commons
env.set_params(command_commons)
collection_available = command_commons.is_collection_available_on_host()
if command_commons.check_hosts and not collection_available:
Logger.info(
format(
"No any '{collection}' replica is used on {params.hostname} host"
))
return
index_migrate_cmd = format(
"{index_helper_script} upgrade-index -d {index_location} -v {index_version}"
)
if command_commons.force is True:
index_migrate_cmd += " -f"
if command_commons.backup_mode is True:
index_migrate_cmd += " -b"
if command_commons.debug is True:
index_migrate_cmd += " -g"
if command_commons.core_filter is not None:
index_migrate_cmd += format(" -c {core_filter}")
if command_commons.delete_lock_on_start:
Logger.info(
format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(
format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
else:
Logger.info("Skip removing write.lock files")
Logger.info(format("Migrate index at location: {index_location}"))
# It can generate a write.lock file
Execute(index_migrate_cmd,
user=params.infra_solr_user,
environment={'JAVA_HOME': params.java64_home},
logoutput=command_commons.log_output)
def restore_collection(env):
"""
Restore collections using replication API (as Solr Cloud Backup API is not available in Solr 5)
"""
import params, command_commons
env.set_params(command_commons)
Logger.info(
format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(
format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
Logger.info(
format("Restore Solr Collection {collection} from {index_location}"))
solr_request_path = format(
"{collection}/replication?command=RESTORE&location={index_location}&name={backup_name}&wt=json"
)
restore_api_cmd = command_commons.create_solr_api_request_command(
solr_request_path)
Execute(restore_api_cmd, user=params.infra_solr_user, logoutput=True)
def restore_collection(env):
"""
Restore collections - by copying snapshots with backup_* prefix, then remove old one and remove backup_* prefixes from the folder names.
"""
import params, command_commons
env.set_params(command_commons)
if command_commons.solr_num_shards == 0:
raise Exception(
format("The 'solr_shards' command parameter is required to set."))
if not command_commons.solr_restore_config_set:
raise Exception(
format(
"The 'solr_restore_config_set' command parameter is required to set."
))
Logger.info("Original core / host map: " +
str(command_commons.solr_backup_core_host_map))
Logger.info("New core / host map: " +
str(command_commons.solr_restore_core_host_map))
original_core_host_pairs = command_commons.sort_core_host_pairs(
command_commons.solr_backup_core_host_map)
new_core_host_pairs = command_commons.sort_core_host_pairs(
command_commons.solr_restore_core_host_map)
core_pairs = command_commons.create_core_pairs(original_core_host_pairs,
new_core_host_pairs)
Logger.info("Generated core pairs: " + str(core_pairs))
Logger.info(
format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(
format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
Logger.info(
format(
"Restore Solr Collection {collection} from {index_location} ..."))
if command_commons.collection in [
"ranger_audits", "history", "hadoop_logs", "audit_logs",
"vertex_index", "edge_index", "fulltext_index"
]: # Make sure ambari wont delete an important collection
raise Exception(
format(
"Selected collection for restore is: {collection}. It is not recommended to restore on default collections."
))
hdfs_cores_on_host = []
for core_pair in core_pairs:
src_core = core_pair['src_core']
target_core = core_pair['target_core']
if src_core in command_commons.skip_cores:
Logger.info(format("Core '{src_core}' (src) is filtered out."))
continue
elif target_core in command_commons.skip_cores:
Logger.info(
format("Core '{target_core}' (target) is filtered out."))
continue
core_data = command_commons.solr_restore_core_data
only_if_cmd = format("test -d {index_location}/snapshot.{src_core}")
core_root_dir = format("{solr_datadir}/backup_{target_core}")
core_root_without_backup_dir = format("{solr_datadir}/{target_core}")
if command_commons.solr_hdfs_path:
Directory([core_root_dir],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
only_if=only_if_cmd)
else:
Directory([
format("{core_root_dir}/data/index"),
format("{core_root_dir}/data/tlog"),
format("{core_root_dir}/data/snapshot_metadata")
],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
only_if=only_if_cmd)
core_details = core_data[target_core]['properties']
core_properties = {}
core_properties['numShards'] = core_details['numShards']
core_properties[
'collection.configName'] = command_commons.solr_restore_config_set
core_properties['name'] = target_core
core_properties['replicaType'] = core_details['replicaType']
core_properties['collection'] = command_commons.collection
if command_commons.solr_hdfs_path:
core_properties[
'coreNodeName'] = 'backup_' + core_details['coreNodeName']
else:
core_properties['coreNodeName'] = core_details['coreNodeName']
core_properties['shard'] = core_details['shard']
if command_commons.solr_hdfs_path:
hdfs_solr_node_folder = command_commons.solr_hdfs_path + format(
"/backup_{collection}/") + core_details['coreNodeName']
source_folder = format("{index_location}/snapshot.{src_core}/")
if command_commons.check_folder_exists(source_folder):
hdfs_cores_on_host.append(target_core)
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/index/"),
type="directory",
action="create_on_execute",
source=source_folder,
owner=params.infra_solr_user,
mode=0755,
recursive_chown=True,
recursive_chmod=True)
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/tlog"),
type="directory",
action="create_on_execute",
owner=params.infra_solr_user,
mode=0755)
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/snapshot_metadata"),
type="directory",
action="create_on_execute",
owner=params.infra_solr_user,
mode=0755)
else:
copy_cmd = format("cp -r {index_location}/snapshot.{src_core}/* {core_root_dir}/data/index/") if command_commons.solr_keep_backup \
else format("mv {index_location}/snapshot.{src_core}/* {core_root_dir}/data/index/")
Execute(copy_cmd,
only_if=only_if_cmd,
user=params.infra_solr_user,
logoutput=True)
PropertiesFile(core_root_dir + '/core.properties',
properties=core_properties,
owner=params.infra_solr_user,
group=params.user_group,
mode=0644,
only_if=only_if_cmd)
Execute(format("rm -rf {solr_datadir}/{collection}*"),
user=params.infra_solr_user,
logoutput=True)
for core_pair in core_pairs:
src_core = core_pair['src_core']
src_host = core_pair['src_host']
target_core = core_pair['target_core']
if src_core in command_commons.skip_cores:
Logger.info(format("Core '{src_core}' (src) is filtered out."))
continue
elif target_core in command_commons.skip_cores:
Logger.info(
format("Core '{target_core}' (target) is filtered out."))
continue
if os.path.exists(format("{index_location}/snapshot.{src_core}")):
data_to_save = {}
host_core_data = command_commons.solr_restore_core_data
core_details = host_core_data[target_core]['properties']
core_node = core_details['coreNodeName']
data_to_save['core'] = target_core
data_to_save['core_node'] = core_node
data_to_save['old_host'] = core_pair['target_host']
data_to_save['new_host'] = src_host
if command_commons.solr_hdfs_path:
data_to_save['new_core_node'] = "backup_" + core_node
else:
data_to_save['new_core_node'] = core_node
command_commons.write_core_file(target_core, data_to_save)
jaas_file = params.infra_solr_jaas_file if params.security_enabled else None
core_json_location = format("{index_location}/{target_core}.json")
znode_json_location = format(
"/restore_metadata/{collection}/{target_core}.json")
solr_cloud_util.copy_solr_znode_from_local(params.zookeeper_quorum,
params.infra_solr_znode,
params.java64_home,
jaas_file,
core_json_location,
znode_json_location)
core_root_dir = format("{solr_datadir}/backup_{target_core}")
core_root_without_backup_dir = format("{solr_datadir}/{target_core}")
if command_commons.solr_hdfs_path:
if target_core in hdfs_cores_on_host:
Logger.info(
format(
"Core data '{target_core}' is located on this host, processing..."
))
host_core_data = command_commons.solr_restore_core_data
core_details = host_core_data[target_core]['properties']
core_node = core_details['coreNodeName']
collection_core_dir = command_commons.solr_hdfs_path + format(
"/{collection}/{core_node}")
backup_collection_core_dir = command_commons.solr_hdfs_path + format(
"/backup_{collection}/{core_node}")
command_commons.HdfsResource(collection_core_dir,
type="directory",
action="delete_on_execute",
owner=params.infra_solr_user)
if command_commons.check_hdfs_folder_exists(
backup_collection_core_dir):
collection_backup_core_dir = command_commons.solr_hdfs_path + format(
"/{collection}/backup_{core_node}")
command_commons.move_hdfs_folder(
backup_collection_core_dir, collection_backup_core_dir)
else:
Logger.info(
format(
"Core data '{target_core}' is not located on this host, skipping..."
))
Execute(format("mv {core_root_dir} {core_root_without_backup_dir}"),
user=params.infra_solr_user,
logoutput=True,
only_if=format("test -d {core_root_dir}"))
Directory([format("{core_root_without_backup_dir}")],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
recursive_ownership=True,
only_if=format("test -d {core_root_without_backup_dir}"))
if command_commons.solr_hdfs_path and not command_commons.solr_keep_backup:
only_if_cmd = format(
"test -d {index_location}/snapshot.{src_core}")
Directory(format("{index_location}/snapshot.{src_core}"),
action="delete",
only_if=only_if_cmd,
owner=params.infra_solr_user)
def restore_collection(env):
"""
Restore collections - by copying snapshots with backup_* prefix, then remove old one and remove backup_* prefixes from the folder names.
"""
import params, command_commons
env.set_params(command_commons)
if command_commons.solr_num_shards == 0:
raise Exception(
format("The 'solr_shards' command parameter is required to set."))
host_cores_backup_map = command_commons.read_backup_json()
host_cores_map = command_commons.get_host_cores_for_collection(
backup=False)
original_core_host_pairs = command_commons.sort_core_host_pairs(
host_cores_backup_map[command_commons.CORE_HOST])
new_core_host_pairs = command_commons.sort_core_host_pairs(
host_cores_map[command_commons.CORE_HOST])
core_pairs = command_commons.create_core_pairs(original_core_host_pairs,
new_core_host_pairs)
Logger.info("Generated core pairs: " + str(core_pairs))
Logger.info(
format("Remove write.lock files from folder '{index_location}'"))
for write_lock_file in command_commons.get_files_by_pattern(
format("{index_location}"), 'write.lock'):
File(write_lock_file, action="delete")
Logger.info(
format(
"Restore Solr Collection {collection} from {index_location} ..."))
if command_commons.collection in [
"ranger_audits", "history", "hadoop_logs", "audit_logs",
"vertex_index", "edge_index", "fulltext_index"
]: # Make sure ambari wont delete an important collection
raise Exception(
format(
"Selected collection for restore is: {collection}. It is not recommended to restore on default collections."
))
hdfs_cores_on_host = []
for core_data in core_pairs:
src_core = core_data['src_core']
target_core = core_data['target_core']
if src_core in command_commons.skip_cores:
Logger.info(format("Core '{src_core}' (src) is filtered out."))
continue
elif target_core in command_commons.skip_cores:
Logger.info(
format("Core '{target_core}' (target) is filtered out."))
continue
core_data = host_cores_map[command_commons.CORE_DATA]
only_if_cmd = format("test -d {index_location}/snapshot.{src_core}")
core_root_dir = format("{solr_datadir}/backup_{target_core}")
core_root_without_backup_dir = format("{solr_datadir}/{target_core}")
if command_commons.solr_hdfs_path:
Directory([core_root_dir],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
only_if=only_if_cmd)
else:
Directory([
format("{core_root_dir}/data/index"),
format("{core_root_dir}/data/tlog"),
format("{core_root_dir}/data/snapshot_metadata")
],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
only_if=only_if_cmd)
core_details = core_data[target_core]
core_properties = {}
core_properties['numShards'] = command_commons.solr_num_shards
core_properties['collection.configName'] = "ranger_audits"
core_properties['name'] = target_core
core_properties['replicaType'] = core_details['type']
core_properties['collection'] = command_commons.collection
core_properties['coreNodeName'] = core_details['node']
core_properties['shard'] = core_details['shard']
if command_commons.solr_hdfs_path:
hdfs_solr_node_folder = command_commons.solr_hdfs_path + format(
"/backup_{collection}/") + core_details['node']
source_folder = format("{index_location}/snapshot.{src_core}/")
if command_commons.check_folder_exists(source_folder):
hdfs_cores_on_host.append(target_core)
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/index/"),
type="directory",
action="create_on_execute",
source=source_folder,
owner=params.infra_solr_user,
mode=0755,
recursive_chown=True,
recursive_chmod=True)
command_commons.HdfsResource(None, action="execute")
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/tlog"),
type="directory",
action="create_on_execute",
owner=params.infra_solr_user,
mode=0755)
command_commons.HdfsResource(None, action="execute")
command_commons.HdfsResource(
format("{hdfs_solr_node_folder}/data/snapshot_metadata"),
type="directory",
action="create_on_execute",
owner=params.infra_solr_user,
mode=0755)
command_commons.HdfsResource(None, action="execute")
if command_commons.solr_keep_backup:
Directory(format("{index_location}/snapshot.{src_core}"),
action="delete",
only_if=only_if_cmd,
owner=params.infra_solr_user)
else:
copy_cmd = format(
"mv {index_location}/snapshot.{src_core}/* {core_root_dir}/data/index/") if command_commons.solr_keep_backup \
else format("cp -r {index_location}/snapshot.{src_core}/* {core_root_dir}/data/index/")
Execute(copy_cmd,
only_if=only_if_cmd,
user=params.infra_solr_user,
logoutput=True)
PropertiesFile(core_root_dir + '/core.properties',
properties=core_properties,
owner=params.infra_solr_user,
group=params.user_group,
mode=0644,
only_if=only_if_cmd)
Execute(format("rm -rf {solr_datadir}/{collection}*"),
user=params.infra_solr_user,
logoutput=True)
for core_data in core_pairs:
src_core = core_data['src_core']
target_core = core_data['target_core']
if src_core in command_commons.skip_cores:
Logger.info(format("Core '{src_core}' (src) is filtered out."))
continue
elif target_core in command_commons.skip_cores:
Logger.info(
format("Core '{target_core}' (target) is filtered out."))
continue
core_root_dir = format("{solr_datadir}/backup_{target_core}")
core_root_without_backup_dir = format("{solr_datadir}/{target_core}")
if command_commons.solr_hdfs_path:
if target_core in hdfs_cores_on_host:
Logger.info(
format(
"Core data '{target_core}' is located on this host, processing..."
))
core_data = host_cores_map[command_commons.CORE_DATA]
core_details = core_data[target_core]
core_node = core_details['node']
collection_core_dir = command_commons.solr_hdfs_path + format(
"/{collection}/{core_node}")
backup_collection_core_dir = command_commons.solr_hdfs_path + format(
"/backup_{collection}/{core_node}")
command_commons.HdfsResource(collection_core_dir,
type="directory",
action="delete_on_execute",
owner=params.infra_solr_user)
command_commons.HdfsResource(None, action="execute")
if command_commons.check_hdfs_folder_exists(
backup_collection_core_dir):
command_commons.move_hdfs_folder(
backup_collection_core_dir, collection_core_dir)
else:
Logger.info(
format(
"Core data '{target_core}' is not located on this host, skipping..."
))
Execute(format("mv {core_root_dir} {core_root_without_backup_dir}"),
user=params.infra_solr_user,
logoutput=True,
only_if=format("test -d {core_root_dir}"))
Directory([format("{core_root_without_backup_dir}")],
mode=0755,
cd_access='a',
create_parents=True,
owner=params.infra_solr_user,
group=params.user_group,
recursive_ownership=True,
only_if=format("test -d {core_root_without_backup_dir}"))
