mas-cli 12.0.0__py3-none-any.whl → 12.27.0__py3-none-any.whl

mas/cli/aiservice/install/params.py

@@ -0,0 +1,120 @@
+# *****************************************************************************
+# Copyright (c) 2024, 2025 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
+#
+# *****************************************************************************
+
+requiredParams = [
+    # MAS
+    "mas_catalog_version",
+    # Storage classes
+    "storage_class_rwo",
+    "storage_class_rwx",
+    # Entitlement
+    "ibm_entitlement_key",
+    # DRO
+    "uds_contact_email",
+    "uds_contact_firstname",
+    "uds_contact_lastname"
+]
+
+optionalParams = [
+    # Pipeline
+    "image_pull_policy",
+    "service_account_name",
+    # Catalogue
+    "mas_catalog_digest",
+    # SLS
+    "sls_namespace",
+    # DRO
+    "dro_namespace",
+    # Db2
+    "db2_action_system",
+    "db2_action_manage",
+    "db2_action_facilities",
+    "db2_type",
+    "db2_timezone",
+    "db2_namespace",
+    "db2_channel",
+    "db2_affinity_key",
+    "db2_affinity_value",
+    "db2_tolerate_key",
+    "db2_tolerate_value",
+    "db2_tolerate_effect",
+    "db2_cpu_requests",
+    "db2_cpu_limits",
+    "db2_memory_requests",
+    "db2_memory_limits",
+    "db2_backup_storage_size",
+    "db2_data_storage_size",
+    "db2_logs_storage_size",
+    "db2_meta_storage_size",
+    "db2_temp_storage_size",
+    # Dev Mode
+    "artifactory_username",
+    "artifactory_token",
+    # Aibroker
+    "mas_aibroker_storage_provider",
+    "mas_aibroker_storage_accesskey",
+    "mas_aibroker_storage_secretkey",
+    "mas_aibroker_storage_host",
+    "mas_aibroker_storage_port",
+    "mas_aibroker_storage_ssl",
+    "mas_aibroker_storage_region",
+    "mas_aibroker_storage_pipelines_bucket",
+    "mas_aibroker_storage_tenants_bucket",
+    "mas_aibroker_storage_templates_bucket",
+    "mas_aibroker_tenant_name",
+    "mas_aibroker_watsonxai_apikey",
+    "mas_aibroker_watsonxai_url",
+    "mas_aibroker_watsonxai_project_id",
+    "mas_aibroker_watsonx_action",
+    "mas_aibroker_db_host",
+    "mas_aibroker_db_port",
+    "mas_aibroker_db_user",
+    "mas_aibroker_db_database",
+    "mas_aibroker_db_secret_name",
+    "mas_aibroker_db_secret_key",
+    "mas_aibroker_db_secret_value",
+    "aibroker_instance_id",
+    "mariadb_user",
+    "mariadb_password",
+    "minio_root_user",
+    "minio_root_password",
+    "tenant_entitlement_type",
+    "tenant_entitlement_start_date",
+    "tenant_entitlement_end_date",
+    "mas_aibroker_s3_bucket_prefix",
+    "mas_aibroker_s3_region",
+    "mas_aibroker_s3_endpoint_url",
+    "mas_aibroker_tenant_s3_bucket_prefix",
+    "mas_aibroker_tenant_s3_region",
+    "mas_aibroker_tenant_s3_endpoint_url",
+    "mas_aibroker_tenant_s3_access_key",
+    "mas_aibroker_tenant_s3_secret_key",
+    "rsl_url",
+    "rsl_org_id",
+    "rsl_token",
+    "install_minio_aiservice",
+    "install_sls_aiservice",
+    "install_dro_aiservice",
+    "install_db2_aiservice",
+    "mas_aibroker_dro_secret_name",
+    "mas_aibroker_dro_api_key",
+    "mas_aibroker_dro_url",
+    "mas_aibroker_dro_ca_cert",
+    "mas_aibroker_db2_username",
+    "mas_aibroker_db2_password",
+    "mas_aibroker_db2_jdbc_url",
+    "mas_aibroker_db2_ssl_enabled",
+    "mas_aibroker_db2_ca_cert",
+    "mas_aibroker_sls_secret_name",
+    "mas_aibroker_sls_registration_key",
+    "mas_aibroker_sls_url",
+    "mas_aibroker_sls_ca_cert",
+    "environment_type",
+]

mas/cli/aiservice/install/summarizer.py

@@ -0,0 +1,193 @@
+# *****************************************************************************
+# Copyright (c) 2024, 2025 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 prompt_toolkit import print_formatted_text, HTML
+from mas.devops.ocp import getConsoleURL
+
+logger = logging.getLogger(__name__)
+
+
+class aiServiceInstallSummarizerMixin():
+    def ocpSummary(self) -> None:
+        self.printH2("Pipeline Configuration")
+        self.printParamSummary("Service Account", "service_account_name")
+        self.printParamSummary("Image Pull Policy", "image_pull_policy")
+        self.printSummary("Skip Pre-Install Healthcheck", "Yes" if self.getParam('skip_pre_check') == "true" else "No")
+
+        self.printH2("OpenShift Container Platform")
+        self.printSummary("Worker Node Architecture", self.architecture)
+        self.printSummary("Storage Class Provider", self.storageClassProvider)
+        self.printParamSummary("ReadWriteOnce Storage Class", "storage_class_rwo")
+        self.printParamSummary("ReadWriteMany Storage Class", "storage_class_rwx")
+
+        self.printParamSummary("Certificate Manager", "cert_manager_provider")
+        self.printParamSummary("Cluster Ingress Certificate Secret", "ocp_ingress_tls_secret_name")
+
+    def masSummary(self) -> None:
+
+        self.printH2("IBM Maximo Application Suite")
+
+        print()
+        self.printParamSummary("Catalog Version", "mas_catalog_version")
+        # We only list the digest if it's specified (primary use case is when running development builds in airgap environments)
+        if self.getParam("mas_catalog_digest" != ""):
+            self.printParamSummary("Catalog Digest", "mas_catalog_digest")
+        self.printParamSummary("Subscription Channel", "mas_channel")
+
+        print()
+        self.printParamSummary("IBM Entitled Registry", "mas_icr_cp")
+        self.printParamSummary("IBM Open Registry", "mas_icr_cpopen")
+
+        print()
+        if self.localConfigDir is not None:
+            self.printSummary("Additional Config", self.localConfigDir)
+        else:
+            self.printSummary("Additional Config", "Not Configured")
+
+    def aibrokerSummary(self) -> None:
+        if self.installAiBroker:
+            self.printSummary("AI Broker", self.params["mas_app_channel_aibroker"])
+            print_formatted_text(HTML("  <SkyBlue>+ Maximo AI Broker Settings</SkyBlue>"))
+            self.printParamSummary("  + Aibroker Instance Id", "aibroker_instance_id")
+            self.printParamSummary("  + Storage provider", "mas_aibroker_storage_provider")
+            if self.getParam("mas_aibroker_storage_provider") == "minio":
+                self.printParamSummary("  + minio root username", "minio_root_user")
+            if self.getParam("mas_app_channel_aibroker") != "9.0.x":
+                self.printParamSummary("  + Mariadb username", "mariadb_user")
+                self.printParamSummary("  + Mariadb password", "mariadb_password")
+            self.printParamSummary("  + Storage access key", "mas_aibroker_storage_accesskey")
+            self.printParamSummary("  + Storage host", "mas_aibroker_storage_host")
+            self.printParamSummary("  + Storage port", "mas_aibroker_storage_port")
+            self.printParamSummary("  + Storage ssl", "mas_aibroker_storage_ssl")
+            self.printParamSummary("  + Storage region", "mas_aibroker_storage_region")
+            self.printParamSummary("  + Storage pipelines bucket", "mas_aibroker_storage_pipelines_bucket")
+            self.printParamSummary("  + Storage tenants bucket", "mas_aibroker_storage_tenants_bucket")
+            self.printParamSummary("  + Storage templates bucket", "mas_aibroker_storage_templates_bucket")
+            self.printParamSummary("  + Watsonxai machine learning url", "mas_aibroker_watsonxai_url")
+            self.printParamSummary("  + Watsonxai project id", "mas_aibroker_watsonxai_project_id")
+            self.printParamSummary("  + Database host", "mas_aibroker_db_host")
+            self.printParamSummary("  + Database port", "mas_aibroker_db_port")
+            self.printParamSummary("  + Database user", "mas_aibroker_db_user")
+            self.printParamSummary("  + Database name", "mas_aibroker_db_database")
+            if self.getParam("mas_app_channel_aibroker") != "9.0.x":
+                self.printParamSummary("  + Tenant entitlement type", "tenant_entitlement_type")
+                self.printParamSummary("  + Tenant start date", "tenant_entitlement_start_date")
+                self.printParamSummary("  + Tenant end date", "tenant_entitlement_end_date")
+                self.printParamSummary("  + Tenant end date", "tenant_entitlement_end_date")
+                self.printParamSummary("  + S3 bucket prefix", "mas_aibroker_s3_bucket_prefix")
+                self.printParamSummary("  + S3 endpoint url", "mas_aibroker_s3_endpoint_url")
+                self.printParamSummary("  + S3 bucket prefix (tenant level)", "mas_aibroker_tenant_s3_bucket_prefix")
+                self.printParamSummary("  + S3 region (tenant level)", "mas_aibroker_tenant_s3_region")
+                self.printParamSummary("  + S3 endpoint url (tenant level)", "mas_aibroker_tenant_s3_endpoint_url")
+                self.printParamSummary("  + RSL url", "rsl_url")
+                self.printParamSummary("  + ORG Id of RSL", "rsl_org_id")
+                self.printParamSummary("  + Token for RSL", "rsl_token")
+                self.printParamSummary("  + Install minio", "install_minio_aiservice")
+                self.printParamSummary("  + Install SLS", "install_sls_aiservice")
+                if self.getParam("install_sls_aiservice") != "true":
+                    self.printParamSummary("  + SLS secret name", "mas_aibroker_sls_secret_name")
+                    self.printParamSummary("  + SLS registration key", "mas_aibroker_sls_registration_key")
+                    self.printParamSummary("  + SLS URL", "mas_aibroker_sls_url")
+                self.printParamSummary("  + Install DRO", "install_dro_aiservice")
+                if self.getParam("install_dro_aiservice") != "true":
+                    self.printParamSummary("  + DRO secret name", "mas_aibroker_dro_secret_name")
+                    self.printParamSummary("  + DRO API key", "mas_aibroker_dro_api_key")
+                    self.printParamSummary("  + DRO URL", "mas_aibroker_dro_url")
+                self.printParamSummary("  + Install DB2", "install_db2_aiservice")
+                if self.getParam("install_db2_aiservice") != "true":
+                    self.printParamSummary("  + DB2 username", "mas_aibroker_db2_username")
+                    self.printParamSummary("  + DB2 JDBC URL", "mas_aibroker_db2_jdbc_url")
+                    self.printParamSummary("  + DB2 SSL enabled", "mas_aibroker_db2_ssl_enabled")
+                self.printParamSummary("  + Environment type", "environment_type")
+
+        else:
+            self.printSummary("AI Broker", "Do Not Install")
+
+    def db2Summary(self) -> None:
+        if self.getParam("db2_action_system") == "install" or self.getParam("db2_action_manage") == "install":
+            self.printH2("IBM Db2 Univeral Operator Configuration")
+            self.printSummary("System Instance", "Install" if self.getParam("db2_action_system") == "install" else "Do Not Install")
+            self.printSummary("Dedicated Manage Instance", "Install" if self.getParam("db2_action_manage") == "install" else "Do Not Install")
+            self.printParamSummary(" - Type", "db2_type")
+            self.printParamSummary(" - Timezone", "db2_timezone")
+            print()
+            self.printParamSummary("Install Namespace", "db2_namespace")
+            self.printParamSummary("Subscription Channel", "db2_channel")
+            print()
+            self.printParamSummary("CPU Request", "db2_cpu_requests")
+            self.printParamSummary("CPU Limit", "db2_cpu_limits")
+            self.printParamSummary("Memory Request", "db2_memory_requests")
+            self.printParamSummary("Memory Limit ", "db2_memory_limits")
+            print()
+            self.printParamSummary("Meta Storage", "db2_meta_storage_size")
+            self.printParamSummary("Data Storage", "db2_data_storage_size")
+            self.printParamSummary("Backup Storage", "db2_backup_storage_size")
+            self.printParamSummary("Temp Storage", "db2_temp_storage_size")
+            self.printParamSummary("Transaction Logs Storage", "db2_logs_storage_size")
+            print()
+            if self.getParam('db2_affinity_key') != "":
+                self.printSummary("Node Affinity", f"{self.getParam('db2_affinity_key')}={self.getParam('db2_affinity_value')}")
+            else:
+                self.printSummary("Node Affinity", "None")
+
+            if self.getParam('db2_tolerate_key') != "":
+                self.printSummary("Node Tolerations", f"{self.getParam('db2_tolerate_key')}={self.getParam('db2_tolerate_value')} @ {self.getParam('db2_tolerate_effect')}")
+            else:
+                self.printSummary("Node Tolerations", "None")
+
+    def droSummary(self) -> None:
+        self.printH2("IBM Data Reporter Operator (DRO) Configuration")
+        self.printParamSummary("Contact e-mail", "uds_contact_email")
+        self.printParamSummary("First name", "uds_contact_firstname")
+        self.printParamSummary("Last name", "uds_contact_lastname")
+        self.printParamSummary("Install Namespace", "dro_namespace")
+
+    def slsSummary(self) -> None:
+        self.printH2("IBM Suite License Service")
+        self.printParamSummary("Namespace", "sls_namespace")
+        if self.getParam("sls_action") == "install":
+            self.printSummary("Subscription Channel", "3.x")
+            self.printParamSummary("IBM Open Registry", "sls_icr_cpopen")
+            if self.slsLicenseFileLocal:
+                self.printSummary("License File", self.slsLicenseFileLocal)
+
+    def mongoSummary(self) -> None:
+        self.printH2("MongoDb")
+        if self.getParam("mongodb_action") == "install":
+            self.printSummary("Type", "MongoCE Operator")
+            self.printParamSummary("Install Namespace", "mongodb_namespace")
+        elif self.getParam("mongodb_action") == "byo":
+            self.printSummary("Type", "BYO (mongodb-system.yaml)")
+        else:
+            self.fatalError(f"Unexpected value for mongodb_action parameter: {self.getParam('mongodb_action')}")
+
+    def displayInstallSummary(self) -> None:
+        self.printH1("Review Settings")
+        self.printDescription([
+            "Connected to:",
+            f" - <u>{getConsoleURL(self.dynamicClient)}</u>"
+        ])
+
+        logger.debug("PipelineRun parameters:")
+        logger.debug(yaml.dump(self.params, default_flow_style=False))
+
+        # Cluster Config & Dependencies
+        self.ocpSummary()
+        self.droSummary()
+        self.slsSummary()
+        self.masSummary()
+        self.printH2("IBM Maximo Application Suite Application - Aiservice")
+        self.aibrokerSummary()
+
+        # Application Dependencies
+        self.mongoSummary()
+        self.db2Summary()

mas/cli/cli.py

@@ -117,7 +117,7 @@ class BaseApp(PrintMixin, PromptMixin):
         logging.getLogger('asyncio').setLevel(logging.INFO)
 
         # Supports extended semver, unlike mas.cli.__version__
-        self.version = "12.0.0"
+        self.version = "12.27.0"
         self.h1count = 0
         self.h2count = 0
 
@@ -132,17 +132,31 @@ class BaseApp(PrintMixin, PromptMixin):
         # Initialize the dictionary that will hold the parameters we pass to a PipelineRun
         self.params = dict()
 
-        # These dicts will hold the additional-configs, pod-templates and manual certificates secrets
+        # These dicts will hold the additional-configs, pod-templates, sls license file and manual certificates secrets
         self.additionalConfigsSecret = None
         self.podTemplatesSecret = None
+        self.slsLicenseFileSecret = None
         self.certsSecret = None
 
         self._isSNO = None
+        self._isAirgap = None
 
         # Until we connect to the cluster we don't know what architecture it's worker nodes are
         self.architecture = None
 
         self.compatibilityMatrix = {
+            "9.1.x": {
+                "facilities": ["9.1.x"],
+                "assist": ["9.1.x", "9.0.x"],
+                "iot": ["9.1.x", "9.0.x"],
+                "manage": ["9.1.x", "9.0.x"],
+                "monitor": ["9.1.x", "9.0.x"],
+                "optimizer": ["9.1.x", "9.0.x"],
+                "predict": ["9.1.x", "9.0.x"],
+                "visualinspection": ["9.1.x", "9.0.x"],
+                "aibroker": ["9.1.x", "9.0.x"],
+
+            },
             "9.1.x-feature": {
                 "assist": ["9.0.x"],
                 "iot": ["9.0.x"],
@@ -190,10 +204,14 @@ class BaseApp(PrintMixin, PromptMixin):
             "8.11.x": " - <u>https://ibm.biz/MAS811-License</u>\n - <u>https://ibm.biz/MAXIT81-License</u>",
             "9.0.x": " - <u>https://ibm.biz/MAS90-License</u>\n - <u>https://ibm.biz/MaximoIT90-License</u>\n - <u>https://ibm.biz/MAXArcGIS90-License</u>",
             "9.1.x-feature": " - <u>https://ibm.biz/MAS90-License</u>\n - <u>https://ibm.biz/MaximoIT90-License</u>\n - <u>https://ibm.biz/MAXArcGIS90-License</u>\n\nBe aware, this channel subscription is supported for non-production use only.   \nIt allows early access to new features for evaluation in non-production environments.   \nThis subscription is offered alongside and in parallel with our normal maintained streams.   \nWhen using this subscription, IBM Support will only accept cases for the latest available bundle deployed in a non-production environment.   \nSeverity must be either 3 or 4 and cases cannot be escalated.   \nPlease refer to IBM documentation for more details.\n",
+            "9.1.x": " - <u>https://ibm.biz/MAS91-License</u>\n - <u>https://ibm.biz/MAXIT91-License</u>\n - <u>https://ibm.biz/MAXESRI91-License</u>",
+            "aibroker-9.1.x": " - <u>https://ibm.biz/MAS91-License</u>",
         }
 
         self.upgrade_path = {
-            "9.0.x": "9.1.x-feature",
+            "9.1.x": "9.1.x",
+            "9.1.x-feature": "9.1.x",
+            "9.0.x": "9.1.x",
             "8.11.x": "9.0.x",
             "8.10.x": "8.11.x",
             "8.9.x": "8.10.x",
@@ -280,6 +298,16 @@ class BaseApp(PrintMixin, PromptMixin):
             self._isSNO = isSNO(self.dynamicClient)
         return self._isSNO
 
+    @logMethodCall
+    def isAirgap(self):
+        if self._isAirgap is None:
+            # First check if the legacy ICSP is installed.  If it is raise an error and instruct the user to re-run configure-airgap to
+            # migrate the cluster from ICSP to IDMS
+            if isAirgapInstall(self.dynamicClient, checkICSP=True):
+                self.fatalError("Deprecated Maximo Application Suite ImageContentSourcePolicy detected on the target cluster.  Run 'mas configure-airgap' to migrate to the replacement ImageDigestMirrorSet beofre proceeding.")
+            self._isAirgap = isAirgapInstall(self.dynamicClient)
+        return self._isAirgap
+
     def setParam(self, param: str, value: str):
         self.params[param] = value
 
@@ -368,11 +396,11 @@ class BaseApp(PrintMixin, PromptMixin):
             self.architecture = nodes[0]["status"]["nodeInfo"]["architecture"]
             logger.debug(f"Target architecture: {self.architecture}")
 
-        if self.architecture not in ["amd64", "s390x"]:
+        if self.architecture not in ["amd64", "s390x", "ppc64le"]:
             self.fatalError(f"Unsupported worker node architecture: {self.architecture}")
 
     @logMethodCall
-    def initializeApprovalConfigMap(self, namespace: str, id: str, key: str = None, maxRetries: int = 100, delay: int = 300, ignoreFailure: bool = True) -> None:
+    def initializeApprovalConfigMap(self, namespace: str, id: str, enabled: bool, maxRetries: int = 100, delay: int = 300, ignoreFailure: bool = True) -> None:
         """
         Set key = None if you don't want approval workflow enabled
         """
@@ -388,8 +416,7 @@ class BaseApp(PrintMixin, PromptMixin):
                 "MAX_RETRIES": str(maxRetries),
                 "DELAY": str(delay),
                 "IGNORE_FAILURE": str(ignoreFailure),
-                "CONFIGMAP_KEY": key,
-                key: ""
+                "STATUS": ""
             }
         }
 
@@ -400,6 +427,6 @@ class BaseApp(PrintMixin, PromptMixin):
         except NotFoundError:
             pass
 
-        if key is not None:
-            logger.debug(f"Enabling approval workflow for {id} using {key} with {maxRetries} max retries on a {delay}s delay ({'ignoring failures' if ignoreFailure else 'abort on failure'})")
+        if enabled:
+            logger.debug(f"Enabling approval workflow for {id} with {maxRetries} max retries on a {delay}s delay ({'ignoring failures' if ignoreFailure else 'abort on failure'})")
             cmAPI.create(body=configMap, namespace=namespace)

mas/cli/gencfg.py

@@ -11,6 +11,7 @@
 from os import path
 from jinja2 import Template
 from base64 import b64encode
+from json import loads
 
 
 class ConfigGeneratorMixin():
@@ -88,3 +89,25 @@ class ConfigGeneratorMixin():
         with open(destination, 'w') as f:
             f.write(cfg)
             f.write('\n')
+
+    def generateFacilitiesCfg(self, destination: str) -> None:
+        templateFile = path.join(self.templatesDir, "facilities-configs.yml.j2")
+
+        with open(templateFile) as tFile:
+            template = Template(tFile.read())
+
+        dwfagents = self.getParam("mas_ws_facilities_dwfagents")
+        maxconnpoolsize = self.getParam("mas_ws_facilities_db_maxconnpoolsize")
+        userfiles_size = self.getParam("mas_ws_facilities_storage_userfiles_size")
+        log_size = self.getParam("mas_ws_facilities_storage_log_size")
+        cfg = template.render(
+            mas_instance_id=self.getParam("mas_instance_id"),
+            mas_ws_facilities_storage_log_size=log_size if log_size != "" else 30,
+            mas_ws_facilities_storage_userfiles_size=userfiles_size if userfiles_size != "" else 50,
+            mas_ws_facilities_db_maxconnpoolsize=maxconnpoolsize if maxconnpoolsize != "" else 200,
+            mas_ws_facilities_dwfagents=loads(dwfagents) if dwfagents != '' else ''
+        )
+
+        with open(destination, 'w') as f:
+            f.write(cfg)
+            f.write('\n')