Skip to content

Commit

Permalink
Fix documentation markdown (#150)
Browse files Browse the repository at this point in the history 
Signed-off-by: Dan Webb <dan.webb@damacus.io>
  • Loading branch information
@damacus
damacus authored Feb 1, 2024
1 parent 0df02c7 commit 6262acc
Show file tree
Hide file tree
Showing 17 changed files with 212 additions and 211 deletions.
13 changes: 6 additions & 7 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,17 @@ jobs:

integration:
needs: "lint-unit"

runs-on: ubuntu-latest
strategy:
matrix:
os:
- "amazonlinux-2"
- "centos-7"
- "centos-8"
- "debian-9"
- "debian-10"
- "ubuntu-1804"
- "amazonlinux-2023"
- "centos-stream-8"
- "centos-stream-9"
- "debian-11"
- "debian-12"
- "ubuntu-2004"
- "ubuntu-2204"
suite:
- "default"
fail-fast: false
Expand Down
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This file is used to list changes made in each version of the keepalived cookboo

## Unreleased

- Fix markdown

## 6.0.15 - *2024-02-01*

## 6.0.14 - *2024-02-01*
Expand Down Expand Up @@ -315,7 +317,7 @@ Standardise files with files in sous-chefs/repo-management

### New Feature

- **[COOK-3017](https://tickets.chef.io/browse/COOK-3017)** - Add support for `vrrp_sync_groups`
- Add support for `vrrp_sync_groups`

## v1.0.4

Expand Down
2 changes: 1 addition & 1 deletion documentation/keepalived_global_defs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ More information available at <https://www.keepalived.org/manpage.html>
## Properties

| Name | Type | Default | Description | Allowed Values |
--------------------------------- | ----------- | -------- | ----------- | -------------- |
|--------------------------------- | ----------- | -------- | ----------- | -------------- |
| `notification_email` | `Array` | `nil` | Set of email To: notify | |
| `notification_email_from` | `String` | `nil` | email from address that will be in the header | |
| `smtp_server` | `String` | `nil` | Remote SMTP server used to send notification email | |
Expand Down
30 changes: 15 additions & 15 deletions documentation/keepalived_http_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ More information available at <https://www.keepalived.org/manpage.html>

## Properties

| Name | Type | Default | Description | Allowed Values |
----------------------- | ------------- | -------- | ----------- | -------------- |
| `url` | `Hash` | `{ path: /, status_code: 200 }`| Optional URL to test | `:path`, `:status_code`, `digest`, note all are symbols
| `delay_before_retry` | `Integer` | `nil` | Optional delay before retry after failure | |
| `connect_ip` | `String` | `nil` | Optional IP address to connect to | |
| `connect_port` | `Integer` | `nil` | Optional port to connect to | |
| `bind_to` | `String` | `nil` | Optional address to use to originate the connection | |
| `bind_port` | `Integer` | `nil` | Optional source port to originate the connection from | |
| `connect_timeout` | `Integer` | `nil` | Optional connection timeout in seconds | |
| `fwmark` | `Integer` | `nil`| Optional fwmark to mark all outgoing checker packets with | |
| `warmup` | `Integer` | `nil`| Optional random delay to start the initial check for maximum N seconds | |
| `config_directory` | `String` | `/etc/keepalived/checks.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, "keepalived_http_get__#{name.to_s.gsub(/\s+/, '-')}__.conf")` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `http_get.conf.erb` | Name of the template to render | |
| Name | Type | Default | Description | Allowed Values |
|----------------------|-----------|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------|---------------------------------------------------------|
| `url` | `Hash` | `{ path: /, status_code: 200 }` | Optional URL to test | `:path`, `:status_code`, `digest`, note all are symbols |
| `delay_before_retry` | `Integer` | `nil` | Optional delay before retry after failure | |
| `connect_ip` | `String` | `nil` | Optional IP address to connect to | |
| `connect_port` | `Integer` | `nil` | Optional port to connect to | |
| `bind_to` | `String` | `nil` | Optional address to use to originate the connection | |
| `bind_port` | `Integer` | `nil` | Optional source port to originate the connection from | |
| `connect_timeout` | `Integer` | `nil` | Optional connection timeout in seconds | |
| `fwmark` | `Integer` | `nil` | Optional fwmark to mark all outgoing checker packets with | |
| `warmup` | `Integer` | `nil` | Optional random delay to start the initial check for maximum N seconds | |
| `config_directory` | `String` | `/etc/keepalived/checks.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, "keepalived_http_get__#{name.to_s.gsub(/\s+/, '-')}__.conf")` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `http_get.conf.erb` | Name of the template to render | |

## Examples

Expand Down
16 changes: 8 additions & 8 deletions documentation/keepalived_install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The `keepalived_service` resource can be used to manage the `keepalived` service

## Properties

| Name | Type | Default | Description | Allowed Values |
------------- | ----------- | -------- | ----------- | -------------- |
| `package_name` | `String` | `keepalived` | The name of the service | |
| `root_path` | `String` | `/etc/keepalived` | The root of the configuration | |
| `config_path` | `String` | `#{root_path}/conf.d` | Path to keep other config on disk | |
| `server_path` | `String` | `#{root_path}/servers.d` | Path to keep all servers on disk | |
| `health_path` | `String` | `#{root_path}/checks.d` | Path to keep all checks on disk | |
| `defaults_path` | `String` | See Resource. | Where the defaults should be stored.| |
| Name | Type | Default | Description | Allowed Values |
|-----------------|----------|--------------------------|--------------------------------------|----------------|
| `package_name` | `String` | `keepalived` | The name of the service | |
| `root_path` | `String` | `/etc/keepalived` | The root of the configuration | |
| `config_path` | `String` | `#{root_path}/conf.d` | Path to keep other config on disk | |
| `server_path` | `String` | `#{root_path}/servers.d` | Path to keep all servers on disk | |
| `health_path` | `String` | `#{root_path}/checks.d` | Path to keep all checks on disk | |
| `defaults_path` | `String` | See Resource. | Where the defaults should be stored. | |

## Examples

Expand Down
20 changes: 10 additions & 10 deletions documentation/keepalived_misc_check.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ More information available at <https://www.keepalived.org/manpage.html>

## Properties

| Name | Type | Default | Description | Allowed Values |
----------------------- | ------------- | -------- | ----------- | -------------- |
| `misc_path` | `String` | `nil` | External script or program | |
| `misc_timeout` | `Integer` | `nil` | Optional Script execution timeout | |
| `misc_dynamic` | `true`, `false`| `false` | See Manpage. | |
| `warmup` | `Integer` | `nil`| Optional random delay to start the initial check for maximum N seconds | |
| `config_directory` | `String` | `/etc/keepalived/checks.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, "keepalived_misc_check__#{name.to_s.gsub(/\s+/, '-')}__.conf")` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `misc_check.conf.erb` | Name of the template to render | |
| Name | Type | Default | Description | Allowed Values |
|--------------------|-----------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------|----------------|
| `misc_path` | `String` | `nil` | External script or program | |
| `misc_timeout` | `Integer` | `nil` | Optional Script execution timeout | |
| `misc_dynamic` | `true`, `false` | `false` | See Manpage. | |
| `warmup` | `Integer` | `nil` | Optional random delay to start the initial check for maximum N seconds | |
| `config_directory` | `String` | `/etc/keepalived/checks.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, "keepalived_misc_check__#{name.to_s.gsub(/\s+/, '-')}__.conf")` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `misc_check.conf.erb` | Name of the template to render | |

## Examples

Expand Down
26 changes: 13 additions & 13 deletions documentation/keepalived_real_server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ More information available at <https://www.keepalived.org/manpage.html>

## Properties

| Name | Type | Default | Description | Allowed Values |
----------------------- | ------------- | -------- | ----------- | -------------- |
| `ipaddress` | `String` | `nil` | IP Address of the Server | |
| `port` | `Integer` | `nil` | Port of the Server | |
| `healthcheck` | `String` | `nil` | Includes a healthcheck file | |
| `weight` | `Integer` | `nil` | Script to run for notifications when any transition of state happens | |
| `inhibit_on_failure` | `true, false` | `nil` | | |
| `notify_up` | `String` | `nil`| Script to execute when healthchecker considers the service as up | |
| `notify_down` | `String` | `nil`| Script to execute when healthchecker considers the service as down | |
| `config_directory` | `String` | `/etc/keepalived/servers.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, 'keepalived_real_server__#{ipaddress}-#{port}__.conf')` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `real_server.conf.erb` | Name of the template to render | |
| Name | Type | Default | Description | Allowed Values |
|----------------------|---------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------|----------------|
| `ipaddress` | `String` | `nil` | IP Address of the Server | |
| `port` | `Integer` | `nil` | Port of the Server | |
| `healthcheck` | `String` | `nil` | Includes a healthcheck file | |
| `weight` | `Integer` | `nil` | Script to run for notifications when any transition of state happens | |
| `inhibit_on_failure` | `true, false` | `nil` | | |
| `notify_up` | `String` | `nil` | Script to execute when healthchecker considers the service as up | |
| `notify_down` | `String` | `nil` | Script to execute when healthchecker considers the service as down | |
| `config_directory` | `String` | `/etc/keepalived/servers.d` | directory for the config file to reside in | |
| `config_file` | `String` | `::File.join(config_directory, 'keepalived_real_server__#{ipaddress}-#{port}__.conf')` | full path to the config file | |
| `cookbook` | `String` | `keepalived` | Which cookbook to look in for the template | |
| `source` | `String` | `real_server.conf.erb` | Name of the template to render | |

## Examples

Expand Down
Loading

0 comments on commit 6262acc

Please sign in to comment.