mas-cli 5.1.4__py3-none-any.whl

mas/cli/install/catalogs.py

@@ -0,0 +1,27 @@
+# *****************************************************************************
+# 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
+#
+# *****************************************************************************
+supportedCatalogs = {
+    "amd64": [
+        "v9-250731-amd64",
+        "v9-250624-amd64",
+        "v9-250501-amd64",
+        "v9-250403-amd64",
+    ],
+    "s390x": [
+        "v9-250731-s390x",
+        "v9-250624-s390x",
+        "v9-250501-s390x",
+        "v9-250403-s390x",
+    ],
+    "ppc64le": [
+        "v9-250731-ppc64le",
+        "v9-250624-ppc64le",
+    ],
+}

mas/cli/install/params.py

@@ -0,0 +1,172 @@
+# *****************************************************************************
+# 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",
+    "service_account_name",
+    # 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_appws_bindings_health_wsl_flag",
+    "mas_domain",
+    "mas_appws_upgrade_type",
+    # IPV6
+    "enable_ipv6",
+    # SLS
+    "sls_namespace",
+    # DNS Providers
+    # TODO: Add CloudFlare and Route53 support
+    "dns_provider",
+    "cis_email",
+    "cis_apikey",
+    "cis_crn",
+    "cis_subdomain",
+    "mas_cluster_issuer",
+    # 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",
+    # CP4D
+    "cpd_product_version",
+    "cpd_install_cognos",
+    "cpd_install_spss",
+    "cpd_install_ws",
+    "cpd_install_wml",
+    "cpd_install_ae",
+    # 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_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",
+    "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",
+    # 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/__init__.py

@@ -0,0 +1,23 @@
+# *****************************************************************************
+# 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
+#
+# *****************************************************************************
+
+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, MongoDbSettingsMixin, KafkaSettingsMixin, ManageSettingsMixin, TurbonomicSettingsMixin, AdditionalConfigsMixin):
+    """
+    This class collects all the Mixins providing interactive prompts for mas-install
+    """
+    pass

mas/cli/install/settings/additionalConfigs.py

@@ -0,0 +1,227 @@
+# *****************************************************************************
+# 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
+#
+# *****************************************************************************
+
+from os import path
+from base64 import b64encode
+from glob import glob
+from prompt_toolkit import print_formatted_text
+
+import logging
+logger = logging.getLogger(__name__)
+
+
+class AdditionalConfigsMixin():
+    def additionalConfigs(self) -> None:
+        if self.interactiveMode:
+            self.printH1("Additional Configuration")
+            self.printDescription([
+                "Additional resource definitions can be applied to the OpenShift Cluster during the MAS configuration step",
+                "The primary purpose of this is to apply configuration for Maximo Application Suite itself, but you can use this to deploy ANY additional resource into your cluster"
+            ])
+
+            # If the user already set up BYO MongoDb or Kafka then they have already chosen to use additional configs
+            if self.localConfigDir is None:
+                if self.yesOrNo("Use additional configurations"):
+                    self.selectLocalConfigDir()
+
+        # If we've set up a local config directory then provide details about what's included in it
+        # and generate the secret that will be used in the pipeline
+        if self.localConfigDir is not None:
+            # Get list of files in localConfigDir
+            configFilesPath = rf'{self.localConfigDir}/*.yaml'
+            configFiles = glob(configFilesPath)
+            if len(configFiles) == 0:
+                self.fatalError(f"No configuration files (*.yaml) were found in {self.localConfigDir}")
+
+            print_formatted_text("The following additional configurations will be applied:")
+            for cf in configFiles:
+                print_formatted_text(f" - {path.basename(cf)}")
+
+            if not self.noConfirm:
+                if not self.yesOrNo("Are these the correct configuration files to apply"):
+                    print_formatted_text("Additional configuration files were not confirmed.  Aborting installation")
+                    exit(0)
+
+            # Generate the secret and apply it to the cluster
+            secret = {
+                "apiVersion": "v1",
+                "kind": "Secret",
+                "type": "Opaque",
+                "metadata": {
+                    "name": "pipeline-additional-configs"
+                }
+            }
+            additionalConfigsSecret = self.addFilesToSecret(secret, self.localConfigDir, "yaml")
+            logger.debug(additionalConfigsSecret)
+            self.additionalConfigsSecret = additionalConfigsSecret
+
+    def podTemplates(self) -> None:
+        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",
+                "For more information about the Kubernetes quality of service (QoS) levels, see <Orange><u>https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/</u></Orange>",
+                "You may also choose to use your own customized pod template definitions"
+            ])
+
+            if not self.yesOrNo("Use pod templates"):
+                return
+
+            self.printDescription([
+                "Make a selection from the list below:",
+                "",
+                "1. Guaranteed QoS",
+                "2. Best Effort QoS",
+                "3. Custom"
+            ])
+
+            podTemplateChoice = self.promptForInt("Select pod templates profile")
+
+            if podTemplateChoice == 1:
+                self.setParam("mas_pod_templates_dir", path.join(self.templatesDir, "pod-templates", "guaranteed"))
+            elif podTemplateChoice == 2:
+                self.setParam("mas_pod_templates_dir", path.join(self.templatesDir, "pod-templates", "best-effort"))
+            elif podTemplateChoice == 3:
+                self.setParam("mas_pod_templates_dir", self.promptForDir("Pod templates directory", mustExist=True))
+            else:
+                self.fatalError(f"Invalid selection: {podTemplateChoice}")
+
+        if self.getParam("mas_pod_templates_dir") != "":
+            templateFilesPath = rf'{self.getParam("mas_pod_templates_dir")}/*.yml'
+            templateFiles = glob(templateFilesPath)
+            if len(templateFiles) == 0:
+                self.fatalError(f"No pod templates (*.yml) were found in {self.getParam('mas_pod_templates_dir')}")
+
+            print_formatted_text("The following pod templates will be applied:")
+            for tf in templateFiles:
+                print_formatted_text(f" - {path.basename(tf)}")
+
+            if not self.noConfirm:
+                if not self.yesOrNo("Are these the correct pod templates to apply"):
+                    print_formatted_text("Pod templates were not confirmed.  Aborting installation")
+                    exit(0)
+
+            # Generate the secret and apply it to the cluster
+            secret = {
+                "apiVersion": "v1",
+                "kind": "Secret",
+                "type": "Opaque",
+                "metadata": {
+                    "name": "pipeline-pod-templates"
+                }
+            }
+            podTemplatesSecret = self.addFilesToSecret(secret, self.getParam("mas_pod_templates_dir"), "yml")
+            logger.debug(podTemplatesSecret)
+            self.podTemplatesSecret = podTemplatesSecret
+
+    def manualCertificates(self) -> None:
+
+        if self.getParam("mas_manual_cert_mgmt"):
+            certsSecret = {
+                "apiVersion": "v1",
+                "kind": "Secret",
+                "type": "Opaque",
+                "metadata": {
+                    "name": "pipeline-certificates"
+                }
+            }
+
+            extensions = ["key", "crt"]
+
+            apps = {
+                "mas_app_channel_assist": {
+                    "dir": self.manualCertsDir + "/assist/",
+                    "keyPrefix": "assist."
+                },
+                "mas_app_channel_manage": {
+                    "dir": self.manualCertsDir + "/manage/",
+                    "keyPrefix": "manage."
+                },
+                "mas_app_channel_iot": {
+                    "dir": self.manualCertsDir + "/iot/",
+                    "keyPrefix": "iot."
+                },
+                "mas_app_channel_monitor": {
+                    "dir": self.manualCertsDir + "/monitor/",
+                    "keyPrefix": "monitor."
+                },
+                "mas_app_channel_predict": {
+                    "dir": self.manualCertsDir + "/predict/",
+                    "keyPrefix": "predict."
+                },
+                "mas_app_channel_visualinspection": {
+                    "dir": self.manualCertsDir + "/visualinspection/",
+                    "keyPrefix": "visualinspection."
+                },
+                "mas_app_channel_optimizer": {
+                    "dir": self.manualCertsDir + "/optimizer/",
+                    "keyPrefix": "optimizer."
+                },
+                "mas_app_channel_facilities": {
+                    "dir": self.manualCertsDir + "/facilities/",
+                    "keyPrefix": "facilities."
+                }
+            }
+
+            for file in ["ca.crt", "tls.crt", "tls.key"]:
+                if file not in map(path.basename, glob(f'{self.manualCertsDir}/core/*')):
+                    self.fatalError(f'{file} is not present in {self.manualCertsDir}/core/')
+            for ext in extensions:
+                certsSecret = self.addFilesToSecret(certsSecret, self.manualCertsDir + '/core/', ext, "core.")
+
+            for app in apps:
+                if self.getParam(app) != "":
+                    for file in ["ca.crt", "tls.crt", "tls.key"]:
+                        if file not in map(path.basename, glob(f'{apps[app]["dir"]}/*')):
+                            self.fatalError(f'{file} is not present in {apps[app]["dir"]}')
+                    for ext in extensions:
+                        certsSecret = self.addFilesToSecret(certsSecret, apps[app]["dir"], ext, apps[app]["keyPrefix"])
+
+            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
+        """
+        filesToProcess = []
+        if path.isdir(configPath):
+            logger.debug(f"Adding all config files in directory {configPath}")
+            filesToProcess = glob(f"{configPath}/*.{extension}")
+        else:
+            logger.debug(f"Adding config file {configPath}")
+            filesToProcess = [configPath]
+
+        for fileToProcess in filesToProcess:
+            logger.debug(f" * Processing config file {fileToProcess}")
+            fileName = path.basename(fileToProcess)
+
+            # Load the file
+            with open(fileToProcess, 'r') as file:
+                data = file.read()
+
+            # Add/update an entry to the secret data
+            if "data" not in secretDict:
+                secretDict["data"] = {}
+            secretDict["data"][keyPrefix + fileName] = b64encode(data.encode('ascii')).decode("ascii")
+
+        return secretDict