Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dadav/webcheck

With this puppet module you can use minimal cross node dependencies.
https://github.com/dadav/webcheck

module puppet

Last synced: about 2 months ago
JSON representation

With this puppet module you can use minimal cross node dependencies.

Host: GitHub
URL: https://github.com/dadav/webcheck
Owner: dadav
Created: 2021-03-14T20:06:56.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2021-03-20T07:44:42.000Z (almost 4 years ago)
Last Synced: 2024-11-16T17:40:05.823Z (3 months ago)
Topics: module, puppet
Language: Ruby
Homepage:
Size: 25.4 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# Reference

## Table of Contents

### Classes

* [`webcheck`](#webcheck): Contains the wait_for_connection and wait_for_response resources

### Resource types

* [`wait_for_connection`](#wait_for_connection): Waits until a socket is available.
* [`wait_for_response`](#wait_for_response): Waits until a certain response is received.

## Classes

### `webcheck`

Contains the wait_for_connection and wait_for_response resources

## Resource types

### `wait_for_connection`

Waits until a socket is available.

#### Properties

The following properties are available in the `wait_for_connection` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

#### Parameters

The following parameters are available in the `wait_for_connection` type.

* [`host`](#host)
* [`port`](#port)
* [`provider`](#provider)
* [`refreshonly`](#refreshonly)
* [`retry_sleep`](#retry_sleep)
* [`timeout`](#timeout)

##### `host`

The DNS name or IP address of the server.

##### `port`

The port that the server should be listening on.

##### `provider`

The specific backend to use for this `wait_for_connection` resource. You will seldom need to specify this --- Puppet
will usually discover the appropriate provider for your platform.

##### `refreshonly`

Valid values: ``true``, ``false``

Only run on refreshs

Default value: ``false``

##### `retry_sleep`

The number of seconds to wait betweet each connection attempt.

Default value: `2`

##### `timeout`

The max. number of seconds to wait for a valid connection.

Default value: `10`

### `wait_for_response`

Waits until a certain response is received.

#### Properties

The following properties are available in the `wait_for_response` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

#### Parameters

The following parameters are available in the `wait_for_response` type.

* [`expected_json`](#expected_json)
* [`expected_keywords`](#expected_keywords)
* [`expected_status_codes`](#expected_status_codes)
* [`provider`](#provider)
* [`refreshonly`](#refreshonly)
* [`retry_sleep`](#retry_sleep)
* [`timeout`](#timeout)
* [`uri`](#uri)

##### `expected_json`

A hash of key/values the reponse should be checked for.

##### `expected_keywords`

A list of keywords the response should be checked for.

Default value: `[]`

##### `expected_status_codes`

A list of status codes which a valid response should have.

Default value: `[200]`