a6a6b84258
This change adds the capability to rename the subcloud after
bootstrap or during subcloud rehome operation.
Added a field in the database to separate the region name
from the subcloud name.
The region name determines the subcloud reference in the
Openstack core, through which it is possible to access
the endpoints of a given subcloud. Since the region name
cannot be changed, this commit adds the ability to maintain
a unique region name based on the UUID format, and allows
subcloud renaming when necessary without any endpoint
impact.
The region is randomly generated to configure the subcloud
when it is created and only applies to future subclouds.
For those systems that have existing subclouds, the region
will be the same as on day 0, that is, region will keep the
same name as the subcloud, but subclouds can be renamed.
This topic involves changes to dcmanager, dcmanager-client
and GUI. To ensure the region name reference needed by the
cert-monitor, a mechanism to determine if the request is
coming from the cert-monitor has been created.
Usage for subcloud rename:
dcmanager subcloud update <subcloud-name> --name <new-name>
Usage for subcloud rehoming:
dcmanager subcloud add --name <subcloud-name> --migrate ...
Note: Upgrade test from StarlingX 8 -> 9 for this commit
is deferred until upgrade functionality in master is
restored. Any issue found during upgrade test will be
addressed in a separate commit
Test Plan:
PASS: Run dcmanager subcloud passing subcommands:
- add/delete/migrate/list/show/show --detail
- errors/manage/unmanage/reinstall/reconfig
- update/deploy
PASS: Run dcmanager subcloud add supplying --name
parameter and validate the operation is not allowed
PASS: Run dcmanager supplying subcommands:
- kube/patch/prestage strategies
PASS: Run dcmanager to apply patch and remove it
PASS: Run dcmanager subcloud-backup:
- create/delete/restore/show/upload
PASS: Run subcloud-group:
- add/delete/list/list-subclouds/show/update
PASS: Run dcmanager subcloud strategy for:
- patch/kubernetes/firmware
PASS: Run dcmanager subcloud update command passing --name
parameter supplying the following values:
- current subcloud name (not changed)
- different existing subcloud name
PASS: Run dcmanager to migrate a subcloud passing --name
parameter supplying a new subcloud name
PASS: Run dcmanager to migrate a subcloud without --name
parameter
PASS: Run dcmanager to migrate a subcloud passing --name
parameter supplying a new subcloud name and
different subcloud name in bootstrap file
PASS: Test dcmanager API response using cURL command line
to validate new region name field
PASS: Run full DC sanity and regression
Story: 2010788
Task: 48217
Signed-off-by: Cristian Mondo <cristian.mondo@windriver.com>
Change-Id: Id04f42504b8e325d9ec3880c240fe4a06e3a20b7
102 lines
4.7 KiB
Python
102 lines
4.7 KiB
Python
#
|
|
# Copyright (c) 2020-2023 Wind River Systems, Inc.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
from dccommon import consts as dccommon_consts
|
|
from dcmanager.common import consts
|
|
from dcmanager.common import exceptions
|
|
from dcmanager.db import api as db_api
|
|
from dcmanager.orchestrator.states.base import BaseState
|
|
from dcmanager.orchestrator.states.upgrade.cache.cache_specifications import \
|
|
REGION_ONE_LICENSE_CACHE_TYPE
|
|
|
|
# When a license is not installed, this will be part of the API error string
|
|
LICENSE_FILE_NOT_FOUND_SUBSTRING = "License file not found"
|
|
|
|
|
|
class InstallingLicenseState(BaseState):
|
|
"""Upgrade state action for installing a license"""
|
|
|
|
def __init__(self, region_name):
|
|
super(InstallingLicenseState, self).__init__(
|
|
next_state=consts.STRATEGY_STATE_IMPORTING_LOAD, region_name=region_name)
|
|
|
|
@staticmethod
|
|
def license_up_to_date(target_license, existing_license):
|
|
return target_license == existing_license
|
|
|
|
def perform_state_action(self, strategy_step):
|
|
"""Install the License for a software upgrade in this subcloud
|
|
|
|
Returns the next state in the state machine on success.
|
|
Any exceptions raised by this method set the strategy to FAILED.
|
|
"""
|
|
|
|
# check if the system controller has a license
|
|
system_controller_license = self._read_from_cache(
|
|
REGION_ONE_LICENSE_CACHE_TYPE)
|
|
# get_license returns a dictionary with keys: content and error
|
|
# 'content' can be an empty string in success or failure case.
|
|
# 'error' is an empty string only in success case.
|
|
target_license = system_controller_license.get('content')
|
|
target_error = system_controller_license.get('error')
|
|
|
|
# If the system controller does not have a license, do not attempt
|
|
# to install licenses on subclouds, simply proceed to the next stage
|
|
if len(target_error) != 0:
|
|
if LICENSE_FILE_NOT_FOUND_SUBSTRING in target_error:
|
|
self.info_log(strategy_step,
|
|
"System Controller License missing: %s."
|
|
% target_error)
|
|
return self.next_state
|
|
else:
|
|
# An unexpected error occurred querying the license
|
|
message = ('An unexpected error occurred querying the license %s. Detail: %s' %
|
|
(dccommon_consts.SYSTEM_CONTROLLER_NAME,
|
|
target_error))
|
|
db_api.subcloud_update(
|
|
self.context, strategy_step.subcloud_id,
|
|
error_description=message[0:consts.ERROR_DESCRIPTION_LENGTH])
|
|
raise exceptions.LicenseInstallError(
|
|
subcloud_id=dccommon_consts.SYSTEM_CONTROLLER_NAME,
|
|
error_message=target_error)
|
|
|
|
# retrieve the keystone session for the subcloud and query its license
|
|
subcloud_sysinv_client = \
|
|
self.get_sysinv_client(strategy_step.subcloud.region_name)
|
|
subcloud_license_response = subcloud_sysinv_client.get_license()
|
|
subcloud_license = subcloud_license_response.get('content')
|
|
subcloud_error = subcloud_license_response.get('error')
|
|
|
|
# Skip license install if the license is already up to date
|
|
# If there was not an error, there might be a license
|
|
if len(subcloud_error) == 0:
|
|
if self.license_up_to_date(target_license, subcloud_license):
|
|
self.info_log(strategy_step, "License up to date.")
|
|
return self.next_state
|
|
else:
|
|
self.debug_log(strategy_step, "License mismatch. Updating.")
|
|
else:
|
|
self.debug_log(strategy_step, "License missing. Installing.")
|
|
|
|
# Install the license
|
|
install_rc = subcloud_sysinv_client.install_license(target_license)
|
|
install_error = install_rc.get('error')
|
|
if len(install_error) != 0:
|
|
# Save error response from sysinv into subcloud error description.
|
|
# Provide exception with sysinv error response to strategy_step details
|
|
message = ('Error installing license on subcloud %s. Detail: %s' %
|
|
(strategy_step.subcloud.name,
|
|
install_error))
|
|
db_api.subcloud_update(
|
|
self.context, strategy_step.subcloud_id,
|
|
error_description=message[0:consts.ERROR_DESCRIPTION_LENGTH])
|
|
raise exceptions.LicenseInstallError(
|
|
subcloud_id=strategy_step.subcloud_id,
|
|
error_message=install_error)
|
|
|
|
# The license has been successfully installed. Move to the next stage
|
|
self.info_log(strategy_step, "License installed.")
|
|
return self.next_state
|