https://github.com/eugenmayer/chef-tinc-cookbook

Chef cookbook for creating tinc vpn networks
https://github.com/eugenmayer/chef-tinc-cookbook

chef chef-cookbook tiny vpn

Last synced: 2 months ago
JSON representation

Chef cookbook for creating tinc vpn networks

• Host: GitHub
• URL: https://github.com/eugenmayer/chef-tinc-cookbook
• Owner: EugenMayer
• License: mit
• Created: 2017-05-31T19:35:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-02-22T08:36:49.000Z (almost 4 years ago)
• Last Synced: 2023-03-11T11:33:23.855Z (almost 2 years ago)
• Topics: chef, chef-cookbook, tiny, vpn
• Language: Ruby
• Size: 85.9 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/EugenMayer/chef-tinc-cookbook.svg?branch=master)](https://travis-ci.com/EugenMayer/chef-tinc-cookbook)

# Description

Installs [tinc vpn](https://www.tinc-vpn.org/) for meshed VPN networks.

  - supports multiple networks per node

  - connect_to can be either configured manually or extracted using node-search

  - you can run router and switch mode, the latter is for unicast/multicast enabled networks

  

All you need is deploying this cookbook on several nodes while using the same network name - the connection between those nodes (hosts)

will be configured automatically (published hosts/ with public keys)

Available on the [chef supermarket](https://supermarket.chef.io/cookbooks/tincvpn)

# Requirements

## Platform:

* debian

* ubuntu

## Cookbooks:

* openssl (= 4.4.0)

# Attributes

See [tincvpn.rb](https://github.com/EugenMayer/chef-tinc-cookbook/blob/master/attributes/tincvpn.rb) for the available attributes and how to use them 

# Recipes

* tincvpn::default

## tincvpn::default

Installs tinc and configure all your hosts and networks. Hosts are actually looked up using a node search, picking all nodes

having the same network deployed

# Release

```bash

bundle install --binstubs --without='development vagrant docker dokken integration' 

./bin/stove login --username --key ~/.ssh/key.pem

# edit metadata.rb and release

./bin/stove 

```

# Tests

You can run the test using kitchen

    # vagrant basesed 

    chef exec bundle exec kitchen test

    

    # dokken based

    export KITCHEN_YAML=.kitchen.dokken.yml

    chef exec bundle exec kitchen test

    # dokken based - just the default suite

    export KITCHEN_YAML=.kitchen.dokken.yml

    chef exec bundle exec kitchen test default

    # docker based

    export KITCHEN_YAML=.kitchen.docker.yml

    chef exec bundle exec kitchen test           

    

There are to test suites, `default` for testing anything with router mode and `switch` to ensure we can set the mode properly/

# Contributions

I am very happy to accept this PRs or work on issues to extend the usage of this cookbook.

Just use the [issue queue](https://github.com/EugenMayer/chef-tinc-cookbook/issues) or even better, create pull requests for what you like to improve.

# License and Maintainer

Maintainer:: 

- [Zedux](https://github.com/zedtux)

- [Eugen Mayer](https://github.com/EugenMayer)

License:: Apache 2.0