mas-cli 10.1.1__py3-none-any.whl → 10.2.0__py3-none-any.whl

mas/cli/install/argParser.py

@@ -39,12 +39,12 @@ catArgGroup = installArgParser.add_argument_group("MAS Catalog Selection & Entit
 catArgGroup.add_argument(
     "-c", "--mas-catalog-version",
     required=False,
-    help=""
+    help="IBM Maximo Operator Catalog to install"
 )
 catArgGroup.add_argument(
     "--ibm-entitlement-key",
     required=False,
-    help=""
+    help="IBM entitlement key"
 )
 
 # MAS Basic Configuration
@@ -53,22 +53,22 @@ masArgGroup = installArgParser.add_argument_group("MAS Basic Configuration")
 masArgGroup.add_argument(
     "-i", "--mas-instance-id",
     required=False,
-    help=""
+    help="MAS Instance ID"
 )
 masArgGroup.add_argument(
     "-w", "--mas-workspace-id",
     required=False,
-    help=""
+    help="MAS Workspace ID"
 )
 masArgGroup.add_argument(
     "-W", "--mas-workspace-name",
     required=False,
-    help=""
+    help="MAS Workspace Name"
 )
 masArgGroup.add_argument(
     "--mas-channel",
     required=False,
-    help=""
+    help="Subscription channel for the Core Platform"
 )
 
 # ECK Integration
@@ -122,27 +122,32 @@ masAdvancedArgGroup.add_argument(
 masAdvancedArgGroup.add_argument(
     "--additional-configs",
     required=False,
-    help=""
+    help="Path to a directory containing additional configuration files to be applied"
 )
 masAdvancedArgGroup.add_argument(
     "--pod-templates",
     required=False,
-    help=""
+    help="Path to directory containing custom podTemplates configuration files to be applied"
 )
 masAdvancedArgGroup.add_argument(
     "--non-prod",
     required=False,
-    help="",
+    help="Install MAS in non-production mode",
     action="store_true"
 )
 masAdvancedArgGroup.add_argument(
     "--disable-ca-trust",
     dest="mas_trust_default_cas",
     required=False,
-    help="",
+    help="Disable built-in trust of well-known CAs",
     action="store_const",
     const="false"
 )
+masAdvancedArgGroup.add_argument(
+    "--manual-certificates",
+    required=False,
+    help="Please enter the path containing the manual certificates for core and the apps to be installed"
+)
 
 # Storage
 # -----------------------------------------------------------------------------
@@ -150,23 +155,23 @@ storageArgGroup = installArgParser.add_argument_group("Storage")
 storageArgGroup.add_argument(
     "--storage-class-rwo",
     required=False,
-    help=""
+    help="ReadWriteOnce (RWO) storage class (e.g. ibmc-block-gold)"
 )
 storageArgGroup.add_argument(
     "--storage-class-rwx",
     required=False,
-    help=""
+    help="ReadWriteMany (RWX) storage class (e.g. ibmc-file-gold-gid)"
 )
 storageArgGroup.add_argument(
     "--storage-pipeline",
     required=False,
-    help=""
+    help="Install pipeline storage class (e.g. ibmc-file-gold-gid)"
 )
 storageArgGroup.add_argument(
     "--storage-accessmode",
     required=False,
-    help="",
-    choices=["ReadOnlyMany", "ReadWriteMany", "ReadWriteOnce", "ReadWriteOncePod"]
+    help="Install pipeline storage class access mode (ReadWriteMany or ReadWriteOnce)",
+    choices=["ReadWriteMany", "ReadWriteOnce"]
 )
 
 # IBM Suite License Service
@@ -175,7 +180,7 @@ slsArgGroup = installArgParser.add_argument_group("IBM Suite License Service")
 slsArgGroup.add_argument(
     "--license-file",
     required=False,
-    help="",
+    help="Path to MAS license file",
     type=lambda x: isValidFile(installArgParser, x)
 )
 
@@ -186,19 +191,19 @@ droArgGroup.add_argument(
     "--uds-email",
     dest="uds_contact_email",
     required=False,
-    help=""
+    help="Contact e-mail address"
 )
 droArgGroup.add_argument(
     "--uds-firstname",
     dest="uds_contact_firstname",
     required=False,
-    help=""
+    help="Contact first name"
 )
 droArgGroup.add_argument(
     "--uds-lastname",
     dest="uds_contact_lastname",
     required=False,
-    help=""
+    help="Contact last name"
 )
 droArgGroup.add_argument(
     "--dro-namespace",
@@ -222,7 +227,7 @@ ocpArgGroup = installArgParser.add_argument_group("OCP Configuration")
 ocpArgGroup.add_argument(
     "--ocp-ingress-tls-secret-name",
     required=False,
-    help=""
+    help="Name of the secret holding the cluster's ingress certificates"
 )
 
 # MAS Applications
@@ -231,42 +236,43 @@ masAppsArgGroup = installArgParser.add_argument_group("MAS Applications")
 masAppsArgGroup.add_argument(
     "--assist-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo Assist"
 )
 masAppsArgGroup.add_argument(
     "--iot-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo IoT"
 )
 masAppsArgGroup.add_argument(
     "--monitor-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo Monitor"
 )
 masAppsArgGroup.add_argument(
     "--manage-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo Manage"
 )
 masAppsArgGroup.add_argument(
     "--predict-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo Predict"
 )
 masAppsArgGroup.add_argument(
     "--visualinspection-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo Visual Inspection"
 )
 masAppsArgGroup.add_argument(
     "--optimizer-channel",
     required=False,
-    help=""
+    help="Subscription channel for Maximo optimizer"
 )
 masAppsArgGroup.add_argument(
     "--optimizer-plan",
     required=False,
-    help=""
+    choices=["full", "limited"],
+    help="Install plan for Maximo Optimizer"
 )
 
 # Arcgis
@@ -293,7 +299,7 @@ manageArgGroup.add_argument(
     "--manage-server-bundle-size",
     dest="mas_app_settings_server_bundles_size",
     required=False,
-    help="",
+    help="Set Manage server bundle size configuration",
     choices=["dev", "snojms", "small", "jms"]
 )
 manageArgGroup.add_argument(
@@ -332,7 +338,7 @@ manageArgGroup.add_argument(
     "--manage-components",
     dest="mas_appws_components",
     required=False,
-    help="",
+    help="Set Manage Components to be installed (e.g 'base=latest,health=latest,civil=latest')",
     default="base=latest,health=latest"
 )
 
@@ -340,75 +346,75 @@ manageArgGroup.add_argument(
     "--manage-customization-archive-name",
     dest="mas_app_settings_customization_archive_name",
     required=False,
-    help=""
+    help="Manage Archive name"
 )
 manageArgGroup.add_argument(
     "--manage-customization-archive-url",
     dest="mas_app_settings_customization_archive_url",
     required=False,
-    help=""
+    help="Manage Archive url"
 )
 manageArgGroup.add_argument(
     "--manage-customization-archive-username",
     dest="mas_app_settings_customization_archive_username",
     required=False,
-    help=""
+    help="Manage Archive username (HTTP basic auth)"
 )
 manageArgGroup.add_argument(
     "--manage-customization-archive-password",
     dest="mas_app_settings_customization_archive_password",
     required=False,
-    help=""
+    help="Manage Archive password (HTTP basic auth)"
 )
 
 manageArgGroup.add_argument(
     "--manage-db-tablespace",
     dest="mas_app_settings_tablespace",
     required=False,
-    help=""
+    help="Database tablespace name that Manage will use to be installed. Default is 'MAXDATA'"
 )
 manageArgGroup.add_argument(
     "--manage-db-indexspace",
     dest="mas_app_settings_indexspace",
     required=False,
-    help=""
+    help="Database indexspace name that Manage will use to be installed. Default is 'MAXINDEX'"
 )
 manageArgGroup.add_argument(
     "--manage-db-schema",
     dest="mas_app_settings_db2_schema",
     required=False,
-    help=""
+    help="Database schema name that Manage will use to be installed. Default is 'maximo'"
 )
 
 manageArgGroup.add_argument(
     "--manage-crypto-key",
     dest="mas_app_settings_crypto_key",
     required=False,
-    help=""
+    help="Customize Manage database encryption keys"
 )
 manageArgGroup.add_argument(
     "--manage-cryptox-key",
     dest="mas_app_settings_cryptox_key",
     required=False,
-    help=""
+    help="Customize Manage database encryption keys"
 )
 manageArgGroup.add_argument(
     "--manage-old-crypto-key",
     dest="mas_app_settings_old_crypto_key",
     required=False,
-    help=""
+    help="Customize Manage database encryption keys"
 )
 manageArgGroup.add_argument(
     "--manage-old-cryptox-key",
     dest="mas_app_settings_old_cryptox_key",
     required=False,
-    help=""
+    help="Customize Manage database encryption keys"
 )
 manageArgGroup.add_argument(
     "--manage-override-encryption-secrets",
     dest="mas_app_settings_override_encryption_secrets_flag",
     required=False,
-    help="",
+    help="Override any existing Manage database encryption keys. A backup of the original secret holding existing encryption keys is taken prior overriding it with the new defined keys",
     action="store_const",
     const="true"
 )
@@ -417,19 +423,19 @@ manageArgGroup.add_argument(
     "--manage-base-language",
     dest="mas_app_settings_base_lang",
     required=False,
-    help=""
+    help="Manage base language to be installed. Default is `EN` (English)"
 )
 manageArgGroup.add_argument(
     "--manage-secondary-languages",
     dest="mas_app_settings_secondary_langs",
     required=False,
-    help=""
+    help="Comma-separated list of Manage secondary languages to be installed (e.g. 'JA,DE,AR')"
 )
 manageArgGroup.add_argument(
     "--manage-server-timezone",
     dest="mas_app_settings_server_timezone",
     required=False,
-    help=""
+    help="Manage server timezone. Default is `GMT`"
 )
 
 # IBM Cloud Pak for Data
@@ -439,13 +445,13 @@ cpdAppsArgGroup.add_argument(
     "--cp4d-version",
     dest="cpd_product_version",
     required=False,
-    help=""
+    help="Product version of CP4D to use"
 )
 cpdAppsArgGroup.add_argument(
     "--cp4d-install-spss",
     dest="cpd_install_spss",
     required=False,
-    help="",
+    help="Add SPSS Modeler as part of Cloud Pak for Data",
     action="store_const",
     const="install"
 )
@@ -453,7 +459,7 @@ cpdAppsArgGroup.add_argument(
     "--cp4d-installopenscale",
     dest="cpd_install_openscale",
     required=False,
-    help="",
+    help="Add Watson Openscale as part of Cloud Pak for Data",
     action="store_const",
     const="install"
 )
@@ -461,7 +467,7 @@ cpdAppsArgGroup.add_argument(
     "--cp4d-install-cognos",
     dest="cpd_install_cognos",
     required=False,
-    help="",
+    help="Add Cognos as part of Cloud Pak for Data",
     action="store_const",
     const="install"
 )
@@ -472,18 +478,18 @@ db2ArgGroup = installArgParser.add_argument_group("IBM Db2 Universal Operator")
 db2ArgGroup.add_argument(
     "--db2-namespace",
     required=False,
-    help=""
+    help="Change namespace where Db2u instances will be created"
 )
 db2ArgGroup.add_argument(
     "--db2-channel",
     required=False,
-    help=""
+    help="Subscription channel for Db2u"
 )
 db2ArgGroup.add_argument(
     "--db2-system",
     dest="db2_action_system",
     required=False,
-    help="",
+    help="Install a shared Db2u instance for MAS (required by IoT & Monitor, supported by Manage)",
     action="store_const",
     const="install"
 )
@@ -491,14 +497,14 @@ db2ArgGroup.add_argument(
     "--db2-manage",
     dest="db2_action_manage",
     required=False,
-    help="",
+    help="Install a dedicated Db2u instance for Maximo Manage (supported by Manage)",
     action="store_const",
     const="install"
 )
 db2ArgGroup.add_argument(
     "--db2-type",
     required=False,
-    help=""
+    help="Choose the type of the Manage dedicated Db2u instance. Available options are `db2wh` (default) or `db2oltp`"
 )
 db2ArgGroup.add_argument(
     "--db2-timezone",
@@ -508,77 +514,77 @@ db2ArgGroup.add_argument(
 db2ArgGroup.add_argument(
     "--db2-affinity-key",
     required=False,
-    help=""
+    help="Set a node label to declare affinity to"
 )
 db2ArgGroup.add_argument(
     "--db2-affinity-value",
     required=False,
-    help=""
+    help="Set the value of the node label to affine with"
 )
 db2ArgGroup.add_argument(
     "--db2-tolerate-key",
     required=False,
-    help=""
+    help="Set a node taint to tolerate"
 )
 db2ArgGroup.add_argument(
     "--db2-tolerate-value",
     required=False,
-    help=""
+    help="Set the value of the taint to tolerate"
 )
 db2ArgGroup.add_argument(
     "--db2-tolerate-effect",
     required=False,
-    help=""
+    help="Set the effect that will be tolerated (NoSchedule, PreferNoSchedule, or NoExecute)"
 )
 db2ArgGroup.add_argument(
     "--db2-cpu-requests",
     required=False,
-    help=""
+    help="Customize Db2 CPU request"
 )
 db2ArgGroup.add_argument(
     "--db2-cpu-limits",
     required=False,
-    help=""
+    help="Customize Db2 CPU limit"
 )
 db2ArgGroup.add_argument(
     "--db2-memory-requests",
     required=False,
-    help=""
+    help="Customize Db2 memory request"
 )
 db2ArgGroup.add_argument(
     "--db2-memory-limits",
     required=False,
-    help=""
+    help="Customize Db2 memory limit"
 )
 db2ArgGroup.add_argument(
     "--db2-backup-storage",
     dest="db2_backup_storage_size",
     required=False,
-    help=""
+    help="Customize Db2 storage capacity"
 )
 db2ArgGroup.add_argument(
     "--db2-data-storage",
     dest="db2_data_storage_size",
     required=False,
-    help=""
+    help="Customize Db2 storage capacity"
 )
 db2ArgGroup.add_argument(
     "--db2-logs-storage",
     dest="db2_logs_storage_size",
     required=False,
-    help=""
+    help="Customize Db2 storage capacity"
 )
 db2ArgGroup.add_argument(
     "--db2-meta-storage",
     dest="db2_meta_storage_size",
     required=False,
-    help=""
+    help="Customize Db2 storage capacity"
 )
 db2ArgGroup.add_argument(
     "--db2-temp-storage",
     dest="db2_temp_storage_size",
     required=False,
-    help=""
+    help="Customize Db2 storage capacity"
 )
 
 
@@ -588,18 +594,18 @@ kafkaCommonArgGroup = installArgParser.add_argument_group("Kafka - Common")
 kafkaCommonArgGroup.add_argument(
     "--kafka-provider",
     required=False,
-    help="",
+    help="Set Kafka provider.  Supported options are `redhat` (Red Hat AMQ Streams), `strimzi` and `ibm` (IBM Event Streams) and `aws` (AWS MSK)",
     choices=["strimzi", "redhat", "ibm", "aws"]
 )
 kafkaCommonArgGroup.add_argument(
     "--kafka-username",
     required=False,
-    help=""
+    help="Set Kafka instance username. Only applicable if installing `redhat` (Red Hat AMQ Streams), `strimzi` or `aws` (AWS MSK)"
 )
 kafkaCommonArgGroup.add_argument(
     "--kafka-password",
     required=False,
-    help=""
+    help="Set Kafka instance password. Only applicable if installing `redhat` (Red Hat AMQ Streams), `strimzi` or `aws` (AWS MSK)"
 )
 
 # Kafka - Strimzi & AMQ Streams
@@ -608,12 +614,12 @@ kafkaOCPArgGroup = installArgParser.add_argument_group("Kafka - Strimzi and AMQ
 kafkaCommonArgGroup.add_argument(
     "--kafka-namespace",
     required=False,
-    help=""
+    help="Set Kafka namespace. Only applicable if installing `redhat` (Red Hat AMQ Streams) or `strimzi`"
 )
 kafkaOCPArgGroup.add_argument(
     "--kafka-version",
     required=False,
-    help=""
+    help="Set version of the Kafka cluster that the Strimzi or AMQ Streams operator will create"
 )
 
 # Kafka - MSK
@@ -623,49 +629,49 @@ mskArgGroup.add_argument(
     "--msk-instance-type",
     dest="aws_msk_instance_type",
     required=False,
-    help=""
+    help="Set the MSK instance type"
 )
 mskArgGroup.add_argument(
     "--msk-instance-nodes",
     dest="aws_msk_instance_number",
     required=False,
-    help=""
+    help="Set total number of MSK instance nodes"
 )
 mskArgGroup.add_argument(
     "--msk-instance-volume-size",
     dest="aws_msk_volume_size",
     required=False,
-    help=""
+    help="Set storage/volume size for the MSK instance"
 )
 mskArgGroup.add_argument(
     "--msk-cidr-az1",
     dest="aws_msk_cidr_az1",
     required=False,
-    help=""
+    help="Set the CIDR subnet for availability zone 1 for the MSK instance"
 )
 mskArgGroup.add_argument(
     "--msk-cidr-az2",
     dest="aws_msk_cidr_az2",
     required=False,
-    help=""
+    help="Set the CIDR subnet for availability zone 2 for the MSK instance"
 )
 mskArgGroup.add_argument(
     "--msk-cidr-az3",
     dest="aws_msk_cidr_az3",
     required=False,
-    help=""
+    help="Set the CIDR subnet for availability zone 3 for the MSK instance"
 )
 mskArgGroup.add_argument(
     "--msk-cidr-egress",
     dest="aws_msk_egress_cidr",
     required=False,
-    help=""
+    help="Set the CIDR for egress connectivity"
 )
 mskArgGroup.add_argument(
     "--msk-cidr-ingress",
     dest="aws_msk_ingress_cidr",
     required=False,
-    help=""
+    help="Set the CIDR for ingress connectivity"
 )
 
 # Kafka - Event Streams
@@ -674,17 +680,17 @@ mskArgGroup = installArgParser.add_argument_group("Kafka - Event Streams")
 mskArgGroup.add_argument(
     "--eventstreams-resource-group",
     required=False,
-    help=""
+    help="Set IBM Cloud resource group to target the Event Streams instance provisioning"
 )
 mskArgGroup.add_argument(
     "--eventstreams-instance-name",
     required=False,
-    help=""
+    help="Set IBM Event Streams instance name"
 )
 mskArgGroup.add_argument(
     "--eventstreams-instance-location",
     required=False,
-    help=""
+    help="Set IBM Event Streams instance location"
 )
 
 # Turbonomic Integration
@@ -727,27 +733,27 @@ cloudArgGroup = installArgParser.add_argument_group("Cloud Providers")
 cloudArgGroup.add_argument(
     "--ibmcloud-apikey",
     required=False,
-    help=""
+    help="Set IBM Cloud API Key"
 )
 cloudArgGroup.add_argument(
     "--aws-region",
     required=False,
-    help=""
+    help="Set target AWS region for the MSK instance"
 )
 cloudArgGroup.add_argument(
     "--aws-access-key-id",
     required=False,
-    help=""
+    help="Set AWS access key ID for the target AWS account"
 )
 cloudArgGroup.add_argument(
     "--secret-access-key",
     required=False,
-    help=""
+    help="Set AWS secret access key for the target AWS account"
 )
 cloudArgGroup.add_argument(
     "--aws-vpc-id",
     required=False,
-    help=""
+    help="Set target Virtual Private Cloud ID for the MSK instance"
 )
 
 otherArgGroup = installArgParser.add_argument_group("More")