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

mas/cli/install/params.py

@@ -29,6 +29,7 @@ requiredParams = [
 optionalParams = [
     # Pipeline
     "image_pull_policy",
+    "service_account_name",
     # OpenShift
     "ocp_ingress_tls_secret_name",
     # MAS
@@ -37,6 +38,7 @@ optionalParams = [
     "mas_superuser_password",
     "mas_trust_default_cas",
     "mas_app_settings_server_bundles_size",
+    "is_full_manage",
     "mas_app_settings_default_jms",
     "mas_app_settings_persistent_volumes_flag",
     "mas_app_settings_demodata",
@@ -57,7 +59,10 @@ optionalParams = [
     "mas_app_settings_server_timezone",
     "mas_appws_bindings_jdbc_manage",
     "mas_appws_components",
+    "mas_appws_bindings_health_wsl_flag",
     "mas_domain",
+    # IPV6
+    "enable_ipv6",
     # SLS
     "sls_namespace",
     # DNS Providers
@@ -67,13 +72,13 @@ optionalParams = [
     "cis_apikey",
     "cis_crn",
     "cis_subdomain",
+    "mas_cluster_issuer",
     # DRO
     "dro_namespace",
-    # MongoDb
-    "mongodb_namespace",
     # Db2
     "db2_action_system",
     "db2_action_manage",
+    "db2_action_facilities",
     "db2_type",
     "db2_timezone",
     "db2_namespace",
@@ -95,8 +100,10 @@ optionalParams = [
     # CP4D
     "cpd_product_version",
     "cpd_install_cognos",
-    "cpd_install_openscale",
     "cpd_install_spss",
+    "cpd_install_ws",
+    "cpd_install_wml",
+    "cpd_install_ae",
     # Kafka
     "kafka_namespace",
     "kafka_version",
@@ -108,13 +115,18 @@ optionalParams = [
     "aws_msk_cidr_az3",
     "aws_msk_egress_cidr",
     "aws_msk_ingress_cidr",
-    "eventstreams_resource_group",
-    "eventstreams_instance_name",
-    "eventstreams_instance_location",
+    "eventstreams_resourcegroup",
+    "eventstreams_name",
+    "eventstreams_location",
     # COS
     "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",
@@ -164,6 +176,20 @@ optionalParams = [
     "mas_aibroker_db_secret_name",
     "mas_aibroker_db_secret_key",
     "mas_aibroker_db_secret_value",
+    # Facilities
+    "mas_ws_facilities_size",
+    "mas_ws_facilities_routes_timeout",
+    "mas_ws_facilities_liberty_extension_XML",
+    "mas_ws_facilities_vault_secret",
+    "mas_ws_facilities_pull_policy",
+    "mas_ws_facilities_storage_log_class",
+    "mas_ws_facilities_storage_log_mode",
+    "mas_ws_facilities_storage_log_size",
+    "mas_ws_facilities_storage_userfiles_class",
+    "mas_ws_facilities_storage_userfiles_mode",
+    "mas_ws_facilities_storage_userfiles_size",
+    "mas_ws_facilities_dwfagents",
+    "mas_ws_facilities_db_maxconnpoolsize",
     # Special chars
     "mas_special_characters"
 ]

mas/cli/install/settings/additionalConfigs.py

@@ -89,7 +89,7 @@ class AdditionalConfigsMixin():
             elif podTemplateChoice == 2:
                 self.setParam("mas_pod_templates_dir", path.join(self.templatesDir, "pod-templates", "best-effort"))
             elif podTemplateChoice == 3:
-                self.promptForDir("Pod templates directory", "mas_pod_templates_dir", mustExist=True)
+                self.setParam("mas_pod_templates_dir", self.promptForDir("Pod templates directory", mustExist=True))
             else:
                 self.fatalError(f"Invalid selection: {podTemplateChoice}")
 
@@ -163,6 +163,10 @@ class AdditionalConfigsMixin():
                 "mas_app_channel_optimizer": {
                     "dir": self.manualCertsDir + "/optimizer/",
                     "keyPrefix": "optimizer."
+                },
+                "mas_app_channel_facilities": {
+                    "dir": self.manualCertsDir + "/facilities/",
+                    "keyPrefix": "facilities."
                 }
             }
 
@@ -182,6 +186,19 @@ class AdditionalConfigsMixin():
 
             self.certsSecret = certsSecret
 
+    def slsLicenseFile(self) -> None:
+        if self.slsLicenseFileLocal:
+            slsLicenseFileSecret = {
+                "apiVersion": "v1",
+                "kind": "Secret",
+                "type": "Opaque",
+                "metadata": {
+                    "name": "pipeline-sls-entitlement"
+                }
+            }
+            self.setParam("sls_entitlement_file", f"/workspace/entitlement/{path.basename(self.slsLicenseFileLocal)}")
+            self.slsLicenseFileSecret = self.addFilesToSecret(slsLicenseFileSecret, self.slsLicenseFileLocal, '')
+
     def addFilesToSecret(self, secretDict: dict, configPath: str, extension: str, keyPrefix: str = '') -> dict:
         """
         Add file (or files) to pipeline-additional-configs

mas/cli/install/settings/db2Settings.py

@@ -13,23 +13,28 @@ from prompt_toolkit import print_formatted_text
 
 
 class Db2SettingsMixin():
-    def configDb2(self) -> None:
-        self.printH1("Configure Databases")
+    # In silentMode, no prompts will show up for "happy path" DB2 configuration scenarios. Prompts will still show up when an input is absolutely required
+    # Settings under showAdvancedOptions are always prompted
+    def configDb2(self, silentMode=False) -> None:
+        if not silentMode:
+            self.printH1("Configure Databases")
         # The channel used for Db2 used has not changed since the January 2024 catalog update
         self.params["db2_channel"] = "v110509.0"
 
-        # If neither Iot or Manage is being installed, we have nothing to do
-        if not self.installIoT and not self.installManage:
+        # If neither Iot, Manage or Facilities is being installed, we have nothing to do
+        if not self.installIoT and not self.installManage and not self.installFacilities:
             print_formatted_text("No applications have been selected that require a Db2 installation")
             self.setParam("db2_action_system", "none")
             self.setParam("db2_action_manage", "none")
+            self.setParam("db2_action_facilities", "none")
             return
 
-        # For now we are limiting users to bring your own database for Manage on s390x
-        # Eventually we will be able to remove this clause and allow the standard logic to work for both s390x and amd64
-        if self.architecture == "s390x" and self.installManage:
+        # For now we are limiting users to bring your own database for Manage on s390x & ppc64le
+        # Eventually we will be able to remove this clause and allow the standard logic to work for s390x, ppc64le and amd64
+        if (self.architecture == "s390x" or self.architecture == "ppc64le") and self.installManage:
+            # silentMode does not apply for s390x/ppc64le because it requires interaction when selecting local config directory
             self.printDescription([
-                "Installation of a Db2 instance using the IBM Db2 Universal Operator is not currently supported on s390x, please provide configuration details for the database you wish to use.",
+                "Installation of a Db2 instance using the IBM Db2 Universal Operator is not currently supported on s390x /ppc64le, please provide configuration details for the database you wish to use.",
             ])
             instanceId = self.getParam('mas_instance_id')
             workspaceId = self.getParam("mas_workspace_id")
@@ -40,58 +45,37 @@ class Db2SettingsMixin():
 
             # Check if a configuration already exists before creating a new one
             jdbcCfgFile = path.join(self.localConfigDir, f"jdbc-{instanceId}-manage.yaml")
-            print_formatted_text(f"Searching for Manage database configuration file in {jdbcCfgFile} ...")
+            print_formatted_text(f"Searching for {self.manageAppName} database configuration file in {jdbcCfgFile} ...")
             if path.exists(jdbcCfgFile):
-                if self.yesOrNo(f"Manage database configuration file 'jdbc-{instanceId}-manage.yaml' already exists.  Do you want to generate a new one"):
+                if self.yesOrNo(f"{self.manageAppName} database configuration file 'jdbc-{instanceId}-manage.yaml' already exists.  Do you want to generate a new one"):
                     self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="manage", destination=jdbcCfgFile)
             else:
-                print_formatted_text(f"Expected file ({jdbcCfgFile}) was not found, generating a valid Manage database configuration file now ...")
+                print_formatted_text(f"Expected file ({jdbcCfgFile}) was not found, generating a valid {self.manageAppName} database configuration file now ...")
                 self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="manage", destination=jdbcCfgFile)
             return
 
         # Proceed as normal
-        # We know we are installing either IoT or Manage, and on amd64 target architecture
-        self.printDescription([
-            "The installer can setup one or more IBM Db2 instances in your OpenShift cluster for the use of applications that require a JDBC datasource (IoT, Manage, Monitor, & Predict) or you may choose to configure MAS to use an existing database"
-        ])
-
-        self.setParam("db2_cpu_requests", "4000m")
-        self.setParam("db2_cpu_limits", "6000m")
-        self.setParam("db2_memory_requests", "8Gi")
-        self.setParam("db2_memory_limits", "12Gi")
-
-        if self.isSNO():
-            # Set smaller defaults for SNO deployments
-            self.setParam("db2_meta_storage_size", "10Gi")
-            self.setParam("db2_backup_storage_size", "10Gi")
-            self.setParam("db2_logs_storage_size", "10Gi")
-            self.setParam("db2_temp_storage_size", "10Gi")
-            self.setParam("db2_data_storage_size", "20Gi")
-
-            # Configure the access mode to RWO
-            self.params["db2_meta_storage_accessmode"] = "ReadWriteOnce"
-            self.params["db2_backup_storage_accessmode"] = "ReadWriteOnce"
-            self.params["db2_logs_storage_accessmode"] = "ReadWriteOnce"
-            self.params["db2_data_storage_accessmode"] = "ReadWriteOnce"
+        # We know we are installing either IoT, Manage or Facilities, and on amd64 target architecture
+        if not silentMode:
+            self.printDescription([
+                f"The installer can setup one or more IBM Db2 instances in your OpenShift cluster for the use of applications that require a JDBC datasource (IoT, {self.manageAppName}, Monitor, & Predict, Real Estate and Facilities) or you may choose to configure MAS to use an existing database"
+            ])
 
-            # Also reduce the CPU requests
-            self.params["db2_cpu_requests"] = "300m"
-        else:
-            self.setParam("db2_meta_storage_size", "20Gi")
-            self.setParam("db2_backup_storage_size", "100Gi")
-            self.setParam("db2_logs_storage_size", "100Gi")
-            self.setParam("db2_temp_storage_size", "100Gi")
-            self.setParam("db2_data_storage_size", "100Gi")
+        self.setDB2DefaultSettings()
 
         instanceId = self.getParam('mas_instance_id')
         # Do we need to set up an IoT database?
         if self.installIoT:
-            self.printH2("Database Configuration for Maximo IoT")
-            self.printDescription([
-                "Maximo IoT requires a shared system-scope Db2 instance because others application in the suite require access to the same database source",
-                " - Only IBM Db2 is supported for this database"
-            ])
-            if self.yesOrNo("Create system Db2 instance using the IBM Db2 Universal Operator"):
+            if not silentMode:
+                self.printH2("Database Configuration for Maximo IoT")
+                self.printDescription([
+                    "Maximo IoT requires a shared system-scope Db2 instance because others application in the suite require access to the same database source",
+                    " - Only IBM Db2 is supported for this database"
+                ])
+            createSystemDb2UsingUniversalOperator = True
+            if not silentMode:
+                createSystemDb2UsingUniversalOperator = self.yesOrNo("Create system Db2 instance using the IBM Db2 Universal Operator")
+            if createSystemDb2UsingUniversalOperator:
                 self.setParam("db2_action_system", "install")
             else:
                 self.setParam("db2_action_system", "byo")
@@ -111,28 +95,39 @@ class Db2SettingsMixin():
             self.setParam("db2_action_system", "none")
 
         if self.installManage:
-            self.printH2("Database Configuration for Maximo Manage")
-            self.printDescription([
-                "Maximo Manage can be configured to share the system Db2 instance or use it's own dedicated database:",
-                " - Use of a shared instance has a significant footprint reduction but is only recommended for development/test/demo installs",
-                " - In most production systems you will want to use a dedicated database",
-                " - IBM Db2, Oracle Database, & Microsoft SQL Server are all supported database options"
-            ])
+            if not silentMode:
+                self.printH2(f"Database Configuration for Maximo {self.manageAppName}")
+                self.printDescription([
+                    f"Maximo {self.manageAppName} can be configured to share the system Db2 instance or use it's own dedicated database:",
+                    " - Use of a shared instance has a significant footprint reduction but is only recommended for development/test/demo installs",
+                    " - In most production systems you will want to use a dedicated database",
+                    " - IBM Db2, Oracle Database, & Microsoft SQL Server are all supported database options"
+                ])
             # Determine whether to use the system or a dedicated database
-            if self.installIoT and self.yesOrNo("Re-use System Db2 instance for Manage application"):
+            reuseSystemDb2 = False
+            if self.installIoT:
+                if not silentMode:
+                    reuseSystemDb2 = self.yesOrNo(f"Re-use System Db2 instance for {self.manageAppName} application")
+            if reuseSystemDb2:
                 # We are going to bind Manage to the system database, which has already been set up in the previous step
                 self.setParam("mas_appws_bindings_jdbc_manage", "system")
                 self.setParam("db2_action_manage", "none")
             else:
                 self.setParam("mas_appws_bindings_jdbc_manage", "workspace-application")
-                if self.yesOrNo("Create manage dedicated Db2 instance using the IBM Db2 Universal Operator"):
+                createSystemDb2UsingUniversalOperator = True
+                if not silentMode:
+                    createSystemDb2UsingUniversalOperator = self.yesOrNo(f"Create {self.manageAppName} dedicated Db2 instance using the IBM Db2 Universal Operator")
+                if createSystemDb2UsingUniversalOperator:
                     self.setParam("db2_action_manage", "install")
-                    self.printDescription([
-                        "Available Db2 instance types for Manage:",
-                        "  1. DB2 Warehouse (Default option)",
-                        "  2. DB2 Online Transactional Processing (OLTP)"
-                    ])
-                    self.promptForListSelect(message="Select the Manage dedicated DB2 instance type", options=["db2wh", "db2oltp"], param="db2_type", default="1")
+                    if not silentMode:
+                        self.printDescription([
+                            f"Available Db2 instance types for {self.manageAppName}:",
+                            "  1. DB2 Warehouse (Default option)",
+                            "  2. DB2 Online Transactional Processing (OLTP)"
+                        ])
+                        self.promptForListSelect(message=f"Select the {self.manageAppName} dedicated DB2 instance type", options=["db2wh", "db2oltp"], param="db2_type", default="1")
+                    else:
+                        self.setParam("db2_type", "db2wh")
                 else:
                     workspaceId = self.getParam("mas_workspace_id")
                     self.setParam("db2_action_manage", "byo")
@@ -141,18 +136,41 @@ class Db2SettingsMixin():
 
                     # Check if a configuration already exists before creating a new one
                     jdbcCfgFile = path.join(self.localConfigDir, f"jdbc-{instanceId}-manage.yaml")
-                    print_formatted_text(f"Searching for Manage database configuration file in {jdbcCfgFile} ...")
+                    print_formatted_text(f"Searching for {self.manageAppName} database configuration file in {jdbcCfgFile} ...")
                     if path.exists(jdbcCfgFile):
-                        if self.yesOrNo(f"Manage database configuration file 'jdbc-{instanceId}-manage.yaml' already exists.  Do you want to generate a new one"):
+                        if self.yesOrNo(f"{self.manageAppName} database configuration file 'jdbc-{instanceId}-manage.yaml' already exists.  Do you want to generate a new one"):
                             self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="manage", destination=jdbcCfgFile)
                     else:
-                        print_formatted_text(f"Expected file ({jdbcCfgFile}) was not found, generating a valid Manage database configuration file now ...")
+                        print_formatted_text(f"Expected file ({jdbcCfgFile}) was not found, generating a valid {self.manageAppName} database configuration file now ...")
                         self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="manage", destination=jdbcCfgFile)
         else:
             self.setParam("db2_action_manage", "none")
 
+        # Do we need to create and configure a Db2 for Facilities ?
+        if self.installFacilities:
+            self.printH2("Database Configuration for Maximo Real Estate and Facilities")
+            if self.yesOrNo("Create Real Estate and Facilities dedicated Db2 instance using the IBM Db2 Universal Operator"):
+                self.setParam("db2_action_facilities", "install")
+            else:
+                self.setParam("db2_action_facilities", "none")
+                instanceId = self.getParam('mas_instance_id')
+                workspaceId = self.getParam("mas_workspace_id")
+                self.selectLocalConfigDir()
+
+                # Check if a configuration already exists before creating a new one
+                jdbcCfgFile = path.join(self.localConfigDir, f"jdbc-{instanceId}-facilities.yaml")
+                print_formatted_text(f"Searching for Real Estate and Facilities database configuration file in {jdbcCfgFile} ...")
+                if path.exists(jdbcCfgFile):
+                    if self.yesOrNo(f"Real Estate and Facilities database configuration file 'jdbc-{instanceId}-facilities.yaml' already exists.  Do you want to generate a new one"):
+                        self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="facilities", destination=jdbcCfgFile)
+                else:
+                    print_formatted_text(f"Expected file ({jdbcCfgFile}) was not found, generating a valid Real Estate and Facilities database configuration file now ...")
+                    self.generateJDBCCfg(instanceId=instanceId, scope="workspace-application", workspaceId=workspaceId, appId="facilities", destination=jdbcCfgFile)
+        else:
+            self.setParam("db2_action_facilities", "none")
+
         # Do we need to configure Db2u?
-        if self.getParam("db2_action_system") == "install" or self.getParam("db2_action_manage") == "install":
+        if self.getParam("db2_action_system") == "install" or self.getParam("db2_action_manage") == "install" or self.getParam("db2_action_facilities") == "install":
             if self.showAdvancedOptions:
                 self.printH2("Installation Namespace")
                 self.promptForString("Install namespace", "db2_namespace", default="db2u")
@@ -161,11 +179,13 @@ class Db2SettingsMixin():
                 # -------------------------------------------------------------------------
                 self.printH2("Node Affinity and Tolerations")
                 self.printDescription([
-                    "Note that the same settings are applied to both the IoT and Manage Db2 instances",
+                    f"Note that the same settings are applied to both the IoT and {self.manageAppName} Db2 instances",
                     "Use existing node labels and taints to control scheduling of the Db2 workload in your cluster",
                     "For more information refer to the Red Hat documentation:",
-                    " - <Orange><u>https://docs.openshift.com/container-platform/4.16/nodes/scheduling/nodes-scheduler-node-affinity.html</u></Orange>",
-                    " - <Orange><u>https://docs.openshift.com/container-platform/4.16/nodes/scheduling/nodes-scheduler-taints-tolerations.html</u></Orange>"
+                    " - <Orange><u>https://docs.openshift.com/container-platform/4.18/nodes/scheduling/nodes-scheduler-node-affinity.html</u></Orange>",
+                    " - <Orange><u>https://docs.openshift.com/container-platform/4.18/nodes/scheduling/nodes-scheduler-taints-tolerations.html</u></Orange>",
+                    " - <Orange><u>https://docs.openshift.com/container-platform/4.17/nodes/scheduling/nodes-scheduler-node-affinity.html</u></Orange>",
+                    " - <Orange><u>https://docs.openshift.com/container-platform/4.17/nodes/scheduling/nodes-scheduler-taints-tolerations.html</u></Orange>"
                 ])
 
                 if self.yesOrNo("Configure node affinity"):
@@ -179,7 +199,7 @@ class Db2SettingsMixin():
 
                 self.printH2("Database CPU & Memory")
                 self.printDescription([
-                    "Note that the same settings are applied to both the IoT and Manage Db2 instances"
+                    f"Note that the same settings are applied to both the IoT and {self.manageAppName} Db2 instances"
                 ])
 
                 if self.yesOrNo("Customize CPU and memory request/limit"):
@@ -190,7 +210,7 @@ class Db2SettingsMixin():
 
                 self.printH2("Database Storage Capacity")
                 self.printDescription([
-                    "Note that the same settings are applied to both the IoT and Manage Db2 instances"
+                    f"Note that the same settings are applied to both the IoT and {self.manageAppName} Db2 instances"
                 ])
 
                 if self.yesOrNo("Customize storage capacity"):
@@ -201,3 +221,32 @@ class Db2SettingsMixin():
                     self.promptForString(" + Backup Volume", "db2_backup_storage_size", default=self.getParam("db2_backup_storage_size"))
             else:
                 self.setParam("db2_namespace", "db2u")
+
+    def setDB2DefaultSettings(self) -> None:
+
+        self.setParam("db2_cpu_requests", "4000m")
+        self.setParam("db2_cpu_limits", "6000m")
+        self.setParam("db2_memory_requests", "8Gi")
+        self.setParam("db2_memory_limits", "12Gi")
+
+        if self.isSNO():
+            # Set smaller defaults for SNO deployments
+            self.setParam("db2_meta_storage_size", "10Gi")
+            self.setParam("db2_backup_storage_size", "10Gi")
+            self.setParam("db2_logs_storage_size", "10Gi")
+            self.setParam("db2_temp_storage_size", "10Gi")
+            self.setParam("db2_data_storage_size", "20Gi")
+
+            # Configure the access mode to RWO
+            self.params["db2_meta_storage_accessmode"] = "ReadWriteOnce"
+            self.params["db2_backup_storage_accessmode"] = "ReadWriteOnce"
+            self.params["db2_logs_storage_accessmode"] = "ReadWriteOnce"
+            self.params["db2_data_storage_accessmode"] = "ReadWriteOnce"
+            self.params["db2_cpu_requests"] = "300m"
+
+        else:
+            self.setParam("db2_meta_storage_size", "20Gi")
+            self.setParam("db2_backup_storage_size", "100Gi")
+            self.setParam("db2_logs_storage_size", "100Gi")
+            self.setParam("db2_temp_storage_size", "100Gi")
+            self.setParam("db2_data_storage_size", "100Gi")

mas/cli/install/settings/kafkaSettings.py

@@ -47,7 +47,7 @@ class KafkaSettingsMixin():
                     ])
                     if self.showAdvancedOptions:
                         self.promptForString("Strimzi namespace", "kafka_namespace", default="strimzi")
-                    self.promptForString("Kafka version", "kafka_version", default="3.7.0")
+                    self.promptForString("Kafka version", "kafka_version", default="3.9.0")
 
                 elif self.getParam("kafka_provider") == "redhat":
                     self.printDescription([
@@ -58,7 +58,7 @@ class KafkaSettingsMixin():
                         " - If you are using older operator catalogs (e.g. in a disconnected install) you should confirm the supported versions in your OperatorHub"
                     ])
                     self.promptForString("Install namespace", "kafka_namespace", default="amq-streams")
-                    self.promptForString("Kafka version", "kafka_version", default="3.5.0")
+                    self.promptForString("Kafka version", "kafka_version", default="3.8.0")
 
                 elif self.getParam("kafka_provider") == "ibm":
                     print()