Skip to content

Enhanced archive creation script and covered the edges cases. #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: development
Choose a base branch
from
+213 −117
Open

Enhanced archive creation script and covered the edges cases. #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3cfbd57
Added function to calculate the remote host disk space
Nov 21, 2025
cdfd516
Minor fixes in description
Nov 21, 2025
796599d
Added modularity in cases
Nov 26, 2025
60c13a9
Minor fix
Nov 26, 2025
b81d5e7
Added clear log messages to track the Case.
Nov 26, 2025
8553505
Minor bug fix and improved logs
Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 153 additions & 99 deletions lib/python/archive_infra.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,9 @@ def ensure_bucket(oci_bucket_name, oci_compartment_id, log_file):
# 1) Try to 'get' the bucket; redirect stdout+stderr to our log_file
get_cmd = "oci os bucket get --bucket-name %s >> %s 2>&1" % (oci_bucket_name, log_file)
result = os.system(get_cmd)
if result != 0:
if result == 0:
return result
else:
# bucket is not there, so try to create it
__logger.info('WLSDPLY-05027', 'Bucket does not exist. Attempting to create bucket...',
class_name=_class_name, method_name=_method_name)
Expand All @@ -269,6 +271,7 @@ def ensure_bucket(oci_bucket_name, oci_compartment_id, log_file):

# success
__logger.info('WLSDPLY-05027',"Bucket created.", class_name=_class_name, method_name=_method_name)
return result2


def upload_to_bucket(file_path, log_file, on_prem_values, wls_domain_name):
Expand Down Expand Up @@ -385,7 +388,7 @@ def delete_remote_archives(model_context, file_pattern):
"rm -f %s/%s" % (remote_dir, file_pattern)
]

__logger.info('WLSDPLY-05027', 'Running remote cleanup: %s' % (" ".join(cmd_array)),
__logger.info('WLSDPLY-05027', 'Running remote cleanup: %s, filepattern %s' % (" ".join(cmd_array), file_pattern),
class_name=_class_name, method_name=_method_name)

runtime = Runtime.getRuntime()
Expand Down Expand Up @@ -464,6 +467,72 @@ def cleanup_archives(file_path, wls_domain_name):
__logger.warning('WLSDPLY-05027', msg, class_name=_class_name, method_name=_method_name)


def process_archives(nodes, model, model_context, machine_nodes, base_location, init_argument_map, on_prem_values,
space_status, log_file, wls_domain_name, per_host_space_key, archive_types, transfer_to_admin, do_upload):

_method_name = 'process_archives'

# Define the archive file patterns
archive_patterns = (
"*-%s-weblogic_home.tar.gz" % wls_domain_name,
"*-%s-java_home.tar.gz" % wls_domain_name,
"*-%s-domain_home.tar.gz" % wls_domain_name,
"*-%s-custom_dirs.tar.gz" % wls_domain_name
)

for machine in nodes:
node_details = OrderedDict()
listen_address = common.traverse(machine_nodes, machine, model_constants.NODE_MANAGER, model_constants.LISTEN_ADDRESS)

init_argument_map[CommandLineArgUtil.SSH_HOST_SWITCH] = listen_address
is_encryption_supported = EncryptionUtils.isEncryptionSupported()

if is_encryption_supported:
__logger.info('WLSDPLY-20044', init_argument_map, class_name=_class_name, method_name=_method_name)
else:
__logger.info('WLSDPLY-20045', init_argument_map, class_name=_class_name, method_name=_method_name)

per_machine_model_context = __process_args(init_argument_map, is_encryption_supported)
archiver = WLSMigrationArchiver(machine, per_machine_model_context, node_details, base_location, model, transfer_to_admin=transfer_to_admin)

# Check space policy for host
host_space_info = space_status.get(
listen_address, {"largest_archive": 1, "full_archives": 1}
)

if host_space_info.get(per_host_space_key, 1) == 1:
archiver.print_per_host_todo_commands()
__logger.warning('WLSDPLY-05027',
'Not enough space on %s to create the archives. '
'Please run the commands manually mentioned in the TODO '
'to create the archive, scp to the admin host '
'and upload to bucket.' % machine,
class_name=_class_name, method_name=_method_name)
continue

# Run archive(s)
for archive_type in archive_types:
result = archiver.archive(archive_type)
if not infra_constants.SUCCESS == result:
ex = exception_helper.create_cla_exception(
ExitCode.ERROR, 'WLSDPLY-32902', "Node archive failed")
__logger.throwing(ex, class_name=_class_name,
method_name=_method_name)
raise ex

# Upload/delete if enabled
if do_upload:
node_dir = per_machine_model_context.get_local_output_dir()

for fname in os.listdir(node_dir):
for pattern in archive_patterns:
if fnmatch.fnmatch(fname, "*%s" % pattern):
path = os.path.join(node_dir, fname)
upload_to_bucket(path, log_file,on_prem_values, wls_domain_name)
delete_local(path)
delete_remote_archives(per_machine_model_context, fname)


def __archive_directories(model, model_context, helper):
global init_argument_map
"""
Expand Down Expand Up @@ -500,14 +569,6 @@ def __archive_directories(model, model_context, helper):
env_file = os.path.abspath(os.path.join(base_dir,'..', 'config', 'on-prem.env'))
log_file = os.path.abspath(os.path.join(base_dir,'..', 'logs', 'upload_to_oci_archive.log'))

# Define the archive file patterns
archive_patterns = (
"*-%s-weblogic_home.tar.gz" % wls_domain_name,
"*-%s-java_home.tar.gz" % wls_domain_name,
"*-%s-domain_home.tar.gz" % wls_domain_name,
"*-%s-custom_dirs.tar.gz" % wls_domain_name
)

# Load the on-prem.env file
on_prem_values = load_env_file(env_file)

Expand Down Expand Up @@ -541,96 +602,89 @@ def __archive_directories(model, model_context, helper):
__logger.throwing(ex, class_name=_class_name, method_name=_method_name)
raise ex

# Case 1: Admin has enough space-just create all the archives, and if skip-transfer is true then don't upload or delete, else upload and delete
if space_admin_rc == 0:
if admin_machine in nodes:
#Do local Discovery. It should include any managed server registered.
archive_result=WLSMigrationArchiver(admin_machine,model_context, OrderedDict(), base_location, model).archive("all_archives")
if not infra_constants.SUCCESS == archive_result:
ex = exception_helper.create_cla_exception(ExitCode.ERROR, 'WLSDPLY-32902', "Admin archive failed")
__logger.throwing(ex, class_name=_class_name, method_name=_method_name)
raise ex

for machine in nodes:
if not machine == admin_machine:
node_details = OrderedDict()
listen_address = common.traverse(machine_nodes, machine, model_constants.NODE_MANAGER, model_constants.LISTEN_ADDRESS)
init_argument_map[CommandLineArgUtil.SSH_HOST_SWITCH] = listen_address
is_encryption_supported = EncryptionUtils.isEncryptionSupported()
if is_encryption_supported:
__logger.info('WLSDPLY-20044',
init_argument_map, class_name=_class_name, method_name=_method_name)
else:
__logger.info('WLSDPLY-20045',
init_argument_map, class_name=_class_name, method_name=_method_name)
per_machine_model_context = __process_args(init_argument_map, is_encryption_supported)
host_result = WLSMigrationArchiver(machine, per_machine_model_context, node_details, base_location, model).archive("all_archives")
if not infra_constants.SUCCESS == host_result:
ex = exception_helper.create_cla_exception(ExitCode.ERROR, 'WLSDPLY-32902', "Node archive failed")
__logger.throwing(ex, class_name=_class_name, method_name=_method_name)
raise ex

if not skip_transfer:
admin_out = model_context.get_local_output_dir()
for fname in os.listdir(admin_out):
for pattern in archive_patterns:
if fnmatch.fnmatch(fname, pattern):
upload_to_bucket(os.path.join(admin_out, fname), log_file, on_prem_values, wls_domain_name)
delete_local(os.path.join(admin_out, fname))
# remote cleanup on per-host model context
if per_machine_model_context:
delete_remote_archives(per_machine_model_context, fname)

# Case 2: Admin has NO space for all the archives together and skip_transfer = false (Selective remote per archive + upload + delete)
elif space_per_archive_rc == 0 and not skip_transfer:
for machine in nodes:
node_details = OrderedDict()
listen_address = common.traverse(machine_nodes, machine, model_constants.NODE_MANAGER, model_constants.LISTEN_ADDRESS)
init_argument_map[CommandLineArgUtil.SSH_HOST_SWITCH] = listen_address
is_encryption_supported = EncryptionUtils.isEncryptionSupported()
if is_encryption_supported:
__logger.info('WLSDPLY-20044',
init_argument_map, class_name=_class_name, method_name=_method_name)
else:
__logger.info('WLSDPLY-20045',
init_argument_map, class_name=_class_name, method_name=_method_name)
per_machine_model_context = __process_args(init_argument_map, is_encryption_supported)
archiver = WLSMigrationArchiver(machine, per_machine_model_context, node_details, base_location, model)

# checking per node space
if space_status.get(listen_address, 1) == 1:
archiver.print_per_host_todo_commands()
__logger.warning('WLSDPLY-05027',
'Not enough space on %s to create the archives. Please run the commands manually mentioned in the TODO to create the archive, '
'scp to the admin host and upload to bucket.' % machine,
class_name=_class_name, method_name=_method_name)
continue

for archive_type in ("oracle_home", "weblogic_home", "java_home", "custom_dirs"):
result = archiver.archive(archive_type)
if not infra_constants.SUCCESS == result:
ex = exception_helper.create_cla_exception(ExitCode.ERROR, 'WLSDPLY-32902', "Node archive failed")
__logger.throwing(ex, class_name=_class_name, method_name=_method_name)
raise ex

# Upload and delete
node_dir = per_machine_model_context.get_local_output_dir()
for fname in os.listdir(node_dir):
for pattern in archive_patterns:
if fnmatch.fnmatch(fname, "*%s" % pattern):
path = os.path.join(node_dir, fname)
upload_to_bucket(path,log_file,on_prem_values)
delete_local(path)
# remote cleanup on per-host model context
if per_machine_model_context:
delete_remote_archives(per_machine_model_context, fname)

# Case 3: Admin has NO space or skip_transfer = true (Manual steps only)
# Case 1: Admin has space to store the largest archive among all the hosts and skip_transfer = false (Selective remote per archive + upload + delete)
# a. If Managed host has space to hold its largest archive, then perform per node per archive upload + delete.
# b. For the Managed host which does not have sufficient space to hold its largest archive, it prints TODO messages for the host.
if space_per_archive_rc == 0 and not skip_transfer:
__logger.info(
'WLSDPLY-05027',
'Admin has space for the largest archive. Managed hosts must have space for largest archive to upload to bucket.',
class_name=_class_name, method_name=_method_name
)

__logger.info(
'WLSDPLY-05027',
'Processing per-host per-archive generation AND upload for archive types: oracle_home, weblogic_home, java_home, custom_dirs',
class_name=_class_name, method_name=_method_name
)
process_archives(
nodes, model, model_context, machine_nodes, base_location,init_argument_map, on_prem_values, space_status,log_file, wls_domain_name,
per_host_space_key="largest_archive",
archive_types=("domain_home","weblogic_home","java_home","custom_dirs"),
transfer_to_admin=True,
do_upload=True
)

# Case 2: Admin does not have space to store the largest archive among all the hosts and skip_transfer = false
# a. Managed hosts have enough space to hold all its archives then store it there.
# b. For Managed nodes which don’t have space to hold all the archives, print TODO messages.
elif space_per_archive_rc == 1 and not skip_transfer:
__logger.info(
'WLSDPLY-05027',
'Admin does NOT have space for the largest archive. Each host will store its own full archive locally. NO transfer to admin.',
class_name=_class_name, method_name=_method_name
)

__logger.info(
'WLSDPLY-05027',
'Processing full archive ("all_archives") on each host with NO upload to bucket',
class_name=_class_name, method_name=_method_name
)
process_archives(
nodes, model, model_context, machine_nodes, base_location,init_argument_map, on_prem_values, space_status,log_file, wls_domain_name,
per_host_space_key="full_archives",
archive_types=("all_archives",),
transfer_to_admin=False,
do_upload=False
)

# Case 3: skip_transfer = true
# a. Admin have enough space to store all the archives, then all the archives are stored in the admin. (covered)
# b. Admin doesn’t have enough space to store all the archives but its own archives, then all nodes stores their respective archives including the admin. (Not covered)
# c. Print TODO messages for any node which doesn’t have enough space to create it’s archive. (Not covered)
else :
__logger.warning('WLSDPLY-05027',
'Admin VM has insufficient space and skip_transfer = true.\n',
class_name=_class_name, method_name=_method_name)
return
__logger.info(
'WLSDPLY-05027',
'skip_transfer=true. Archives will NOT be uploaded to the bucket.',
class_name=_class_name, method_name=_method_name
)
if space_admin_rc == 0:
__logger.info(
'WLSDPLY-05027',
'Admin have enough space to store all the archives. Managed hosts must have space for largest archive to transfer to admin.',
class_name=_class_name, method_name=_method_name
)
process_archives(
nodes, model, model_context, machine_nodes, base_location,init_argument_map, on_prem_values, space_status,log_file, wls_domain_name,
per_host_space_key="largest_archive",
archive_types=("domain_home", "weblogic_home","java_home", "custom_dirs"),
transfer_to_admin=True,
do_upload=False
)
else :
__logger.info(
'WLSDPLY-05027',
'Admin does not have enough space to store all the archives. Each nodes stores their own full archive locally.',
class_name=_class_name, method_name=_method_name
)
process_archives(
nodes, model, model_context, machine_nodes, base_location,init_argument_map, on_prem_values, space_status,log_file, wls_domain_name,
per_host_space_key="full_archives",
archive_types=("all_archives",),
transfer_to_admin=False,
do_upload=False
)


if len(hosts_details) == 0:
return
Expand Down
6 changes: 4 additions & 2 deletions lib/python/migrate/data/wls_migration_archive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@

class WLSMigrationArchiver(object):

def __init__(self, machine, model_context, dictionary, base_location, model, wlst_mode=None, aliases=None, credential_injector=None):
def __init__(self, machine, model_context, dictionary, base_location, model, wlst_mode=None, aliases=None, credential_injector=None, transfer_to_admin=True):
"""
:param model_context: context about the model for this instance of discoverDomain
:param base_location: to look for common WebLogic resources. By default, this is the global path or '/'
Expand All @@ -139,6 +139,8 @@ def __init__(self, machine, model_context, dictionary, base_location, model, wls
self._weblogic_helper = model_context.get_weblogic_helper()
self._wlst_helper = WlstHelper(ExceptionType.DISCOVER)

self._transfer_to_admin = transfer_to_admin

# self._wls_version = model_context.get_effective_wls_version()
self.path_helper = path_helper.get_path_helper()

Expand Down Expand Up @@ -270,7 +272,7 @@ def __archive_directory(self, dir_to_compress, archive_file_name, ssh_download_d
is_dry_run = self._model_context.is_skip_archive()
response=self._cmd_helper.compress_archive(archive_file_name, dir_to_compress, is_dry_run)
if not is_dry_run :
if self._model_context.is_ssh():
if self._model_context.is_ssh() and self._transfer_to_admin:
entry_path = self._cmd_helper.download_file_from_remote_server(self._model_context,archive_file_name,
self._model_context.get_local_output_dir(),
"")
Expand Down
Loading