mas-cli 10.7.3__py3-none-any.whl → 10.9.0__py3-none-any.whl

mas/cli/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-__version__ = "10.7.3"
+__version__ = "10.9.0"  # Python module compatible semver

mas/cli/cli.py

@@ -15,6 +15,9 @@ from argparse import RawTextHelpFormatter
 from shutil import which
 from os import path, environ
 from sys import exit
+from subprocess import PIPE, Popen, TimeoutExpired
+import threading
+import json
 
 # Use of the openshift client rather than the kubernetes client allows us access to "apply"
 from kubernetes import config
@@ -24,9 +27,9 @@ from openshift.dynamic.exceptions import NotFoundError
 
 from prompt_toolkit import prompt, print_formatted_text, HTML
 
+from mas.devops.mas import isAirgapInstall
 from mas.devops.ocp import connect, isSNO
 
-from . import __version__ as packageVersion
 from .validators import YesNoValidator
 from .displayMixins import PrintMixin, PromptMixin
 
@@ -36,6 +39,7 @@ logger = logging.getLogger(__name__)
 # Disable warnings when users are connecting to OCP clusters with self-signed certificates
 urllib3.disable_warnings()
 
+
 def getHelpFormatter(formatter=RawTextHelpFormatter, w=160, h=50):
     """
     Return a wider HelpFormatter, if possible.
@@ -51,6 +55,41 @@ def getHelpFormatter(formatter=RawTextHelpFormatter, w=160, h=50):
         return formatter
 
 
+class RunCmdResult(object):
+    def __init__(self, returnCode, output, error):
+        self.rc = returnCode
+        self.out = output
+        self.err = error
+
+    def successful(self):
+        return self.rc == 0
+
+    def failed(self):
+        return self.rc != 0
+
+
+def runCmd(cmdArray, timeout=630):
+    """
+    Run a command on the local host.  This drives all the helm operations,
+    as there is no python Helm client available.
+    # Parameters
+    cmdArray (list<string>): Command to execute
+    timeout (int): How long to allow for the command to complete
+    # Returns
+    [int, string, string]: `returnCode`, `stdOut`, `stdErr`
+    """
+
+    lock = threading.Lock()
+
+    with lock:
+        p = Popen(cmdArray, stdin=PIPE, stdout=PIPE, stderr=PIPE, bufsize=-1)
+        try:
+            output, error = p.communicate(timeout=timeout)
+            return RunCmdResult(p.returncode, output, error)
+        except TimeoutExpired as e:
+            return RunCmdResult(127, 'TimeoutExpired', str(e))
+
+
 class BaseApp(PrintMixin, PromptMixin):
     def __init__(self):
         # Set up a log formatter
@@ -68,13 +107,18 @@ class BaseApp(PrintMixin, PromptMixin):
         rootLogger.addHandler(ch)
         rootLogger.setLevel(logging.DEBUG)
 
-        self.version = packageVersion
+        # Supports extended semver, unlike mas.cli.__version__
+        self.version = "10.9.0"
         self.h1count = 0
         self.h2count = 0
 
         self.localConfigDir = None
         self.templatesDir = path.join(path.abspath(path.dirname(__file__)), "templates")
-        self.tektonDefsPath = path.join(self.templatesDir, "ibm-mas-tekton.yaml")
+        self.tektonDefsWithoutDigestPath = path.join(self.templatesDir, "ibm-mas-tekton.yaml")
+        self.tektonDefsWithDigestPath = path.join(self.templatesDir, "ibm-mas-tekton-with-digest.yaml")
+
+        # Default to using the tekton definitions without image digests
+        self.tektonDefsPath = self.tektonDefsWithoutDigestPath
 
         # Initialize the dictionary that will hold the parameters we pass to a PipelineRun
         self.params = dict()
@@ -131,6 +175,48 @@ class BaseApp(PrintMixin, PromptMixin):
         if which("kubectl") is None:
             self.fatalError("Could not find kubectl on the path, see <DarkGoldenRod><u>https://kubernetes.io/docs/tasks/tools/#kubectl</u></DarkGoldenRod> for installation instructions")
 
+    def createTektonFileWithDigest(self) -> None:
+        if path.exists(self.tektonDefsWithDigestPath):
+            logger.debug(f"We have already generated {self.tektonDefsWithDigestPath}")
+        elif isAirgapInstall(self.dynamicClient):
+            # We need to modify the tekton definitions to
+            imageWithoutDigest = f"quay.io/ibmmas/cli:{self.version}"
+            self.printH1("Disconnected OpenShift Preparation")
+            self.printDescription([
+                f"Unless the {imageWithoutDigest} image is accessible from your cluster the MAS CLI container image must be present in your mirror registry"
+            ])
+            cmdArray = ["skopeo", "inspect", f"docker://{imageWithoutDigest}"]
+            logger.info(f"Skopeo inspect command: {' '.join(cmdArray)}")
+            skopeoResult = runCmd(cmdArray)
+            if skopeoResult.successful():
+                skopeoData = json.loads(skopeoResult.out)
+                logger.info(f"Skopeo Data for {imageWithoutDigest}: {skopeoData}")
+                if "Digest" not in skopeoData:
+                    self.fatalError("Recieved bad data inspecting CLI manifest to determine digest")
+                cliImageDigest = skopeoData["Digest"]
+            else:
+                warning = f"Unable to retrieve image digest for {imageWithoutDigest} ({skopeoResult.rc})"
+                self.printWarning(warning)
+                logger.warning(warning)
+                logger.warning(skopeoResult.err)
+                if self.noConfirm:
+                    self.fatalError("Unable to automatically determine CLI image digest and --no-confirm flag has been set")
+                else:
+                    cliImageDigest = self.promptForString(f"Enter {imageWithoutDigest} image digest")
+
+            # Overwrite the tekton definitions with one that uses the looked up image digest
+            imageWithDigest = f"quay.io/ibmmas/cli@{cliImageDigest}"
+            self.printHighlight(f"\nConverting Tekton definitions to use {imageWithDigest}")
+            with open(self.tektonDefsPath, 'r') as file:
+                tektonDefsWithoutDigest = file.read()
+
+            tektonDefsWithDigest = tektonDefsWithoutDigest.replace(imageWithoutDigest, imageWithDigest)
+
+            with open(self.tektonDefsWithDigestPath, 'w') as file:
+                file.write(tektonDefsWithDigest)
+
+            self.tektonDefsPath = self.tektonDefsWithDigestPath
+
     def getCompatibleVersions(self, coreChannel: str, appId: str) -> list:
         if coreChannel in self.compatibilityMatrix:
             return self.compatibilityMatrix[coreChannel][appId]

mas/cli/install/app.py

@@ -25,6 +25,7 @@ from halo import Halo
 
 from ..cli import BaseApp
 from ..gencfg import ConfigGeneratorMixin
+from .argBuilder import installArgBuilderMixin
 from .argParser import installArgParser
 from .settings import InstallSettingsMixin
 from .summarizer import InstallSummarizerMixin
@@ -51,7 +52,7 @@ from mas.devops.tekton import (
 logger = logging.getLogger(__name__)
 
 
-class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGeneratorMixin):
+class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGeneratorMixin, installArgBuilderMixin):
     def validateCatalogSource(self):
         catalogsAPI = self.dynamicClient.resources.get(api_version="operators.coreos.com/v1alpha1", kind="CatalogSource")
         try:
@@ -185,17 +186,19 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         self.promptForString("Install namespace", "mongodb_namespace", default="mongoce")
 
     def configCP4D(self):
-        # TODO: It's probably time to remove v8-amd64 support from the CLI entirely now
-        if self.getParam("mas_catalog_version") in ["v8-amd64", "v9-240625-amd64", "v9-240730-amd64"]:
+        if self.getParam("mas_catalog_version") in ["v9-240625-amd64", "v9-240730-amd64", "v9-240827-amd64"]:
+            logger.debug(f"Using automatic CP4D product version: {self.getParam('cpd_product_version')}")
             self.setParam("cpd_product_version", "4.8.0")
-        elif self.getParam("mas_catalog_version") in ["v8-240528-amd64"]:
-            self.setParam("cpd_product_version", "4.6.6")
-        else:
+        elif self.getParam("cpd_product_version") == "":
+            if self.noConfirm:
+                self.fatalError("Cloud Pak for Data version must be set manually, but --no-confirm flag has been set")
             self.printDescription([
                 f"Unknown catalog {self.getParam('mas_catalog_version')}, please manually select the version of Cloud Pak for Data to use"
             ])
             self.promptForString("Cloud Pak for Data product version", "cpd_product_version", default="4.8.0")
-
+            logger.debug(f"Using user-provided (prompt) CP4D product version: {self.getParam('cpd_product_version')}")
+        else:
+            logger.debug(f"Using user-provided (flags) CP4D product version: {self.getParam('cpd_product_version')}")
         self.deployCP4D = True
 
     def configSSOProperties(self):
@@ -221,6 +224,14 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             self.yesOrNo("Disable LDAP cookie", "disable_ldap_cookie")
             self.yesOrNo("Allow custom cache key", "allow_custom_cache_key")
 
+    def configGuidedTour(self):
+        self.printH1("Enable Guided Tour")
+        self.printDescription([
+            "By default, Maximo Application Suite is configured with guided tour, you can disable this if it not required"
+        ])
+        if not self.yesOrNo("Enable Guided Tour"):
+            self.setParam("mas_enable_walkme","false")
+
     def configMAS(self):
         self.printH1("Configure MAS Instance")
         self.printDescription([
@@ -250,6 +261,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         self.configCATrust()
         self.configDNSAndCerts()
         self.configSSOProperties()
+        self.configGuidedTour()
 
     def configCATrust(self) -> None:
         self.printH1("Certificate Authority Trust")
@@ -469,11 +481,11 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         # 3. Azure
         elif getStorageClass(self.dynamicClient, "managed-premium") is not None:
             print_formatted_text(HTML("<MediumSeaGreen>Storage provider auto-detected: Azure Managed</MediumSeaGreen>"))
-            print_formatted_text(HTML("<LightSlateGrey>  - Storage class (ReadWriteOnce): azurefiles-premium</LightSlateGrey>"))
-            print_formatted_text(HTML("<LightSlateGrey>  - Storage class (ReadWriteMany): managed-premium</LightSlateGrey>"))
+            print_formatted_text(HTML("<LightSlateGrey>  - Storage class (ReadWriteOnce): managed-premium</LightSlateGrey>"))
+            print_formatted_text(HTML("<LightSlateGrey>  - Storage class (ReadWriteMany): azurefiles-premium</LightSlateGrey>"))
             self.storageClassProvider = "azure"
-            self.params["storage_class_rwo"] = "azurefiles-premium"
-            self.params["storage_class_rwx"] = "managed-premium"
+            self.params["storage_class_rwo"] = "managed-premium"
+            self.params["storage_class_rwx"] = "azurefiles-premium"
         # 4. AWS
         elif getStorageClass(self.dynamicClient, "gp2") is not None:
             print_formatted_text(HTML("<MediumSeaGreen>Storage provider auto-detected: AWS gp2</MediumSeaGreen>"))
@@ -635,6 +647,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         ]
         optionalParams = [
             # MAS
+            "mas_catalog_digest",
             "mas_superuser_username",
             "mas_superuser_password",
             "mas_trust_default_cas",
@@ -704,6 +717,9 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             "eventstreams_resource_group",
             "eventstreams_instance_name",
             "eventstreams_instance_location",
+            # COS
+            "cos_type",
+            "cos_resourcegroup",
             # ECK
             "eck_action",
             "eck_enable_logstash",
@@ -727,7 +743,9 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             "artifactory_token",
             # TODO: The way arcgis has been implemented needs to be fixed
             "install_arcgis",
-            "mas_arcgis_channel"
+            "mas_arcgis_channel",
+            # Guided Tour
+            "mas_enable_walkme"
         ]
 
         for key, value in vars(self.args).items():
@@ -890,10 +908,49 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         # These flags work for setting params in both interactive and non-interactive modes
         if args.skip_pre_check:
             self.setParam("skip_pre_check", "true")
-        
+
         self.installOptions = [
             {
                 "#": 1,
+                "catalog": "v9-240827-amd64",
+                "release": "9.0.x",
+                "core": "9.0.2",
+                "assist": "9.0.2",
+                "iot": "9.0.2",
+                "manage": "9.0.2",
+                "monitor": "9.0.2",
+                "optimizer": "9.0.2",
+                "predict": "9.0.1",
+                "inspection": "9.0.2"
+            },
+            {
+                "#": 2,
+                "catalog": "v9-240827-amd64",
+                "release": "8.11.x",
+                "core": "8.11.14",
+                "assist": "8.8.6",
+                "iot": "8.8.12",
+                "manage": "8.7.11",
+                "monitor": "8.11.10",
+                "optimizer": "8.5.8",
+                "predict": "8.9.3",
+                "inspection": "8.9.5"
+            },
+            {
+                "#": 3,
+                "catalog": "v9-240827-amd64",
+                "release": "8.10.x",
+                "core": "8.10.17",
+                "assist": "8.7.7",
+                "iot": "8.7.16",
+                "manage": "8.6.17",
+                "monitor": "8.10.13",
+                "optimizer": "8.4.9",
+                "predict": "8.8.3",
+                "inspection": "8.8.4"
+            },
+            {
+                "#": 4,
                 "catalog": "v9-240730-amd64",
                 "release": "9.0.x",
                 "core": "9.0.1",
@@ -906,7 +963,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "inspection": "9.0.0"
             },
             {
-                "#": 2,
+                "#": 5,
                 "catalog": "v9-240730-amd64",
                 "release": "8.11.x",
                 "core": "8.11.13",
@@ -919,7 +976,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "inspection": "8.9.4"
             },
             {
-                "#": 3,
+                "#": 6,
                 "catalog": "v9-240730-amd64",
                 "release": "8.10.x",
                 "core": "8.10.16",
@@ -932,7 +989,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "inspection": "8.8.4"
             },
             {
-                "#": 4,
+                "#": 7,
                 "catalog": "v9-240625-amd64",
                 "release": "9.0.x",
                 "core": "9.0.0",
@@ -945,7 +1002,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "inspection": "9.0.0"
             },
             {
-                "#": 5,
+                "#": 8,
                 "catalog": "v9-240625-amd64",
                 "release": "8.11.x",
                 "core": "8.11.12",
@@ -958,7 +1015,7 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "inspection": "8.9.3"
             },
             {
-                "#": 6,
+                "#": 9,
                 "catalog": "v9-240625-amd64",
                 "release": "8.10.x",
                 "core": "8.10.15",
@@ -969,32 +1026,6 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                 "optimizer": "8.4.7",
                 "predict": "N/A",
                 "inspection": "8.8.4"
-            },
-            {
-                "#": 7,
-                "catalog": "v8-240528-amd64",
-                "release": "8.11.x",
-                "core": "8.11.11",
-                "assist": "N/A",
-                "iot": "8.8.9",
-                "manage": "8.7.8",
-                "monitor": "8.11.7",
-                "optimizer": "8.5.5",
-                "predict": "8.9.2",
-                "inspection": "8.9.3"
-            },
-            {
-                "#": 8,
-                "catalog": "v8-240528-amd64",
-                "release": "8.10.x",
-                "core": "8.10.14",
-                "assist": "N/A",
-                "iot": "8.7.13",
-                "manage": "8.6.14",
-                "monitor": "8.10.10",
-                "optimizer": "8.4.6",
-                "predict": "N/A",
-                "inspection": "8.8.4"
             }
         ]
 
@@ -1038,6 +1069,13 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
         self.manualCertificates()
 
         # Show a summary of the installation configuration
+        self.printH1("Non-Interactive Install Command")
+        self.printDescription([
+            "Save and re-use the following script to re-run this install without needing to answer the interactive prompts again",
+            "",
+            self.buildCommand()
+        ])
+
         self.displayInstallSummary()
 
         if not self.noConfirm:
@@ -1049,6 +1087,8 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
         # Prepare the namespace and launch the installation pipeline
         if self.noConfirm or continueWithInstall:
+            self.createTektonFileWithDigest()
+
             self.printH1("Launch Install")
             pipelinesNamespace = f"mas-{self.getParam('mas_instance_id')}-pipelines"