Merge pull request #29 from papanito/papanito/correct-readme

Papanito/correct readme
develop
Marcus 2019-04-21 04:04:09 +02:00 committed by GitHub
commit 49d61b875e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions

View File

@ -13,7 +13,6 @@ Technically this role has no requirements. If it's ran without any variables set
[**zerotier_network_id**](#zerotier_network_id): when set hosts are told to join this network. [**zerotier_network_id**](#zerotier_network_id): when set hosts are told to join this network.
[**zerotier_api_accesstoken**](#zerotier_api_accesstoken): when set the role can handle member authentication and configuration using the ZeroTier API. [**zerotier_api_accesstoken**](#zerotier_api_accesstoken): when set the role can handle member authentication and configuration using the ZeroTier API.
Role Variables Role Variables
-------------- --------------
@ -35,7 +34,7 @@ Role Variables
### zerotier_member_description ### zerotier_member_description
*Type*: string *Type*: string
*Default value*: `""` *Default value*: `""`
*Description*: Optional desription for a member. *Description*: Optional description for a member.
### zerotier_api_accesstoken ### zerotier_api_accesstoken
*Type*: string *Type*: string
@ -50,7 +49,7 @@ Role Variables
### zerotier_api_delegate ### zerotier_api_delegate
*Type*: string *Type*: string
*Default value*: `localhost` *Default value*: `localhost`
*Description*: Option to delegate tasks for Zerotier API calls. This is usefull in a situation where API calls can only be made from a whitelisted management server, for example. *Description*: Option to delegate tasks for Zerotier API calls. This is useful in a situation where API calls can only be made from a white-listed management server, for example.
Example Playbook Example Playbook
---------------- ----------------
@ -59,7 +58,7 @@ Example Playbook
- hosts: servers - hosts: servers
vars: vars:
zerotier_network_id: 1234567890qwerty zerotier_network_id: 1234567890qwerty
zerotier_accesstoken: "{{ vault_zerotier_accesstoken }}" zerotier_api_accesstoken: "{{ vault_zerotier_accesstoken }}"
zerotier_register_short_hostname: true zerotier_register_short_hostname: true
roles: roles: