mas-cli 11.6.0__py3-none-any.whl → 11.8.0__py3-none-any.whl

mas/cli/install/argBuilder.py

@@ -119,6 +119,8 @@ class installArgBuilderMixin():
         # IBM Suite License Service
         # -----------------------------------------------------------------------------
         command += f"  --license-file \"{self.slsLicenseFileLocal}\"{newline}"
+        if self.getParam("sls_namespace") != "ibm-sls":
+            command += f"  --sls-namespace \"{self.getParam('sls_namespace')}\"{newline}"
 
         # IBM Data Reporting Operator (DRO)
         # -----------------------------------------------------------------------------

mas/cli/install/argParser.py

@@ -250,6 +250,12 @@ slsArgGroup.add_argument(
     help="Path to MAS license file",
     type=lambda x: isValidFile(installArgParser, x)
 )
+slsArgGroup.add_argument(
+    "--sls-namespace",
+    required=False,
+    help="Customize the SLS install namespace",
+    default="ibm-sls"
+)
 
 # IBM Data Reporting Operator (DRO)
 # -----------------------------------------------------------------------------
@@ -1041,6 +1047,19 @@ approvalsGroup.add_argument(
 # More Options
 # -----------------------------------------------------------------------------
 otherArgGroup = installArgParser.add_argument_group("More")
+otherArgGroup.add_argument(
+    "--advanced",
+    action="store_true",
+    default=False,
+    help="Show advanced install options (in interactve mode)"
+)
+otherArgGroup.add_argument(
+    "--simplified",
+    action="store_true",
+    default=False,
+    help="Don't show advanced install options (in interactve mode)"
+)
+
 otherArgGroup.add_argument(
     "--accept-license",
     action="store_true",

mas/cli/install/catalogs.py

@@ -0,0 +1,141 @@
+# *****************************************************************************
+# 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
+#
+# *****************************************************************************
+
+catalogChoices = {
+    "amd64": [
+        {
+            "#": 1,
+            "catalog": "v9-241107-amd64",
+            "release": "9.0.x",
+            "core": "9.0.5",
+            "assist": "9.0.2",
+            "iot": "9.0.4",
+            "manage": "9.0.5",
+            "monitor": "9.0.4",
+            "optimizer": "9.0.4",
+            "predict": "9.0.2",
+            "inspection": "9.0.4",
+            "aibroker": "9.0.3"
+        },
+        {
+            "#": 2,
+            "catalog": "v9-241107-amd64",
+            "release": "8.11.x",
+            "core": "8.11.16",
+            "assist": "8.8.6",
+            "iot": "8.8.14",
+            "manage": "8.7.13",
+            "monitor": "8.11.12",
+            "optimizer": "8.5.10",
+            "predict": "8.9.5",
+            "inspection": "8.9.7"
+        },
+        {
+            "#": 3,
+            "catalog": "v9-241107-amd64",
+            "release": "8.10.x",
+            "core": "8.10.19",
+            "assist": "8.7.7",
+            "iot": "8.7.18",
+            "manage": "8.6.19",
+            "monitor": "8.10.14",
+            "optimizer": "8.4.11",
+            "predict": "8.8.4",
+            "inspection": "8.8.4"
+        },
+        {
+            "#": 4,
+            "catalog": "v9-241003-amd64",
+            "release": "9.0.x",
+            "core": "9.0.3",
+            "assist": "9.0.2",
+            "iot": "9.0.3",
+            "manage": "9.0.3",
+            "monitor": "9.0.3",
+            "optimizer": "9.0.3",
+            "predict": "9.0.2",
+            "inspection": "9.0.3"
+        },
+        {
+            "#": 5,
+            "catalog": "v9-241003-amd64",
+            "release": "8.11.x",
+            "core": "8.11.15",
+            "assist": "8.8.6",
+            "iot": "8.8.13",
+            "manage": "8.7.12",
+            "monitor": "8.11.11",
+            "optimizer": "8.5.9",
+            "predict": "8.9.5",
+            "inspection": "8.9.6"
+        },
+        {
+            "#": 6,
+            "catalog": "v9-241003-amd64",
+            "release": "8.10.x",
+            "core": "8.10.18",
+            "assist": "8.7.7",
+            "iot": "8.7.17",
+            "manage": "8.6.18",
+            "monitor": "8.10.14",
+            "optimizer": "8.4.10",
+            "predict": "8.8.3",
+            "inspection": "8.8.4"
+        },
+        {
+            "#": 7,
+            "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"
+        },
+        {
+            "#": 8,
+            "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"
+        },
+        {
+            "#": 9,
+            "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"
+        }
+    ],
+    "s390x": [
+        {
+            "#": 1,
+            "catalog": "v9-241107-s390x",
+            "release": "9.0.x",
+            "core": "9.0.5",
+            "manage": "9.0.5"
+        }
+    ]
+}

mas/cli/install/params.py

@@ -0,0 +1,168 @@
+# *****************************************************************************
+# 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
+#
+# *****************************************************************************
+
+requiredParams = [
+    # MAS
+    "mas_catalog_version",
+    "mas_channel",
+    "mas_instance_id",
+    "mas_workspace_id",
+    "mas_workspace_name",
+    # 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",
+    # OpenShift
+    "ocp_ingress_tls_secret_name",
+    # MAS
+    "mas_catalog_digest",
+    "mas_superuser_username",
+    "mas_superuser_password",
+    "mas_trust_default_cas",
+    "mas_app_settings_server_bundles_size",
+    "mas_app_settings_default_jms",
+    "mas_app_settings_persistent_volumes_flag",
+    "mas_app_settings_demodata",
+    "mas_app_settings_customization_archive_name",
+    "mas_app_settings_customization_archive_url",
+    "mas_app_settings_customization_archive_username",
+    "mas_app_settings_customization_archive_password",
+    "mas_app_settings_tablespace",
+    "mas_app_settings_indexspace",
+    "mas_app_settings_db2_schema",
+    "mas_app_settings_crypto_key",
+    "mas_app_settings_cryptox_key",
+    "mas_app_settings_old_crypto_key",
+    "mas_app_settings_old_cryptox_key",
+    "mas_app_settings_override_encryption_secrets_flag",
+    "mas_app_settings_base_lang",
+    "mas_app_settings_secondary_langs",
+    "mas_app_settings_server_timezone",
+    "mas_appws_bindings_jdbc_manage",
+    "mas_appws_components",
+    "mas_domain",
+    # SLS
+    "sls_namespace",
+    # DNS Providers
+    # TODO: Add CloudFlare and Route53 support
+    "dns_provider",
+    "cis_email",
+    "cis_apikey",
+    "cis_crn",
+    "cis_subdomain",
+    # DRO
+    "dro_namespace",
+    # MongoDb
+    "mongodb_namespace",
+    # Db2
+    "db2_action_system",
+    "db2_action_manage",
+    "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",
+    # CP4D
+    "cpd_product_version",
+    "cpd_install_cognos",
+    "cpd_install_openscale",
+    "cpd_install_spss",
+    # Kafka
+    "kafka_namespace",
+    "kafka_version",
+    "aws_msk_instance_type",
+    "aws_msk_instance_number",
+    "aws_msk_volume_size",
+    "aws_msk_cidr_az1",
+    "aws_msk_cidr_az2",
+    "aws_msk_cidr_az3",
+    "aws_msk_egress_cidr",
+    "aws_msk_ingress_cidr",
+    "eventstreams_resource_group",
+    "eventstreams_instance_name",
+    "eventstreams_instance_location",
+    # COS
+    "cos_type",
+    "ibmcos_resourcegroup",
+    # ECK
+    "eck_action",
+    "eck_enable_logstash",
+    "eck_remote_es_hosts",
+    "eck_remote_es_username",
+    "eck_remote_es_password",
+    # Turbonomic
+    "turbonomic_target_name",
+    "turbonomic_server_url",
+    "turbonomic_server_version",
+    "turbonomic_username",
+    "turbonomic_password",
+    # Cloud Providers
+    "ibmcloud_apikey",
+    "aws_region",
+    "aws_access_key_id",
+    "secret_access_key",
+    "aws_vpc_id",
+    # Dev Mode
+    "artifactory_username",
+    "artifactory_token",
+    # TODO: The way arcgis has been implemented needs to be fixed
+    "install_arcgis",
+    "mas_arcgis_channel",
+    # Guided Tour
+    "mas_enable_walkme",
+    # 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",
+    # Special chars
+    "mas_special_characters"
+]

mas/cli/install/settings/__init__.py

@@ -9,13 +9,14 @@
 # *****************************************************************************
 
 from .db2Settings import Db2SettingsMixin
+from .mongodbSettings import MongoDbSettingsMixin
 from .kafkaSettings import KafkaSettingsMixin
 from .manageSettings import ManageSettingsMixin
 from .turbonomicSettings import TurbonomicSettingsMixin
 from .additionalConfigs import AdditionalConfigsMixin
 
 
-class InstallSettingsMixin(Db2SettingsMixin, KafkaSettingsMixin, ManageSettingsMixin, TurbonomicSettingsMixin, AdditionalConfigsMixin):
+class InstallSettingsMixin(Db2SettingsMixin, MongoDbSettingsMixin, KafkaSettingsMixin, ManageSettingsMixin, TurbonomicSettingsMixin, AdditionalConfigsMixin):
     """
     This class collects all the Mixins providing interactive prompts for mas-install
     """

mas/cli/install/settings/additionalConfigs.py

@@ -63,7 +63,7 @@ class AdditionalConfigsMixin():
             self.additionalConfigsSecret = additionalConfigsSecret
 
     def podTemplates(self) -> None:
-        if self.interactiveMode:
+        if self.interactiveMode and self.showAdvancedOptions:
             self.printH1("Configure Pod Templates")
             self.printDescription([
                 "The CLI supports two pod template profiles out of the box that allow you to reconfigure MAS for either a guaranteed or best effort QoS level",

mas/cli/install/settings/db2Settings.py

@@ -18,12 +18,39 @@ class Db2SettingsMixin():
         # 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:
             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")
             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:
+            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.",
+            ])
+            instanceId = self.getParam('mas_instance_id')
+            workspaceId = self.getParam("mas_workspace_id")
+
+            self.setParam("mas_appws_bindings_jdbc_manage", "workspace-application")
+            self.setParam("db2_action_manage", "byo")
+            self.selectLocalConfigDir()
+
+            # 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} ...")
+            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"):
+                    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 ...")
+                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"
         ])
@@ -126,48 +153,51 @@ class Db2SettingsMixin():
 
         # Do we need to configure Db2u?
         if self.getParam("db2_action_system") == "install" or self.getParam("db2_action_manage") == "install":
-            self.printH2("Installation Namespace")
-            self.promptForString("Install namespace", "db2_namespace", default="db2u")
-
-            # Node Affinity & Tolerations
-            # -------------------------------------------------------------------------
-            self.printH2("Node Affinity and Tolerations")
-            self.printDescription([
-                "Note that the same settings are applied to both the IoT and Manage 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:",
-                " - <u>https://docs.openshift.com/container-platform/4.12/nodes/scheduling/nodes-scheduler-node-affinity.html</u>",
-                " - <u>https://docs.openshift.com/container-platform/4.12/nodes/scheduling/nodes-scheduler-taints-tolerations.html</u>"
-            ])
-
-            if self.yesOrNo("Configure node affinity"):
-                self.promptForString(" + Key", "db2_affinity_key")
-                self.promptForString(" + Value", "db2_affinity_value")
-
-            if self.yesOrNo("Configure node tolerations"):
-                self.promptForString(" + Key", "db2_tolerate_key")
-                self.promptForString(" + Value", "db2_tolerate_value")
-                self.promptForString(" + Effect", "db2_tolerate_effect")
-
-            self.printH2("Database CPU & Memory")
-            self.printDescription([
-                "Note that the same settings are applied to both the IoT and Manage Db2 instances"
-            ])
-
-            if self.yesOrNo("Customize CPU and memory request/limit"):
-                self.promptForString(" + CPU Request", "db2_cpu_requests", default=self.getParam("db2_cpu_requests"))
-                self.promptForString(" + CPU Limit", "db2_cpu_limits", default=self.getParam("db2_cpu_limits"))
-                self.promptForString(" + Memory Request", "db2_memory_requests", default=self.getParam("db2_memory_requests"))
-                self.promptForString(" + Memory Limit", "db2_memory_limits", default=self.getParam("db2_memory_limits"))
-
-            self.printH2("Database Storage Capacity")
-            self.printDescription([
-                "Note that the same settings are applied to both the IoT and Manage Db2 instances"
-            ])
-
-            if self.yesOrNo("Customize storage capacity"):
-                self.promptForString(" + Data Volume", "db2_data_storage_size", default=self.getParam("db2_data_storage_size"))
-                self.promptForString(" + Temporary Volume", "db2_temp_storage_size", default=self.getParam("db2_temp_storage_size"))
-                self.promptForString(" + Metadata Volume", "db2_meta_storage_size", default=self.getParam("db2_meta_storage_size"))
-                self.promptForString(" + Transaction Logs Volume", "db2_logs_storage_size", default=self.getParam("db2_logs_storage_size"))
-                self.promptForString(" + Backup Volume", "db2_backup_storage_size", default=self.getParam("db2_backup_storage_size"))
+            if self.showAdvancedOptions:
+                self.printH2("Installation Namespace")
+                self.promptForString("Install namespace", "db2_namespace", default="db2u")
+
+                # Node Affinity & Tolerations
+                # -------------------------------------------------------------------------
+                self.printH2("Node Affinity and Tolerations")
+                self.printDescription([
+                    "Note that the same settings are applied to both the IoT and Manage 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:",
+                    " - <u>https://docs.openshift.com/container-platform/4.12/nodes/scheduling/nodes-scheduler-node-affinity.html</u>",
+                    " - <u>https://docs.openshift.com/container-platform/4.12/nodes/scheduling/nodes-scheduler-taints-tolerations.html</u>"
+                ])
+
+                if self.yesOrNo("Configure node affinity"):
+                    self.promptForString(" + Key", "db2_affinity_key")
+                    self.promptForString(" + Value", "db2_affinity_value")
+
+                if self.yesOrNo("Configure node tolerations"):
+                    self.promptForString(" + Key", "db2_tolerate_key")
+                    self.promptForString(" + Value", "db2_tolerate_value")
+                    self.promptForString(" + Effect", "db2_tolerate_effect")
+
+                self.printH2("Database CPU & Memory")
+                self.printDescription([
+                    "Note that the same settings are applied to both the IoT and Manage Db2 instances"
+                ])
+
+                if self.yesOrNo("Customize CPU and memory request/limit"):
+                    self.promptForString(" + CPU Request", "db2_cpu_requests", default=self.getParam("db2_cpu_requests"))
+                    self.promptForString(" + CPU Limit", "db2_cpu_limits", default=self.getParam("db2_cpu_limits"))
+                    self.promptForString(" + Memory Request", "db2_memory_requests", default=self.getParam("db2_memory_requests"))
+                    self.promptForString(" + Memory Limit", "db2_memory_limits", default=self.getParam("db2_memory_limits"))
+
+                self.printH2("Database Storage Capacity")
+                self.printDescription([
+                    "Note that the same settings are applied to both the IoT and Manage Db2 instances"
+                ])
+
+                if self.yesOrNo("Customize storage capacity"):
+                    self.promptForString(" + Data Volume", "db2_data_storage_size", default=self.getParam("db2_data_storage_size"))
+                    self.promptForString(" + Temporary Volume", "db2_temp_storage_size", default=self.getParam("db2_temp_storage_size"))
+                    self.promptForString(" + Metadata Volume", "db2_meta_storage_size", default=self.getParam("db2_meta_storage_size"))
+                    self.promptForString(" + Transaction Logs Volume", "db2_logs_storage_size", default=self.getParam("db2_logs_storage_size"))
+                    self.promptForString(" + Backup Volume", "db2_backup_storage_size", default=self.getParam("db2_backup_storage_size"))
+            else:
+                self.setParam("db2_namespace", "db2u")

mas/cli/install/settings/kafkaSettings.py

@@ -24,15 +24,18 @@ class KafkaSettingsMixin():
             if self.yesOrNo("Create system Kafka instance using one of the supported providers"):
                 self.setParam("kafka_action_system", "install")
 
-                self.printDescription([
-                    "",
-                    "Kafka Provider:",
-                    "  1. Strimzi (opensource)",
-                    "  2. Red Hat AMQ Streams (requires a separate license)",
-                    "  3. IBM Cloud Event Streams (paid IBM Cloud service)",
-                    "  4. AWS MSK (paid AWS service)"
-                ])
-                self.promptForListSelect("Select Kafka provider", ["strimzi", "redhat", "ibm", "aws"], "kafka_provider")
+                if self.showAdvancedOptions:
+                    self.printDescription([
+                        "",
+                        "Kafka Provider:",
+                        "  1. Strimzi (opensource)",
+                        "  2. Red Hat AMQ Streams (requires a separate license)",
+                        "  3. IBM Cloud Event Streams (paid IBM Cloud service)",
+                        "  4. AWS MSK (paid AWS service)"
+                    ])
+                    self.promptForListSelect("Select Kafka provider", ["strimzi", "redhat", "ibm", "aws"], "kafka_provider")
+                else:
+                    self.setParam("kafka_provider", "strimzi")
 
                 if self.getParam("kafka_provider") == "strimzi":
                     self.printDescription([
@@ -42,7 +45,8 @@ class KafkaSettingsMixin():
                         " - If you are using the latest available operator catalog then the default version below can be accepted",
                         " - 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="strimzi")
+                    if self.showAdvancedOptions:
+                        self.promptForString("Strimzi namespace", "kafka_namespace", default="strimzi")
                     self.promptForString("Kafka version", "kafka_version", default="3.7.0")
 
                 elif self.getParam("kafka_provider") == "redhat":