ansible-role-zerotier/README.md

37 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2017-07-27 00:21:35 +00:00
[![Build Status](https://travis-ci.org/m4rcu5nl/ansible-role-zerotier.svg?branch=master)](https://travis-ci.org/m4rcu5nl/ansible-role-zerotier) [![GitHub issues](https://img.shields.io/github/issues/m4rcu5nl/ansible-role-zerotier.svg)](https://github.com/m4rcu5nl/ansible-role-zerotier/issues)
2017-07-26 23:58:44 +00:00
Zerotier
2017-07-26 21:34:38 +00:00
=========
This Ansible role installs the zerotier-one package, adds and authorizes new members to (existing) Zerotier network and tells the new members to join the network.
2017-07-26 21:34:38 +00:00
Requirements
------------
2017-07-26 23:58:44 +00:00
This roles requires an access token for the Zerotier API. This enables the role to add new members to a private network and authorizes them. Also, the role needs the network ID of the Zerotier network the new members should join.
2017-07-26 21:34:38 +00:00
Role Variables
--------------
### zerotier_api_url
2017-07-26 23:58:44 +00:00
The url where the Zerotier API lives. Must use https protocol.
Default: https://my.zerotier.com
2017-07-26 21:34:38 +00:00
### zerotier_accesstoken
2017-07-26 23:58:44 +00:00
The access token needed to authorize with the Zerotier API. You can generate one in your account settings on my.zerotier.com.
2017-07-26 21:34:38 +00:00
### zerotier_network_id (required)
2017-07-26 23:58:44 +00:00
The 16 character network ID of the network the new members should join.
2017-07-26 21:34:38 +00:00
Example Playbook
----------------
```yaml
2017-07-26 21:34:38 +00:00
- hosts: servers
2017-07-26 23:58:44 +00:00
vars:
zerotier_network_id: 1234567890qwerty
zerotier_accesstoken: "{{ vault_zerotier_accesstoken }}"
2017-07-26 21:34:38 +00:00
roles:
2017-07-26 23:58:44 +00:00
- { role: m4rcu5nl.zerotier }
```