~wesmason/conn-check/configs-django-dev

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Wes Mason
  • Date: 2014-09-24 21:00:06 UTC
  • Revision ID: wesley.mason@canonical.com-20140924210006-57cm49c9aqhpaipu
Update readme and add manifest

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
conn-check
2
 
==========
3
 
 
4
 
conn-check allows for checking connectivity with external services.
5
 
 
6
 
You can write a config file that defines services that you need to
7
 
have access to, and conn-check will check connectivity with each.
8
 
 
9
 
It supports various types of services, all of which allow for
10
 
basic network checks, but some allow for confirming credentials
11
 
work also.
12
 
 
13
 
Configuration
14
 
-------------
15
 
 
16
 
The configuration is done via a yaml file. The file defines a list
17
 
of checks to do::
18
 
 
19
 
    - type: tcp
20
 
      host: localhost
21
 
      port: 80
22
 
    - type: ssl
23
 
      host: localhost
24
 
      port: 443
25
 
      verify: true
26
 
 
27
 
Each check defines a type, and then options as appropriate for that type.
28
 
 
29
 
Check Types
30
 
-----------
31
 
 
32
 
tcp
33
 
```
34
 
 
35
 
A simple tcp connectivity check.
36
 
 
37
 
host
38
 
    The host.
39
 
 
40
 
port
41
 
    The port.
42
 
 
43
 
 
44
 
ssl
45
 
```
46
 
 
47
 
A check that uses SSL.
48
 
 
49
 
host
50
 
    The host.
51
 
 
52
 
port
53
 
    The port.
54
 
 
55
 
verify
56
 
    Whether to also verify the SSL certificate. Optional. Default: true.
57
 
 
58
 
 
59
 
udp
60
 
```
61
 
 
62
 
Check that sending a specific UDP packet gets a specific response.
63
 
 
64
 
host
65
 
    The host.
66
 
 
67
 
port
68
 
    The port.
69
 
 
70
 
send
71
 
    The string to send.
72
 
 
73
 
expect
74
 
    The string to expect in the response.
75
 
 
76
 
 
77
 
http
78
 
````
79
 
 
80
 
Check that a HTTP request succeeds.
81
 
 
82
 
url
83
 
    The URL to fetch.
84
 
 
85
 
method
86
 
    The method to use. Optional. Default: "GET".
87
 
 
88
 
expected_code
89
 
    The status code that defines success. Optional. Default: 200.
90
 
 
91
 
 
92
 
amqp
93
 
````
94
 
 
95
 
Check that an AMQP server can be authenticated against.
96
 
 
97
 
host
98
 
    The host.
99
 
 
100
 
port
101
 
    The port.
102
 
 
103
 
username
104
 
    The username to authenticate with.
105
 
 
106
 
password
107
 
    The password to authenticate with.
108
 
 
109
 
use_ssl
110
 
    Whether to connect with ssl. Optional. Default: true.
111
 
 
112
 
vhost
113
 
    The vhost to connect to. Optional. Default '/'.
114
 
 
115
 
 
116
 
postgres
117
 
````````
118
 
 
119
 
Check that a postgres db can be authenticated against.
120
 
 
121
 
host
122
 
    The host.
123
 
 
124
 
port
125
 
    The port.
126
 
 
127
 
username
128
 
    The username to authenticate with.
129
 
 
130
 
password
131
 
    The password to authenticate with.
132
 
 
133
 
database
134
 
    The database to connect to.
135
 
 
136
 
 
137
 
redis
138
 
`````
139
 
 
140
 
Check that a redis server is present, optionally checking authentication.
141
 
 
142
 
host
143
 
    The host.
144
 
 
145
 
port
146
 
    The port.
147
 
 
148
 
password
149
 
    The password to authenticatie with. Optional.
150
 
 
151
 
 
152
 
memcached
153
 
`````````
154
 
 
155
 
Check that a memcached server is present (`memcache` also works).
156
 
 
157
 
host
158
 
    The host.
159
 
 
160
 
port
161
 
    The port.
162
 
 
 
1
conn-check-configs
 
2
==================
 
3
 
 
4
This is a set of Python modules and utilities for generating `conn-check <https://launchpad.net/conn-check>`_
 
5
config YAML from other sources, such as Django settings modules.
 
6
 
 
7
 
 
8
Supported sources
 
9
-----------------
 
10
 
 
11
 - Django settings modules
 
12
 
 
13
 
 
14
Usage
 
15
-----
 
16
 
 
17
Django
 
18
``````
 
19
You can export common settings from a Django application using the `conn-check-django` command line
 
20
utility, which takes the following arguments:
 
21
 
 
22
 - `-m`, `--settings-module`: the Python module for Django to import.
 
23
 - `-d`, `--database-name`: the database schema name if not set as `NAME` in the Django settings.
 
24
 
 
25
 Followed by a path to the generated YAML file, for example::
 
26
 
 
27
     $ conn-check-django -m myapp.settings /tmp/myapp-conncheck.yaml
 
28
     $ conn-check /tmp/myapp-conncheck.yaml
163
29
 
164
30
Building wheels
165
31
---------------
166
32
 
167
33
To allow for easier/more portable distribution of this tool you can build
168
 
conn-check and all it's dependencies as `Python wheels <http://legacy.python.org/dev/peps/pep-0427/>`_::
 
34
conn-check-configs and all it's dependencies as `Python wheels <http://legacy.python.org/dev/peps/pep-0427/>`_::
169
35
 
170
36
    make clean-wheels
171
37
    make build-wheels
172
 
    EXTRA=amqp make build-wheels-extra
173
 
    EXTRA=redis make build-wheels-extra
174
38
 
175
 
The `build-wheels` make target will build conn-check and it's base
176
 
dependencies, but to include the optional extra dependencies for other
177
 
checks such as amqp, redis or postgres you need to use the
178
 
`build-wheels-extra` target with the `EXTRA` env value.
 
39
The `build-wheels` make target will build conn-check-configs and it's base dependencies.
179
40
 
180
41
By default all the wheels will be placed in `./wheels`.