Formula to install and configure openvpn server and client.
Table of Contents
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA file and/or git tag,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
Commit message formatting is significant!!
Please see How to contribute for more details.
Installs OpenVPN.
Configures OpenVPN client and server. Multiple clients and servers are possible.
Configures OpenVPN GUI (Windows only). Sets global registry settings as described here.
Manages TAP-Windows device adapters (Windows only). Ensures that any devices specified with dev_node in pillar exist.
Installs and configures an ifconfig_pool_persist file. Used to assign host IPs.
Don't setup a OpenVPN client service, but add ready-to-use NetworkManager configurations.
See openvpn/pillar.example.
This formula does can optionally deploy certificates and keys, but does not generate them. This must be done manually or with another formula.
Linux testing is done with kitchen-salt.
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]Where [platform] is the platform name defined in kitchen.yml,
e.g. debian-9-2019-2-py3.
Creates the docker instance and runs the openvpn main state, ready for testing.
Runs the inspec tests on the actual instance.
Removes the docker instance.
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
Gives you SSH access to the instance for manual testing.
Windows testing is done with kitchen-salt.
- Ruby
- Virtualbox
- Vagrant
$ gem install bundler
$ bundle install --with=vagrant
$ bin/kitchen test [platform]Where [platform] is the platform name defined in kitchen.yml,
e.g. windows-81-2019-2-py3.
When testing using Vagrant you must set the environment variable KITCHEN_LOCAL_YAML to kitchen.vagrant.yml. For example:
$ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test # Alternatively,
$ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml
$ bin/kitchen testThen run the following commands as needed.
Creates the Vagrant instance and runs the openvpn main state, ready for testing.
Runs the inspec tests on the actual instance.
Removes the Vagrant instance.
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
Gives you RDP access to the instance for manual testing.