Browse Source

Update documentation

* Remove old yaml config file
* Provide instructions on how to run monasca-notification

Change-Id: If764e666209acbefe80be4de8743d54e371cca58
Doug Szumski 6 months ago
parent
commit
9fb6663395
3 changed files with 18 additions and 139 deletions
  1. 13
    0
      README.rst
  2. 5
    0
      etc/monasca/README-notification.conf.txt
  3. 0
    139
      notification.yaml

+ 13
- 0
README.rst View File

@@ -92,6 +92,19 @@ generated by running:
92 92
 
93 93
     tox -e genconfig
94 94
 
95
+To run the service using the default config file location
96
+of `/etc/monasca/notification.conf`:
97
+
98
+::
99
+
100
+    monasca-notification
101
+
102
+To run the service and explicitly specify the config file:
103
+
104
+::
105
+
106
+    monasca-notification --config-file /etc/monasca/monasca-notification.conf
107
+
95 108
 Monitoring
96 109
 ----------
97 110
 

+ 5
- 0
etc/monasca/README-notification.conf.txt View File

@@ -0,0 +1,5 @@
1
+To generate the sample notification.conf file, run the following command from the top
2
+level of the monasca-notification directory:
3
+
4
+    tox -egenconfig
5
+

+ 0
- 139
notification.yaml View File

@@ -1,139 +0,0 @@
1
-kafka:
2
-    url: 127.0.0.1:9092  # or comma seperated list of multiple hosts
3
-    group: monasca-notification
4
-    alarm_topic: alarm-state-transitions
5
-    notification_topic: alarm-notifications
6
-    notification_retry_topic: retry-notifications
7
-    periodic:
8
-        60: 60-seconds-notifications
9
-
10
-    max_offset_lag: 600  # In seconds, undefined for none
11
-
12
-database:
13
-#  repo_driver: monasca_notification.common.repositories.postgres.pgsql_repo:PostgresqlRepo
14
-#  repo_driver: monasca_notification.common.repositories.orm.orm_repo:OrmRepo
15
-  repo_driver: monasca_notification.common.repositories.mysql.mysql_repo:MysqlRepo
16
-  orm:
17
-    url: 'postgres://notification:password@127.0.0.1:5432/mon'
18
-
19
-mysql:
20
-  host: 127.0.0.1
21
-  port: 3306
22
-  user: notification
23
-  passwd: password
24
-  db: mon
25
-  # A dictionary set according to the params defined in, http://dev.mysql.com/doc/refman/5.0/en/mysql-ssl-set.html
26
-  #    ssl: {'ca': '/path/to/ca'}
27
-
28
-postgresql:
29
-  user: notification
30
-  password: password
31
-  database: mon
32
-  port: 5432
33
-  host: 127.0.0.1
34
-
35
-notification_types:
36
-    plugins:
37
-     - monasca_notification.plugins.hipchat_notifier:HipChatNotifier
38
-     - monasca_notification.plugins.slack_notifier:SlackNotifier
39
-     - monasca_notification.plugins.jira_notifier:JiraNotifier
40
-
41
-    email:
42
-        server: 127.0.0.1
43
-        port: 25
44
-        user:
45
-        password:
46
-        timeout: 60
47
-        from_addr: monasca-notification@none.invalid
48
-        grafana_url: 'http://127.0.0.1:3000'
49
-
50
-    webhook:
51
-        timeout: 5
52
-
53
-    pagerduty:
54
-        timeout: 5
55
-        url: "https://events.pagerduty.com/generic/2010-04-15/create_event.json"
56
-
57
-    hipchat:
58
-        timeout: 5
59
-        ca_certs: "/etc/ssl/certs/ca-certificates.crt"
60
-        insecure: False
61
-        proxy:  https://myproxy.corp.invalid:8080
62
-
63
-    slack:
64
-        timeout: 5
65
-        ca_certs: "/etc/ssl/certs/ca-certificates.crt"
66
-        insecure: False
67
-        proxy:  https://myproxy.corp.invalid:8080
68
-
69
-    jira:
70
-        user: username
71
-        password: password
72
-
73
-processors:
74
-    alarm:
75
-        number: 2
76
-        ttl: 14400  # In seconds, undefined for none. Alarms older than this are not processed
77
-    notification:
78
-        number: 4
79
-
80
-retry:
81
-    interval: 30
82
-    max_attempts: 5
83
-
84
-queues:
85
-    alarms_size: 256
86
-    finished_size: 256
87
-    notifications_size: 256
88
-    sent_notifications_size: 50  # limiting this size reduces potential # of re-sent notifications after a failure
89
-
90
-zookeeper:
91
-    url: 127.0.0.1:2181  # or comma separated list of multiple hosts
92
-    notification_path: /notification/alarms
93
-    notification_retry_path: /notification/retry
94
-    periodic_path:
95
-        60: /notification/60_seconds
96
-
97
-logging: # Used in logging.dictConfig
98
-    # This sets logging.raiseExcetpions. It is recommended to leave this set to False.
99
-    # See https://docs.python.org/2/howto/logging.html#exceptions-raised-during-logging
100
-    raise_exceptions: False
101
-    version: 1
102
-    disable_existing_loggers: False
103
-    formatters:
104
-        default:
105
-            format: "%(asctime)s %(levelname)s %(name)s %(message)s"
106
-    handlers:
107
-        console:
108
-            class: logging.StreamHandler
109
-            formatter: default
110
-        file:
111
-            class : logging.handlers.RotatingFileHandler
112
-            filename: /tmp/notification.log
113
-            formatter: default
114
-            maxBytes: 10485760  # Rotate at file size ~10MB
115
-            backupCount: 5  # Keep 5 older logs around
116
-    loggers:
117
-        kazoo:
118
-            level: WARN
119
-        kafka:
120
-            level: WARN
121
-        statsd:
122
-            level: WARN
123
-    root:
124
-        handlers:
125
-            - console
126
-        level: DEBUG
127
-statsd:
128
-    host: 'localhost'
129
-    port: 8125
130
-
131
-keystone:
132
-    auth_required: False
133
-    auth_url: 'http://127.0.0.1/identity/v3'
134
-    username: 'admin'
135
-    password: 'password'
136
-    project_name: 'admin'
137
-    user_domain_name: 'default'
138
-    project_domain_name: 'default'
139
-    auth_type: 'password'

Loading…
Cancel
Save