Development repository for Chef Cookbook dynect
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.delivery
.github
attributes
providers
recipes
resources
spec
.foodcritic
.gitignore
.kitchen.dokken.yml
.kitchen.yml
.travis.yml
Berksfile
CHANGELOG.md
CONTRIBUTING.md
Gemfile
LICENSE
README.md
TESTING.md
chefignore
metadata.rb

README.md

dynect Cookbook

Build Status Cookbook Version

Automatically configures system DNS using Dyn's API.

Requirements

Platforms

  • All platforms supported by Chef

Chef

  • Chef 12.1+

Cookbooks

  • none

A Dynect account.

The dynect_rest gem. The dynect::default recipe installs this gem from http://rubygems.org

Attributes

The following attributes need to be set for the cookbook to function. Note: These are rather sensitive attributes so it's advised that you store these in a secure location such as an encrypted databag and set them via a wrapper cookbook.

  • node['dynect']['customer'] - Customer ID
  • node['dynect']['username'] - Username
  • node['dynect']['password'] - Password
  • node['dynect']['zone']- Zone
  • node['dynect']['domain'] - Domain

EC2 specific attributes:

  • node['dynect']['ec2']['type'] - type of system, web, db, etc. Default is 'ec2'.
  • node['dynect']['ec2']['env'] - logical application environment the system is in. Default is 'prod'.

Custom Resources

rr

DNS Resource Record.

Actions:

Applies to the DNS record being managed.

  • :create
  • :replace
  • :update
  • :delete

Attribute Parameters:

  • record_type - DNS record type (CNAME, A, etc)
  • rdata - record data, see the Dyn API documentation.
  • ttl - time to live in seconds
  • fqdn - fully qualified domain name
  • username - dyn username
  • password - dyn password
  • customer - dyn customer id
  • zone - DNS zone

None of the parameters have default values.

Example:

dynect_rr "webprod" do
    record_type "A"
    rdata({"address" => "10.1.1.10"})
    fqdn "webprod.#{node['dynect']['domain']}"
    customer node['dynect']['customer']
    username node['dynect']['username']
    password node['dynect']['password']
    zone     node['dynect']['zone']
end

Recipes

This cookbook provides the following recipes.

default

The default recipe installs Adam Jacob's dynect_rest gem during the Chef run's compile time to ensure it is available in the same run as utilizing the dynect_rr resource/provider.

ec2

Only use this recipe on Amazon AWS EC2 hosts!

The dynect::ec2 recipe provides an example of working with the Dyn API with EC2 instances. It creates CNAME records based on the EC2 instance ID (node['ec2']['instance_id']), and a constructed hostname from the dynect.ec2 attributes.

The recipe also edits /etc/resolv.conf to search compute-1.internal and the dynect.domain and use dynect.domain as the default domain, and it will set the nodes hostname per the DNS settings.

a_record

The dynect::a_record recipe will create an A record for the node using the detected hostname and IP address from ohai.

Further Reading

Information on the Dynect API:

Dynect REST Ruby Library:

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

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.