Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-healthcheck
Puppet resources to evaluate the health and status of things.
https://github.com/voxpupuli/puppet-healthcheck
centos-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet redhat-puppet-module scientific-puppet-module ubuntu-puppet-module
Last synced: about 2 months ago
JSON representation
Puppet resources to evaluate the health and status of things.
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-healthcheck
- Owner: voxpupuli
- License: apache-2.0
- Created: 2015-05-20T10:44:49.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T18:46:47.000Z (5 months ago)
- Last Synced: 2024-11-30T17:49:40.448Z (2 months ago)
- Topics: centos-puppet-module, hacktoberfest, linux-puppet-module, oraclelinux-puppet-module, puppet, redhat-puppet-module, scientific-puppet-module, ubuntu-puppet-module
- Language: Ruby
- Homepage: https://forge.puppet.com/puppet/healthcheck
- Size: 218 KB
- Stars: 23
- Watchers: 46
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-puppet - puppet-healthcheck - Healthcheck resources. (Modules)
- awesome-puppet - puppet-healthcheck - Healthcheck resources. (Modules)
README
# puppet-healthcheck
## Types
### tcp_conn_validator
`tcp_conn_validator` is used to verify that a service is listening on a given port.
It could be used to test either a remote or a local service. It support both IPv4 and
IPv6 connection strings. It also works with hostname.
```puppet
tcp_conn_validator { 'foo-machine ssh service' :
host => '192.168.0.42',
port => 22,
}
```
The namevar of this resource can also be the connection string. It comes handy when
one already have an array of ip:port or hostname:port string to test.
```puppet
mongodb_cluster_nodes = ['192.168.0.2:27017', 'node02.foo.bar.com:27017']
tcp_conn_validator { $mongodb_cluster_nodes : }
```
#### `host`
IP address or server DNS name on which the service is supposed to be bound to. Required if the namevar is not a connection string.
#### `port`
Port on which the service is supposed to listen. Required if the namevar is not a connection string.
#### `try_sleep`
The time to sleep in seconds between ‘tries’. Default: 1
#### `timeout`
Number of seconds to wait before timing out. Default: 60
### http_conn_validator
`http_conn_validator` is used to verify that an http server is answering on a given port.
It could be used to test either a remote or a local service. It support both IPv4 and
IPv6 connection strings. It also works with hostname.
**It currently has the `Accept` header hardcoded to `application/json`, you can only connect to sites that return json**
See https://github.com/voxpupuli/puppet-healthcheck/blob/b3723805d629cc01767a2fb12c4c8a023d707f94/lib/puppet_x/puppet-community/http_validator.rb#L19 for details
```puppet
http_conn_validator { 'foo-machine home' :
host => '127.0.0.1',
port => 80,
use_ssl => true,
}
```
The namevar of this resource can also be the connection string. It comes handy when
one already have an array of URLs string to test.
```puppet
appli_cluster_nodes = ['https://server1.com/test-url', 'https://server2.com/test-url']
http_conn_validator { $appli_cluster_nodes : }
```
#### `host`
IP address or server DNS name on which the service is supposed to be bound to. Required if the namevar is not a connection string.
#### `port`
Port on which the service is supposed to listen. Required if the namevar is not a connection string.
#### `use_ssl`
Whether the connection will be attempted using https. Default: false
#### `test_url`
URL to use for testing if the HTTP server is up. Default: /
#### `try_sleep`
The time to sleep in seconds between ‘tries’. Default: 1
#### `timeout`
Number of seconds to wait before timing out. Default: 60
#### `expected_code`
Expected HTTP result code to consider success. Default: 200
#### `verify_peer`
Whether to verify the peer credentials, if possible. Verification will not take place if the CA certificate is missing