mas-cli 11.5.0__py3-none-any.whl → 11.7.0__py3-none-any.whl

mas/cli/install/argBuilder.py

@@ -96,7 +96,15 @@ class installArgBuilderMixin():
             command += f"  --disable-ca-trust{newline}"
 
         if self.getParam('mas_manual_cert_mgmt') is True:
-            command += f"  --manual-certificates \"{self.getParam('mas_manual_cert_dir')}\"{newline}"
+            command += f"  --manual-certificates \"{self.manualCertsDir}\"{newline}"
+
+        if self.getParam('mas_domain') is True:
+            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}"
 
         if self.getParam('mas_enable_walkme') == "false":
             command += f"  --disable-walkme{newline}"
@@ -111,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)
         # -----------------------------------------------------------------------------
@@ -307,7 +317,7 @@ class installArgBuilderMixin():
         # -----------------------------------------------------------------------------
         if self.getParam('cos_type') != "":
             command += f"  --cos \"{self.getParam('cos_type')}\""
-            if self.getParam('cos_resourcegroup') != "":
+            if self.getParam('ibmcos_resourcegroup') != "":
                 command += f" --cos-resourcegroup \"{self.getParam('cos_resourcegroup')}\""
             command += newline
 
@@ -366,6 +376,8 @@ class installArgBuilderMixin():
             command += f"  --skip-pre-check{newline}"
         if self.getParam('skip_grafana_install') is True:
             command += f"  --skip-grafana-install{newline}"
+        if self.getParam('image_pull_policy') != "":
+            command += f"  --image-pull-policy {self.getParam('image_pull_policy')}{newline}"
 
         command += "  --accept-license --no-confirm"
         return command

mas/cli/install/argParser.py

@@ -164,6 +164,13 @@ masAdvancedArgGroup.add_argument(
     required=False,
     help="Path to directory containing the certificates to be applied"
 )
+masAdvancedArgGroup.add_argument(
+    "--domain",
+    dest="mas_domain",
+    required=False,
+    help="Configure MAS with a custom domain"
+)
+
 masAdvancedArgGroup.add_argument(
     "--disable-walkme",
     dest="mas_enable_walkme",
@@ -173,6 +180,42 @@ masAdvancedArgGroup.add_argument(
     const="false"
 )
 
+masAdvancedArgGroup.add_argument(
+    "--dns-provider",
+    dest="dns_provider",
+    required=False,
+    help="Enable Automatic DNS management (see DNS Configuration options)",
+    choices=["cloudflare", "cis", "route53"]
+)
+
+# DNS Configuration - IBM CIS
+# -----------------------------------------------------------------------------
+cisArgGroup = installArgParser.add_argument_group("DNS Configuration - CIS")
+cisArgGroup.add_argument(
+    "--cis-email",
+    dest="cis_email",
+    required=False,
+    help="Required when DNS provider is CIS and you want to use a Let's Encrypt ClusterIssuer"
+)
+cisArgGroup.add_argument(
+    "--cis-apikey",
+    dest="cis_apikey",
+    required=False,
+    help="Required when DNS provider is CIS"
+)
+cisArgGroup.add_argument(
+    "--cis-crn",
+    dest="cis_crn",
+    required=False,
+    help="Required when DNS provider is CIS"
+)
+cisArgGroup.add_argument(
+    "--cis-subdomain",
+    dest="cis_subdomain",
+    required=False,
+    help="Optionally setup MAS instance as a subdomain under a multi-tenant CIS DNS record"
+)
+
 # Storage
 # -----------------------------------------------------------------------------
 storageArgGroup = installArgParser.add_argument_group("Storage")
@@ -207,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)
 # -----------------------------------------------------------------------------
@@ -244,7 +293,6 @@ mongoArgGroup.add_argument(
     help=""
 )
 
-
 # OCP Configuration
 # -----------------------------------------------------------------------------
 ocpArgGroup = installArgParser.add_argument_group("OCP Configuration")
@@ -298,6 +346,147 @@ masAppsArgGroup.add_argument(
     choices=["full", "limited"],
     help="Install plan for Maximo Optimizer"
 )
+masAppsArgGroup.add_argument(
+    "--aibroker-channel",
+    required=False,
+    help="Subscription channel for Maximo Ai Broker"
+)
+
+# AI Broker
+# -----------------------------------------------------------------------------
+aibrokerArgGroup = installArgParser.add_argument_group("Maximo AI Broker")
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-provider",
+    dest="mas_aibroker_storage_provider",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-accesskey",
+    dest="mas_aibroker_storage_accesskey",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-secretkey",
+    dest="mas_aibroker_storage_secretkey",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-host",
+    dest="mas_aibroker_storage_host",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-port",
+    dest="mas_aibroker_storage_port",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-ssl",
+    dest="mas_aibroker_storage_ssl",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-region",
+    dest="mas_aibroker_storage_region",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-pipelines-bucket",
+    dest="mas_aibroker_storage_pipelines_bucket",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-tenants-bucket",
+    dest="mas_aibroker_storage_tenants_bucket",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-storage-templates-bucket",
+    dest="mas_aibroker_storage_templates_bucket",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-tenant-name",
+    dest="mas_aibroker_tenant_name",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-watsonxai-apikey",
+    dest="mas_aibroker_watsonxai_apikey",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-watsonxai-url",
+    dest="mas_aibroker_watsonxai_url",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-watsonxai-project-id",
+    dest="mas_aibroker_watsonxai_project_id",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-watsonx-action",
+    dest="mas_aibroker_watsonx_action",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-host",
+    dest="mas_aibroker_db_host",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-port",
+    dest="mas_aibroker_db_port",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-user",
+    dest="mas_aibroker_db_user",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-database",
+    dest="mas_aibroker_db_database",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-secret-name",
+    dest="mas_aibroker_db_secret_name",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-secret-key",
+    dest="mas_aibroker_db_secret_key",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
+aibrokerArgGroup.add_argument(
+    "--mas-aibroker-db-secret-value",
+    dest="mas_aibroker_db_secret_value",
+    required=False,
+    help="Customize Manage database encryption keys"
+)
 
 # Arcgis
 # -----------------------------------------------------------------------------
@@ -728,6 +917,7 @@ cosArgGroup.add_argument(
 )
 cosArgGroup.add_argument(
     "--cos-resourcegroup",
+    dest="ibmcos_resourcegroup",
     required=False,
     help="When using IBM COS, set the resource group where the instance will run"
 )
@@ -857,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",
@@ -895,6 +1098,12 @@ otherArgGroup.add_argument(
     default=False,
     help="Launch the upgrade without prompting for confirmation",
 )
+otherArgGroup.add_argument(
+    "--image-pull-policy",
+    dest="image_pull_policy",
+    required=False,
+    help="Manually set the image pull policy used in the Tekton Pipeline",
+)
 
 otherArgGroup.add_argument(
     "-h", "--help",

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
     """