Skip to content

Commit bf8b384

Browse files
timdamantimdaman
authored
Fixing documentation formatting and copyright date (#32)
* Fixing text formatting and copyright date
1 parent 12f4c42 commit bf8b384

File tree

3 files changed

+53
-53
lines changed

3 files changed

+53
-53
lines changed

‎README.txt‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -38,56 +38,56 @@ check_docker Usage
3838

3939
::
4040

41-
usage: check_docker [-h]
42-
[--connection [/<path to>/docker.socket|<ip/host address>:<port>]
43-
| --secure-connection [<ip/host address>:<port>]]
44-
[--binary_units | --decimal_units] [--timeout TIMEOUT]
45-
[--containers CONTAINERS [CONTAINERS ...]] [--present]
46-
[--cpu WARN:CRIT] [--memory WARN:CRIT:UNITS]
47-
[--status STATUS] [--health] [--uptime WARN:CRIT]
48-
[--version]
49-
[--insecure-registries INSECURE_REGISTRIES [INSECURE_REGISTRIES ...]]
50-
[--restarts WARN:CRIT]
51-
52-
Check docker containers.
53-
54-
optional arguments:
55-
-h, --help show this help message and exit
56-
--connection [/<path to>/docker.socket|<ip/host address>:<port>]
57-
Where to find docker daemon socket. (default:
58-
/var/run/docker.sock)
59-
--secure-connection [<ip/host address>:<port>]
60-
Where to find TLS protected docker daemon socket.
61-
--binary_units Use a base of 1024 when doing calculations of KB, MB,
62-
GB, & TB (This is default)
63-
--decimal_units Use a base of 1000 when doing calculations of KB, MB,
64-
GB, & TB
65-
--timeout TIMEOUT Connection timeout in seconds. (default: 10.0)
66-
--containers CONTAINERS [CONTAINERS ...]
67-
One or more RegEx that match the names of the
68-
container(s) to check. If omitted all containers are
69-
checked. (default: ['all'])
70-
--present Modifies --containers so that each RegEx must match at
71-
least one container.
72-
--cpu WARN:CRIT Check cpu usage percentage taking into account any
73-
limits. Valid values are 0 - 100.
74-
--memory WARN:CRIT:UNITS
75-
Check memory usage taking into account any limits.
76-
Valid values for units are %,B,KB,MB,GB.
77-
--status STATUS Desired container status (running, exited, etc).
78-
(default: None)
79-
--health Check container's health check status
80-
--uptime WARN:CRIT Minimum container uptime in seconds. Use when
81-
infrequent crashes are tolerated.
82-
--version Check if the running images are the same version as
83-
those in the registry. Useful for finding stale
84-
images. Does not support login.
85-
--insecure-registries INSECURE_REGISTRIES [INSECURE_REGISTRIES ...]
86-
List of registries to connect to with http(no TLS).
87-
Useful when using "--version" with images from
88-
insecure registries.
89-
--restarts WARN:CRIT Container restart thresholds.
41+
usage: check_docker [-h]
42+
[--connection [/<path to>/docker.socket|<ip/host address>:<port>]
43+
| --secure-connection [<ip/host address>:<port>]]
44+
[--binary_units | --decimal_units] [--timeout TIMEOUT]
45+
[--containers CONTAINERS [CONTAINERS ...]] [--present]
46+
[--cpu WARN:CRIT] [--memory WARN:CRIT:UNITS]
47+
[--status STATUS] [--health] [--uptime WARN:CRIT]
48+
[--version]
49+
[--insecure-registries INSECURE_REGISTRIES [INSECURE_REGISTRIES ...]]
50+
[--restarts WARN:CRIT]
51+
52+
Check docker containers.
9053

54+
optional arguments:
55+
-h, --help show this help message and exit
56+
--connection [/<path to>/docker.socket|<ip/host address>:<port>]
57+
Where to find docker daemon socket. (default:
58+
/var/run/docker.sock)
59+
--secure-connection [<ip/host address>:<port>]
60+
Where to find TLS protected docker daemon socket.
61+
--binary_units Use a base of 1024 when doing calculations of KB, MB,
62+
GB, & TB (This is default)
63+
--decimal_units Use a base of 1000 when doing calculations of KB, MB,
64+
GB, & TB
65+
--timeout TIMEOUT Connection timeout in seconds. (default: 10.0)
66+
--containers CONTAINERS [CONTAINERS ...]
67+
One or more RegEx that match the names of the
68+
container(s) to check. If omitted all containers are
69+
checked. (default: ['all'])
70+
--present Modifies --containers so that each RegEx must match at
71+
least one container.
72+
--cpu WARN:CRIT Check cpu usage percentage taking into account any
73+
limits. Valid values are 0 - 100.
74+
--memory WARN:CRIT:UNITS
75+
Check memory usage taking into account any limits.
76+
Valid values for units are %,B,KB,MB,GB.
77+
--status STATUS Desired container status (running, exited, etc).
78+
(default: None)
79+
--health Check container's health check status
80+
--uptime WARN:CRIT Minimum container uptime in seconds. Use when
81+
infrequent crashes are tolerated.
82+
--version Check if the running images are the same version as
83+
those in the registry. Useful for finding stale
84+
images. Does not support login.
85+
--insecure-registries INSECURE_REGISTRIES [INSECURE_REGISTRIES ...]
86+
List of registries to connect to with http(no TLS).
87+
Useful when using "--version" with images from
88+
insecure registries.
89+
--restarts WARN:CRIT Container restart thresholds.
90+
9191
check_swarm Usage
9292
-----------------
9393

‎check_docker‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import re
1818

1919
logger = logging.getLogger()
2020
__author__ = 'Tim Laurence'
21-
__copyright__ = "Copyright 2017"
21+
__copyright__ = "Copyright 2018"
2222
__credits__ = ['Tim Laurence']
2323
__license__ = "GPL"
24-
__version__ = "2.0.0"
24+
__version__ = "2.0.1"
2525

2626
'''
2727
nrpe compatible check for docker containers.

‎check_swarm‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ import re
1313

1414
logger = logging.getLogger()
1515
__author__ = 'Tim Laurence'
16-
__copyright__ = "Copyright 2017"
16+
__copyright__ = "Copyright 2018"
1717
__credits__ = ['Tim Laurence']
1818
__license__ = "GPL"
19-
__version__ = "2.0.0"
19+
__version__ = "2.0.1"
2020

2121
'''
2222
nrpe compatible check for docker swarm

0 commit comments

Comments
 (0)