infra
/
ansible-role-zerotier
2
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Fix some minor typos in text

pull/29/head
papanito 2019-04-20 20:59:35 +02:00
parent 2b56aaf46c
commit ffba32f382
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -13,13 +13,12 @@ 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
-------------- --------------
### zerotier_network_id ### zerotier_network_id
*Type*: string *Type*: string
*Default value*: *Default value*:
*Description*: The 16 character network ID of the network the new members should join. The node will not join any network if omitted. *Description*: The 16 character network ID of the network the new members should join. The node will not join any network if omitted.
### zerotier_member_register_short_hostname ### zerotier_member_register_short_hostname
@ -29,17 +28,17 @@ Role Variables
### zerotier_member_ip_assignments ### zerotier_member_ip_assignments
*Type*: list *Type*: list
*Default value*: `[]` *Default value*: `[]`
*Description*: A list of IP addresses to assign this member. The member will be automatically assigned an address on the network if left out. *Description*: A list of IP addresses to assign this member. The member will be automatically assigned an address on the network if left out.
### 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
*Default value*: `""` *Default value*: `""`
*Description*: The access token needed to authorize with the ZeroTier API. You can generate one in your account settings at https://my.zerotier.com/. If this is left out then the newly joined member will not be automatically authorized. *Description*: The access token needed to authorize with the ZeroTier API. You can generate one in your account settings at https://my.zerotier.com/. If this is left out then the newly joined member will not be automatically authorized.
### zerotier_api_url ### zerotier_api_url
@ -49,8 +48,8 @@ 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
---------------- ----------------
@ -91,4 +90,4 @@ Example Inventory
[dbservers:vars] [dbservers:vars]
zerotier_member_description='<AppName> db cluster node' zerotier_member_description='<AppName> db cluster node'
``` ```