default: false
Setting this to True will run the highstate with test=True (good for testing states syntax)
default: nil
Name of the formula directory for finding where the state files are located.
default: nil
Directory containing salt states that is not a formula
default: false
Treat the root directory of this project as a complete file root.
Setting the is_file_root flag allows you to work with a directory tree that more closely resembles a built file_root on a salt-master, where you have may have multiple directories of states or formula. The project is recursively copied down to guest instance.
Consider a directory that looks like this:
top.sls
.kitchen.yml
apache/init.sls
mysql/init.sls
mysql/client.sls
mysql/server.sls
php/init.sls
...
With a .kitchen.yml like this you can now test the completed collection:
---
driver:
name: vagrant
provisioner:
name: salt_solo
is_file_root: true
state_top:
base:
'*':
- apache
- mysql.client
platforms:
- name: ubuntu-12.04
suites:
- name: default
In this example, the apache state could use functionality from the php state etc. You're not just restricted to a single formula.
default: nil
When used with is_file_root, the directory specified here represents the /srv/ directory and everything will be copied there.
provisioner:
is_file_root: true
local_salt_root: setup/
The above will require that a salt directory be located at setup/salt/ with all the state files in it. To use the root directory, set local_salt_root: '.'.
default: nil
Note that this is not used if state_collection or local_salt_root are specified, or is_file_root is set to true.
This is used for testing environments. Specify the salt states elsewhere, and then use them to deploy code from the current environment.
For example, saltstack itself uses a Salt-Jenkins project to configure its testing environment. This is done like so:
---
provisioner:
name: salt_solo
remote_states:
repo: git
name: git://github.com/saltstack/salt-jenkins.git
branch: 2017.7
testingdir: /testing
state_top:
base:
'*':
- git.salt
This will clone the salt-jenkins.git git repository to the salt_file_root (/srv/salt) directory, and then run the git.salt state.
The optional testingdir field specifies where to create a copy of the test kitchen project's root directory. The salt_copy_filter provisioner option is applied during this copy to exclude any files.
default: nil
The log level with which the salt-call command will be run.
default: {}
Dictionary that will be turned into a top file on the test instance.
suites:
- name: client
provisioner:
state_top:
base:
'*':
- beaver
- beaver.ppa
- name: server
provisioner:
state_top:
base:
'*':
- beaver.server
- beaver.ppa
default: base
Environment to use in minion config file for the file and pillar roots.
default: false
If a top.sls file is provided in the states directory, and that is the top.sls
that is to be used, then this should be set to true so that it is not
overwritten by state_top
default: nil
Absolute or relative path to a collection of formulas required for the states that are being tested.
Example
provisioner:
vendor_path: ./srv/env/dev/_formulas
default: nil
Setup repositories for installing packaged formula dependencies.
Types:
- apt: apt repository
- ppa: ppa repository
- spm: spm repository
TODO: add yum
Examples
provisioner:
vendor_repo:
- type: apt
url: http://apt-mk.mirantis.com/trusty
key_url: http://apt-mk.mirantis.com/public.gpg
components: salt
distribution: nightly
- type: ppa
name: neovim-ppa/unstable
- type: spm
url: https://spm.hubblestack.io/2016.7.1
name: hubblestack
default: []
A list of hashes for installing formula depenencies into the VM.
Types:
- path: relative or absolute path to one formula
- apt: install formula via apt package
- yum: install formula via yum package
- spm: install formula via spm package from http, path, or spm repository
- git: install formula by cloning git repository
Examples
provisioner:
dependencies:
- name: foo
path: ./tests/formula-foo
- name: nginx
repo: apt
package: salt-formula-nginx
- name: linux
repo: git
source: https://github.com/salt-formulas/salt-formula-linux.git
- name: nginx
repo: yum
package: salt-formula-nginx
- name: hubblestack_nova
repo: spm
package: https://spm.hubblestack.io/nova/hubblestack_nova-2016.10.1-1.spm
default: nil
This options allows grains to be set on the guest, written out to /etc/salt/grains
For example, the following suite will define grains on the guest:
- name: set-grains-test
provisioner:
salt_version: 0.16.2
grains:
roles:
- webserver
- memcache
deployment: datacenter4
cabinet: 13
cab_u: 14-15
default: {}
Dictionary of pillar files to setup on the minion.
pillars:
top.sls:
base:
'*':
- testing
testing.sls:
python:
bin: /usr/bin/python3
version: 3
default: nil
The pillars_from_files option allows for loading pillar data from another file, instead of being embedded in the .kitchen.yml. This allows the re-use of the example files or reduce the clutter in .kitchen.yml
Consider the following suite definition:
- name: tcp-output-external-pillar
provisioner:
pillars_from_files:
beaver.sls: pillar.example
pillars:
top.sls:
base:
'*':
- beaver
And the contents of pillar.example is a normal pillar file:
# defaults are set in map.jinja and can be over-ridden like this
beaver:
transport: stdout
format: json
default: []
An array of strings or hashes of directories that will be copied recursively to the pillar root.
pillars_from_directories:
- source: ../foo/bar
dest: srv/pillar/baz
- ../qux
The result would be:
{sandbox_path}/srv/pillar
|- baz
|- [contents of qux]
default: nil
Environment to use in minion config file for the pillar root, if different from salt_env.
default: bootstrap
Method by which salt will be installed:
- bootstrap: install salt with the bootstrap script.
- yum: install salt from a yum repository.
- apt: install salt from an apt repository.
- distrib: install the version of salt that comes with the distribution.
- ppa: install salt from a ppa.
- false: bypass salt installation.
Except for distrib and bootstrap, most of these options will require extra configuration to make sure it fits the tests distribution version. Unless the newest version is used, then it should just work for yum and apt setups.
If set to none, salt must already exist or provisioning will fail. This option is useful for images that have salt pre-installed.
default: latest
The desired version of salt that will be installed. For some places, this is used to set the repo to enable or what version to pass to bootstrap.
This is also used to verify that the correct version of salt was installed before running the highstate.
default: https://bootstrap.saltproject.io
Location of the bootstrap script. This can also be a file located locally. If running a local file, install_after_init_environment must be set to true.
For Windows, use the powershell script
default: nil
Optional options passed to the bootstrap script. By default this gets set to the salt_version if nothing is specified here.
For example, this could be used to install salt from the develop branch:
suites:
- name: use-development-branch-salt
provisioner:
salt_bootstrap_options: -M -N git develop
Details on the various options available at the salt-bootstrap documentation.
For the Windows Powershell script:
platforms:
- name: windows
provisioner:
salt_bootstrap_script: https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.ps1
salt_bootstrap_options: -version 2017.7.2
You can also use %s in any part of this, to replace with the version of salt, as specified by salt_version
For example, below is a custom bootstrap option for centos6 requiring python2.7, here %s gets replaced by 2018.3
platforms:
- centos-6:
provisioner:
salt_bootstrap_options: "-P -p git -p curl -p sudo -y -x python2.7 git %s"
suites:
- name: oxygen
provisioner:
salt_version: '2018.3'
salt_install: bootstrap
default: https://repo.saltproject.io/apt/ubuntu/16.04/amd64
This should be the top level of the apt repository so that the salt_version can be appended to the url.
default: https://repo.saltproject.io/apt/ubuntu/16.04/amd64/latest/SALTSTACK-GPG-KEY.pub
The location of the apt repo key.
default: ppa:saltstack/salt
Specify the ppa to enable for installing. This is probably not as useful anymore now that salt is managed from the official repos
default: https://repo.saltproject.io/yum/redhat/7/x86_64/archive/%s/SALTSTACK-GPG-KEY.pub
The rpm key that should be installed for verifying signatures of the yum repo packages.
default: https://repo.saltproject.io/yum/redhat/$releasever/$basearch/archive/%s
The baseurl for the yum repository. %s is replaced with salt_version. More information on SaltStack Package Repo
default: https://repo.saltproject.io/yum/redhat/$releasever/$basearch/archive/%s/SALTSTACK-GPG-KEY.pub
The gpg key url to the key for the yum repository file. %s is replaced with salt_version. More information on SaltStack Package Repo
default : https://repo.saltproject.io/yum/redhat/salt-repo-latest-2.el7.noarch.rpm
The url for the yum repository rpm. Used to install if salt_version is latest. More information on SaltStack Package Repo
default: salt==%s
Name of the pip package to install for salt. This can be a file location or a package name from a pypi simple server.
default: false
Install using the editable flag for pip
default: https://pypi.org/simple/
Path to the pypi simple index to use for installing salt.
default: []
List of extra index urls to fall back to if dependencies are not found on the main index.
default: pip
pip binary in the $PATH or path to a pip binary to use for installing salt.
default: ~/.gnupg/
Directory that the gnupg keyring is located.
default: nil
Identifier for the gpg key to transfer to the test instance. Email or key id will work.
default: ""
Commands to run prior to running salt-call
default: false
Install salt after init_environment is run
default: https://raw.githubusercontent.com/saltstack/kitchen-salt/master/assets/install.sh
A bootstrap script used to provide Ruby (ruby and ruby-dev) required for the serverspec test runner on the guest OS. If this script is unable to setup Ruby, it will fallback to using Chef bootstrap installer (set via chef_bootstrap_url)
default: https://www.chef.io/chef/install.sh
The chef bootstrap installer, used to provide Ruby for the serverspec test runner on the guest OS.
default: nil
Run any command just before running salt_command. If not successful, execution stops.
default: true
Install chef. This is required by the busser to run tests, if no verification driver is specified in the .kitchen.yml
default: true
If false bypassed the salt-call command execution. For cases where the guest OS is already provisioned.
default for Windows: c:\salt\salt-call.bat
default for others: salt-call
Command used to invoke salt-call.
default: /etc/salt
Location in the sandbox where the salt configs are placed.
default: []
List of filenames and directories to be excluded when copying to the sandbox.
Example
provisioner:
is_file_root: true
salt_copy_filter:
- .git
- .travis.yml
default: {}
Allows extra configuraiton that will be written to a minion config drop-in. Data will be written in /tmp/kitchen/etc/salt/minion.d/99-minion.conf
Example
provisioner:
salt_minion_extra_config:
mine_functions:
test.ping: []
network.ip_addrs:
interface: eth0
cidr: '10.0.0.0/8'
default: []
Allows reading of files outside the kitchen for files to add as minion config drop-ins. The files will be numbered in order of appearance in the array and will be written to /tmp/kitchen/etc/salt/minion.d.
Example
provisioner:
salt_minion_config_include_files:
- ../salt-base/master.d/nodegroups.conf
- ../sea-salt/output-config.yml
This would generate the following files :
/tmp/kitchen/etc/salt/minion.d
|- 97-nodegroups.conf
|- 98-output-config.yml
default: /etc/salt/minion
Location to place the minion config in the sandbox.
default: nil
Local custom minion config template to be used in kitchen-salt. If filename ends in '.erb' it will be loaded as an Ruby ERB template, else it will be copied without modification. The default is {file:lib/kitchen/provisioner/minion.erb}
default: nil
Customize salt minion_id. If none specified, the machine hostname is used.
default: /srv/salt
File root to use in the minion config and sandbox.
default: /srv/pillar
Pillar root to use in the minion config and sandbox.
default: /srv/salt/top.sls
Location to place the top file in the sandbox.
default: false
Pass --force-color to the salt-call command.