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 Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


dnsimple (33) Versions 2.0.1

Provides Chef Resource for automating DNS configuration with DNSimple

cookbook 'dnsimple', '= 2.0.1', :supermarket
cookbook 'dnsimple', '= 2.0.1'
knife supermarket install dnsimple
knife supermarket download dnsimple
Quality 100%


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

Build Status
Build Status


If you used the 1.x series of this cookbook please carefully review your usage of the resource and create a new account access token. The access token you used previously will not work with this version of the cookbook. You will also not need a username and password for this version either. Please refer to the examples below for more details, but the majority of the changes are around authentication.



  • None



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.


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

Parameter Attributes:

The type of record can be one of the following: A, CNAME, ALIAS, MX,

| Parameter    | Description                        | Required | Default   |
| ------------ | ---------------------------------  | -------- | --------- |
| *domain*     | Domain to manage                   | true     |           |
| *name*       | Name of the record                 |          | Apex of the domain |
| *type*       | Type of DNS record                 | true     |           |
| *content*    | String/Array content of records    | true     |           |
| *ttl*        | Time to live                       |          | 3600      |
| *priority*   | Priorty of record                  |          |           |
| *regions*    | Specific regions for this record   |          |           |
| *token*      | DNSimple API token                 |          |           |

Note: If you do not provide the name parameter, it will be assumed from the
resource name, which cannot be blank. If you want to create multiple record
types on the apex then you need to name each resource separately, but keep the
name an empty string.

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.


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 'fooserver' do
      domain ''
      type 'A'
      content ''
      ttl 3600
      access_token chef_vault_item('secrets', 'dnsimple_token')
      action :create

    dnsimple_record 'create a CNAME record for a Google Apps site calendar' do
      name 'calendar'
      content ''
      type 'CNAME'
      domain ''
      access_token chef_vault_item('secrets', 'dnsimple_token')
      action :create

    dnsimple_record "create a A record with multiple content values" do
      name     'servers'
      content  ['', '']
      type     'A'
      domain   ''
      access_token chef_vault_item('secrets', 'dnsimple_token')
      action   :create

    # 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
      name     'myserverinjapan'
      content  ''
      type     'A'
      domain   ''
      regions  ['tko']
      access_token chef_vault_item('secrets', 'dnsimple_token')
      action   :create


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





License and Authors

Copyright:: 2014-2017 Aetrion, LLC dba DNSimple

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

generic_dns Applicable Versions

Change Log

v2.0.1 (2017-05-18)

Full Changelog

Fixed bugs:

  • Re-release 2.0.0 with updated Stove #47

v2.0.0 (2017-04-24)

Full Changelog

Fixed bugs:

Closed issues:

  • Chef 11 needs compat resources #45

Merged pull requests:

v1.3.4 (2016-09-30)

Full Changelog

Merged pull requests:

v1.3.3 (2016-06-27)

Full Changelog

Fixed bugs:

Merged pull requests:

v1.3.2 (2016-06-24)

Full Changelog

Merged pull requests:

v1.3.1 (2016-06-10)

Full Changelog

Merged pull requests:

  • Update documentation with a correction for the token usage #35 (martinisoft)

v1.3.0 (2016-06-10)

Full Changelog

Fixed bugs:

  • DNSimple API authentication #24

Merged pull requests:

v1.2.0 (2016-06-10)

Fixed bugs:

  • Fix ChefSpec Deprecation Warning #25
  • centos-65 requires patch utility due to nokogiri, only build-essential ~> 2.0.4 installs patch #21
  • Fix converging in modern chef 11 and chef 12 #32 (onlyhavecans)
  • Cleanup testing #31 (martinisoft)

Closed issues:

  • Use Fog DNSimple API Auth #27
  • Ubuntu 14.04 package requirement #23
  • Should have option to gracefully handle existing A record for CNAME create #18
  • Release a new version to Chef Community site #11
  • Add Test Kitchen #10
  • Cookbook removes undesired records #9
  • Should depend on 'build-essential' #7
  • LWRP should use load_current_resource #2

Merged pull requests:

  • Update build status and metadata #30 (martinisoft)
  • Unpin build-essential, blocks many popular cookbooks from use #22 (martinb3)
  • Support creating record with multiple content values #20 (josacar)
  • Use load_current_resource in lwrp #15 (josacar)
  • Integrate Test Kitchen #14 (dje)
  • Configure attributes for ohai to workaround empty node.platform_family #13 (josacar)
  • Avoid removing records with different type on create #12 (josacar)
  • Build Essential Dependancy #8 (ichilton)
  • add platform support for rhel platforms and expand coverage for more debian platforms #6 (mattkasa)
  • Fix missing pkg dependencies, update to chef_gem; add name to metadata. #5 (mdxp)
  • Improvements to LWRP and Documentation #1 (jtimberman)

* This Change Log was automatically generated by github_changelog_generator

Collaborator Number Metric

2.0.1 passed this metric

Contributing File Metric

2.0.1 passed this metric

Foodcritic Metric

2.0.1 passed this metric

License Metric

2.0.1 passed this metric

No Binaries Metric

2.0.1 passed this metric

Testing File Metric

2.0.1 passed this metric

Version Tag Metric

2.0.1 passed this metric