cookbook 'openvpn_okta', '~> 1.1.1'
The openvpn_okta cookbook has been deprecated
Author provided reason for deprecation:
The openvpn_okta cookbook has been deprecated and is no longer being maintained by its authors. Use of the openvpn_okta cookbook is no longer recommended.
openvpn_okta (5) Versions 1.1.1 Follow0
Installs/configures the OpenVPN Okta plugin
cookbook 'openvpn_okta', '~> 1.1.1', :supermarket
knife supermarket install openvpn_okta
knife supermarket download openvpn_okta
Openvpn Okta Cookbook README
A Chef cookbook for the OpenVPN Okta plugin.
Note: This cookbook installs a version of the Okta plugin built from a custom branch that includes currently unreleased patches that add support for Okta Verify.
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 in the config file and starting the service until the end of the Chef run, then install and configure the plugin based on Chef attribbutes (below).
Attributes
default
The Okta plugin has four possible attributes that can be set, two of which are required for it to function.
node['openvpn_okta']['url'] (required) node['openvpn_okta']['token'] (required) node['openvpn_okta']['username_suffix'] (optional) node['openvpn_okta']['allow_untrusted_users'] (optional)
Resources
openvpn_okta
The main resource for managing the plugin.
Syntax:
openvpn_okta 'default' do url 'https://example.okta.com' token 'abc123' username_suffix 'example.com' allow_untrusted_users false 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 |
---|---|---|
url | nil |
The Okta URL |
token | nil |
The Okta API token |
username_suffix | nil |
A base @domain Okta user suffix |
allow_untrusted_users | nil |
Whether to allow untrusted users |
action | %i(install enable) |
Action(s) to perform |
openvpn_okta_rhel
The RHEL implementation of the openvpn_okta
resource.
openvpn_okta_ubuntu
The Ubuntu implementation of the openvpn_okta
resource.
Maintainers
- Jonathan Hartman jonathan.hartman@tylertech.com
Dependent cookbooks
packagecloud < 2.0 |
openvpn ~> 3.0 |
yum-epel < 4.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Openvpn Okta Cookbook CHANGELOG
This file is used to list changes made in each version of the openvpn_okta cookbook.
1.1.1 (2020-02-11)
- Install
chefdk@v3
instead ofchef-workstation
.
1.0.1 (2019-01-22)
- Remove 'rvm: system' from the TravisCI config
1.0.0 (2018-12-07)
- Update boilerplate and resolve all style offenses
- Support the latest packagecloud cookbook
- Upgrade to the latest openvpn cookbook
- Ensure gnupg is installed before trying to configure the repo
- Ensure CA certs are installed and configured before configuring the repo
- Ensure /etc/openvpn exists when needed
0.1.0 (2016-10-11)
- Initial release
0.0.1 (2016-09-19)
- Development started
Collaborator Number Metric
1.1.1 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.1.1 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
1.1.1 passed this metric
No Binaries Metric
1.1.1 passed this metric
Testing File Metric
1.1.1 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
1.1.1 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 include a tag that matches this cookbook version number
1.1.1 failed this metric
1.1.1 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
1.1.1 passed this metric
No Binaries Metric
1.1.1 passed this metric
Testing File Metric
1.1.1 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
1.1.1 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 include a tag that matches this cookbook version number
1.1.1 passed this metric
1.1.1 passed this metric
Testing File Metric
1.1.1 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
1.1.1 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 include a tag that matches this cookbook version number
1.1.1 failed this metric
1.1.1 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 include a tag that matches this cookbook version number