fdbb073719
This change adds arbitrary parameters, to reduce or avoid the need to patchback when new features are added. The snapshot parameter was removed to use this new change with -o snapshot=true. This commit also add a sanitize function to allow only letters, numbers, space, - and _. Usage: software deploy start/precheck <major release> -o snapshot=true --options test=test Test Plan: PASS: Build-pkgs, Build-image, Install/Bootstrap/Unlock PASS: Check precheck script receives the parameters (by injecting logs manually) PASS: Check deploy start receives the parameters by injecting manual logs. PASS: Check software.json stores the parameters under options field. PASS: Deploy start blocked with reserved key in options. PASS: Check activate-rollback is using deploy options for snapshot. PASS: Major release deployment stx10 -> stx11 in sx. Story: 2011357 Task: 52264 Change-Id: I53b8863ceeec74c45831d959fe6cea00990cc156 Signed-off-by: Luis Eduardo Bonatti <luizeduardo.bonatti@windriver.com>
209 lines
5.5 KiB
Python
209 lines
5.5 KiB
Python
#
|
|
# Copyright (c) 2024 Wind River Systems, Inc.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
|
|
from software_client.common import utils
|
|
|
|
|
|
def do_show(cc, args):
|
|
"""Show the software deployments states"""
|
|
resp, data = cc.deploy.show()
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
rc = utils.check_rc(resp, data)
|
|
if rc == 0:
|
|
if len(data) == 0:
|
|
print("No deploy in progress")
|
|
else:
|
|
header_data_list = {"From Release": "from_release",
|
|
"To Release": "to_release",
|
|
"RR": "reboot_required",
|
|
"State": "state"}
|
|
utils.format_data(data, header="state", format_func=lambda x: f"deploy-{x}")
|
|
utils.display_result_list(header_data_list, data)
|
|
else:
|
|
utils.display_info(resp)
|
|
|
|
return rc
|
|
|
|
|
|
def do_host_list(cc, args):
|
|
"""List of hosts for software deployment """
|
|
resp, data = cc.deploy.host_list()
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
rc = utils.check_rc(resp, data)
|
|
if rc == 0:
|
|
if len(data) == 0:
|
|
print("No deploy in progress")
|
|
else:
|
|
header_data_list = {"Host": "hostname", "From Release": "software_release",
|
|
"To Release": "target_release", "RR": "reboot_required",
|
|
"State": "host_state"}
|
|
utils.format_data(data, header="host_state", format_func=lambda x: f"deploy-host-{x}")
|
|
utils.display_result_list(header_data_list, data)
|
|
else:
|
|
utils.display_info(resp)
|
|
|
|
return rc
|
|
|
|
|
|
@utils.arg('deployment',
|
|
help='Verify if prerequisites are met for this Deployment ID')
|
|
@utils.arg('-f',
|
|
'--force',
|
|
action='store_true',
|
|
required=False,
|
|
help='Allow bypassing non-critical checks')
|
|
@utils.arg('--region_name',
|
|
default=None,
|
|
required=False,
|
|
help='Run precheck against a subcloud')
|
|
@utils.arg('-o',
|
|
'--options',
|
|
action='append',
|
|
required=False,
|
|
help='Additional parameters in key=value format.')
|
|
def do_precheck(cc, args):
|
|
"""Verify whether prerequisites for installing the software deployment are satisfied"""
|
|
resp, data = cc.deploy.precheck(args)
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
rc = utils.check_rc(resp, data)
|
|
if rc == 0:
|
|
if data.get("system_healthy") is False:
|
|
print("System is unhealthy for deploy")
|
|
rc = 1
|
|
|
|
utils.display_info(resp)
|
|
return rc
|
|
|
|
|
|
@utils.arg('deployment',
|
|
help='Deployment ID to start')
|
|
@utils.arg('-f',
|
|
'--force',
|
|
action='store_true',
|
|
required=False,
|
|
help='Allow bypassing non-critical checks')
|
|
@utils.arg('-o',
|
|
'--options',
|
|
action='append',
|
|
required=False,
|
|
help='Additional parameters in key=value format.')
|
|
def do_start(cc, args):
|
|
"""Start the software deployment"""
|
|
resp, data = cc.deploy.start(args)
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
rc = utils.check_rc(resp, data)
|
|
if rc == 0:
|
|
if "system_healthy" in data and data["system_healthy"] is False:
|
|
print("System is unhealthy for deploy")
|
|
rc = 1
|
|
|
|
utils.display_info(resp)
|
|
return rc
|
|
|
|
|
|
@utils.arg('host',
|
|
help="Name of the host that the deploy is triggered")
|
|
@utils.arg('-f',
|
|
'--force',
|
|
action='store_true',
|
|
required=False,
|
|
help="Force deploy host")
|
|
def do_host(cc, args):
|
|
"""Deploy prestaged software deployment to the host"""
|
|
resp, data = cc.deploy.host(args)
|
|
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
@utils.arg('host',
|
|
help="Name of the host that the deploy is triggered")
|
|
@utils.arg('-f',
|
|
'--force',
|
|
action='store_true',
|
|
required=False,
|
|
help="Force deploy host")
|
|
def do_host_rollback(cc, args):
|
|
"""Deploy prestaged software deployment to the host"""
|
|
resp, data = cc.deploy.host_rollback(args)
|
|
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
def do_abort(cc, args):
|
|
"""Abort the software deployment"""
|
|
resp, data = cc.deploy.abort(args)
|
|
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
def do_activate(cc, args):
|
|
"""Activate the software deployment"""
|
|
resp, data = cc.deploy.activate(args)
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
def do_activate_rollback(cc, args):
|
|
"""Rolls back the activate of software deployment"""
|
|
resp, data = cc.deploy.activate_rollback(args)
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
def do_complete(cc, args):
|
|
"""Complete the software deployment"""
|
|
resp, data = cc.deploy.complete(args)
|
|
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|
|
|
|
|
|
def do_delete(cc, args):
|
|
"""Delete the software deployment"""
|
|
resp, data = cc.deploy.delete(args)
|
|
|
|
if args.debug:
|
|
utils.print_result_debug(resp, data)
|
|
|
|
utils.display_info(resp)
|
|
|
|
return utils.check_rc(resp, data)
|