[minor] Enhanced Slack Notification System

README.md

@@ -18,4 +18,4 @@ Documentation
 Want to contribute to MAS Command Line Interface?
 -------------------------------------------------------------------------------
 We welcome every Maximo Application Suite users, developers and enthusiasts to contribute to the MAS Command Line Interface while fixing code issues and implementing new automated functionalities.
-You can contribute to this collection by raising [a new issue](https://github.com/ibm-mas/cli/issues) with suggestions on how to make our MAS automation engine even better, or if you want to become a new code contributor, please refer to the [Contributing Guidelines](CONTRIBUTING.md) and learn more about how to get started.
+You can contribute to this collection by raising [a new issue](https://github.com/ibm-mas/cli/issues) with suggestions on how to make our MAS automation engine even better, or if you want to become a new code contributor, please refer to the [Contributing Guidelines](CONTRIBUTING.md) and learn more about how to get started.

image/cli/app-root/src/run-playbook.sh

@@ -16,7 +16,32 @@ source /opt/app-root/src/env.sh
 
 python3 /opt/app-root/src/register-start.py
 
+# Capture the playbook name for notification
+PLAYBOOK_NAME="$1"
+
+# Send Slack start notification if configured
+if [ -n "$SLACK_TOKEN" ] && [ -n "$SLACK_CHANNEL" ]; then
+  python3 /opt/app-root/bin/mas-devops-notify-slack \
+    --action ansible-start \
+    --task-name "$DEVOPS_SUITE_NAME" \
+    --pipeline-name "${PIPELINERUN_NAME:-unknown}" \
+    --instance-id "${DEVOPS_ENVIRONMENT:-}" || true
+      echo "# ----------------- Sending Start Notification Suite: $DEVOPS_SUITE_NAME | pipeline: $PIPELINE_NAME($PIPELINERUN_NAME) | Instance id: $DEVOPS_ENVIRONMENT -------------------- #"
+fi
+
 ansible-playbook ibm.mas_devops."$@"
 rc=$?
+
+# Send Slack completion notification if configured
+if [ -n "$SLACK_TOKEN" ] && [ -n "$SLACK_CHANNEL" ]; then
+  python3 /opt/app-root/bin/mas-devops-notify-slack \
+    --action ansible-complete \
+    --rc $rc \
+    --task-name "$DEVOPS_SUITE_NAME" \
+    --pipeline-name "${PIPELINERUN_NAME:-unknown}" \
+    --instance-id "${DEVOPS_ENVIRONMENT:-}" || true
+      echo "# ----------------- Sending Start Notification Suite: $DEVOPS_SUITE_NAME | pipeline: $PIPELINE_NAME($PIPELINERUN_NAME) | Instance id: $DEVOPS_ENVIRONMENT -------------------- #"
+fi
+
 python3 /opt/app-root/src/save-junit-to-mongo.py
 exit $rc

image/cli/app-root/src/run-role.sh

@@ -15,7 +15,30 @@ python3 /opt/app-root/src/register-start.py
 
 export ROLE_NAME=$1
 shift
+
+# Send Slack start notification if configured
+if [ -n "$SLACK_TOKEN" ] && [ -n "$SLACK_CHANNEL" ]; then
+  python3 /opt/app-root/bin/mas-devops-notify-slack \
+    --action ansible-start \
+    --task-name "$DEVOPS_SUITE_NAME" \
+    --pipeline-name "${PIPELINERUN_NAME:-unknown}" \
+    --instance-id "${DEVOPS_ENVIRONMENT:-}" || true
+  echo "# ----------------- Sending Start Notification Suite: $DEVOPS_SUITE_NAME | pipeline: $PIPELINE_NAME($PIPELINERUN_NAME) | Instance id: $DEVOPS_ENVIRONMENT -------------------- #"
+fi
+
 ansible-playbook ibm.mas_devops.run_role $@
 rc=$?
+
+# Send Slack completion notification if configured
+if [ -n "$SLACK_TOKEN" ] && [ -n "$SLACK_CHANNEL" ]; then
+  python3 /opt/app-root/bin/mas-devops-notify-slack \
+    --action ansible-complete \
+    --rc $rc \
+    --task-name "$DEVOPS_SUITE_NAME" \
+    --pipeline-name "${PIPELINERUN_NAME:-unknown}" \
+    --instance-id "${DEVOPS_ENVIRONMENT:-}" || true
+    echo "# ----------------- Sending Stop Notification Suite: $DEVOPS_SUITE_NAME | pipeline: $PIPELINE_NAME($PIPELINERUN_NAME) | Instance id: $DEVOPS_ENVIRONMENT -------------------- #"
+fi
+
 python3 /opt/app-root/src/save-junit-to-mongo.py
 exit $rc

image/cli/app-root/src/update-pipeline-status.py

@@ -8,17 +8,62 @@
 
 import os
 import sys
+import subprocess
 from datetime import datetime, UTC
 from pymongo import MongoClient
 
-if __name__ == "__main__":
-    if "DEVOPS_MONGO_URI" not in os.environ or os.environ['DEVOPS_MONGO_URI'] == "":
-        sys.exit(0)
 
-    print("MongoDb integration enabled (v2 data model)")
+def send_slack_notification(action, pipeline_name, instance_id, rc=0):
+    """
+    Send Slack notification for pipeline start or completion using CLI command.
 
-    # Initialize the properties we need
+    Args:
+        action: Either 'pipeline-start' or 'pipeline-complete'
+        pipeline_name: Name of the pipeline
+        instance_id: MAS instance ID
+        rc: Return code (0 for success, non-zero for failure)
+    """
+    slack_token = os.getenv("SLACK_TOKEN", "")
+    slack_channel = os.getenv("SLACK_CHANNEL", "")
+
+    if not slack_token or not slack_channel:
+        return
+
+    try:
+        print(f"Sending Slack notification: action={action}, pipeline={pipeline_name}, instance={instance_id}")
+
+        if action == "pipeline-start":
+            cmd = [
+                "python3", "/opt/app-root/bin/mas-devops-notify-slack",
+                "--action", "pipeline-start",
+                "--instance-id", instance_id,
+                "--pipeline-name", pipeline_name
+            ]
+        elif action == "pipeline-complete":
+            cmd = [
+                "python3", "/opt/app-root/bin/mas-devops-notify-slack",
+                "--action", "pipeline-complete",
+                "--rc", str(rc),
+                "--instance-id", instance_id,
+                "--pipeline-name", pipeline_name
+            ]
+        else:
+            print(f"Unknown action: {action}")
+            return
+
+        # Run the command, ignore errors (|| true equivalent)
+        result = subprocess.run(cmd, capture_output=True, text=True)
+        if result.returncode == 0:
+            print("Slack notification sent successfully")
+        else:
+            print(f"Slack notification command failed (ignored): {result.stderr}")
+
+    except Exception as e:
+        print(f"Error sending Slack notification (ignored): {e}")
 
+
+if __name__ == "__main__":
+    # Initialize the properties we need
     # Note: We don't use MAS_INSTANCE_ID to remove the confusion between when a role actually
     # needs MAS_INSTANCE_ID and when we are providing it just for the reporting framework
     instanceId = os.getenv("DEVOPS_ENVIRONMENT", "")
@@ -28,11 +73,40 @@
     pipelineRunName = os.getenv("PIPELINERUN_NAME", "")
     pipelineRunNamespace = os.getenv("PIPELINERUN_NAMESPACE", "")
 
-    if "" in [instanceId, build, pipelineName, pipelineStatus, pipelineRunName, pipelineRunNamespace]:
-        print("Pipeline status not recorded because one or more required env vars are not set")
-        sys.exit(0)
+    # =========================================================================
+    # Slack Notification Logic (runs independently)
+    # =========================================================================
+    SLACK_TOKEN = os.getenv("SLACK_TOKEN", "")
+    SLACK_CHANNEL = os.getenv("SLACK_CHANNEL", "")
 
-    runId = f"{instanceId}:{build}"
+    if SLACK_TOKEN and SLACK_CHANNEL:
+        print("\nSlack integration enabled")
+
+        if "" in [instanceId, pipelineName, pipelineRunName, pipelineStatus]:
+            print("Slack notification skipped: one or more required env vars are not set")
+        elif pipelineName not in ["mas-install", "mas-update", "mas-upgrade", "mas-uninstall"]:
+            print(f"No slack notifications for pipeline: {pipelineName}")
+        else:
+            if pipelineStatus == "Started":
+                print("Sending pipeline start notification to Slack...")
+                send_slack_notification("pipeline-start", pipelineRunName, instanceId)
+
+            elif pipelineStatus in ["Completed", "Succeeded"]:
+                print("Sending pipeline completion (success) notification to Slack...")
+                send_slack_notification("pipeline-complete", pipelineRunName, instanceId, rc=0)
+
+            elif pipelineStatus == "Failed":
+                print("Sending pipeline completion (failure) notification to Slack...")
+                send_slack_notification("pipeline-complete", pipelineRunName, instanceId, rc=1)
+    else:
+        print("\nSlack integration disabled (SLACK_TOKEN or SLACK_CHANNEL not set)")
+
+    # =========================================================================
+    # MongoDB Integration Logic (runs independently)
+    # =========================================================================
+    if "DEVOPS_MONGO_URI" not in os.environ or os.environ['DEVOPS_MONGO_URI'] == "":
+        print("\nMongoDb integration disabled (DEVOPS_MONGO_URI not set)")
+        sys.exit(0)
 
     print(f"Instance ID .............. {instanceId}")
     print(f"Build .................... {build}")
@@ -41,6 +115,14 @@
     print(f"PipelineRun Namespace .... {pipelineRunNamespace}")
     print(f"Status ................... {pipelineStatus}")
 
+    print("\nMongoDb integration enabled (v2 data model)")
+
+    if "" in [instanceId, build, pipelineName, pipelineStatus, pipelineRunName, pipelineRunNamespace]:
+        print("Pipeline status not recorded because one or more required env vars are not set")
+        sys.exit(0)
+
+    runId = f"{instanceId}:{build}"
+
     # Connect to mongoDb
     client = MongoClient(os.getenv("DEVOPS_MONGO_URI"))
     db = client.masfvt
@@ -55,16 +137,19 @@
             f"pipelines.{pipelineName}.status": "Started",
             f"pipelines.{pipelineName}.timestamp": datetime.now(UTC)
         }
+
     elif pipelineStatus in ["Completed", "Succeeded"]:
         updates = {
             f"pipelines.{pipelineName}.status": "Completed",
             f"pipelines.{pipelineName}.timestampFinished": datetime.now(UTC)
         }
+
     elif pipelineStatus == "Failed":
         updates = {
             f"pipelines.{pipelineName}.status": "Failed",
             f"pipelines.{pipelineName}.timestampFinished": datetime.now(UTC)
         }
+
     else:
         print("Unexpected state detected")
         sys.exit(0)
@@ -85,3 +170,5 @@
         },
         upsert=True
     )
+
+    print("Pipeline status recorded in MongoDB successfully")

image/cli/mascli/functions/internal/save_config

@@ -252,5 +252,9 @@ export MAS_MANUAL_CERT_MGMT=$MAS_MANUAL_CERT_MGMT
 # Guided Tour
 export MAS_ENABLE_WALKME=$MAS_ENABLE_WALKME
 
+# Slack
+export SLACK_TOKEN=$SLACK_TOKEN
+export SLACK_CHANNEL=$SLACK_CHANNEL
+
 EOF
 }

python/Makefile

@@ -24,4 +24,3 @@ lint: venv
 pyinstaller: venv
 	rm -f README.rst
 	. .venv/bin/activate && pyinstaller src/mas-upgrade --onefile --noconfirm --add-data="src/mas/devops/templates/ibm-mas-tekton.yaml:mas/devops/templates" --add-data="src/mas/devops/templates/subscription.yml.j2:mas/devops/templates/" --add-data="src/mas/devops/templates/pipelinerun-upgrade.yml.j2:mas/devops/templates/"
-

python/src/mas/cli/aiservice/install/app.py

@@ -493,7 +493,9 @@ def install(self, argv):
                     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)

python/src/mas/cli/aiservice/install/params.py

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

python/src/mas/cli/aiservice/install/summarizer.py

@@ -110,6 +110,13 @@ def mongoSummary(self) -> None:
         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 @@ def displayInstallSummary(self) -> None:
         self.slsSummary()
         self.mongoSummary()
         self.db2Summary()
+
+        # Notification Integration
+        self.slackSummary()

python/src/mas/cli/install/app.py

@@ -2120,7 +2120,9 @@ def install(self, argv):
                     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)

python/src/mas/cli/install/argBuilder.py

@@ -579,6 +579,11 @@ def buildCommand(self) -> str:
         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:

python/src/mas/cli/install/argParser.py

@@ -1581,6 +1581,18 @@ def isValidFile(parser: argparse.ArgumentParser, arg: str) -> str:
     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",

python/src/mas/cli/install/params.py

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

python/src/mas/cli/install/summarizer.py

@@ -411,6 +411,13 @@ def grafanaSummary(self) -> None:
         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 @@ def displayInstallSummary(self) -> None:
         self.cp4dSummary()
         self.grafanaSummary()
 
+        # Notification Integration
+        self.slackSummary()
+
         # Install options
         self.installSummary()

python/src/mas/cli/uninstall/app.py

@@ -39,6 +39,10 @@ def uninstall(self, argv):
         droNamespace = args.dro_namespace
         self.noConfirm = args.no_confirm
 
+        # Set image_pull_policy if provided
+        if args.image_pull_policy and args.image_pull_policy != "":
+            self.setParam("image_pull_policy", args.image_pull_policy)
+
         if args.uninstall_all_deps:
             uninstallGrafana = True
             uninstallIBMCatalog = True