4b876fa82c
Make the following changes for decontainerizing rvmc.py:
1. Copy rvmc.py from the Metal repo to the DC repo. Convert it into a
common module that can be imported either from an independent script
(rvmc_install.py), which is invoked from the Ansible installation
playbook, or from other DC Python modules, such as the
subcloud_install module. This module is used to shut down the host
when subcloud deployment is aborted.
2. Create a Redfish Debian package called python3-redfish to install
the Redfish Python library for the rvmc module.
3. Install rvmc_install.py to /usr/local/bin using the
distributedcloud-dccommon package.
Make the following changes in the rvmc module/script:
1. Create LoggingUtil and ExitHandler classes to differentiate the way
of logging and exit handling when called from the module or an
independent script.
2. Implement HTTP request logging when the debug log level is set to 0.
3. Introduce a timeout mechanism to restrict the total execution time
of the script during installation.
4. Add a signal handler to ensure the script exits properly when
aborting a subcloud installation. Implement process ID tracking to
allow only one RVMC process to run at a time for a subcloud
installation, regardless of the termination status of previous
installations.
5. Incorporate a power-off function to be called from the DC
subcloud_install module, which is used in "subcloud deploy abort."
6. Include "subcloud_name" and "config_file" parameters/arguments to
enhance functionality and flexibility.
Test Plan:
PASS: Verify successful subcloud installation.
PASS: Verify successful "subcloud deploy abort/resume".
PASS: Verify the playbook execution is halted, and the subcloud is
shut down when an abort is triggered during subcloud installation
PASS: Verify the successful generation of the Redfish Debian package
using the 'build-pkgs' command.
PASS: Verify that the image is successfully generated, along with
the required Redfish package and its dependencies,
using the 'build-image' command.
PASS: Verify that 'rvmc_install.py' is located in '/usr/local/bin'
after the successful installation of the system controller with
the new image.
PASS: Verify HTTP request and response logging are generated regardless
of debug log level for failure conditions.
PASS: Verify the retry attempts to be applied only when the response
status code is 5XX.
PASS: Verify that the subcloud installation command fails with
the expected error message when the value of 'rvmc_debug_level'
is set outside of the range [0..4].
PASS: Verify the success of the subcloud installation command by setting
the 'rvmc_debug_level' value within the range [0..4].
PASS: Verify that the RVMC script exits when the timeout is reached.
PASS: Verify that only one RVMC process is running at a time for
a subcloud installation, regardless of whether the previous
subcloud installation terminated properly or not.
Story: 2010144
Task: 48897
Depends-On: https://review.opendev.org/c/starlingx/tools/+/900206
Change-Id: Ic35da91a35594ede668cef6875c752b93a19d6d5
Signed-off-by: lzhu1 <li.zhu@windriver.com>
148 lines
4.2 KiB
Python
148 lines
4.2 KiB
Python
# Copyright 2015 Huawei Technologies Co., Ltd.
|
|
# Copyright 2015 Ericsson AB.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed 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.
|
|
#
|
|
# Copyright (c) 2020-2023 Wind River Systems, Inc.
|
|
#
|
|
|
|
"""
|
|
DC Orchestrator base exception handling.
|
|
"""
|
|
import six
|
|
|
|
from oslo_utils import encodeutils
|
|
from oslo_utils import excutils
|
|
|
|
from dcorch.common.i18n import _
|
|
|
|
|
|
class DCCommonException(Exception):
|
|
"""Base Commond Driver Exception.
|
|
|
|
To correctly use this class, inherit from it and define
|
|
a 'message' property. That message will get printf'd
|
|
with the keyword arguments provided to the constructor.
|
|
"""
|
|
|
|
message = _("An unknown exception occurred.")
|
|
|
|
def __init__(self, **kwargs):
|
|
try:
|
|
super(DCCommonException, self).__init__(self.message % kwargs) # pylint: disable=W1645
|
|
self.msg = self.message % kwargs # pylint: disable=W1645
|
|
except Exception:
|
|
with excutils.save_and_reraise_exception() as ctxt:
|
|
if not self.use_fatal_exceptions():
|
|
ctxt.reraise = False
|
|
# at least get the core message out if something happened
|
|
super(DCCommonException, self).__init__(self.message) # pylint: disable=W1645
|
|
|
|
if six.PY2:
|
|
def __unicode__(self):
|
|
return encodeutils.exception_to_unicode(self.msg)
|
|
|
|
def use_fatal_exceptions(self):
|
|
return False
|
|
|
|
|
|
class NotFound(DCCommonException):
|
|
pass
|
|
|
|
|
|
class Forbidden(DCCommonException):
|
|
message = _("Requested API is forbidden")
|
|
|
|
|
|
class Conflict(DCCommonException):
|
|
pass
|
|
|
|
|
|
class ServiceUnavailable(DCCommonException):
|
|
message = _("The service is unavailable")
|
|
|
|
|
|
class InvalidInputError(DCCommonException):
|
|
message = _("An invalid value was provided")
|
|
|
|
|
|
class InternalError(DCCommonException):
|
|
message = _("Error when performing operation")
|
|
|
|
|
|
class ProjectNotFound(NotFound):
|
|
message = _("Project %(project_id)s doesn't exist")
|
|
|
|
|
|
class OAMAddressesNotFound(NotFound):
|
|
message = _("OAM Addresses Not Found")
|
|
|
|
|
|
class CertificateNotFound(NotFound):
|
|
message = _("Certificate in region=%(region_name)s with signature "
|
|
"%(signature)s not found")
|
|
|
|
|
|
class LoadNotFound(NotFound):
|
|
message = _("Load in region=%(region_name)s with id %(load_id)s not found")
|
|
|
|
|
|
class LoadNotInVault(NotFound):
|
|
message = _("Load at path %(path)s not found")
|
|
|
|
|
|
class LoadMaxReached(Conflict):
|
|
message = _("Load in region=%(region_name)s at maximum number of loads")
|
|
|
|
|
|
class PlaybookExecutionFailed(DCCommonException):
|
|
message = _("Playbook execution failed, command=%(playbook_cmd)s")
|
|
|
|
|
|
class PlaybookExecutionTimeout(PlaybookExecutionFailed):
|
|
message = _("Playbook execution failed [TIMEOUT (%(timeout)s)], "
|
|
"command=%(playbook_cmd)s")
|
|
|
|
|
|
class ImageNotInLocalRegistry(NotFound):
|
|
message = _("Image %(image_name)s:%(image_tag)s not found in the local registry. "
|
|
"Please check with command: system registry-image-list or "
|
|
"system registry-image-tags %(image_name)s")
|
|
|
|
|
|
class ApiException(DCCommonException):
|
|
message = _("%(endpoint)s failed with status code: %(rc)d")
|
|
|
|
|
|
class SubcloudNotFound(NotFound):
|
|
message = _("Subcloud %(subcloud_ref)s not found")
|
|
|
|
|
|
class SubcloudPeerGroupNotFound(NotFound):
|
|
message = _("Subcloud Peer Group %(peer_group_ref)s not found")
|
|
|
|
|
|
class SubcloudPeerGroupDeleteFailedAssociated(DCCommonException):
|
|
message = _("Subcloud Peer Group %(peer_group_ref)s delete failed "
|
|
"cause it is associated with a system peer.")
|
|
|
|
|
|
class RvmcException(Exception):
|
|
def __init__(self, message=None):
|
|
super(RvmcException, self).__init__(message)
|
|
|
|
|
|
class RvmcExit(DCCommonException):
|
|
message = _("Rvmc failed with status code: %(rc)d")
|