Chef cookbook for DNSimple
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
libraries
spec
test
.gitignore
.kitchen.docker.yml
.kitchen.yml
.travis.yml
Berksfile
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
RELEASE.md
Rakefile
TESTING.md
metadata.rb

README.md

Description

A chef resource for automated DNS configuration via the dnsimple API.

Build Status Build Status

DEPRECATION WARNING

If you used the dnsimple_record resource, you'll want to do the following to migrate:

  • Rename the name property to record_name
  • For every record_name property, if this record was meant to be on the apex (the naked domain) then remove it entirely

If you used the dnsimple_certificate resource, you'll want to do the following to migrate:

  • Rename certificate_common_name properties to common_name
  • Update your expires_on to be a parsable date string (see examples below)
  • Add an install_path if you have not

Requirements

Attributes

  • None

Resources/Providers

dnsimple_record

Manage a DNS record through the dnsimple API. This resource uses the dnsimple Ruby library to connect and use the dnsimple API. This resource also exposes a ChefSpec matcher for you to do unit testing as well.

Actions:

Action Description Default
create Create the record. Yes
update Update the record.
destroy Destroy the record.

Resource Properties:

Property Description Required Default
domain Domain to manage true
record_name Name of the record ''
type Type of DNS record (see note) true
content String/Array content of records true
ttl Time to live 3600
priority Priorty of record
regions Specific regions for this record
access_token DNSimple API token true
base_url DNSimple API url https://api.dnsimple.com

Record Types: The type of record can be one of the following: A, AAAA, CAA, CNAME, MX, NS, TXT, SPF, SRV, NAPTR, HINFO, SSHFP, ALIAS, URL or POOL. Some of these record types such as POOL require special account access which you can contact support for access and assistance.

Note: If you do not provide the record_name parameter, it will be blank and thus will be assumed to be the domain apex. The apex is the domain name without a subdomain. For example bar.com is the apex of foo.bar.com.

Regional Records: Only certain plan types have regional records so it is blank by default. If you do not have this feature available it will return an error.

Examples

Note that these examples assume you have obtained an account level access token which is documented above (see Requirements). We're also assuming you're securely storing your API keys in Chef Vault but it is not a requirement.

dnsimple_record 'foo.com main server' do
  domain 'foo.com'
  type 'A'
  content '1.2.3.4'
  ttl 3600
  access_token chef_vault_item('secrets', 'dnsimple_token')
  action :create
end

dnsimple_record 'create a CNAME record for a Google Apps site calendar at calendar.example.com' do
  record_name    'calendar'
  content        'ghs.google.com'
  type           'CNAME'
  domain         'example.com'
  access_token   chef_vault_item('secrets',   'dnsimple_token')
  action         :create
end

dnsimple_record 'create an A record with multiple content values at servers.example.com' do
  record_name   'servers'
  content       ['1.1.1.1', '2.2.2.2']
  type          'A'
  domain        'example.com'
  access_token  chef_vault_item('secrets', 'dnsimple_token')
  action        :create
end

# Note: This only works with certain accounts, see the note above for
# regional records! The Chef run will fail otherwise.
dnsimple_record "create an A record in Tokyo only" do
  record_name   'myserverinjapan'
  content       '2.2.2.2'
  type          'A'
  domain        'example.com'
  regions       ['tko']
  access_token  chef_vault_item('secrets', 'dnsimple_token')
  action        :create
end

dnsimple_certificate

Download and install a certificate. Currently this only supports basic matched .crt & .key files. We would like to expand this to support all formats including java keystores. PRs are welcome!

This resource uses the dnsimple Ruby library to connect and use the dnsimple API. This resource also exposes a ChefSpec matcher for you to do unit testing as well.

Actions:

Action Description Default
install Install the crt & key Yes

Resource Properties:

Property Description Required Default
install_path where the crt & key are installed yes
common_name certificate common name yes name of the resource
domain the main domain name on the crt yes
expires on when the certificate expires yes
private_key_pem provide your own private key no
mode files mode no 0600
owner files owner no root
group files group no root
access_token DNSimple API token true
base_url DNSimple API url https://api.dnsimple.com

Examples

dnsimple_certificate 'dnsimple.xyz certificate' do
  install_path '/etc/apache2/ssl'
  common_name 'www.dnsimple.xyz'
  domain 'dnsimple.xyz'
  expires_on '2019-09-08'
  mode '0755'
  owner 'web_admin'
  group 'web_admin'
  access_token chef_vault_item('secrets', 'dnsimple_token')
end

Usage

Add the dnsimple cookbook to your cookbook's metadata and it will automatically install the dnsimple gem and make the dnsimple_record resource available.

Note: If you want to avoid any issues with a maintenance window or service outage causing a Chef run failure, be sure to set the ignore_failure property to true as documented in the common properties which will only print warnings if records could not be updated during the Chef run.

Testing

See TESTING.md

Contributing

See CONTRIBUTING.md

License and Authors

Copyright:: 2014-2018 DNSimple Corp

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.