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>
291 lines
9.2 KiB
Python
291 lines
9.2 KiB
Python
#
|
|
# Copyright (c) 2023-2025 Wind River Systems, Inc.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# This is an utility module used by standalone USM upgrade scripts
|
|
# that runs on the FROM-side context but using TO-side code base
|
|
#
|
|
|
|
import configparser
|
|
import json
|
|
import logging
|
|
import os
|
|
import re
|
|
import requests
|
|
import subprocess
|
|
import sys
|
|
import time
|
|
import yaml
|
|
|
|
from oslo_config import cfg
|
|
|
|
from keystoneauth1 import exceptions
|
|
from keystoneauth1 import identity
|
|
from keystoneauth1 import session
|
|
|
|
LOG = logging.getLogger('main_logger')
|
|
CONF = cfg.CONF
|
|
|
|
logging_default_format_string = None
|
|
software_conf_mtime = 0
|
|
software_conf = '/etc/software/software.conf'
|
|
|
|
|
|
def get_token_endpoint(config, service_type="platform"):
|
|
"""Returns an endpoint and a token for a service
|
|
|
|
:param config: A configuration dictionary containing the
|
|
authentication credentials
|
|
:param service_type: The service to get the related token
|
|
and endpoint
|
|
"""
|
|
required_user_keys = ['auth_url',
|
|
'username',
|
|
'password',
|
|
'project_name',
|
|
'user_domain_name',
|
|
'project_domain_name']
|
|
if not all(key in config for key in required_user_keys):
|
|
raise Exception("Missing required key(s) to authenticate to Keystone")
|
|
|
|
try:
|
|
auth = identity.Password(
|
|
auth_url=config["auth_url"],
|
|
username=config["username"],
|
|
password=config["password"],
|
|
project_name=config["project_name"],
|
|
user_domain_name=config["user_domain_name"],
|
|
project_domain_name=config["project_domain_name"]
|
|
)
|
|
sess = session.Session(auth=auth)
|
|
token = sess.get_token()
|
|
endpoint = sess.get_endpoint(service_type=service_type,
|
|
region_name=config["region_name"],
|
|
interface='internal')
|
|
except exceptions.http.Unauthorized:
|
|
raise Exception("Failed to authenticate to Keystone. Request unauthorized")
|
|
except Exception as e:
|
|
raise Exception("Failed to get token and endpoint. Error: %s", str(e))
|
|
|
|
if service_type == "usm":
|
|
endpoint += "/v1"
|
|
|
|
return token, endpoint
|
|
|
|
|
|
def get_sysinv_client(token, endpoint):
|
|
"""Returns a sysinv client instance
|
|
|
|
:param token: auth token
|
|
:param endpoint: service endpoint
|
|
"""
|
|
# if platform type is sysinv then return the client as well
|
|
try:
|
|
from cgtsclient import client
|
|
return client.Client(version='1', endpoint=endpoint, token=token, timeout=600)
|
|
except ImportError:
|
|
msg = "Failed to import cgtsclient"
|
|
raise ImportError(msg)
|
|
except Exception as e:
|
|
msg = "Failed to get sysinv client. Error: %s" % str(e)
|
|
raise Exception(msg)
|
|
|
|
|
|
def call_api(token_id, method, api_cmd, api_cmd_headers=None,
|
|
api_cmd_payload=None, timeout_in_secs=40):
|
|
|
|
headers = {"Accept": "application/json"}
|
|
if token_id:
|
|
headers["X-Auth-Token"] = token_id
|
|
|
|
if api_cmd_headers:
|
|
headers.update(api_cmd_headers)
|
|
if api_cmd_payload:
|
|
api_cmd_payload = json.loads(api_cmd_payload)
|
|
try:
|
|
response = requests.request(
|
|
method, api_cmd, headers=headers, json=api_cmd_payload,
|
|
timeout=timeout_in_secs
|
|
)
|
|
response.raise_for_status()
|
|
# Check if the content type starts with 'application/json'
|
|
content_type = response.headers.get('content-type', '')
|
|
if content_type.startswith('application/json'):
|
|
return response.json()
|
|
else:
|
|
return response.text
|
|
|
|
except requests.HTTPError as e:
|
|
msg = "Error response=%s" % str(e)
|
|
raise Exception(msg)
|
|
|
|
|
|
def get_keystone_config(args: dict) -> dict:
|
|
"""Returns keystone config
|
|
|
|
:param args: Dict containing Keystone configuration parameters.
|
|
"""
|
|
keystone_config = {}
|
|
|
|
required_keystone_config = ["auth_url",
|
|
"username",
|
|
"password",
|
|
"project_name",
|
|
"user_domain_name",
|
|
"project_domain_name",
|
|
"region_name"]
|
|
for config in required_keystone_config:
|
|
if config not in args:
|
|
raise Exception("keystone configuration %s is not provided" % config)
|
|
keystone_config[config] = args[config]
|
|
return keystone_config
|
|
|
|
|
|
def parse_arguments(sys_argv: list) -> dict:
|
|
"""Returns a dict containing parsed key-value
|
|
|
|
:param sys_argv: List of system arguments to be parsed
|
|
"""
|
|
pattern = re.compile(r'--(\w+)=(.*)')
|
|
args = {}
|
|
for arg in sys_argv:
|
|
match = pattern.match(arg)
|
|
if match:
|
|
args[match.group(1)] = match.group(2)
|
|
return args
|
|
|
|
|
|
def print_usage(script_name, extra_args=""):
|
|
"""Prints the usage instructions for the script with optional additional arguments.
|
|
|
|
:param script_name: The name of the script.
|
|
:param extra_args: Additional arguments to be included.
|
|
"""
|
|
print("Usage: %s --rootdir=<rootdir> --from_release=<from_release> --to_release=<to_release> "
|
|
"--auth_url=<auth_url> --username=<username> --password=<password> "
|
|
"--project_name=<project_name>"
|
|
"--user_domain_name=<user_domain_name> --project_domain_name=<project_domain_name> "
|
|
"--region_name=<region_name> %s" % script_name, extra_args)
|
|
|
|
|
|
def get_system_info(sysinv_client):
|
|
"""Returns system type and system mode
|
|
|
|
:param sysinv_client: Sysinv client instance.
|
|
"""
|
|
system_info = sysinv_client.isystem.list()[0]
|
|
return system_info.system_type, system_info.system_mode
|
|
|
|
|
|
def configure_logging(filename, log_level=logging.INFO):
|
|
read_log_config()
|
|
|
|
my_exec = os.path.basename(sys.argv[0])
|
|
|
|
log_format = logging_default_format_string
|
|
log_format = log_format.replace('%(exec)s', my_exec)
|
|
formatter = logging.Formatter(log_format, datefmt="%FT%T")
|
|
|
|
LOG.setLevel(log_level)
|
|
main_log_handler = logging.FileHandler(filename)
|
|
main_log_handler.setFormatter(formatter)
|
|
LOG.addHandler(main_log_handler)
|
|
|
|
|
|
def get_platform_conf(key):
|
|
default = "DEFAULT"
|
|
with open("/etc/platform/platform.conf", "r") as fp:
|
|
cp = configparser.ConfigParser()
|
|
cp.read_string(f"[{default}]\n" + fp.read())
|
|
try:
|
|
return cp[default][key]
|
|
except KeyError:
|
|
return None
|
|
|
|
|
|
def get_distributed_cloud_role():
|
|
return get_platform_conf("distributed_cloud_role")
|
|
|
|
|
|
def is_tls_key_rsa(key):
|
|
cmd = 'openssl rsa -in <(echo \'%s\') -noout -check' % key
|
|
sub = subprocess.Popen(cmd,
|
|
shell=True,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
_, _ = sub.communicate()
|
|
return sub.returncode == 0
|
|
|
|
|
|
def get_secret_data_yaml(name, namespace):
|
|
get_cmd = 'kubectl get secret -n %s %s' % (namespace, name)
|
|
flags = ' -o yaml --ignore-not-found --kubeconfig=/etc/kubernetes/admin.conf'
|
|
retries = 3
|
|
wait_seconds = 5
|
|
|
|
for _ in range(0, retries):
|
|
sub = subprocess.Popen(get_cmd + flags,
|
|
shell=True,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
stdout, _ = sub.communicate()
|
|
if sub.returncode == 0:
|
|
return yaml.safe_load(stdout.decode('utf-8'))
|
|
else:
|
|
time.sleep(wait_seconds)
|
|
return None
|
|
|
|
|
|
def read_log_config():
|
|
global software_conf_mtime
|
|
global software_conf
|
|
|
|
if software_conf_mtime == os.stat(software_conf).st_mtime:
|
|
# The file has not changed since it was last read
|
|
return
|
|
|
|
global logging_default_format_string
|
|
|
|
# TODO(lbonatti) Remove this default_format when logging_default_format_string is present in stx11,
|
|
# when this becomes the N release.
|
|
default_format = ('%(asctime)s.%(msecs)03d USM - %(exec)s [%(process)s:%(thread)d]: %(filename)s(%(lineno)s): '
|
|
'%(levelname)s: %(message)s')
|
|
config = configparser.ConfigParser(interpolation=None)
|
|
|
|
config.read(software_conf)
|
|
software_conf_mtime = os.stat(software_conf).st_mtime
|
|
logging_default_format_string = config.get("DEFAULT", "logging_default_format_string", fallback=default_format)
|
|
|
|
|
|
def get_available_gib_in_vg():
|
|
"""Get the free space for cgts-vg volume group
|
|
returns: Free space in GiB
|
|
"""
|
|
cmd = ['vgs', 'cgts-vg', '--noheadings', '--units', 'g', '-o', 'free']
|
|
try:
|
|
result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, check=True)
|
|
|
|
vfree = result.stdout.strip()
|
|
vfree = float(vfree.strip('gG'))
|
|
except subprocess.CalledProcessError as e:
|
|
msg = "Error getting free space for cgts-vg: %s" % e.stderr.strip()
|
|
raise Exception(msg)
|
|
|
|
return vfree
|
|
|
|
|
|
def get_deployment_data():
|
|
"""Get the current deployment data"""
|
|
with open("/opt/software/software.json", "r") as fp:
|
|
deployment = json.loads(fp.read())
|
|
return deployment.get("deploy")[0]
|
|
|
|
|
|
def to_bool(value):
|
|
if isinstance(value, bool):
|
|
return value
|
|
if isinstance(value, str):
|
|
return value.lower() == 'true'
|
|
return False
|