mas-cli 12.1.0__py3-none-any.whl → 13.1.0__py3-none-any.whl

mas/cli/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-__version__ = "12.1.0"  # Python module compatible semver
+__version__ = "13.1.0"  # Python module compatible semver

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.1.0"
+        self.version = "13.1.0"
         self.h1count = 0
         self.h2count = 0
 
@@ -138,6 +138,7 @@ class BaseApp(PrintMixin, PromptMixin):
         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
@@ -280,6 +281,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
 
@@ -372,7 +383,7 @@ class BaseApp(PrintMixin, PromptMixin):
             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 +399,7 @@ class BaseApp(PrintMixin, PromptMixin):
                 "MAX_RETRIES": str(maxRetries),
                 "DELAY": str(delay),
                 "IGNORE_FAILURE": str(ignoreFailure),
-                "CONFIGMAP_KEY": key,
-                key: ""
+                "STATUS": ""
             }
         }
 
@@ -400,6 +410,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/install/app.py

@@ -651,9 +651,12 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
     def optimizerSettings(self) -> None:
         if self.installOptimizer:
             self.printH1("Configure Maximo Optimizer")
-            self.printDescription(["Customize your Optimizer installation, 'full' and 'limited' install plans are available, refer to the product documentation for more information"])
-
-            self.promptForString("Plan [full/limited]", "mas_app_plan_optimizer", default="full", validator=OptimizerInstallPlanValidator())
+            if self.isSNO():
+                self.printDescription(["Using Optimizer 'limited' plan as it is being installed in a single node cluster"])
+                self.setParam("mas_app_plan_optimizer", "limited")
+            else:
+                self.printDescription(["Customize your Optimizer installation, 'full' and 'limited' install plans are available, refer to the product documentation for more information"])
+                self.promptForString("Plan [full/limited]", "mas_app_plan_optimizer", default="full", validator=OptimizerInstallPlanValidator())
 
     @logMethodCall
     def predictSettings(self) -> None:
@@ -904,16 +907,15 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
 
                 if value != "":
                     valueParts = value.split(":")
-                    if len(valueParts) != 4:
-                        self.fatalError(f"Unsupported format for {key} ({value}).  Expected APPROVAL_KEY:MAX_RETRIES:RETRY_DELAY:IGNORE_FAILURE")
+                    if len(valueParts) != 3:
+                        self.fatalError(f"Unsupported format for {key} ({value}).  Expected MAX_RETRIES:RETRY_DELAY:IGNORE_FAILURE")
                     else:
                         try:
-                            self.approvals[key]["approvalKey"] = valueParts[0]
-                            self.approvals[key]["maxRetries"] = int(valueParts[1])
-                            self.approvals[key]["retryDelay"] = int(valueParts[2])
-                            self.approvals[key]["ignoreFailure"] = bool(valueParts[3])
+                            self.approvals[key]["maxRetries"] = int(valueParts[0])
+                            self.approvals[key]["retryDelay"] = int(valueParts[1])
+                            self.approvals[key]["ignoreFailure"] = bool(valueParts[2])
                         except ValueError:
-                            self.fatalError(f"Unsupported format for {key} ({value}).  Expected string:int:int:boolean")
+                            self.fatalError(f"Unsupported format for {key} ({value}).  Expected int:int:boolean")
 
             # Arguments that we don't need to do anything with
             elif key in ["accept_license", "dev_mode", "skip_pre_check", "skip_grafana_install", "no_confirm", "no_wait_for_pvc", "help", "advanced", "simplified"]:
@@ -979,6 +981,10 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             print_formatted_text(HTML("<Red>Error: The Kubernetes dynamic Client is not available.  See log file for details</Red>"))
             exit(1)
 
+        # Perform a check whether the cluster is set up for airgap install, this will trigger an early failure if the cluster is using the now
+        # deprecated MaximoApplicationSuite ImageContentSourcePolicy instead of the new ImageDigestMirrorSet
+        self.isAirgap()
+
         # Configure the installOptions for the appropriate architecture
         self.catalogOptions = supportedCatalogs[self.architecture]
 
@@ -1094,11 +1100,11 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
          - present with the chosen state field initialized to ""
         """
         for approval in self.approvals.values():
-            if "approvalKey" in approval:
+            if "maxRetries" in approval:
                 # Enable this approval workload
-                logger.debug(f"Approval workflow for {approval['id']} will be enabled during install ({approval['maxRetries']} / {approval['retryDelay']}s / {approval['approvalKey']} / {approval['ignoreFailure']})")
-                self.initializeApprovalConfigMap(namespace, approval['id'], approval['approvalKey'], approval['maxRetries'], approval['retryDelay'], approval['ignoreFailure'])
+                logger.debug(f"Approval workflow for {approval['id']} will be enabled during install ({approval['maxRetries']} / {approval['retryDelay']}s / {approval['ignoreFailure']})")
+                self.initializeApprovalConfigMap(namespace, approval['id'], True, approval['maxRetries'], approval['retryDelay'], approval['ignoreFailure'])
             else:
                 # Disable this approval workload
                 logger.debug(f"Approval workflow for {approval['id']} will be disabled during install")
-                self.initializeApprovalConfigMap(namespace, approval['id'])
+                self.initializeApprovalConfigMap(namespace, approval['id'], False)

mas/cli/install/argBuilder.py

@@ -102,9 +102,13 @@ class installArgBuilderMixin():
             command += f"  --domain \"{self.getParam('mas_domain')}\"{newline}"
 
         if self.getParam('--dns-provider') == "cis":
-            command += f"  --dns-provider cis --cis-apikey \"{self.getParam('cis_apikey')}"
-            command += f" --cis-subdomain \"{self.getParam('cis_subdomain')}"
-            command += f" --cis-crn \"{self.getParam('cis_crn')}\"{newline}"
+            command += f"  --dns-provider cis --cis-apikey \"{self.getParam('cis_apikey')}\""
+            command += f" --cis-subdomain \"{self.getParam('cis_subdomain')}\""
+            command += f" --cis-crn \"{self.getParam('cis_crn')}\""
+            command += f" --cis-email \"{self.getParam('cis_email')}\"{newline}"
+
+        if self.getParam('--mas-cluster-issuer') != "":
+            command += f"  --mas-cluster-issuer \"{self.getParam('mas_cluster_issuer')}\"{newline}"
 
         if self.getParam('mas_enable_walkme') == "false":
             command += f"  --disable-walkme{newline}"
@@ -212,6 +216,12 @@ class installArgBuilderMixin():
             if self.getParam('mas_app_settings_server_timezone') != "":
                 command += f"  --manage-server-timezone \"{self.getParam('mas_app_settings_server_timezone')}\"{newline}"
 
+            if self.getParam('mas_manage_attachments_provider') != "":
+                command += f"  --manage-attachments-provider \"{self.getParam('mas_manage_attachments_provider')}\"{newline}"
+
+            if self.getParam('mas_manage_attachment_configuration_mode') != "":
+                command += f"  --manage-attachments-mode \"{self.getParam('mas_manage_attachment_configuration_mode')}\"{newline}"
+
         # IBM Cloud Pak for Data
         # -----------------------------------------------------------------------------
         if self.getParam('cpd_product_version') != "":
@@ -321,6 +331,10 @@ class installArgBuilderMixin():
                 command += f" --cos-resourcegroup \"{self.getParam('cos_resourcegroup')}\""
             if self.getParam('cos_apikey') != "":
                 command += f" --cos-apikey \"{self.getParam('cos_apikey')}\""
+            if self.getParam('cos_instance_name') != "":
+                command += f" --cos-instance-name \"{self.getParam('cos_instance_name')}\""
+            if self.getParam('cos_bucket_name') != "":
+                command += f" --cos-bucket-name \"{self.getParam('cos_bucket_name')}\"{newline}"
             command += newline
 
         # Turbonomic Integration

mas/cli/install/argParser.py

@@ -188,6 +188,13 @@ masAdvancedArgGroup.add_argument(
     choices=["cloudflare", "cis", "route53"]
 )
 
+masAdvancedArgGroup.add_argument(
+    "--mas-cluster-issuer",
+    dest="mas_cluster_issuer",
+    required=False,
+    help="Provide the name of the ClusterIssuer to configure MAS to issue certificates",
+)
+
 # DNS Configuration - IBM CIS
 # -----------------------------------------------------------------------------
 cisArgGroup = installArgParser.add_argument_group("DNS Configuration - CIS")
@@ -519,7 +526,7 @@ manageArgGroup.add_argument(
     "--manage-jms",
     dest="mas_app_settings_default_jms",
     required=False,
-    help="",
+    help="Set JMS configuration",
     action="store_const",
     const="true"
 )
@@ -651,6 +658,22 @@ manageArgGroup.add_argument(
     help="Manage server timezone. Default is `GMT`"
 )
 
+# Manage Attachments
+# -----------------------------------------------------------------------------
+manageArgGroup.add_argument(
+    "--manage-attachments-provider",
+    dest="mas_manage_attachments_provider",
+    required=False,
+    help="Defines the storage provider type to be used to store attachments in Maximo Manage"
+)
+manageArgGroup.add_argument(
+    "--manage-attachments-mode",
+    dest="mas_manage_attachment_configuration_mode",
+    required=False,
+    help="Defines how attachment properties will be configured in Manage. Possible values are: cr and db",
+    choices=["cr", "db"]
+)
+
 # IBM Cloud Pak for Data
 # -----------------------------------------------------------------------------
 cpdAppsArgGroup = installArgParser.add_argument_group("IBM Cloud Pak for Data")
@@ -927,6 +950,18 @@ cosArgGroup.add_argument(
     required=False,
     help="When using IBM COS, set COS priviledged apikey for IBM Cloud"
 )
+cosArgGroup.add_argument(
+    "--cos-instance-name",
+    dest="cos_instance_name",
+    required=False,
+    help="When using IBM COS, set COS instance name to be used/created"
+)
+cosArgGroup.add_argument(
+    "--cos-bucket-name",
+    dest="cos_bucket_name",
+    required=False,
+    help="When using IBM COS, set COS bucket name to be used/created"
+)
 
 # Turbonomic Integration
 # -----------------------------------------------------------------------------
@@ -1007,7 +1042,7 @@ devArgGroup.add_argument(
 
 # Approvals
 # -----------------------------------------------------------------------------
-approvalsGroup = installArgParser.add_argument_group("Integrated Approval Workflow (APPROVAL_KEY:MAX_RETRIES:RETRY_DELAY:IGNORE_FAILURE)")
+approvalsGroup = installArgParser.add_argument_group("Integrated Approval Workflow (MAX_RETRIES:RETRY_DELAY:IGNORE_FAILURE)")
 approvalsGroup.add_argument(
     "--approval-core",
     default="",

mas/cli/install/catalogs.py

@@ -9,12 +9,13 @@
 # *****************************************************************************
 supportedCatalogs = {
     "amd64": [
+        "v9-250109-amd64",
         "v9-241205-amd64",
         "v9-241107-amd64",
         "v9-241003-amd64",
-        "v9-240827-amd64",
     ],
     "s390x": [
+        "v9-250109-s390x",
         "v9-241205-s390x",
         "v9-241107-s390x",
     ],

mas/cli/install/params.py

@@ -67,6 +67,7 @@ optionalParams = [
     "cis_apikey",
     "cis_crn",
     "cis_subdomain",
+    "mas_cluster_issuer",
     # DRO
     "dro_namespace",
     # MongoDb
@@ -115,6 +116,11 @@ optionalParams = [
     "cos_type",
     "cos_resourcegroup",
     "cos_apikey",
+    "cos_instance_name",
+    "cos_bucket_name",
+    # Attachments
+    "mas_manage_attachments_provider",
+    "mas_manage_attachment_configuration_mode",
     # ECK
     "eck_action",
     "eck_enable_logstash",

mas/cli/install/settings/turbonomicSettings.py

@@ -8,8 +8,6 @@
 #
 # *****************************************************************************
 
-from mas.devops.mas import isAirgapInstall
-
 
 class TurbonomicSettingsMixin():
 
@@ -21,7 +19,7 @@ class TurbonomicSettingsMixin():
                 " - Learn more: <Orange><u>https://www.ibm.com/products/turbonomic</u></Orange>"
             ])
 
-            if isAirgapInstall(self.dynamicClient):
+            if self.isAirgap():
                 self.printHighlight("The Turbonomic Kubernetes Operator does not support disconnected installation at this time")
             elif self.yesOrNo("Configure IBM Turbonomic integration"):
                 self.promptForString("Turbonomic Target Name", "turbonomic_target_name")

mas/cli/install/summarizer.py

@@ -11,7 +11,6 @@
 import logging
 import yaml
 from prompt_toolkit import print_formatted_text, HTML
-from mas.devops.mas import isAirgapInstall
 from mas.devops.ocp import getConsoleURL
 
 logger = logging.getLogger(__name__)
@@ -46,7 +45,7 @@ class InstallSummarizerMixin():
 
         print()
         self.printSummary("Operational Mode", operationalModeNames[self.operationalMode])
-        if isAirgapInstall(self.dynamicClient):
+        if self.isAirgap():
             self.printSummary("Install Mode", "Disconnected Install")
         else:
             self.printSummary("Install Mode", "Connected Install")