mas-cli 9.5.0__tar.gz

mas_cli-9.5.0/MANIFEST.in

@@ -0,0 +1 @@
+include src/mas/devops/cli/*.yaml

mas_cli-9.5.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: mas-cli
+Version: 9.5.0
+Summary: Python Admin CLI for Maximo Application Suite
+Home-page: https://github.com/ibm-mas/cli
+Author: David Parker
+Author-email: parkerda@uk.ibm.com
+License: Eclipse Public License - v1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Communications
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: mas-devops
+Requires-Dist: halo
+Requires-Dist: prompt_toolkit
+Requires-Dist: openshift
+Requires-Dist: kubernetes
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pyinstaller; extra == "dev"
+
+mas.devops
+----------
+
+Example
+=======
+
+.. code:: python
+
+   from openshift import dynamic
+   from kubernetes import config
+   from kubernetes.client import api_client
+
+   from mas.devops.ocp import createNamespace
+   from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+
+   instanceId = "mymas"
+   pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+   # Create an OpenShift client
+   dynClient = dynamic.DynamicClient(
+       api_client.ApiClient(configuration=config.load_kube_config())
+   )
+
+   # Install OpenShift Pipelines Operator
+   installOpenShiftPipelines(dynamicClient)
+
+   # Create the pipelines namespace and install the MAS tekton definitions
+   createNamespace(dynamicClient, pipelinesNamespace)
+   updateTektonDefinitions(pipelinesNamespace)
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_cli-9.5.0/README.rst

@@ -0,0 +1,33 @@
+mas.devops
+----------
+
+Example
+=======
+
+.. code:: python
+
+   from openshift import dynamic
+   from kubernetes import config
+   from kubernetes.client import api_client
+
+   from mas.devops.ocp import createNamespace
+   from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+
+   instanceId = "mymas"
+   pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+   # Create an OpenShift client
+   dynClient = dynamic.DynamicClient(
+       api_client.ApiClient(configuration=config.load_kube_config())
+   )
+
+   # Install OpenShift Pipelines Operator
+   installOpenShiftPipelines(dynamicClient)
+
+   # Create the pipelines namespace and install the MAS tekton definitions
+   createNamespace(dynamicClient, pipelinesNamespace)
+   updateTektonDefinitions(pipelinesNamespace)
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_cli-9.5.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+  "setuptools",
+  "pypandoc"
+]
+build-backend = "setuptools.build_meta"

mas_cli-9.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mas_cli-9.5.0/setup.py

@@ -0,0 +1,88 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+# *****************************************************************************
+
+import codecs
+import sys
+import os
+sys.path.insert(0, 'src')
+
+from setuptools import setup, find_namespace_packages
+
+if not os.path.exists('README.rst'):
+    import pypandoc
+    pypandoc.download_pandoc(targetfolder='~/bin/')
+    pypandoc.convert_file('README.md', 'rst', outputfile='README.rst')
+
+here = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
+    long_description = f.read()
+
+# Maintain a single source of versioning
+# https://packaging.python.org/en/latest/guides/single-sourcing-package-version/
+def read(rel_path):
+    here = os.path.abspath(os.path.dirname(__file__))
+    with codecs.open(os.path.join(here, rel_path), 'r') as fp:
+        return fp.read()
+
+def get_version(rel_path):
+    for line in read(rel_path).splitlines():
+        if line.startswith('__version__'):
+            delim = '"' if '"' in line else "'"
+            return line.split(delim)[1]
+    else:
+        raise RuntimeError("Unable to find version string.")
+
+setup(
+    name='mas-cli',
+    version=get_version("src/mas/cli/__init__.py"),
+    author='David Parker',
+    author_email='parkerda@uk.ibm.com',
+    package_dir={'': 'src'},
+    packages=find_namespace_packages(where='src', include=[
+        'mas.cli',
+        'mas.cli.templates'
+    ]),
+    include_package_data=True,
+    scripts=[
+        'src/mas-upgrade',
+        'src/mas-uninstall'
+    ],
+    url='https://github.com/ibm-mas/cli',
+    license='Eclipse Public License - v1.0',
+    description='Python Admin CLI for Maximo Application Suite',
+    long_description=long_description,
+    install_requires=[
+        'mas-devops',     # EPL
+        'halo',           # MIT License
+        'prompt_toolkit', # BSD License
+        'openshift',      # Apache Software License
+        'kubernetes'      # Apache Software License
+    ],
+    extras_require={
+        'dev': [
+            'build',       # MIT License
+            'flake8',      # MIT License
+            'pytest',      # MIT License
+            'pyinstaller'  # GPL, https://pyinstaller.org/en/stable/license.html & https://github.com/pyinstaller/pyinstaller/wiki/FAQ#license
+        ]
+    },
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX :: Linux',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Topic :: Communications',
+        'Topic :: Internet',
+        'Topic :: Software Development :: Libraries :: Python Modules'
+    ]
+)

mas_cli-9.5.0/src/mas/cli/__init__.py

@@ -0,0 +1,11 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+
+__version__ = "9.5.0"

mas_cli-9.5.0/src/mas/cli/cli.py

@@ -0,0 +1,189 @@
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+from argparse import RawTextHelpFormatter
+from shutil import which
+from os import path
+
+# Use of the openshift client rather than the kubernetes client allows us access to "apply"
+from openshift import dynamic
+from kubernetes import config
+from kubernetes.client import api_client
+
+from prompt_toolkit import prompt, print_formatted_text, HTML
+from prompt_toolkit.validation import Validator, ValidationError
+
+# Available named colours in prompt_toolkit
+# -----------------------------------------------------------------------------
+# AliceBlue  AntiqueWhite  Aqua  Aquamarine  Azure  Beige  Bisque  Black  BlanchedAlmond  Blue  BlueViolet
+# Brown  BurlyWood  CadetBlue  Chartreuse  Chocolate  Coral  CornflowerBlue  Cornsilk  Crimson  Cyan
+# DarkBlue  DarkCyan  DarkGoldenRod  DarkGray  DarkGreen  DarkGrey  DarkKhaki  DarkMagenta  DarkOliveGreen
+# DarkOrange  DarkOrchid  DarkRed  DarkSalmon  DarkSeaGreen  DarkSlateBlue  DarkSlateGray  DarkSlateGrey
+# DarkTurquoise  DarkViolet  DeepPink  DeepSkyBlue  DimGray  DimGrey  DodgerBlue  FireBrick  FloralWhite
+# ForestGreen  Fuchsia  Gainsboro  GhostWhite  Gold  GoldenRod  Gray  Green  GreenYellow  Grey  HoneyDew
+# HotPink  IndianRed  Indigo  Ivory  Khaki  Lavender  LavenderBlush  LawnGreen  LemonChiffon  LightBlue
+# LightCoral  LightCyan  LightGoldenRodYellow  LightGray  LightGreen  LightGrey  LightPink  LightSalmon
+# LightSeaGreen  LightSkyBlue  LightSlateGray  LightSlateGrey  LightSteelBlue  LightYellow  Lime
+# LimeGreen  Linen  Magenta  Maroon  MediumAquaMarine  MediumBlue  MediumOrchid  MediumPurple  MediumSeaGreen
+# MediumSlateBlue  MediumSpringGreen  MediumTurquoise  MediumVioletRed  MidnightBlue  MintCream  MistyRose
+# Moccasin  NavajoWhite  Navy  OldLace  Olive  OliveDrab  Orange  OrangeRed  Orchid  PaleGoldenRod  PaleGreen
+# PaleTurquoise  PaleVioletRed  PapayaWhip  PeachPuff  Peru  Pink  Plum  PowderBlue  Purple  RebeccaPurple
+# Red  RosyBrown  RoyalBlue  SaddleBrown  Salmon  SandyBrown  SeaGreen  SeaShell  Sienna  Silver  SkyBlue
+# SlateBlue  SlateGray  SlateGrey  Snow  SpringGreen  SteelBlue  Tan  Teal  Thistle  Tomato  Turquoise
+# Violet  Wheat  White  WhiteSmoke  Yellow  YellowGreen
+
+from mas.cli import __version__ as packageVersion
+from mas.devops.ocp import connect
+from mas.devops.mas import verifyMasInstance
+
+from sys import exit
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class InstanceIDValidator(Validator):
+    def validate(self, document):
+        """
+        Validate that a MAS instance ID exists on the target cluster
+        """
+        instanceId = document.text
+
+        dynClient = dynamic.DynamicClient(
+            api_client.ApiClient(configuration=config.load_kube_config())
+        )
+        if not verifyMasInstance(dynClient, instanceId):
+            raise ValidationError(message='Not a valid MAS instance ID on this cluster', cursor_position=len(instanceId))
+
+
+class YesNoValidator(Validator):
+    def validate(self, document):
+        """
+        Validate that a response is understandable as a yes/no response
+        """
+        response = document.text
+        if response.lower() not in ["y", "n", "yes", "no"]:
+            raise ValidationError(message='Enter a valid response: y(es), n(o)', cursor_position=len(response))
+
+
+def getHelpFormatter(formatter=RawTextHelpFormatter, w=160, h=50):
+    """
+    Return a wider HelpFormatter, if possible.
+
+    https://stackoverflow.com/a/57655311
+    """
+    try:
+        kwargs = {'width': w, 'max_help_position': h}
+        formatter(None, **kwargs)
+        return lambda prog: formatter(prog, **kwargs)
+    except TypeError:
+        logger.warn("argparse help formatter failed, falling back.")
+        return formatter
+
+
+class BaseApp(object):
+    def __init__(self):
+        # Set up a log formatter
+        chFormatter = logging.Formatter('%(asctime)-25s' + ' %(levelname)-8s %(message)s')
+
+        # Set up a log handler (5mb rotating log file)
+        ch = logging.handlers.RotatingFileHandler(
+            "mas.log", maxBytes=(1048576*5), backupCount=2
+        )
+        ch.setLevel(logging.DEBUG)
+        ch.setFormatter(chFormatter)
+
+        # Configure the root logger
+        rootLogger = logging.getLogger()
+        rootLogger.addHandler(ch)
+        rootLogger.setLevel(logging.DEBUG)
+
+        self.version = packageVersion
+        self.h1count = 0
+
+        self.tektonDefsPath = path.join(path.abspath(path.dirname(__file__)), "templates", "ibm-mas-tekton.yaml")
+        print(self.tektonDefsPath)
+
+        self.spinner = {
+            "interval": 80,
+            "frames": [" ⠋", " ⠙", " ⠹", " ⠸", " ⠼", " ⠴", " ⠦", " ⠧", " ⠇", " ⠏"]
+        }
+        self.successIcon = "✅️"
+        self.failureIcon = "❌"
+
+        self._dynClient = None
+
+        self.printTitle(f"IBM Maximo Application Suite Admin CLI v{self.version}")
+        print_formatted_text(HTML("Powered by <DarkGoldenRod><u>https://github.com/ibm-mas/ansible-devops/</u></DarkGoldenRod> and <DarkGoldenRod><u>https://tekton.dev/</u></DarkGoldenRod>"))
+
+        if which("kubectl") is None:
+            logger.error("Could not find kubectl on the path")
+            print_formatted_text(HTML("\n<Red>Error: Could not find kubectl on the path, see <u>https://kubernetes.io/docs/tasks/tools/#kubectl</u> for installation instructions</Red>\n"))
+            exit(1)
+
+    def printTitle(self, message):
+        print_formatted_text(HTML(f"<b><u>{message}</u></b>"))
+
+    def printH1(self, message):
+        self.h1count += 1
+        print()
+        print_formatted_text(HTML(f"<u><SteelBlue>{self.h1count}. {message}</SteelBlue></u>"))
+
+    @property
+    def dynamicClient(self):
+        if self._dynClient is not None:
+            return self._dynClient
+        else:
+            return self.reloadDynamicClient()
+
+    def reloadDynamicClient(self):
+        """
+        Configure the Kubernetes API Client using the active context in kubeconfig
+        """
+        logger.debug("Reloading Kubernetes Client Configuration")
+        try:
+            config.load_kube_config()
+            self._dynClient = dynamic.DynamicClient(
+                api_client.ApiClient(configuration=config.load_kube_config())
+            )
+            return self._dynClient
+        except Exception as e:
+            logger.warning(f"Error: Unable to connect to OpenShift Container Platform: {e}")
+            return None
+
+    def connect(self, noConfirm):
+        promptForNewServer = False
+        self.reloadDynamicClient()
+        if self._dynClient is not None:
+            try:
+                routesAPI = self._dynClient.resources.get(api_version="route.openshift.io/v1", kind="Route")
+                consoleRoute = routesAPI.get(name="console", namespace="openshift-console")
+                print_formatted_text(HTML(f"Already connected to OCP Cluster:\n <u><Orange>https://{consoleRoute.spec.host}</Orange></u>"))
+                print()
+                if not noConfirm:
+                    # We are already connected to a cluster, but prompt the user if they want to use this connection
+                    continueWithExistingCluster = prompt(HTML('<Yellow>Proceed with this cluster?</Yellow> '), validator=YesNoValidator(), validate_while_typing=False)
+                    promptForNewServer = continueWithExistingCluster in ["n", "no"]
+            except Exception:
+                # We are already connected to a cluster, but the connection is not valid so prompt for connection details
+                promptForNewServer = True
+        else:
+            # We are not already connected to any cluster, so prompt for connection details
+            promptForNewServer = True
+
+        if promptForNewServer:
+            # Prompt for new connection properties
+            server = prompt(HTML('<Yellow>Server URL:</Yellow> '), placeholder="https://...")
+            token = prompt(HTML('<Yellow>Login Token:</Yellow> '), is_password=True, placeholder="sha256~...")
+            connect(server, token)
+            self.reloadDynamicClient()
+            if self._dynClient is None:
+                print_formatted_text(HTML("<Red>Unable to connect to cluster.  See log file for details</Red>"))
+                exit(1)

mas_cli-9.5.0/src/mas-uninstall

@@ -0,0 +1,281 @@
+#!/usr/bin/env python
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+
+import argparse
+import sys
+import logging
+import logging.handlers
+from prompt_toolkit import prompt, print_formatted_text, HTML
+from prompt_toolkit.completion import WordCompleter
+
+from halo import Halo
+
+from mas.cli import __version__ as packageVersion
+from mas.cli.cli import InstanceIDValidator, YesNoValidator, BaseApp, getHelpFormatter
+from mas.devops.ocp import createNamespace
+from mas.devops.mas import listMasInstances, verifyMasInstance
+from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUninstallPipeline
+from openshift.dynamic.exceptions import NotFoundError
+
+logger = logging.getLogger(__name__)
+
+class App(BaseApp):
+    def uninstall(self, args):
+        """
+        Uninstall MAS instance
+        """
+        instanceId = args.instance_id
+        noConfirm = args.no_confirm
+        if args.uninstall_all_deps:
+            uninstallGrafana = True
+            uninstallIBMCatalog = True
+            uninstallCommonServices = True
+            uninstallCertManager = True
+            uninstallUDS = True
+            uninstallMongoDb = True
+            uninstallSLS = True
+        else:
+            uninstallGrafana = args.uninstall_grafana
+            uninstallIBMCatalog = args.uninstall_ibm_catalog
+            uninstallCommonServices = args.uninstall_common_services
+            uninstallCertManager = args.uninstall_cert_manager
+            uninstallUDS = args.uninstall_uds
+            uninstallMongoDb = args.uninstall_mongodb
+            uninstallSLS = args.uninstall_sls
+
+        if instanceId is None:
+            self.printH1("Set Target OpenShift Cluster")
+            # Connect to the target cluster
+            self.connect(noConfirm)
+        else:
+            logger.debug("MAS instance ID is set, so we assume already connected to the desired OCP")
+
+        if self.dynamicClient is None:
+            print_formatted_text(HTML("<Red>Error: The Kubernetes dynamic Client is not available.  See log file for details</Red>"))
+            sys.exit(1)
+
+        if instanceId is None:
+            # Interactive mode
+            self.printH1("Instance Selection")
+            print_formatted_text(HTML("<LightSlateGrey>Select a MAS instance to uninstall from the list below:</LightSlateGrey>"))
+            suites = listMasInstances(self.dynamicClient)
+            suiteOptions = []
+            for suite in suites:
+                print_formatted_text(HTML(f"- <u>{suite['metadata']['name']}</u> v{suite['status']['versions']['reconciled']}"))
+                suiteOptions.append(suite['metadata']['name'])
+
+            suiteCompleter = WordCompleter(suiteOptions)
+            print()
+            instanceId = prompt(HTML(f'<Yellow>Enter MAS instance ID: </Yellow>'), completer=suiteCompleter, validator=InstanceIDValidator(), validate_while_typing=False)
+
+            self.printH1("Uninstall MAS Dependencies")
+            uninstallCertManager = prompt(HTML(f'<Yellow>Uninstall Certificate Manager? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+            if uninstallCertManager:
+                # If you choose to uninstall Cert-Manager, everything will be uninstalled
+                uninstallGrafana = True
+                uninstallIBMCatalog = True
+                uninstallCommonServices = True
+                uninstallUDS = True
+                uninstallMongoDb = True
+                uninstallSLS = True
+            else:
+                uninstallMongoDb = prompt(HTML(f'<Yellow>Uninstall MongoDb? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+                if uninstallMongoDb:
+                    # If you are removing MongoDb then SLS needs to be uninstalled too
+                    uninstallSLS = True
+                else:
+                    uninstallSLS = prompt(HTML(f'<Yellow>Uninstall IBM Suite Licensing Service? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+
+                uninstallGrafana = prompt(HTML(f'<Yellow>Uninstall Grafana? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+                uninstallIBMCatalog = prompt(HTML(f'<Yellow>Uninstall IBM Catalog Source? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+                if uninstallIBMCatalog:
+                    # If you choose to uninstall IBM Operator Catalog, everything from the catalog will be uninstalled
+                    uninstallCommonServices = True
+                    uninstallUDS = True
+                    uninstallMongoDb = True
+                    uninstallSLS = True
+                else:
+                    uninstallCommonServices = prompt(HTML(f'<Yellow>Uninstall IBM Common Services? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+                    uninstallUDS = prompt(HTML(f'<Yellow>Uninstall IBM User Data Services? </Yellow>'), validator=YesNoValidator()) in ["y", "yes"]
+
+        else:
+            # Non-interactive mode
+            if not verifyMasInstance(self.dynamicClient, instanceId):
+                print_formatted_text(HTML(f"<Red>Error: MAS Instance {instanceId} not found on this cluster</Red>"))
+                sys.exit(1)
+
+        # Default to Red Hat Cert-Manager, and check if IBM cert-manager is installed
+        certManagerProvider="redhat"
+        namespaceAPI = self.dynamicClient.resources.get(api_version="v1", kind="Namespace")
+        try:
+            # Check if 'ibm-common-services' namespace exist, this will throw NotFoundError exception when not found.
+            namespaceAPI.get(name="ibm-common-services")
+            podsAPI = self.dynamicClient.resources.get(api_version="v1", kind="Pod")
+            podsList = podsAPI.get(namespace="ibm-common-services")
+            for pod in podsList:
+                if pod is not None and pod.metadata.name.contains("cert-manager-cainjector"):
+                    certManagerProvider = "ibm"
+        except NotFoundError:
+            print()
+            # ibm cert manager not found, proceed with default redhat.
+
+        self.printH1("Review Settings")
+        print_formatted_text(HTML(f"<LightSlateGrey>Instance ID ..................... {instanceId}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall Cert-Manager .......... {uninstallCertManager} ({certManagerProvider})</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall Grafana ............... {uninstallGrafana}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall IBM Operator Catalog .. {uninstallIBMCatalog}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall IBM Common Services ... {uninstallCommonServices}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall UDS ................... {uninstallUDS}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall MongoDb ............... {uninstallMongoDb}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Uninstall SLS ................... {uninstallSLS}</LightSlateGrey>"))
+
+        if not noConfirm:
+            print()
+            continueWithUninstall = prompt(HTML(f'<Yellow>Proceed with these settings?</Yellow> '), validator=YesNoValidator(), validate_while_typing=False)
+
+        if noConfirm or continueWithUninstall in ["y", "yes"]:
+            self.printH1("Launch uninstall")
+            pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+            with Halo(text='Validating OpenShift Pipelines installation', spinner=self.spinner) as h:
+                installOpenShiftPipelines(self.dynamicClient)
+                h.stop_and_persist(symbol=self.successIcon, text=f"OpenShift Pipelines Operator is installed and ready to use")
+
+            with Halo(text=f'Preparing namespace ({pipelinesNamespace})', spinner=self.spinner) as h:
+                createNamespace(self.dynamicClient, pipelinesNamespace)
+                h.stop_and_persist(symbol=self.successIcon, text=f"Namespace is ready ({pipelinesNamespace})")
+
+            with Halo(text=f'Installing latest Tekton definitions (v{self.version})', spinner=self.spinner) as h:
+                updateTektonDefinitions(pipelinesNamespace, self.tektonDefsPath)
+                h.stop_and_persist(symbol=self.successIcon, text=f"Latest Tekton definitions are installed (v{self.version})")
+
+            with Halo(text='Submitting PipelineRun for {instanceId} uninstall', spinner=self.spinner) as h:
+                pipelineURL = launchUninstallPipeline(
+                    dynClient = self.dynamicClient,
+                    instanceId = instanceId,
+                    certManagerProvider = "redhat",
+                    uninstallCertManager = uninstallCertManager,
+                    uninstallGrafana = uninstallGrafana,
+                    uninstallCatalog = uninstallCommonServices,
+                    uninstallCommonServices = uninstallCommonServices,
+                    uninstallUDS = uninstallUDS,
+                    uninstallMongoDb = uninstallMongoDb,
+                    uninstallSLS = uninstallSLS
+                )
+                if pipelineURL is not None:
+                    h.stop_and_persist(symbol=self.successIcon, text=f"PipelineRun for {instanceId} uninstall submitted")
+                    print_formatted_text(HTML(f"\nView progress:\n  <Cyan><u>{pipelineURL}</u></Cyan>\n"))
+                else:
+                    h.stop_and_persist(symbol=self.failureIcon, text=f"Failed to submit PipelineRun for {instanceId} uninstall, see log file for details")
+                    print()
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        prog='mas uninstall',
+        description="\n".join([
+            f"IBM Maximo Application Suite Admin CLI v{packageVersion}",
+            "Uninstall MAS by configuring and launching the MAS Uninstall Tekton Pipeline.\n",
+            "Interactive Mode:",
+            "Omitting the --instance-id option will trigger an interactive prompt"
+        ]),
+        epilog="Refer to the online documentation for more information: https://ibm-mas.github.io/cli/",
+        formatter_class=getHelpFormatter(),
+        add_help=False
+    )
+
+    masArgGroup = parser.add_argument_group('MAS Instance Selection')
+    masArgGroup.add_argument(
+        '--instance-id',
+        required=False,
+        help="The MAS instance ID to be uninstalled"
+    )
+
+    depsArgGroup = parser.add_argument_group('MAS Dependencies Selection')
+    depsArgGroup.add_argument(
+        '--uninstall-all-deps',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall all MAS-related dependencies from the target cluster",
+    )
+
+    depsArgGroup.add_argument(
+        '--uninstall-cert-manager',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall Certificate Manager from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-common-services',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall IBM Common Services from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-grafana',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall Grafana from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-ibm-catalog',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall the IBM Maximo Operator Catalog Source (ibm-operator-catalog) from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-mongodb',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall MongoDb from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-sls',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall IBM Suite License Service from the target cluster",
+    )
+    depsArgGroup.add_argument(
+        '--uninstall-uds',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Uninstall IBM User Data Services from the target cluster",
+    )
+
+    otherArgGroup = parser.add_argument_group('More')
+    otherArgGroup.add_argument(
+        '--no-confirm',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Launch the upgrade without prompting for confirmation",
+    )
+    otherArgGroup.add_argument(
+        '-h', "--help",
+        action='help',
+        default=False,
+        help="Show this help message and exit",
+    )
+
+    args = parser.parse_args()
+
+    try:
+        app = App()
+        app.uninstall(args)
+    except KeyboardInterrupt as e:
+        pass

mas_cli-9.5.0/src/mas-upgrade

@@ -0,0 +1,156 @@
+#!/usr/bin/env python
+# *****************************************************************************
+# Copyright (c) 2024 IBM Corporation and other Contributors.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# which accompanies this distribution, and is available at
+# http://www.eclipse.org/legal/epl-v10.html
+#
+# *****************************************************************************
+
+import argparse
+import sys
+import logging
+import logging.handlers
+from prompt_toolkit import prompt, print_formatted_text, HTML
+from prompt_toolkit.completion import WordCompleter
+
+from halo import Halo
+
+from mas.cli import __version__ as packageVersion
+from mas.cli.cli import InstanceIDValidator, YesNoValidator, BaseApp, getHelpFormatter
+from mas.devops.ocp import createNamespace
+from mas.devops.mas import listMasInstances, verifyMasInstance
+from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+
+logger = logging.getLogger(__name__)
+
+class App(BaseApp):
+    def upgrade(self, instanceId, skipPreCheck, noConfirm):
+        """
+        Upgrade MAS instance
+        """
+
+        if instanceId is None:
+            self.printH1("Set Target OpenShift Cluster")
+            # Connect to the target cluster
+            self.connect(noConfirm)
+        else:
+            logger.debug("MAS instance ID is set, so we assume already connected to the desired OCP")
+
+        if self.dynamicClient is None:
+            print_formatted_text(HTML("<Red>Error: The Kubernetes dynamic Client is not available.  See log file for details</Red>"))
+            sys.exit(1)
+
+        if instanceId is None:
+            # Interactive mode
+            self.printH1("Instance Selection")
+            print_formatted_text(HTML("<LightSlateGrey>Select a MAS instance to upgrade from the list below:</LightSlateGrey>"))
+            suites = listMasInstances(self.dynamicClient)
+            suiteOptions = []
+
+            if len(suites) == 0:
+                print_formatted_text(HTML(f"<Red>Error: No MAS instances detected on this cluster</Red>"))
+                sys.exit(1)
+
+            for suite in suites:
+                print_formatted_text(HTML(f"- <u>{suite['metadata']['name']}</u> v{suite['status']['versions']['reconciled']}"))
+                suiteOptions.append(suite['metadata']['name'])
+
+            suiteCompleter = WordCompleter(suiteOptions)
+            print()
+            instanceId = prompt(HTML(f'<Yellow>Enter MAS instance ID: </Yellow>'), completer=suiteCompleter, validator=InstanceIDValidator(), validate_while_typing=False)
+        else:
+            # Non-interactive mode
+            if not verifyMasInstance(self.dynamicClient, instanceId):
+                print_formatted_text(HTML(f"<Red>Error: MAS instance {instanceId} not found on this cluster</Red>"))
+                sys.exit(1)
+
+        self.printH1("Review Settings")
+        print_formatted_text(HTML(f"<LightSlateGrey>Instance ID ..................... {instanceId}</LightSlateGrey>"))
+        print_formatted_text(HTML(f"<LightSlateGrey>Skip Pre-Upgrade Checks ......... {skipPreCheck}</LightSlateGrey>"))
+
+        if not noConfirm:
+            print()
+            continueWithUpgrade = prompt(HTML(f'<Yellow>Proceed with these settings?</Yellow> '), validator=YesNoValidator(), validate_while_typing=False)
+
+        if noConfirm or continueWithUpgrade in ["y", "yes"]:
+            self.printH1("Launch Upgrade")
+            pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+            with Halo(text='Validating OpenShift Pipelines installation', spinner=self.spinner) as h:
+                installOpenShiftPipelines(self.dynamicClient)
+                h.stop_and_persist(symbol=self.successIcon, text=f"OpenShift Pipelines Operator is installed and ready to use")
+
+            with Halo(text=f'Preparing namespace ({pipelinesNamespace})', spinner=self.spinner) as h:
+                createNamespace(self.dynamicClient, pipelinesNamespace)
+                h.stop_and_persist(symbol=self.successIcon, text=f"Namespace is ready ({pipelinesNamespace})")
+
+            with Halo(text=f'Installing latest Tekton definitions (v{self.version})', spinner=self.spinner) as h:
+                updateTektonDefinitions(pipelinesNamespace, self.tektonDefsPath)
+                h.stop_and_persist(symbol=self.successIcon, text=f"Latest Tekton definitions are installed (v{self.version})")
+
+            with Halo(text='Submitting PipelineRun for {instanceId} upgrade', spinner=self.spinner) as h:
+                pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+                if pipelineURL is not None:
+                    h.stop_and_persist(symbol=self.successIcon, text=f"PipelineRun for {instanceId} upgrade submitted")
+                    print_formatted_text(HTML(f"\nView progress:\n  <Cyan><u>{pipelineURL}</u></Cyan>\n"))
+                else:
+                    h.stop_and_persist(symbol=self.failureIcon, text=f"Failed to submit PipelineRun for {instanceId} upgrade, see log file for details")
+                    print()
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(
+        prog='mas upgrade',
+        description="\n".join([
+            f"IBM Maximo Application Suite Admin CLI v{packageVersion}",
+            "Upgrade MAS by configuring and launching the MAS Upgrade Tekton Pipeline.\n",
+            "Interactive Mode:",
+            "Omitting the --instance-id option will trigger an interactive prompt"
+        ]),
+        epilog="Refer to the online documentation for more information: https://ibm-mas.github.io/cli/",
+        formatter_class=getHelpFormatter(),
+        add_help=False
+    )
+
+    masArgGroup = parser.add_argument_group('MAS Instance Selection')
+    masArgGroup.add_argument(
+        '--instance-id',
+        required=False,
+        help="The MAS instance ID to be upgraded"
+    )
+
+    otherArgGroup = parser.add_argument_group('More')
+    otherArgGroup.add_argument(
+        '--skip-pre-check',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Disable the 'pre-upgrade-check' and 'post-upgrade-verify' tasks in the upgrade pipeline"
+    )
+    otherArgGroup.add_argument(
+        '--no-confirm',
+        required=False,
+        action='store_true',
+        default=False,
+        help="Launch the upgrade without prompting for confirmation",
+    )
+    otherArgGroup.add_argument(
+        '-h', "--help",
+        action='help',
+        default=False,
+        help="Show this help message and exit",
+    )
+
+    args = parser.parse_args()
+
+    try:
+        app = App()
+        app.upgrade(
+            args.instance_id,
+            args.skip_pre_check,
+            args.no_confirm
+        )
+    except KeyboardInterrupt as e:
+        pass

mas_cli-9.5.0/src/mas_cli.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: mas-cli
+Version: 9.5.0
+Summary: Python Admin CLI for Maximo Application Suite
+Home-page: https://github.com/ibm-mas/cli
+Author: David Parker
+Author-email: parkerda@uk.ibm.com
+License: Eclipse Public License - v1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Communications
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: mas-devops
+Requires-Dist: halo
+Requires-Dist: prompt_toolkit
+Requires-Dist: openshift
+Requires-Dist: kubernetes
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pyinstaller; extra == "dev"
+
+mas.devops
+----------
+
+Example
+=======
+
+.. code:: python
+
+   from openshift import dynamic
+   from kubernetes import config
+   from kubernetes.client import api_client
+
+   from mas.devops.ocp import createNamespace
+   from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+
+   instanceId = "mymas"
+   pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+   # Create an OpenShift client
+   dynClient = dynamic.DynamicClient(
+       api_client.ApiClient(configuration=config.load_kube_config())
+   )
+
+   # Install OpenShift Pipelines Operator
+   installOpenShiftPipelines(dynamicClient)
+
+   # Create the pipelines namespace and install the MAS tekton definitions
+   createNamespace(dynamicClient, pipelinesNamespace)
+   updateTektonDefinitions(pipelinesNamespace)
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_cli-9.5.0/src/mas_cli.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+MANIFEST.in
+README.rst
+pyproject.toml
+setup.py
+src/mas-uninstall
+src/mas-upgrade
+src/mas/cli/__init__.py
+src/mas/cli/cli.py
+src/mas_cli.egg-info/PKG-INFO
+src/mas_cli.egg-info/SOURCES.txt
+src/mas_cli.egg-info/dependency_links.txt
+src/mas_cli.egg-info/requires.txt
+src/mas_cli.egg-info/top_level.txt

mas_cli-9.5.0/src/mas_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mas_cli-9.5.0/src/mas_cli.egg-info/requires.txt

@@ -0,0 +1,11 @@
+mas-devops
+halo
+prompt_toolkit
+openshift
+kubernetes
+
+[dev]
+build
+flake8
+pytest
+pyinstaller

mas_cli-9.5.0/src/mas_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+mas