diff options
Diffstat (limited to 'website/docs')
-rw-r--r-- | website/docs/index.html.markdown | 13 | ||||
-rw-r--r-- | website/docs/r/ssl.html.markdown | 72 |
2 files changed, 84 insertions, 1 deletions
diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index d25a866..db2e56d 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown | |||
@@ -3,7 +3,7 @@ layout: "statuscake" | |||
3 | page_title: "Provider: StatusCake" | 3 | page_title: "Provider: StatusCake" |
4 | sidebar_current: "docs-statuscake-index" | 4 | sidebar_current: "docs-statuscake-index" |
5 | description: |- | 5 | description: |- |
6 | The StatusCake provider configures tests in StatusCake. | 6 | The StatusCake provider configures tests and in StatusCake. |
7 | --- | 7 | --- |
8 | 8 | ||
9 | # StatusCake Provider | 9 | # StatusCake Provider |
@@ -36,4 +36,15 @@ resource "statuscake_test" "google" { | |||
36 | check_rate = 300 | 36 | check_rate = 300 |
37 | contact_id = 12345 | 37 | contact_id = 12345 |
38 | } | 38 | } |
39 | |||
40 | resource "statuscake_ssl" "google" { | ||
41 | domain = "https://www.google.com" | ||
42 | contact_groups_c = "3,12" | ||
43 | checkrate = 3600 | ||
44 | alert_at = "18,71,344" | ||
45 | alert_reminder = true | ||
46 | alert_expiry = true | ||
47 | alert_broken = false | ||
48 | alert_mixed = true | ||
49 | } | ||
39 | ``` | 50 | ``` |
diff --git a/website/docs/r/ssl.html.markdown b/website/docs/r/ssl.html.markdown new file mode 100644 index 0000000..4b768dd --- /dev/null +++ b/website/docs/r/ssl.html.markdown | |||
@@ -0,0 +1,72 @@ | |||
1 | --- | ||
2 | layout: "statuscake" | ||
3 | page_title: "StatusCake: statuscake_ssl" | ||
4 | sidebar_current: "docs-statuscake-ssl" | ||
5 | description: |- | ||
6 | The statuscake_ssl resource allows StatusCake ssl tests to be managed by Terraform. | ||
7 | --- | ||
8 | |||
9 | # statuscake\_ssl | ||
10 | |||
11 | The ssl resource allows StatusCake ssl tests to be managed by Terraform. | ||
12 | |||
13 | ## Example Usage | ||
14 | |||
15 | ```hcl | ||
16 | resource "statuscake_ssl" "google" { | ||
17 | domain = "https://www.google.com" | ||
18 | contact_groups_c = "3,12" | ||
19 | checkrate = 3600 | ||
20 | alert_at = "18,71,344" | ||
21 | alert_reminder = true | ||
22 | alert_expiry = true | ||
23 | alert_broken = false | ||
24 | alert_mixed = true | ||
25 | } | ||
26 | ``` | ||
27 | |||
28 | ## Argument Reference | ||
29 | |||
30 | The following arguments are supported: | ||
31 | |||
32 | * `domain` - (Required) URL to check, has to start with https:// | ||
33 | * `contact_groups_c` - (Required) Contactgroup IDs, separated by a comma. Can be an empty string | ||
34 | * `checkrate` - (Required) Checkrate in seconds. Accepted: [300, 600, 1800, 3600, 86400, 2073600] | ||
35 | * `alert_at` - (Required) When you wish to receive reminders. Must be exactly 3 numeric values seperated by commas | ||
36 | * `alert_reminder` - (Required) Set to true to enable reminder alerts. False to disable. Also see alert_at | ||
37 | * `alert_expiry` - (Required) Set to true to enable expiration alerts. False to disable | ||
38 | * `alert_broken` - (Required) Set to true to enable broken alerts. False to disable | ||
39 | * `alert_mixed` - (Required) Set to true to enable mixed content alerts. False to disable | ||
40 | |||
41 | ## Attributes Reference | ||
42 | |||
43 | The following attribute is exported: | ||
44 | |||
45 | * `ssl_id` - A unique identifier for the ssl test. | ||
46 | * `issuer_cn` - | ||
47 | * `paused` - Whether the test has been paused (Administrative only) | ||
48 | * `cert_score` - Certificate score in % | ||
49 | * `cipher_score` - Cipher strength in % | ||
50 | * `cert_status` - Certificate status | ||
51 | * `cipher` - Cipher code (SSL spec) | ||
52 | * `valid_from_utc` - Certificate Validity Start (In UTC/GMT+0) | ||
53 | * `valid_until_utc` - Certificate Validity End (In UTC/GMT+0) | ||
54 | * `mixed_content` - Mixed content if present. Empty array if not. | ||
55 | * `last_reminder` - The last reminder to be detected (days) | ||
56 | * `last_updated_utc` - When the certificate has last been updated (Either by user action or by testing) | ||
57 | * `flags` : | ||
58 | * `is_extended` : Certificate has an Extended Validation certificate | ||
59 | * `has_pfs` : Certificate has Perfect Forward Secrecy enabled | ||
60 | * `is_broken` : Certificate has errors | ||
61 | * `is_expired` : Certificate is expired | ||
62 | * `is_missing` : Certificate not present | ||
63 | * `is_revoked` : Certificate has been revoked by CA | ||
64 | * `is_mixed` : Website contains Mixed Content | ||
65 | |||
66 | ## Import | ||
67 | |||
68 | StatusCake ssl tests can be imported using the ssl id, e.g. | ||
69 | |||
70 | ``` | ||
71 | tf import statuscake_ssl.example 123 | ||
72 | ``` | ||