Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the supermarket mailing list.

Select Badges

Select Supported Platforms

RSS

openvpn_okta (1) Versions 0.1.0

Installs/configures the OpenVPN Okta plugin

Berkshelf/Librarian
Policyfile
Knife
cookbook 'openvpn_okta', '~> 0.1.0'
cookbook 'openvpn_okta', '~> 0.1.0', :supermarket
knife cookbook site install openvpn_okta
knife cookbook site download openvpn_okta
README
Dependencies
Changelog
Quality

Openvpn_Okta Cookbook

Cookbook Version Build Status Code Climate Coverage Status

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.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Add tests for the new feature; ensure they pass (rake)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

License & Authors

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

openvpn ~> 2.1
packagecloud ~> 0.2

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Openvpn_Okta Cookbook CHANGELOG

v0.1.0 (2016-10-11)

  • Initial release

v0.0.1 (2016-09-19)

  • Development started

Foodcritic Metric
            

0.1.0 passed this metric

Collaborator Number Metric
            

0.1.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.