mas-devops 1.0.0__tar.gz

mas_devops-1.0.0/LICENSE

@@ -0,0 +1,277 @@
+Eclipse Public License - v 2.0
+
+    THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+    PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+    OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+  a) in the case of the initial Contributor, the initial content
+     Distributed under this Agreement, and
+
+  b) in the case of each subsequent Contributor:
+     i) changes to the Program, and
+     ii) additions to the Program;
+  where such changes and/or additions to the Program originate from
+  and are Distributed by that particular Contributor. A Contribution
+  "originates" from a Contributor if it was added to the Program by
+  such Contributor itself or anyone acting on such Contributor's behalf.
+  Contributions do not include changes or additions to the Program that
+  are not Modified Works.
+
+"Contributor" means any person or entity that Distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which
+are necessarily infringed by the use or sale of its Contribution alone
+or when combined with the Program.
+
+"Program" means the Contributions Distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement
+or any Secondary License (as applicable), including Contributors.
+
+"Derivative Works" shall mean any work, whether in Source Code or other
+form, that is based on (or derived from) the Program and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship.
+
+"Modified Works" shall mean any work in Source Code or other form that
+results from an addition to, deletion from, or modification of the
+contents of the Program, including, for purposes of clarity any new file
+in Source Code form that contains any contents of the Program. Modified
+Works shall not include works that contain only declarations,
+interfaces, types, classes, structures, or files of the Program solely
+in each case in order to link to, bind by name, or subclass the Program
+or Modified Works thereof.
+
+"Distribute" means the acts of a) distributing or b) making available
+in any manner that enables the transfer of a copy.
+
+"Source Code" means the form of a Program preferred for making
+modifications, including but not limited to software source code,
+documentation source, and configuration files.
+
+"Secondary License" means either the GNU General Public License,
+Version 2.0, or any later versions of that license, including any
+exceptions or additional permissions as identified by the initial
+Contributor.
+
+2. GRANT OF RIGHTS
+
+  a) Subject to the terms of this Agreement, each Contributor hereby
+  grants Recipient a non-exclusive, worldwide, royalty-free copyright
+  license to reproduce, prepare Derivative Works of, publicly display,
+  publicly perform, Distribute and sublicense the Contribution of such
+  Contributor, if any, and such Derivative Works.
+
+  b) Subject to the terms of this Agreement, each Contributor hereby
+  grants Recipient a non-exclusive, worldwide, royalty-free patent
+  license under Licensed Patents to make, use, sell, offer to sell,
+  import and otherwise transfer the Contribution of such Contributor,
+  if any, in Source Code or other form. This patent license shall
+  apply to the combination of the Contribution and the Program if, at
+  the time the Contribution is added by the Contributor, such addition
+  of the Contribution causes such combination to be covered by the
+  Licensed Patents. The patent license shall not apply to any other
+  combinations which include the Contribution. No hardware per se is
+  licensed hereunder.
+
+  c) Recipient understands that although each Contributor grants the
+  licenses to its Contributions set forth herein, no assurances are
+  provided by any Contributor that the Program does not infringe the
+  patent or other intellectual property rights of any other entity.
+  Each Contributor disclaims any liability to Recipient for claims
+  brought by any other entity based on infringement of intellectual
+  property rights or otherwise. As a condition to exercising the
+  rights and licenses granted hereunder, each Recipient hereby
+  assumes sole responsibility to secure any other intellectual
+  property rights needed, if any. For example, if a third party
+  patent license is required to allow Recipient to Distribute the
+  Program, it is Recipient's responsibility to acquire that license
+  before distributing the Program.
+
+  d) Each Contributor represents that to its knowledge it has
+  sufficient copyright rights in its Contribution, if any, to grant
+  the copyright license set forth in this Agreement.
+
+  e) Notwithstanding the terms of any Secondary License, no
+  Contributor makes additional grants to any Recipient (other than
+  those set forth in this Agreement) as a result of such Recipient's
+  receipt of the Program under the terms of a Secondary License
+  (if permitted under the terms of Section 3).
+
+3. REQUIREMENTS
+
+3.1 If a Contributor Distributes the Program in any form, then:
+
+  a) the Program must also be made available as Source Code, in
+  accordance with section 3.2, and the Contributor must accompany
+  the Program with a statement that the Source Code for the Program
+  is available under this Agreement, and informs Recipients how to
+  obtain it in a reasonable manner on or through a medium customarily
+  used for software exchange; and
+
+  b) the Contributor may Distribute the Program under a license
+  different than this Agreement, provided that such license:
+     i) effectively disclaims on behalf of all other Contributors all
+     warranties and conditions, express and implied, including
+     warranties or conditions of title and non-infringement, and
+     implied warranties or conditions of merchantability and fitness
+     for a particular purpose;
+
+     ii) effectively excludes on behalf of all other Contributors all
+     liability for damages, including direct, indirect, special,
+     incidental and consequential damages, such as lost profits;
+
+     iii) does not attempt to limit or alter the recipients' rights
+     in the Source Code under section 3.2; and
+
+     iv) requires any subsequent distribution of the Program by any
+     party to be under a license that satisfies the requirements
+     of this section 3.
+
+3.2 When the Program is Distributed as Source Code:
+
+  a) it must be made available under this Agreement, or if the
+  Program (i) is combined with other material in a separate file or
+  files made available under a Secondary License, and (ii) the initial
+  Contributor attached to the Source Code the notice described in
+  Exhibit A of this Agreement, then the Program may be made available
+  under the terms of such Secondary Licenses, and
+
+  b) a copy of this Agreement must be included with each copy of
+  the Program.
+
+3.3 Contributors may not remove or alter any copyright, patent,
+trademark, attribution notices, disclaimers of warranty, or limitations
+of liability ("notices") contained within the Program from any copy of
+the Program which they Distribute, provided that Contributors may add
+their own appropriate notices.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities
+with respect to end users, business partners and the like. While this
+license is intended to facilitate the commercial use of the Program,
+the Contributor who includes the Program in a commercial product
+offering should do so in a manner which does not create potential
+liability for other Contributors. Therefore, if a Contributor includes
+the Program in a commercial product offering, such Contributor
+("Commercial Contributor") hereby agrees to defend and indemnify every
+other Contributor ("Indemnified Contributor") against any losses,
+damages and costs (collectively "Losses") arising from claims, lawsuits
+and other legal actions brought by a third party against the Indemnified
+Contributor to the extent caused by the acts or omissions of such
+Commercial Contributor in connection with its distribution of the Program
+in a commercial product offering. The obligations in this section do not
+apply to any claims or Losses relating to any actual or alleged
+intellectual property infringement. In order to qualify, an Indemnified
+Contributor must: a) promptly notify the Commercial Contributor in
+writing of such claim, and b) allow the Commercial Contributor to control,
+and cooperate with the Commercial Contributor in, the defense and any
+related settlement negotiations. The Indemnified Contributor may
+participate in any such claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those performance
+claims and warranties, and if a court requires any other Contributor to
+pay any damages as a result, the Commercial Contributor must pay
+those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+PURPOSE. Each Recipient is solely responsible for determining the
+appropriateness of using and distributing the Program and assumes all
+risks associated with its exercise of rights under this Agreement,
+including but not limited to the risks and costs of program errors,
+compliance with applicable laws, damage to or loss of data, programs
+or equipment, and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further
+action by the parties hereto, such provision shall be reformed to the
+minimum extent necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the
+Program itself (excluding combinations of the Program with other software
+or hardware) infringes such Recipient's patent(s), then such Recipient's
+rights granted under Section 2(b) shall terminate as of the date such
+litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of
+time after becoming aware of such noncompliance. If all Recipient's
+rights under this Agreement terminate, Recipient agrees to cease use
+and distribution of the Program as soon as reasonably practicable.
+However, Recipient's obligations under this Agreement and any licenses
+granted by Recipient relating to the Program shall continue and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement,
+but in order to avoid inconsistency the Agreement is copyrighted and
+may only be modified in the following manner. The Agreement Steward
+reserves the right to publish new versions (including revisions) of
+this Agreement from time to time. No one other than the Agreement
+Steward has the right to modify this Agreement. The Eclipse Foundation
+is the initial Agreement Steward. The Eclipse Foundation may assign the
+responsibility to serve as the Agreement Steward to a suitable separate
+entity. Each new version of the Agreement will be given a distinguishing
+version number. The Program (including Contributions) may always be
+Distributed subject to the version of the Agreement under which it was
+received. In addition, after a new version of the Agreement is published,
+Contributor may elect to Distribute the Program (including its
+Contributions) under the new version.
+
+Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+receives no rights or licenses to the intellectual property of any
+Contributor under this Agreement, whether expressly, by implication,
+estoppel or otherwise. All rights in the Program not expressly granted
+under this Agreement are reserved. Nothing in this Agreement is intended
+to be enforceable by any entity that is not a Contributor or Recipient.
+No third-party beneficiary rights are created under this Agreement.
+
+Exhibit A - Form of Secondary Licenses Notice
+
+"This Source Code may also be made available under the following
+Secondary Licenses when the conditions for such availability set forth
+in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+version(s), and exceptions or additional permissions here}."
+
+  Simply including a copy of this Agreement, including this Exhibit A
+  is not sufficient to license the Source Code under Secondary Licenses.
+
+  If it is not possible or desirable to put the notice in a particular
+  file, then You may include the notice in a location (such as a LICENSE
+  file in a relevant directory) where a recipient would be likely to
+  look for such a notice.
+
+  You may add additional accurate notices of copyright ownership.

mas_devops-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include src/mas/devops/templates/*.yaml
+include src/mas/devops/templates/*.yml.j2

mas_devops-1.0.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: mas-devops
+Version: 1.0.0
+Summary: Python for Maximo Application Suite Dev/Ops
+Home-page: https://github.com/ibm-mas/python-devops
+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
+License-File: LICENSE
+Requires-Dist: pyyaml
+Requires-Dist: openshift
+Requires-Dist: kubernetes
+Requires-Dist: kubeconfig
+Requires-Dist: jinja2
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; 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, "/mascli/templates/ibm-mas-tekton.yaml")
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_devops-1.0.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, "/mascli/templates/ibm-mas-tekton.yaml")
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_devops-1.0.0/pyproject.toml

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

mas_devops-1.0.0/setup.cfg

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

mas_devops-1.0.0/setup.py

@@ -0,0 +1,83 @@
+# *****************************************************************************
+# 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-devops',
+    version=get_version("src/mas/devops/__init__.py"),
+    author='David Parker',
+    author_email='parkerda@uk.ibm.com',
+    package_dir={'': 'src'},
+    packages=find_namespace_packages(where='src', include=[
+        'mas.devops',
+        'mas.devops.templates'
+    ]),
+    include_package_data=True,
+    url='https://github.com/ibm-mas/python-devops',
+    license='Eclipse Public License - v1.0',
+    description='Python for Maximo Application Suite Dev/Ops',
+    long_description=long_description,
+    install_requires=[
+        'pyyaml',         # MIT License
+        'openshift',      # Apache Software License
+        'kubernetes',     # Apache Software License
+        'kubeconfig',     # BSD License
+        'jinja2'          # BSD License
+    ],
+    extras_require={
+        'dev': [
+            'build',       # MIT License
+            'flake8',      # MIT License
+            'pytest'      # MIT 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_devops-1.0.0/src/mas/devops/__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__ = "1.0.0"

mas_devops-1.0.0/src/mas/devops/mas.py

@@ -0,0 +1,47 @@
+# *****************************************************************************
+# 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 logging
+
+from openshift.dynamic import DynamicClient
+from openshift.dynamic.exceptions import NotFoundError, UnauthorizedError
+
+logger = logging.getLogger(__name__)
+
+
+def listMasInstances(dynClient: DynamicClient) -> list:
+    """
+    Get a list of MAS instances on the cluster
+    """
+    suitesAPI = dynClient.resources.get(api_version="core.mas.ibm.com/v1", kind="Suite")
+
+    suites = suitesAPI.get().to_dict()['items']
+    if len(suites) > 0:
+        logger.info(f"There are {len(suites)} MAS instances installed on this cluster:")
+        for suite in suites:
+            logger.info(f" * {suite['metadata']['name']} v{suite['status']['versions']['reconciled']}")
+    else:
+        logger.info("There are no MAS instances installed on this cluster")
+    return suites
+
+
+def verifyMasInstance(dynClient: DynamicClient, instanceId: str) -> bool:
+    """
+    Validate that the chosen MAS instance exists
+    """
+    try:
+        suitesAPI = dynClient.resources.get(api_version="core.mas.ibm.com/v1", kind="Suite")
+        suitesAPI.get(name=instanceId, namespace=f"mas-{instanceId}-core")
+        return True
+    except NotFoundError:
+        return False
+    except UnauthorizedError:
+        logger.error("Error: Unable to verify MAS instance due to failed authorization: {e}")
+        return False

mas_devops-1.0.0/src/mas/devops/ocp.py

@@ -0,0 +1,105 @@
+# *****************************************************************************
+# 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 logging
+from time import sleep
+
+from kubeconfig import KubeConfig
+from kubeconfig.exceptions import KubectlNotFoundError
+from openshift.dynamic import DynamicClient
+from openshift.dynamic.exceptions import NotFoundError
+
+logger = logging.getLogger(__name__)
+
+
+def connect(server: str, token: str) -> bool:
+    """
+    Connect to target OCP
+    """
+    logger.info(f"Connect(server={server}, token=***)")
+
+    try:
+        conf = KubeConfig()
+    except KubectlNotFoundError:
+        logger.warning("Unable to locate kubectl on the path")
+        return False
+
+    conf.view()
+    logger.debug(f"Starting KubeConfig context: {conf.current_context()}")
+
+    conf.set_credentials(
+        name='my-credentials',
+        token=token
+    )
+    conf.set_cluster(
+        name='my-cluster',
+        server=server
+    )
+    conf.set_context(
+        name='my-context',
+        cluster='my-cluster',
+        user='my-credentials'
+    )
+
+    conf.use_context('my-context')
+    conf.view()
+    logger.info(f"KubeConfig context changed to {conf.current_context()}")
+    return True
+
+
+def createNamespace(dynClient: DynamicClient, namespace: str) -> bool:
+    """
+    Create a namespace if it does not exist
+    """
+    namespaceAPI = dynClient.resources.get(api_version="v1", kind="Namespace")
+    try:
+        namespaceAPI.get(name=namespace)
+        logger.debug(f"Namespace {namespace} already exists")
+    except NotFoundError:
+        nsObj = {
+            "apiVersion": "v1",
+            "kind": "Namespace",
+            "metadata": {
+                "name": namespace
+            }
+        }
+        namespaceAPI.create(body=nsObj)
+        logger.debug(f"Created namespace {namespace}")
+    return True
+
+
+def waitForCRD(dynClient: DynamicClient, crdName: str) -> bool:
+    crdAPI = dynClient.resources.get(api_version="apiextensions.k8s.io/v1", kind="CustomResourceDefinition")
+    maxRetries = 100
+    foundReadyCRD = False
+    retries = 0
+    while not foundReadyCRD and retries < maxRetries:
+        retries += 1
+        try:
+            tasksCRD = crdAPI.get(name=crdName)
+            conditions = tasksCRD.status.conditions
+            for condition in conditions:
+                if condition.type == "Established":
+                    if condition.status == "True":
+                        foundReadyCRD = True
+                    else:
+                        logger.debug("Waiting 5s for tasks.tekton.dev CRD to be ready before checking again ...")
+                        sleep(5)
+                        continue
+        except NotFoundError:
+            logger.debug("Waiting 5s for tasks.tekton.dev CRD to be installed before checking again ...")
+            sleep(5)
+    return foundReadyCRD
+
+
+def getConsoleURL(dynClient: DynamicClient) -> str:
+    routesAPI = dynClient.resources.get(api_version="route.openshift.io/v1", kind="Route")
+    consoleRoute = routesAPI.get(name="console", namespace="openshift-console")
+    return f"https://{consoleRoute.spec.host}"

mas_devops-1.0.0/src/mas/devops/tekton.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
+#
+# *****************************************************************************
+
+import logging
+import yaml
+
+from datetime import datetime
+from os import path
+
+from kubeconfig import kubectl
+from kubeconfig.exceptions import KubectlCommandError
+from openshift.dynamic import DynamicClient
+from openshift.dynamic.exceptions import NotFoundError, UnprocessibleEntityError
+
+from jinja2 import Environment, FileSystemLoader
+from jinja2.exceptions import TemplateNotFound
+
+from .ocp import getConsoleURL, waitForCRD
+
+logger = logging.getLogger(__name__)
+
+
+def installOpenShiftPipelines(dynClient: DynamicClient) -> bool:
+    """
+    Install the OpenShift Pipelines Operator and wait for it to be ready to use
+    """
+    packagemanifestAPI = dynClient.resources.get(api_version="packages.operators.coreos.com/v1", kind="PackageManifest")
+    subscriptionsAPI = dynClient.resources.get(api_version="operators.coreos.com/v1alpha1", kind="Subscription")
+
+    # Create the Operator Subscription
+    try:
+        manifest = packagemanifestAPI.get(name="openshift-pipelines-operator-rh", namespace="openshift-marketplace")
+        defaultChannel = manifest.status.defaultChannel
+        catalogSource = manifest.status.catalogSource
+        catalogSourceNamespace = manifest.status.catalogSourceNamespace
+
+        logger.info(f"OpenShift Pipelines Operator Details: {catalogSourceNamespace}/{catalogSource}@{defaultChannel}")
+
+        templateDir = path.join(path.abspath(path.dirname(__file__)), "templates")
+        env = Environment(
+            loader=FileSystemLoader(searchpath=templateDir)
+        )
+        try:
+            template = env.get_template("templates/subscription.yml.j2")
+        except TemplateNotFound as e:
+            logger.warning(f"Could not find subscription template in {templateDir}: {e}")
+            return False
+        renderedTemplate = template.render(
+            pipelines_channel=defaultChannel,
+            pipelines_source=catalogSource,
+            pipelines_source_namespace=catalogSourceNamespace
+        )
+        subscription = yaml.safe_load(renderedTemplate)
+        subscriptionsAPI.apply(body=subscription, namespace="openshift-operators")
+
+    except NotFoundError:
+        logger.warning("Error: Couldn't find package manifest for Red Hat Openshift Pipelines Operator")
+    except UnprocessibleEntityError:
+        logger.warning("Error: Couldn't create/update OpenShift Pipelines Operator Subscription")
+
+    foundReadyCRD = waitForCRD(dynClient, "tasks.tekton.dev")
+    if foundReadyCRD:
+        logger.info("OpenShift Pipelines Operator is installed and ready")
+        return True
+    else:
+        logger.error("OpenShift Pipelines Operator is NOT installed and ready")
+        return False
+
+
+def updateTektonDefinitions(namespace: str, yamlFile: str) -> bool:
+    """
+    Install/update the MAS tekton pipeline and task definitions
+
+    Unfortunately there's no API equivalent of what the kubectl CLI gives us with the ability to just apply a file containing a mix of
+    """
+    # https://github.com/gtaylor/kubeconfig-python/blob/master/kubeconfig/kubectl.py
+    try:
+        result = kubectl.run(subcmd_args=['apply', '-n', namespace, '-f', yamlFile])
+        for line in result.split("\n"):
+            logger.debug(line)
+        return True
+    except KubectlCommandError as e:
+        logger.warning(f"Error: Unable to install/update Tekton definitions: {e}")
+        return False
+
+
+def launchUpgradePipeline(dynClient: DynamicClient,
+                          instanceId: str,
+                          masChannel: str = "") -> str:
+    """
+    Create a PipelineRun to upgrade the chosen MAS instance
+    """
+    pipelineRunsAPI = dynClient.resources.get(api_version="tekton.dev/v1beta1", kind="PipelineRun")
+    namespace = f"mas-{instanceId}-pipelines"
+    timestamp = datetime.now().strftime("%y%m%d-%H%M")
+    # Create the PipelineRun
+    try:
+        templateDir = path.join(path.abspath(path.dirname(__file__)), "templates")
+        env = Environment(
+            loader=FileSystemLoader(searchpath=templateDir)
+        )
+        try:
+            template = env.get_template("pipelinerun-upgrade.yml.j2")
+        except TemplateNotFound as e:
+            logger.warning(f"Could not find pipelinerun template in {templateDir}: {e}")
+            return None
+        renderedTemplate = template.render(
+            timestamp=timestamp,
+            mas_instance_id=instanceId,
+            mas_channel=masChannel
+        )
+        pipelineRun = yaml.safe_load(renderedTemplate)
+        pipelineRunsAPI.apply(body=pipelineRun, namespace=namespace)
+
+    except Exception as e:
+        logger.warning(f"Error: An unexpected error occured: {e}")
+        logger.debug(renderedTemplate)
+        return None
+
+    pipelineURL = f"{getConsoleURL(dynClient)}/k8s/ns/mas-{instanceId}-pipelines/tekton.dev~v1beta1~PipelineRun/{instanceId}-upgrade-{timestamp}"
+    return pipelineURL
+
+
+def launchUninstallPipeline(dynClient: DynamicClient,
+                            instanceId: str,
+                            certManagerProvider: str = "redhat",
+                            uninstallCertManager: bool = False,
+                            uninstallGrafana: bool = False,
+                            uninstallCatalog: bool = False,
+                            uninstallCommonServices: bool = False,
+                            uninstallUDS: bool = False,
+                            uninstallMongoDb: bool = False,
+                            uninstallSLS: bool = False) -> str:
+    """
+    Create a PipelineRun to uninstall the chosen MAS instance (and selected dependencies)
+    """
+    pipelineRunsAPI = dynClient.resources.get(api_version="tekton.dev/v1beta1", kind="PipelineRun")
+    namespace = f"mas-{instanceId}-pipelines"
+    timestamp = datetime.now().strftime("%y%m%d-%H%M")
+    # Create the PipelineRun
+    try:
+        templateDir = path.join(path.abspath(path.dirname(__file__)), "templates")
+        env = Environment(
+            loader=FileSystemLoader(searchpath=templateDir)
+        )
+        try:
+            template = env.get_template("pipelinerun-uninstall.yml.j2")
+        except TemplateNotFound as e:
+            logger.warning(f"Could not find pipelinerun template in {templateDir}: {e}")
+            return None
+
+        grafanaAction = "uninstall" if uninstallGrafana else "none"
+        certManagerAction = "uninstall" if uninstallCertManager else "none"
+        commonServicesAction = "uninstall" if uninstallCommonServices else "none"
+        ibmCatalogAction = "uninstall" if uninstallCatalog else "none"
+        mongoDbAction = "uninstall" if uninstallMongoDb else "none"
+        slsAction = "uninstall" if uninstallSLS else "none"
+        udsAction = "uninstall" if uninstallUDS else "none"
+
+        # Render the pipelineRun
+        renderedTemplate = template.render(
+            timestamp=timestamp,
+            mas_instance_id=instanceId,
+            grafana_action=grafanaAction,
+            cert_manager_provider=certManagerProvider,
+            cert_manager_action=certManagerAction,
+            common_services_action=commonServicesAction,
+            ibm_catalogs_action=ibmCatalogAction,
+            mongodb_action=mongoDbAction,
+            sls_action=slsAction,
+            uds_action=udsAction
+        )
+        pipelineRun = yaml.safe_load(renderedTemplate)
+        pipelineRunsAPI.apply(body=pipelineRun, namespace=namespace)
+
+    except Exception as e:
+        logger.warning(f"Error: An unexpected error occured: {e}")
+        logger.debug(renderedTemplate)
+        return None
+
+    pipelineURL = f"{getConsoleURL(dynClient)}/k8s/ns/mas-{instanceId}-pipelines/tekton.dev~v1beta1~PipelineRun/{instanceId}-uninstall-{timestamp}"
+    return pipelineURL

mas_devops-1.0.0/src/mas/devops/templates/pipelinerun-uninstall.yml.j2

@@ -0,0 +1,34 @@
+---
+apiVersion: tekton.dev/v1beta1
+kind: PipelineRun
+metadata:
+  name: "{{mas_instance_id}}-uninstall-{{ timestamp }}"
+  labels:
+    tekton.dev/pipeline: mas-uninstall
+spec:
+  pipelineRef:
+    name: mas-uninstall
+
+  serviceAccountName: pipeline
+  timeouts:
+    pipeline: "5h"
+
+  params:
+    - name: mas_instance_id
+      value: {{ mas_instance_id }}
+    - name: grafana_action
+      value: {{ grafana_action }}
+    - name: cert_manager_provider
+      value: {{ cert_manager_provider }}
+    - name: cert_manager_action
+      value: {{ cert_manager_action }}
+    - name: common_services_action
+      value: {{ common_services_action }}
+    - name: ibm_catalogs_action
+      value: {{ ibm_catalogs_action }}
+    - name: mongodb_action
+      value: {{ mongodb_action }}
+    - name: sls_action
+      value: {{ sls_action }}
+    - name: uds_action
+      value: {{ uds_action }}

mas_devops-1.0.0/src/mas/devops/templates/pipelinerun-upgrade.yml.j2

@@ -0,0 +1,20 @@
+---
+apiVersion: tekton.dev/v1beta1
+kind: PipelineRun
+metadata:
+  name: "{{ mas_instance_id }}-upgrade-{{ timestamp }}"
+  labels:
+    tekton.dev/pipeline: mas-upgrade
+spec:
+  pipelineRef:
+    name: mas-upgrade
+
+  serviceAccountName: pipeline
+  timeouts:
+    pipeline: "10h"
+
+  params:
+    - name: mas_instance_id
+      value: "{{ mas_instance_id }}"
+    - name: mas_channel
+      value: "{{ mas_channel }}"

mas_devops-1.0.0/src/mas/devops/templates/subscription.yml.j2

@@ -0,0 +1,11 @@
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+    name: openshift-pipelines-operator
+    namespace: openshift-operators
+spec:
+    channel: {{pipelines_channel}}
+    name: openshift-pipelines-operator-rh
+    source: {{pipelines_source}}
+    sourceNamespace: {{pipelines_source_namespace}}

mas_devops-1.0.0/src/mas_devops.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: mas-devops
+Version: 1.0.0
+Summary: Python for Maximo Application Suite Dev/Ops
+Home-page: https://github.com/ibm-mas/python-devops
+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
+License-File: LICENSE
+Requires-Dist: pyyaml
+Requires-Dist: openshift
+Requires-Dist: kubernetes
+Requires-Dist: kubeconfig
+Requires-Dist: jinja2
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; 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, "/mascli/templates/ibm-mas-tekton.yaml")
+
+   # Launch the upgrade pipeline and print the URL to view the pipeline run
+   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+   print(pipelineURL)

mas_devops-1.0.0/src/mas_devops.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+MANIFEST.in
+README.rst
+pyproject.toml
+setup.py
+src/mas/devops/__init__.py
+src/mas/devops/mas.py
+src/mas/devops/ocp.py
+src/mas/devops/tekton.py
+src/mas/devops/templates/pipelinerun-uninstall.yml.j2
+src/mas/devops/templates/pipelinerun-upgrade.yml.j2
+src/mas/devops/templates/subscription.yml.j2
+src/mas_devops.egg-info/PKG-INFO
+src/mas_devops.egg-info/SOURCES.txt
+src/mas_devops.egg-info/dependency_links.txt
+src/mas_devops.egg-info/requires.txt
+src/mas_devops.egg-info/top_level.txt

mas_devops-1.0.0/src/mas_devops.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mas_devops-1.0.0/src/mas_devops.egg-info/requires.txt

@@ -0,0 +1,10 @@
+pyyaml
+openshift
+kubernetes
+kubeconfig
+jinja2
+
+[dev]
+build
+flake8
+pytest

mas_devops-1.0.0/src/mas_devops.egg-info/top_level.txt

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