Yriser 0.0.3 - Santa Fe

docs/tutorials/command.md

@@ -59,6 +59,14 @@ Only CLI Input without JSON.
 
 > Do not disable output without CSV (command -u) for the JSON outputs
 
+## Slack
+
+Send report result to Slack
+
+``` shell
+./yriser.sh -w <webhook_token>
+```
+
 ## AWS
 
 ### AWS - Display help documentation

docs/tutorials/reporting.md

@@ -64,4 +64,12 @@ Multiple Tag:
     "NUMBER": null
   }
 ]
-```
+```
+
+## Slack
+
+Send a notification on Slack when the audit is complete.
+
+![Send report result to Slack](img/report-slack.png)
+
+See Slack [documentation to create a weebhook](https://api.slack.com/messaging/webhooks)

file/logo.txt

@@ -2,6 +2,6 @@ __  __     _
 \ \/ /____(_)_______  _____
  \  / ___/ / ___/ _ \/ ___/
  / / /  / (__  )  __/ /    
-/_/_/  /_/____/\___/_/ v0.0.2 - Lisa
+/_/_/  /_/____/\___/_/ v0.0.3 - Santa Fe
 An Open-Source FinOps Tool for Efficient Tag Management
 

report_tag.sh

@@ -462,4 +462,69 @@ if [ "$cli_output_json" = "yes" ]; then
 echo "  - JSON: $(pwd)/output/json/$OUTPUT_FILE.json"
 fi
 
-rm -rf output/.txt 2> /dev/null
+rm -rf output/.txt 2> /dev/null
+
+# Slack message
+if [ "$WEBHOOK_URL" != ""  ]; then
+MESSAGE='{
+    "blocks": [
+        {
+            "type": "section",
+            "text": {
+                "type": "mrkdwn",
+                "text": "Hi there 👋\n\n*Yriser*, FinOps tool to perform AWS tagging best practices, tagging strategy, continuous adjustments in cloud optimization 🛣️\n\n I have just finished the scan on your AWS Account *'"$ACCOUNT"'* ('"$REGION"')  with a total *'"$TOTAL_RESOURCES"' ressources scanning*. "
+            },
+            "accessory": {
+                "type": "image",
+                "image_url": "https://avatars.githubusercontent.com/u/124205798?s=200&v=4",
+                "alt_text": "cute cat"
+            }
+        },
+        {
+            "type": "divider"
+        },
+        {
+            "type": "section",
+            "text": {
+                "type": "plain_text",
+                "text": "🏷️ '"$TAG_CPT"' Total Tags\n✅ '"$NUMBER_OF_OK"' Correctly tagged ('"$TAG_CORRECT_PER"'%)\n📊 '"$NUMBER_OF_ERRORS"' Errors ('"$NUMBER_OF_ERRORS_PER"'%)\n🛑 '"$NUMBER_OF_ERRORS_CAL"' Ressources with other tags ('"$NUMBER_OF_ERRORS_CAL_PER"'%)\n❌ '"$number_RESOURCETAGMAPPINGLIST_without_tag"' Without tag ('"$number_RESOURCETAGMAPPINGLIST_without_tag_PER"'%)",
+                "emoji": true
+            }
+        },
+        {
+            "type": "divider"
+        },
+        {
+            "type": "section",
+            "text": {
+                "type": "mrkdwn",
+                "text": "Used parameters `-'"$SOURCE_FILE"' -'"$OUTPUT_FILE"' -'"$OUTPUT_CSV"'`"
+            }
+        },
+        {
+            "type": "divider"
+        },
+        {
+            "type": "section",
+            "text": {
+                "type": "mrkdwn",
+                "text": "Version '"$VERSION"' | Join us"
+            },
+            "accessory": {
+                "type": "button",
+                "text": {
+                    "type": "plain_text",
+                    "text": "Yris :slack:",
+                    "emoji": true
+                },
+                "value": "click_me_123",
+                "url": "https://join.slack.com/t/yrisgroupe/shared_invite/zt-1q51z8dmv-GC0XzUSclzBnUQ0tpKhznw",
+                "action_id": "button-action"
+            }
+        }
+    ]
+}'
+
+curl -X POST -H 'Content-type: application/json' --data "$MESSAGE" "$WEBHOOK_URL" &> /dev/null
+echo ""
+fi

yriser.sh

@@ -3,7 +3,7 @@
 # Copyright: Apache License 2.0
 # Yriser - https://github.com/yris-ops/yriser
 
-export VERSION="0.0.2-Lisa-15August2023"
+export VERSION="0.0.3-SantaFe-22September2023"
 REGION_LIST="allregions"
 show_banner=true
 specific_aws_profile=true
@@ -26,7 +26,8 @@ Command line options:
     -w,   show config file
     -o,   only cli output whiout html
     -u,   only cli output whiout csv
-    -u,   only cli output whiout json
+    -j,   only cli output whiout json
+    -w,   send report result to slack
 
 Yriser Available Cloud Providers:
     -a,  show AWS Provider help
@@ -110,7 +111,13 @@ S3()
     echo "Upload into the bucket: $AWS_S3_NAME, done"
 }
 
-while getopts "h/a/v/b/c/o/u/j/y/r:/p:/s:" option; do
+# Send Slack message
+Slack()
+{
+    export WEBHOOK_URL="$WEBHOOK_URL"
+}
+
+while getopts "h/a/v/b/c/o/u/j/y/r:/p:/s:/w:" option; do
     case $option in
       h) # display help
          echo "$COMMAND_LINE_OPTIONS_HELP"
@@ -147,6 +154,10 @@ while getopts "h/a/v/b/c/o/u/j/y/r:/p:/s:" option; do
          AWS_S3_NAME+="$OPTARG"
          s3_aws_profile=true
          ;;
+      w) # send report result to slack
+         WEBHOOK_URL+="$OPTARG"
+         Slack
+         ;;
       \?) # incorrect option
          echo "Error: Invalid option"
          exit;;