-
Notifications
You must be signed in to change notification settings - Fork 7
/
README.yaml
74 lines (65 loc) · 1.99 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Ansible Role Slack SSH Notifier
# License of this project
license: "MIT"
# Canonical GitHub repo
github_repo: clouddrove/ansible-role-slack-ssh-notifier
# Badges to display
badges:
- name: "Ansible"
image: "https://img.shields.io/badge/Ansible-2.8-green?style=flat&logo=ansible"
url: "https://www.ansible.com"
- name: "Licence"
image: "https://img.shields.io/badge/License-MIT-blue.svg"
url: "LICENSE.md"
- name: "Distribution"
image: "https://img.shields.io/badge/ubuntu-16.x-orange?style=flat&logo=ubuntu"
url: "https://ubuntu.com/"
- name: "Distribution"
image: "https://img.shields.io/badge/ubuntu-18.x-orange?style=flat&logo=ubuntu"
url: "https://ubuntu.com/"
- name: "Distribution"
image: "https://img.shields.io/badge/centos-7.x-orange"
url: "https://www.centos.org/"
# Prerequesties to display
# yamllint disable
prerequesties:
- name: "Ansible2.8"
url: "https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html"
- name: "Python"
url: "https://www.python.org/downloads"
- name: "Docker"
url: "https://docs.docker.com/install/linux/docker-ce/ubuntu"
# yamllint enable
# What Includes to display
what_includes:
- name: "slack-ssh-notifier"
# description of this project
description: |-
This ansible role is used to install Slack SSH notifier on server.
# How to use this project
usage: |-
```yaml
- hosts: localhost
remote_user: root
become: true
roles:
- clouddrove.ansible_role_slack_ssh_notifier
```
# Variables use in the project
variables: |-
```yaml
channel: "testing"
webhook_url: "https://hooks.slack.com/services/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"
dir_path: "/opt/slack-ssh-notifier"
```
# How to install project
installation: |-
```console
$ ansible-galaxy install clouddrove.ansible_role_slack_ssh_notifier
```