haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

website/docs: sync Chef option documentation 

[ci skip]
This commit is contained in:
Teemu Matilainen 2014-02-22 00:59:14 -03:00
parent be4c633a5a
commit 2aa3a8bcde
2 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/docs/source/v2/provisioning/chef_common.html.md
View File

@ -21,8 +21,8 @@ provisioners.
This defaults to 1. This can be increased to a higher number if your Chef This defaults to 1. This can be increased to a higher number if your Chef
runs take multiple runs to reach convergence. runs take multiple runs to reach convergence.
* `binary_path` (string) - The full path to the binary to execute to run * `binary_path` (string) - The path to the directory of the Chef executable
Chef. By default, Vagrant looks for the proper Chef binary on the PATH. binaries. By default, Vagrant looks for the proper Chef binary on the PATH.
* `custom_config_path` (string) - A path to a custom Chef configuration local * `custom_config_path` (string) - A path to a custom Chef configuration local
on your machine that will be used as the Chef configuration. This Chef on your machine that will be used as the Chef configuration. This Chef
@ -31,6 +31,12 @@ provisioners.
also a great way to use new Chef features that may not be supported fully also a great way to use new Chef features that may not be supported fully
by Vagrant's abstractions yet. by Vagrant's abstractions yet.
* `encrypted_data_bag_secret_key_path` (string) - The path to the secret key
file to decrypt encrypted data bags. By default, this is not set.
* `environment` (string) - The environment you want the Chef run to be
a part of.
* `formatter` (string) - The formatter to use for output from Chef. * `formatter` (string) - The formatter to use for output from Chef.
* `http_proxy`, `http_proxy_user`, `http_proxy_pass`, `no_proxy` (string) - Settings * `http_proxy`, `http_proxy_user`, `http_proxy_pass`, `no_proxy` (string) - Settings

20
website/docs/source/v2/provisioning/chef_solo.html.md
View File

@ -40,23 +40,22 @@ that are available with both the Chef solo and Chef client provisioners.
are stored. By default this is "cookbooks", expecting a cookbooks folder are stored. By default this is "cookbooks", expecting a cookbooks folder
relative to the Vagrantfile location. relative to the Vagrantfile location.
* `data_bags_path` (string or array) - A list of paths where data bags are * `data_bags_path` (string) - A path where data bags are stored. By default, no
stored. By default, no data bag paths are set. data bag path is set.
* `encrypted_data_bag_secret_key_path` (string) - The path to the secret key * `environments_path` (string) - A path where environment definitions are
file to decrypt encrypted data bags. By default, this is not set. located. By default, no environments folder is set.
* `environments_path` (string or array) - A list of paths where environment
definitions are located. By default, no environments folder is set.
* `environment` (string) - The environment you want the Chef run to be * `environment` (string) - The environment you want the Chef run to be
a part of. This requires that `environments_path` is set. a part of. This requires Chef 11.6.0 or later, and that `environments_path`
is set.
* `recipe_url` (string) - URL to an archive of cookbooks that Chef will download * `recipe_url` (string) - URL to an archive of cookbooks that Chef will download
and use. and use.
* `roles_path` (string or array) - A list of paths where roles are defined. * `roles_path` (string or array) - A list of paths where roles are defined.
By default this is empty. By default this is empty. Multiple role directories are only supported by
Chef 11.8.0 and later.
* `synced_folder_type` (string) - The type of synced folders to use when * `synced_folder_type` (string) - The type of synced folders to use when
sharing the data required for the provisioner to work properly. By default sharing the data required for the provisioner to work properly. By default
@ -134,6 +133,9 @@ end
Just like the cookbooks path, the roles path is relative to the project Just like the cookbooks path, the roles path is relative to the project
root if a relative path is given. root if a relative path is given.
The configuration value can also be an array of paths on Chef 11.8.0 and newer.
On older Chef versions only the first path is used.
**Note:** The name of the role file must be the same as the role name. **Note:** The name of the role file must be the same as the role name.
For example the `web` role must be in the `roles_path` as web.json or web.rb. For example the `web` role must be in the `roles_path` as web.json or web.rb.
This is required by Chef itself, and isn't a limitation imposed by This is required by Chef itself, and isn't a limitation imposed by