mas-cli 19.8.0__tar.gz → 20.0.0__tar.gz

{mas_cli-19.8.0/src/mas_cli.egg-info → mas_cli-20.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mas-cli
-Version: 19.8.0
+Version: 20.0.0
 Summary: Python Admin CLI for Maximo Application Suite
 Home-page: https://github.com/ibm-mas/cli
 Author: David Parker
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Communications
 Classifier: Topic :: Internet
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
 Requires-Dist: mas-devops>=5.2.0
 Requires-Dist: alive-progress
 Requires-Dist: halo
@@ -31,6 +32,7 @@ Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
 Dynamic: description
+Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
 Dynamic: provides-extra
@@ -38,36 +40,37 @@ Dynamic: requires-dist
 Dynamic: summary
 
 mas.devops
-----------
+-------------------------------------------------------------------------------
 
-Example
-=======
 
-.. code:: python
+Example
+===============================================================================
+```python
+from openshift import dynamic
+from kubernetes import config
+from kubernetes.client import api_client
 
-   from openshift import dynamic
-   from kubernetes import config
-   from kubernetes.client import api_client
+from mas.devops.ocp import createNamespace
+from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
 
-   from mas.devops.ocp import createNamespace
-   from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+instanceId = "mymas"
+pipelinesNamespace = f"mas-{instanceId}-pipelines"
 
-   instanceId = "mymas"
-   pipelinesNamespace = f"mas-{instanceId}-pipelines"
+# Create an OpenShift client
+dynClient = dynamic.DynamicClient(
+    api_client.ApiClient(configuration=config.load_kube_config())
+)
 
-   # Create an OpenShift client
-   dynClient = dynamic.DynamicClient(
-       api_client.ApiClient(configuration=config.load_kube_config())
-   )
+# Install OpenShift Pipelines Operator
+success = installOpenShiftPipelines(dynamicClient)
+assert success is True
 
-   # Install OpenShift Pipelines Operator
-   success = installOpenShiftPipelines(dynamicClient)
-   assert success is True
+# Create the pipelines namespace and install the MAS tekton definitions
+createNamespace(dynamicClient, pipelinesNamespace)
+updateTektonDefinitions(pipelinesNamespace)
 
-   # Create the pipelines namespace and install the MAS tekton definitions
-   createNamespace(dynamicClient, pipelinesNamespace)
-   updateTektonDefinitions(pipelinesNamespace)
+# Launch the upgrade pipeline and print the URL to view the pipeline run
+pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+print(pipelineURL)
+```
 
-   # Launch the upgrade pipeline and print the URL to view the pipeline run
-   pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
-   print(pipelineURL)

mas_cli-20.0.0/README.md

@@ -0,0 +1,35 @@
+mas.devops
+-------------------------------------------------------------------------------
+
+
+Example
+===============================================================================
+```python
+from openshift import dynamic
+from kubernetes import config
+from kubernetes.client import api_client
+
+from mas.devops.ocp import createNamespace
+from mas.devops.tekton import installOpenShiftPipelines, updateTektonDefinitions, launchUpgradePipeline
+
+instanceId = "mymas"
+pipelinesNamespace = f"mas-{instanceId}-pipelines"
+
+# Create an OpenShift client
+dynClient = dynamic.DynamicClient(
+    api_client.ApiClient(configuration=config.load_kube_config())
+)
+
+# Install OpenShift Pipelines Operator
+success = installOpenShiftPipelines(dynamicClient)
+assert success is True
+
+# Create the pipelines namespace and install the MAS tekton definitions
+createNamespace(dynamicClient, pipelinesNamespace)
+updateTektonDefinitions(pipelinesNamespace)
+
+# Launch the upgrade pipeline and print the URL to view the pipeline run
+pipelineURL = launchUpgradePipeline(self.dynamicClient, instanceId)
+print(pipelineURL)
+```
+

{mas_cli-19.8.0 → mas_cli-20.0.0}/pyproject.toml

@@ -1,6 +1,5 @@
 [build-system]
 requires = [
-  "setuptools",
-  "pypandoc"
+  "setuptools"
 ]
 build-backend = "setuptools.build_meta"

{mas_cli-19.8.0 → mas_cli-20.0.0}/setup.py

@@ -14,13 +14,8 @@ import os
 sys.path.insert(0, 'src')
 
 
-if not os.path.exists('README.rst'):
-    import pypandoc
-    pypandoc.download_pandoc(targetfolder='~/bin/')
-    pypandoc.convert_file('README.md', 'rst', outputfile='README.rst')
-
 here = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
 # Maintain a single source of versioning
@@ -57,6 +52,7 @@ setup(
     license='Eclipse Public License - v1.0',
     description='Python Admin CLI for Maximo Application Suite',
     long_description=long_description,
+    long_description_content_type='text/markdown',
     install_requires=[
         'mas-devops >= 5.2.0',   # EPL
         'alive-progress',        # MIT License

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/__init__.py

@@ -8,4 +8,4 @@
 #
 # *****************************************************************************
 
-__version__ = "19.8.0"  # Python module compatible semver
+__version__ = "20.0.0"  # Python module compatible semver

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/aiservice/install/app.py

@@ -493,7 +493,9 @@ class AiServiceInstallApp(BaseApp, aiServiceInstallArgBuilderMixin, aiServiceIns
                     slsLicenseFile=self.slsLicenseFileSecret,
                     additionalConfigs=self.additionalConfigsSecret,
                     podTemplates=self.podTemplatesSecret,
-                    certs=self.certsSecret
+                    certs=self.certsSecret,
+                    slack_token=self.getParam("slack_token"),
+                    slack_channel=self.getParam("slack_channel")
                 )
 
                 self.setupApprovals(pipelinesNamespace)

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/aiservice/install/params.py

@@ -106,4 +106,8 @@ optionalParams = [
 
     # Enable IPv6 networking
     "enable_ipv6",
+
+    # Slack
+    "slack_token",
+    "slack_channel",
 ]

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/aiservice/install/summarizer.py

@@ -110,6 +110,13 @@ class aiServiceInstallSummarizerMixin():
         else:
             self.fatalError(f"Unexpected value for mongodb_action parameter: {self.getParam('mongodb_action')}")
 
+    def slackSummary(self) -> None:
+        self.printH2("Slack Integration")
+        if self.getParam("slack_channel") != "":
+            self.printParamSummary("Slack Channel", "slack_channel")
+        else:
+            self.printSummary("Slack Channel", "Not Configured")
+
     def displayInstallSummary(self) -> None:
         self.printH1("Review Settings")
         self.printDescription([
@@ -129,3 +136,6 @@ class aiServiceInstallSummarizerMixin():
         self.slsSummary()
         self.mongoSummary()
         self.db2Summary()
+
+        # Notification Integration
+        self.slackSummary()

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/cli.py

@@ -120,7 +120,7 @@ class BaseApp(PrintMixin, PromptMixin):
         logging.getLogger('asyncio').setLevel(logging.INFO)
 
         # Supports extended semver, unlike mas.cli.__version__
-        self.version: str = "19.8.0"
+        self.version: str = "20.0.0"
         self.h1count: int = 0
         self.h2count: int = 0
 
@@ -155,6 +155,7 @@ class BaseApp(PrintMixin, PromptMixin):
                 "visualinspection": ["9.2.x-feature", "9.1.x"],
                 "iot": ["9.2.x-feature", "9.1.x"],
                 "monitor": ["9.2.x-feature", "9.1.x"],
+                "facilities": ["9.2.x-feature", "9.1.x"],
             },
             "9.1.x": {
                 "facilities": ["9.1.x"],

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/app.py

@@ -1630,6 +1630,14 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                     self.setParam("mongodb_action", "byo")
                     self.setParam("sls_mongodb_cfg_file", "/workspace/additional-configs/mongodb-system.yaml")
 
+                # If there is a file named kafka-<instance>-system.yaml we will use this as a BYO Kafka datasource
+                if self.localConfigDir is not None:
+                    instanceId = self.getParam("mas_instance_id")
+                    if instanceId is not None and instanceId != "":
+                        kafkaConfigFile = path.join(self.localConfigDir, f"kafka-{instanceId}-system.yaml")
+                        if path.exists(kafkaConfigFile):
+                            self.setParam("kafka_action_system", "byo")
+
             elif key == "pod_templates":
                 # For the named configurations we will convert into the path
                 if value in ["best-effort", "guaranteed"]:
@@ -1884,6 +1892,13 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
             if arcgis_channel and not isVersionEqualOrAfter('9.0.0', arcgis_channel):
                 self.fatalError(f"--arcgis-channel must be 9.0 or later (current: {arcgis_channel})")
 
+        # Validate Kafka requirements for IoT installation in non-interactive mode
+        if self.installIoT:
+            kafkaAction = self.getParam("kafka_action_system")
+            hasKafkaConfig = kafkaAction in ["install", "byo"]
+            if not hasKafkaConfig:
+                self.fatalError("--iot-channel requires Kafka configuration. Provide Kafka install arguments such as --kafka-provider, or supply a BYO Kafka config file named kafka-<mas-instance-id>-system.yaml using --additional-configs")
+
     @logMethodCall
     def install(self, argv):
         """
@@ -2120,7 +2135,9 @@ class InstallApp(BaseApp, InstallSettingsMixin, InstallSummarizerMixin, ConfigGe
                     slsLicenseFile=self.slsLicenseFileSecret,
                     additionalConfigs=self.additionalConfigsSecret,
                     podTemplates=self.podTemplatesSecret,
-                    certs=self.certsSecret
+                    certs=self.certsSecret,
+                    slack_token=self.getParam("slack_token"),
+                    slack_channel=self.getParam("slack_channel")
                 )
 
                 self.setupApprovals(pipelinesNamespace)

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/argBuilder.py

@@ -579,6 +579,11 @@ class installArgBuilderMixin():
         if self.getParam('approval_aiservice') != "":
             command += f"  --approval-aiservice \"{self.getParam('approval_aiservice')}\"{newline}"
 
+        # Slack
+        # -----------------------------------------------------------------------------
+        if self.getParam('slack_channel') != "" and self.getParam('slack_token'):
+            command += f"  --slack-channel \"{self.getParam('slack_channel')}\"  --slack-token $SLACK_TOKEN{newline}"
+
         # More Options
         # -----------------------------------------------------------------------------
         if self.devMode:

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/argParser.py

@@ -1581,6 +1581,18 @@ otherArgGroup.add_argument(
     default=False,
     help="Don't show advanced install options (in interactive mode)"
 )
+otherArgGroup.add_argument(
+    "--slack-token",
+    dest="slack_token",
+    required=False,
+    help="Slack bot token for sending pipeline notifications"
+)
+otherArgGroup.add_argument(
+    "--slack-channel",
+    dest="slack_channel",
+    required=False,
+    help="Slack channel(s) for notifications (comma-separated for multiple channels)"
+)
 
 otherArgGroup.add_argument(
     "--accept-license",

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/params.py

@@ -221,5 +221,9 @@ optionalParams = [
     # Grafana
     "skip_grafana_install",
     "grafana_v5_namespace",
-    "grafana_instance_storage_size"
+    "grafana_instance_storage_size",
+
+    # Slack Integration
+    "slack_token",
+    "slack_channel"
 ]

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/settings/kafkaSettings.py

@@ -11,7 +11,6 @@
 from typing import TYPE_CHECKING, Dict, List, NoReturn
 from os import path
 from prompt_toolkit import print_formatted_text
-from mas.devops.utils import isVersionEqualOrAfter
 
 
 if TYPE_CHECKING:
@@ -24,7 +23,6 @@ class KafkaSettingsMixin():
         # Attributes from BaseApp and other mixins
         params: Dict[str, str]
         installIoT: bool
-        installMonitor: bool
         showAdvancedOptions: bool
         localConfigDir: str | None
 
@@ -74,15 +72,10 @@ class KafkaSettingsMixin():
             ...
 
     def configKafka(self) -> None:
-        # Check if we should use the new dependency (Monitor >= 9.2.0)
-        monitorChannel = self.getParam("mas_app_channel_monitor")
-        useNewDependency = monitorChannel and isVersionEqualOrAfter('9.2.0', monitorChannel)
-
-        if (useNewDependency and self.installMonitor) or (not useNewDependency and self.installIoT):
-            appName = "Monitor" if (useNewDependency and self.installMonitor) else "IoT"
+        if self.installIoT:
             self.printH1("Configure Kafka")
             self.printDescription([
-                f"Maximo {appName} requires a shared system-scope Kafka instance",
+                "Maximo IoT requires a shared system-scope Kafka instance",
                 "Supported Kafka providers: Strimzi, Red Hat AMQ Streams, IBM Cloud Event Streams and AWS MSK",
                 "You may also choose to configure MAS to use an existing Kafka instance by providing a pre-existing configuration file"
             ])

{mas_cli-19.8.0 → mas_cli-20.0.0}/src/mas/cli/install/summarizer.py

@@ -411,6 +411,13 @@ class InstallSummarizerMixin():
         else:
             self.printSummary("Install Grafana", "Do Not Install")
 
+    def slackSummary(self) -> None:
+        self.printH2("Slack Integration")
+        if self.getParam("slack_channel") != "":
+            self.printParamSummary("Slack Channel", "slack_channel")
+        else:
+            self.printSummary("Slack Channel", "Not Configured")
+
     def installSummary(self) -> None:
         pass
         # self.printH2("Install Process")
@@ -451,5 +458,8 @@ class InstallSummarizerMixin():
         self.cp4dSummary()
         self.grafanaSummary()
 
+        # Notification Integration
+        self.slackSummary()
+
         # Install options
         self.installSummary()