{"id":20073295,"url":"https://github.com/slenky/puppet-notifier","last_synced_at":"2025-03-02T12:20:38.716Z","repository":{"id":57665074,"uuid":"114249306","full_name":"slenky/puppet-notifier","owner":"slenky","description":"Custom Puppet report handler for Skype, Slack and Telegram.","archived":false,"fork":false,"pushed_at":"2017-12-18T16:00:51.000Z","size":25,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-14T03:48:56.637Z","etag":null,"topics":["custom","notifier","puppet","reports","ruby","skype","slack","telegram"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/slenky/notifier","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slenky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-14T12:42:31.000Z","updated_at":"2017-12-18T16:12:35.000Z","dependencies_parsed_at":"2022-09-26T20:31:16.152Z","dependency_job_id":null,"html_url":"https://github.com/slenky/puppet-notifier","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slenky%2Fpuppet-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slenky%2Fpuppet-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slenky%2Fpuppet-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slenky%2Fpuppet-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slenky","download_url":"https://codeload.github.com/slenky/puppet-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241504020,"owners_count":19973165,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom","notifier","puppet","reports","ruby","skype","slack","telegram"],"created_at":"2024-11-13T14:44:44.898Z","updated_at":"2025-03-02T12:20:38.698Z","avatar_url":"https://github.com/slenky.png","language":"Ruby","readme":"\n# Puppet-Notifier module\n\n\n\n#### Table of Contents\n\n1. [Description](#description)\n2. [Setup - The basics of getting started with notifier](#setup)\n    * [Installation](#installation)\n    * [Skyper](#skyper)\n    * [Slacker](#slacker)\n    * [Telegramer](#telegramer)\n3. [Usage - Configuration options and additional functionality](#usage)\n4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n## Description\n\nThis module allows you to send managed Puppet reports into Skype, Slack and Telegram about status changes on your infrastructure on every Puppet run. Reports would be sent for you if the status equals changed or failed.\nIntegration with PuppetBoard included!\n\n## Setup\n\n### Installation\nIt is *vital* to install this module into core modules folder of your Puppetserver (i.e /etc/puppetlabs/code/modules)!\n\n### Skyper\n\n1. Create the Skype bot at [BotFramework](https://dev.botframework.com/bots). Catch the Application ID and Application secret values.\n2. Create conversation in Skype, add bot and write '/get name' in IM to gather chat ID.\n\n### Slacker\n\nYou just need to add new webhook for your team [here](https://my.slack.com/services/new/incoming-webhook/). No additional modifications required.\nWebhook would be in format https://hooks.slack.com/services/ABC/123/QWE\n\n### Telegramer\n\n1. Find the @BotFather contact\n2. Write /newbot and pass through multiple questions.\n3. Get the access token from the answer.\n4. Add your new bot into channel and write something like @YOURBOT hello\n5. Open https://api.telegram.org/bot\u003cACCESS_TOKEN\u003e/getUpdates and find the chat id variable.\n\n## Usage\nSimply add the class of the service you want to use into your manifest within Puppetserver node:\n```\nnode 'puppetserver' {\n\n  $puppetboard_link = 'http://172.16.100.101/puppetboard/'\n  class { 'notifier::skyper':\n    chat_id =\u003e 'somechatid@thread.skype',\n    client_id =\u003e 'someclientid',\n    puppetboard =\u003e $puppetboard_link,\n    client_secret =\u003e 'someclientsecret'\n  }\n  class { 'notifier::slacker':\n    hook_url =\u003e 'https://hooks.slack.com/services/ABC/123/QWE',\n    username =\u003e 'Puppet Notifier',\n    channel  =\u003e '#puppet-test',\n    puppetboard =\u003e $puppetboard_link,\n    icon_url =\u003e 'https://www.404techsupport.com/wp-content/uploads/2014/06/puppet-labs-featured.png'\n  }\n  class { 'notifier::telegramer':\n    token =\u003e 'your_bot_token',\n    chat_id =\u003e 'chat_id_from_api',\n    send_stickers  =\u003e 'true',\n    puppetboard =\u003e $puppetboard_link\n  }\n\n}\n```\n\n\n## Reference\n\n### notifier::skyper\nchat_id - your conversation ID from '/get name' command\nclient_id - Application ID from BotFramework\nclient_secret - Application Secret\npuppetboard - Link to your Puppetboard\n\n### notifier::slacker\nhook_url - your Incoming Webhook URL\nchannel - where to send reports\nusername - bot name which send reports\nicon_url - small image which stands for bot avatar\n\n### notifier::telegramer\ntoken - access key from BotFather\nchat_id - conversation ID from API\nsend_stickers - should your bot send telegram stickers with report based on his status or not. Remove this attribute to disable.\n\n## Limitations\n\nThis module was tested on Puppet 5.2.0 with latest Puppetserver 5.1.4.\n\n## Development\n\nFeel free to create issues, PR and so on :)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslenky%2Fpuppet-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslenky%2Fpuppet-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslenky%2Fpuppet-notifier/lists"}