update documentation for the ssl resource

diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown
index d25a866543ea4632edb7155984a8380aefa3aeed..db2e56d4beee714b637e8c13778059db55835362 100644 (file)
--- a/website/docs/index.html.markdown
+++ b/website/docs/index.html.markdown
@@ -3,7 +3,7 @@ layout: "statuscake"
 page_title: "Provider: StatusCake"
 sidebar_current: "docs-statuscake-index"
 description: |-
-  The StatusCake provider configures tests in StatusCake.
+  The StatusCake provider configures tests and in StatusCake.
 ---
 
 # StatusCake Provider
@@ -36,4 +36,15 @@ resource "statuscake_test" "google" {
   check_rate   = 300
   contact_id   = 12345
 }
+
+resource "statuscake_ssl" "google" {
+       domain = "https://www.google.com"
+       contact_groups_c = "3,12"
+        checkrate = 3600
+        alert_at = "18,71,344"
+        alert_reminder = true
+       alert_expiry = true
+        alert_broken = false
+        alert_mixed = true
+}
 ```

diff --git a/website/docs/r/ssl.html.markdown b/website/docs/r/ssl.html.markdown
new file mode 100644 (file)
index 0000000..4b768dd
--- /dev/null
+++ b/website/docs/r/ssl.html.markdown
@@ -0,0 +1,72 @@
+---
+layout: "statuscake"
+page_title: "StatusCake: statuscake_ssl"
+sidebar_current: "docs-statuscake-ssl"
+description: |-
+  The statuscake_ssl resource allows StatusCake ssl tests to be managed by Terraform.
+---
+
+# statuscake\_ssl
+
+The ssl resource allows StatusCake ssl tests to be managed by Terraform.
+
+## Example Usage
+
+```hcl
+resource "statuscake_ssl" "google" {
+       domain = "https://www.google.com"
+       contact_groups_c = "3,12"
+        checkrate = 3600
+        alert_at = "18,71,344"
+        alert_reminder = true
+       alert_expiry = true
+        alert_broken = false
+        alert_mixed = true
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `domain` - (Required) URL to check, has to start with https://
+* `contact_groups_c` - (Required) Contactgroup IDs, separated by a comma. Can be an empty string
+* `checkrate` - (Required) Checkrate in seconds. Accepted: [300, 600, 1800, 3600, 86400, 2073600]
+* `alert_at` - (Required) When you wish to receive reminders. Must be exactly 3 numeric values seperated by commas
+* `alert_reminder` - (Required) Set to true to enable reminder alerts. False to disable. Also see alert_at
+* `alert_expiry` - (Required) Set to true to enable expiration alerts. False to disable
+* `alert_broken` - (Required) Set to true to enable broken alerts. False to disable
+* `alert_mixed` - (Required) Set to true to enable mixed content alerts. False to disable
+
+## Attributes Reference
+
+The following attribute is exported:
+
+* `ssl_id` - A unique identifier for the ssl test.
+* `issuer_cn` - 
+* `paused` - Whether the test has been paused (Administrative only)
+* `cert_score` - Certificate score in %
+* `cipher_score` - Cipher strength in %
+* `cert_status` - Certificate status
+* `cipher` - Cipher code (SSL spec)
+* `valid_from_utc` - Certificate Validity Start (In UTC/GMT+0)
+* `valid_until_utc` - Certificate Validity End (In UTC/GMT+0)
+* `mixed_content` - Mixed content if present. Empty array if not.
+* `last_reminder` - The last reminder to be detected (days)
+* `last_updated_utc` - When the certificate has last been updated (Either by user action or by testing)
+* `flags` :
+    * `is_extended` : Certificate has an Extended Validation certificate
+    * `has_pfs` : Certificate has Perfect Forward Secrecy enabled
+    * `is_broken` : Certificate has errors
+    * `is_expired` : Certificate is expired
+    * `is_missing` : Certificate not present
+    * `is_revoked` : Certificate has been revoked by CA
+    * `is_mixed` : Website contains Mixed Content
+
+## Import
+
+StatusCake ssl tests can be imported using the ssl id, e.g.
+
+```
+tf import statuscake_ssl.example 123
+```

diff --git a/website/statuscake.erb b/website/statuscake.erb
index d5edf5942e0650c1943e5fe1827b69cc79d9c222..652552f1778e0f0043a5d827a6d4c981005e6d88 100644 (file)
--- a/website/statuscake.erb
+++ b/website/statuscake.erb
@@ -16,6 +16,9 @@
             <li<%= sidebar_current("docs-statuscake-test") %>>
               <a href="/docs/providers/statuscake/r/test.html">statuscake_test</a>
             </li>
+           <li<%= sidebar_current("docs-statuscake-ssl") %>>
+              <a href="/docs/providers/statuscake/r/ssl.html">statuscake_ssl</a>
+            </li>
           </ul>
         </li>
       </ul>