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


flywaydb (30) Versions 5.0.1

Installs and configures flywaydb database migration tool

cookbook 'flywaydb', '= 5.0.1', :supermarket
cookbook 'flywaydb', '= 5.0.1'
knife supermarket install flywaydb
knife supermarket download flywaydb
Quality 100%

Flywaydb Cookbook

Cookbook Version
Build Status

Installs flywaydb and allows for execution of flyway commands via resource actions.


  • Chef 11+


  • CentOS/RedHat
  • Ubuntu
  • Windows


Include default recipe in cookbook or run list to install flywaydb.


  • node['flywaydb']['version'] - The flywaydb version to install. Default 4.0.
  • node['flywaydb']['sha256'] - The flywaydb SHA 256 checksum for linux or windows platform.
  • node['flywaydb']['install_dir'] - The base install directory. Default linux: /opt/flyway windows: C:\flyway.
  • node['flywaydb']['user'] - The owner of flywaydb. Default flyway.
  • node['flywaydb']['group'] - The group of flywaydb. Default flyway.


Use migrate, info, validate, baseline, or repair actions to install flywaydb and execute associated flyway command.


  • flyway_conf - Flyway configuration path or settings to copy or create #{install_dir}/conf/flyway.conf. Settings in alt_conf override settings in flyway.conf. Settings in params override all settings. Default: nil.
  • alt_conf - Alternative configuration path or settings. An array containing paths and/or settings is also supported. Each path and settings are written as #{install_dir}/conf/#{name}[_#{i + 1}].conf where name is the resource name and i is the index in array. Each item in array will result in an independent execution of Flyway. Settings in alt_conf override settings in flyway.conf. Settings in params override all settings. Default: nil.
  • params - Command-line parameters to pass to flyway command. Settings in params override all settings. Default: {}.
  • name - Name of the alternative conf file when alt_conf is defined. Defaults to resource block name.
  • debug - Print debug output during execution of flyway commands. Default: false.
  • password - Password of user. Added for Windows platform to avoid 'The password does not meet the password policy requirements.' error when creating flyway user. Default: nil.
  • sensitive - Suppress logging the Flyway command executed to hide sensitive information but still log Flyway stdout and stderr to Chef-client. Writing of conf files will also be suppressed when executing with Chef-client versions that support sensitive. Default: true.


Single migration using settings
flywaydb 'myapp' do
    url: 'jdbc:mysql/localhost/mydb',
    user: 'root',
    locations: 'filesystem:/opt/myapp/db/migration',
    cleanDisabled: true
  action :migrate
Single migration using path
flywaydb 'myapp' do
  action :migrate
Multiple migrations using settings with alt_conf and params
flywaydb 'myapp' do
    user: 'root',
    url: 'jdbc:mysql/localhost/mysql'
      schemas: 'custA',
      locations: 'filesystem:/opt/myapp/db/migration/core,/opt/myapp/db/migration/custA'
       schemas: 'custB',
       locations: 'filesystem:/opt/myapp/db/migration/core,/opt/myapp/db/migration/custB'
    password: password   
  action :migrate
Multiple migrations using paths with alt_conf and params
flywaydb 'myapp' do
    password: password   
  action :migrate

ChefSpec Matchers

This cookbook includes custom ChefSpec matchers you can use to test
your own cookbooks.

Example Matcher Usage

expect(chef_run).to migrate_flywaydb('flyway').with(
  flyway_conf_: {
      'user' => 'root',
      'url' => 'jdbc:mysql://localhost/mysql'
  alt_conf: [
      'schemas' => 'custA',
      'locations' => 'filesystem:/opt/myapp/db/migration/core,/opt/myapp/db/migration/custA'
      'schemas' => 'custB',
      'locations' => 'filesystem:/opt/myapp/db/migration/core,/opt/myapp/db/migration/custB'
  params: {
      'password' => 'password'
  debug: false,
  sensitive: true

Cookbook Matchers

  • migrate_flywaydb(resource_name)
  • clean_flywaydb(resource_name)
  • baseline_flywaydb(resource_name)
  • info_flywaydb(resource_name)
  • repair_flywaydb(resource_name)
  • validate_flywaydb(resource_name)

Getting Help


Please refer to CONTRIBUTING.


MIT - see the accompanying LICENSE file for details.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.


5.0.1 2016-04-19

  • Fix #9 Extracting to flyway-4.0 on windows

5.0.0 2016-04-15

  • Add flyway_conf attribute
  • Add alt_conf attribute
  • Remove conf and ext_conf attributes

4.1.0 2016-04-14

  • Fix #6 Suppress the command that was executed to hide sensitive information but still log stdout and stderr

4.0.1 2016-04-12

  • Include default recipe in provide only if required

4.0.0 2016-03-24

  • Fix #4 Quote param values to avoid interpretation by the shell

3.1.0 2016-03-09

  • Use Flyway 4.0

3.0.1 2016-03-08

  • Fix #3 sensitive not defaulting to true
  • Fix clean action

3.0.0 2016-02-20

  • Remove global attributes ext_conf, conf, params, sensitive, and debug
  • Default sensitive to true

2.0.0 2016-02-10

  • Remove command recipes

1.0.0 2016-02-04

  • Initial release

Foodcritic Metric

5.0.1 passed this metric