cookbook 'openvpn_duo', '= 0.1.0'
openvpn_duo (5) Versions 0.1.0 Follow2
Installs/configures the OpenVPN Duo plugin
cookbook 'openvpn_duo', '= 0.1.0', :supermarket
knife supermarket install openvpn_duo
knife supermarket download openvpn_duo
Openvpn_Duo Cookbook
A Chef cookbook for the OpenVPN Duo plugin.
Requirements
This cookbook depends on the openvpn and packagecloud community cookbooks, for
the OpenVPN server itself and for the packaged version of the plugin that we
build in PackageCloud.io.
It primarily supports Ubuntu. There is support for RHEL platforms as well, but
the openvpn cookbook as currently released has some issues related to Systemd
that RHEL users will need to work around on their own.
It requires Chef 12.10.24+ or Chef 12 and the compat_resource cookbook.
Usage
Either add the default recipe to your node's run list or use the included
custom resource in a recipe of your own.
Recipes
default
Ensure the OpenVPN server is installed, patch it to delay writing the config
file and starting the service until the end of the Chef run, then install and
configure the plugin based on Chef attributes (below).
Attributes
default
The Duo plugin requires three pieces of information to function, all of which
can be set via attributes:
node['openvpn_duo']['integration_key']
node['openvpn_duo']['secret_key']
node['openvpn_duo']['hostname']
Resources
openvpn_duo
The main resource for managing the plugin.
Syntax:
openvpn_duo 'default' do
integration_key '123'
secret_key 'abcd'
hostname 'example.com'
action %i(install enable)
end
Actions:
Action | Description |
---|---|
:install |
Install the plugin package |
:enable |
Patch the plugin into the OpenVPN server config |
:remove |
Uninstall the plugin package |
:disable |
Remove the plugin from the OpenVPN server config |
Properties:
Property | Default | Description |
---|---|---|
integration_key | nil |
The Duo integration key |
secret_key | nil |
The Duo secret key |
hostname | nil |
The Duo hostname |
action | %i(install enable) |
Action(s) to perform |
openvpn_duo_rhel
The RHEL implementation of the openvpn_duo
resource.
openvpn_duo_ubuntu
The Ubuntu implementation of the openvpn_duo
resource.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Add tests for the new feature; ensure they pass (
rake
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License & Authors
- Author: Jonathan Hartman jonathan.hartman@socrata.com
Copyright 2016, Socrata, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
packagecloud ~> 0.2 |
openvpn ~> 2.1 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Openvpn_Duo Cookbook CHANGELOG
v0.1.0 (2016-10-11)
- Initial release
v0.0.1 (2016-09-19)
- Development started
Collaborator Number Metric
0.1.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.1.0 passed this metric
No Binaries Metric
0.1.0 passed this metric
Testing File Metric
0.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.0 passed this metric
0.1.0 failed this metric
0.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.1.0 passed this metric
No Binaries Metric
0.1.0 passed this metric
Testing File Metric
0.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.0 passed this metric
0.1.0 passed this metric
0.1.0 passed this metric
Testing File Metric
0.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.1.0 passed this metric
0.1.0 failed this metric
0.1.0 passed this metric