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


ad-join (25) Versions 5.0.1

Joins windows computers to Active Directory (LDAP) Domain

cookbook 'ad-join', '= 5.0.1', :supermarket
cookbook 'ad-join', '= 5.0.1'
knife supermarket install ad-join
knife supermarket download ad-join
Quality 29%

ad-join Cookbook

Library cookbook that will join an Active Directory domain

Tested OS's

  • Windows 2012R2
  • Ubuntu 14.04 (experimental)
  • Ubuntu 16.04 (experimental)


This cookbook is a library cookbook and is intended to be used by your own wrapper cookbook. See the [test/cookbooks directory](./test/cookbooks) for examples.
While the examples show running separate cookbooks for windows and linux, this isn't required. It is possible for one wrapper cookbook to manage both windows and linux hosts.


  • join
  • leave

It contains a custom resource named domain_join with the following properties

  • domain
  • domain_user
  • domain_password
  • ou
  • server (optional)
  • update_hostname (optional, windows only, Set to false if you want the domain name/hostname to be different from the chef node name. (see #5).)
  • double_reboot (optional, windows only, Will continue to reboot windows until joined to domain and breadcrumb c:\\Windows\\chef-ad-join.txt exists. Useful since timezone doesn't always sync after first reboot. )
  • visual_warning true (optional, windows only, display a login warning to anyone who connects via RDP to the machine before chef has finished the reboots and the converge. This will override any group policy your company might have in place for displaying custom login messages.)
  • hide_sensitive (optional, linux only, hide password used in realmd command, set to false for debugging)


domain_join 'foobar' do
  domain          ''
  domain_user     'binduser'
  domain_password 'correct-horse-battery-staple'
  ou              'OU=US,OU=West,OU=Web,DC=example,DC=com'
  server          'DC01'
  update_hostname true
  double_reboot true
  visual_warning true
  hide_sensitive true
  action :join


The ou must be formatted with OU= before each organizational unit and DC= before each domain component. see [test/cookbooks directory](./test/cookbooks) for an example of how to derive the OU from attributes.

Behind the scenes

If you bootstrapped the node with the name option; e.g.

knife bootstrap -N us-web01

Then that is the name that will be used to join the domain (not the hostname since windows randomly generates it on first boot)

The name cannot include control characters, leading or trailing spaces, or any of the following characters: / \ [ ].


In most cases, Windows hostnames must be 15 characters or less.

The cookbook creates a windows scheduled task that runs chef as soon as the VM is started. The scheduled task is deleted after all the reboots.

The cookbook will restart windows twice since some group policy objects (like the time zone) are not applied on first boot. You can change this behavior by changing the following attribute to false.

default['ad-join']['windows']['double_reboot'] = true  

This cookbook basically runs this powershell command, then reboots

$adminname = "EXAMPLE.COM\\bob"
$password = 'correct-horse-battery-staple' | ConvertTo-SecureString -asPlainText -Force
$credential = New-Object System.Management.Automation.PSCredential($adminname,$password)
Add-computer -DomainName  -OUPath  -Server "'} -Credential $credential -force -Options JoinWithNewName,AccountCreate -PassThru


ad-join can join ubuntu machines to active directory. (experimental. Bug reports / pull requests encouraged)
It does not reboot or manage any of the additional files that might be required for a complete ad join

domain_join 'foobar' do
  domain          'EXAMPLE.COM'
  domain_user     'binduser'
  domain_password 'correct-horse-battery-staple'
  ou              'OU=US,OU=West,OU=Web,DC=example,DC=com'
  server          'DC01'
  hide_sensitive true
  action :join

Common pitfalls

  • Hostnames longer than 15 characters will be truncated
  • NetBios names are not supported (Windows 2000 domain controllers )
  • Domain is cAsE SenSITive. In most cases this needs to be all UPPERCASE.
  • Debugging can be difficult, temporarily set 'hide_sensitive' false to get additional information. domain_password will be shown in plain text.

The ad-join cookbook is as unopinionated as possible. It will not configure sudoers file, /etc/pam.d or /etc/krb5.conf. Use the sudoers cookbook in your wrapper cookbook to manage those services. See [test/cookbooks/ad-join-linux directory](./test/cookbooks/ad-join-linux) for examples on how to manage those files

This cookbook basically runs this bash command

echo "correct-horse-battery-staple" | sudo realm join --verbose EXAMPLE.COM --user bob@EXAMPLE.COM --computer-ou OU=foobar --install=/



realm: No such realm found

Realm is case sensitive. Try EXAMPLE.COM instead of

realm: Not authorized to perform this action

Not all packages installed successfully. Verify adcli and packagekit are installed. Please open github issue if you find missing packages.

! Couldn't get kerberos ticket for: KDC reply did not match expectations
adcli: couldn't connect to domain: Couldn't get kerberos ticket for: KDC reply did not match expectations

The domain is case sensitive. Try changing to EXAMPLE.COM


Make sure a fqdn is setup hostname -f

License and Authors


Volodymyr Babchynskyy

Spencer Owen

Dependent cookbooks

windows >= 1.36.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.


Fix scheduled task not running on windows


Adds Ubuntu support

Fix Chef 13. Requires 13.4.19 or greater (or >=12.7) (#12, #20, #23)


Throws error if running on chef 11 or chef 13
Temporary fix until this issue is fixed


Fixes issue #19
Fixes deprecation warning for chef 13


Fix berkshelf supermarket url


Abort if hostname is longer than 15 characters on windows


Adds domain leave functionality (#16 metalseargolid)


Fix: Scheduled task wont run if time zone changes on reboot (#13)


Fix: No longer gives deprecation warnings if 'server' is nil. (#9)


Improvement: Adds name to scheduled task, removing need for workaround
Change: Changes c:\windows\chef-ad-join.txt to windows friendly path c:/windows/chef-ad-join.txt


Fix: Warning registry key not cleaned up


Add: 'server' parameter to allow for specifying a specific domain controller
Fix: Warning message wouldn't be displayed (#4)


Fix: Passwords with special characters now work properly (#7 Thanks opsline-radek)
Fix: OU Parameter is now truly optional (#6 Thanks opsline-radek)


Adds new attribute default['ad-join']['windows']['update_hostname']


Adds warning attribute


Fixes incorrect CWD in sched task (issue #3)
Fixes incorrect ohai fact "node['os']"


Fixes powershell error when vm name is same as bootstrap name. issue #2


Updates metadata for supermarket


Fixes attribute name for double reboot


Created new git repo for public release on github


Create breadcrumb only if missing


Fixes OU not having quotes


Complete rewrite to make it a library cookbook


More verbose logging in scheduled task


Reduces timeout to 30 seconds


general cleanup, removed private domain name and so on, prepared for public release


removed private usernames and passwords


rubocop convention alerts accepted


changed databag name


rubocop check for line length now is 120 symbols


rubocop and foodcritic inspections added


icon added


tests added


Added possibility to run it on teamcity CI


Fixed, directory server is unavailable issue, code commented for future use


Passwords moved into databag


added ohai reload for new fqdn resolution in chef


Initial release of ad-join

Collaborator Number Metric

5.0.1 failed this metric

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

Contributing File Metric

5.0.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, and your repo must contain a file

Foodcritic Metric

5.0.1 failed this metric

FC038: Invalid resource action: ad-join/resources/domain_join_windows.rb:80
FC038: Invalid resource action: ad-join/resources/domain_join_windows.rb:165
Run with Foodcritic Version 11.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric

5.0.1 failed this metric

ad-join does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric

5.0.1 passed this metric

Testing File Metric

5.0.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, and your repo must contain a file

Version Tag Metric

5.0.1 passed this metric