From fd555f86ac4e9eac0dfc1c4cf146f622def966f9 Mon Sep 17 00:00:00 2001 From: Marcus Meurs Date: Fri, 7 Dec 2018 23:43:27 +0100 Subject: [PATCH] Update Galaxy meta and readme Readme mostly formatting changes. Meta file now includes supported Ubuntu releases. --- README.md | 22 +++++++++++----------- meta/main.yml | 6 +++++- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2e5fc74..6f73300 100644 --- a/README.md +++ b/README.md @@ -17,40 +17,40 @@ Technically this role has no requirements. If it's ran without any variables set Role Variables -------------- -#### zerotier_network_id +### zerotier_network_id *Type*: string *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. -#### zerotier_member_register_short_hostname +### zerotier_member_register_short_hostname *Type*: boolean *Default value*: `false` -*Description*: Used to register the short hostname (without the FQDN) on the network instead of the long one. +*Description*: By default `inventory_hostname` will be used to name a member in a network. If set to `true`, `inventory_hostname_short` will be used instead. -#### zerotier_member_ip_assignments +### zerotier_member_ip_assignments *Type*: list *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. -#### zerotier_member_description +### zerotier_member_description *Type*: string -*Default value*: +*Default value*: `""` *Description*: Optional desription for a member. -#### zerotier_api_accesstoken +### zerotier_api_accesstoken *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. -#### zerotier_api_url +### zerotier_api_url *Type*: string *Default value*: `https://my.zerotier.com` *Description*: The url where the Zerotier API lives. Must use HTTPS protocol. -#### zerotier_api_delegate +### zerotier_api_delegate *Type*: string *Default value*: `localhost` -*Description*: Option to delegate tasks for Zerotier API calls. By default the API calls are made from the machine running the role. +*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. Example Playbook ---------------- diff --git a/meta/main.yml b/meta/main.yml index b424db0..f589906 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -27,7 +27,7 @@ galaxy_info: # this branch. If Travis integration is configured, only notifications for this # branch will be accepted. Otherwise, in all cases, the repo's default branch # (usually master) will be used. - #github_branch: + github_branch: master # # platforms is a list of platforms, and each platform has a name and a list of versions. @@ -39,6 +39,10 @@ galaxy_info: - name: Debian versions: - stretch + - name: Ubuntu + versions: + - Bionic + - Cosmic - name: Fedora versions: - 28