Better documentation (variables in table form, better formatting)

Wolfgang Kulhanek

2018-09-26 76f57ee1706581e310a258d5a489f3f53db9bea9

Better documentation (variables in table form, better formatting)

Recommit changes from Wolfgang

 ansible/roles/host-lets-encrypt-certs/README.md

@@ -16,42 +16,21 @@
Role Variables
--------------

*acme_domain*: ""
  domain name for which to request a certificate
  _Limitation_: Curently only *one* domain name can be requested.
*acme_wildcard_domain*: ""
  Wildcard domain name for which to request a certificate
*acme_aws_access_key*: ""
  AWS Access Key for Route53 (Only for Wildcard Domains)
*acme_aws_secret_access_key*: ""
  AWS Secret Access Key for Route53  (Only for Wildcard Domains)

*acme_additional_args*: ""
  additional arguments for the Acme script
*acme_remote_dir*: "/root"
  The directoroy on the remote host in which to install acme.sh

*acme_cache_cert_file*: "/tmp/ssl.cert"
*acme_cache_key_file*: "/tmp/ssl.key"
*acme_cache_ca_file*: "/tmp/ssl_ca.cer"
*acme_archive_file*: /tmp/acme.tar.gz"
  Local (to the host ansible is running on) cache of certificates
  Prevents re-requesting certificates for later runs of the playbook
  when the domains haven't changed. acme.tar.gz will contain the entire
  .acme.sh directory so that it can be restored for future runs on new machines
  with the same domain names.

*acme_production*: False
  Use the Production Let's Encrypt Server. Leave to False for testing runs
  to prevent issues with the Let's Encrypt rate limits
*acme_renew_automatically*: False
  Install a cron job to automatically renew Certificates. Checks
  once a day.

*acme_force_issue*: False
  Force the creation of new certificates even if there are
  a) certificates already on the host or
  b) certificates in the local cache
|Variable Name|Required|Default Value|Description
|------------ |----------- |-----------|-----------
|*acme_domain*|Yes|"" |Domain name for which to request a certificate. _Limitation_: Curently only *one* domain name can be requested.
|*acme_wildcard_domain*|No|""|Wildcard domain name for which to request a certificate
|*acme_aws_access_key*|No |"" |AWS Access Key for Route53 (Only for Wildcard Domains)
|*acme_aws_secret_access_key*|No| "" |AWS Secret Access Key for Route53  (Only for Wildcard Domains)
|*acme_additional_args*|No |"" |Additional arguments for the Acme script
|*acme_remote_dir*|Yes| "/root"| The directoroy on the remote host in which to install acme.sh
|*acme_cache_cert_file*|Yes| "/tmp/ssl.cert"| Local Cache File for Certificate
|*acme_cache_key_file*|Yes| "/tmp/ssl.key"|Local Cache File for Key
|*acme_cache_ca_file*|Yes| "/tmp/ssl_ca.cer"|Local Cache File for CA Certificate
|*acme_archive_file*|Yes| "/tmp/acme.tar.gz"| Local (to the host ansible is running on) cache of certificates. Prevents re-requesting certificates for later runs of the playbook when the domains haven't changed. acme.tar.gz will contain the entire .acme.sh directory so that it can be restored for future runs on new machines with the same domain names.
|*acme_production*|Yes|False|Use the Production Let's Encrypt Server. Leave to False for testing runs to prevent issues with the Let's Encrypt rate limits
|*acme_renew_automatically*|Yes|False|Install a cron job to automatically renew Certificates. Checks once a day.
|*acme_force_issue*|Yes|False|Force the creation of new certificates even if there are certificates already on the host or certificates in the local cache


Dependencies
@@ -64,6 +43,7 @@

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

```
- name: Request Let's Encrypt Static Certificates
  hosts: server
  gather_facts: False
@@ -119,3 +99,4 @@
    - acme_local_cache_ca_file: "/tmp/server_ca.cer"
    - acme_renew_automatically: False
    - acme_force_issue: False
```