ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some edits to the Chef provisioner page 

1. Fixed some formatting issues.
2. Fixed some grammar and structure issues.
This commit is contained in:
James Turnbull 2016-10-09 10:46:31 -04:00 committed by GitHub
parent 28cbd48cd3
commit 27c3e9a107
1 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
website/source/docs/provisioners/chef.html.markdown
View File

@ -3,20 +3,22 @@ layout: "docs"
page_title: "Provisioner: chef" page_title: "Provisioner: chef"
sidebar_current: "docs-provisioners-chef" sidebar_current: "docs-provisioners-chef"
description: |- description: |-
The `chef` provisioner invokes a Chef Client run on a remote resource after first installing and configuring Chef Client on the remote resource. The `chef` provisioner supports both `ssh` and `winrm` type connections. The `chef` provisioner installs, configures and runs the Chef client on a resource.
--- ---
# Chef Provisioner # Chef Provisioner
The `chef` provisioner invokes a Chef Client run on a remote resource after first installing The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh`
and configuring Chef Client on the remote resource. The `chef` provisioner supports both `ssh`
and `winrm` type [connections](/docs/provisioners/connection.html). and `winrm` type [connections](/docs/provisioners/connection.html).
## Requirements ## Requirements
In order for the `chef` provisioner to work properly, you need either `cURL` (when using The `chef` provisioner has some prerequisites for specific connection types:
a `ssh` type connection) or `PowerShell 2.0` (when using a `winrm` type connection) to be
available on the target machine. * For `ssh` type connections, `cURL` must be available on the remote host.
* For `winrm` connections, `PowerShell 2.0` must be available on the remote host.
Without these prerequisites, your provisioning execution will fail.
## Example usage ## Example usage
@ -44,8 +46,8 @@ resource "aws_instance" "web" {
secret_key = "${file("../encrypted_data_bag_secret")}" secret_key = "${file("../encrypted_data_bag_secret")}"
server_url = "https://chef.company.com/organizations/org1" server_url = "https://chef.company.com/organizations/org1"
recreate_client = true recreate_client = true
user_name = "bob" user_name = "bork"
user_key = "${file("../bob.pem")}" user_key = "${file("../bork.pem")}"
version = "12.4.1" version = "12.4.1"
} }
} }
@ -60,19 +62,20 @@ The following arguments are supported:
interpolation function](/docs/configuration/interpolation.html#file_path_). interpolation function](/docs/configuration/interpolation.html#file_path_).
* `client_options (array)` - (Optional) A list of optional Chef Client configuration * `client_options (array)` - (Optional) A list of optional Chef Client configuration
options. See the [Chef Client ](https://docs.chef.io/config_rb_client.html) documentation for all available options. options. See the [Chef Client ](https://docs.chef.io/config_rb_client.html) documentation
for all available options.
* `disable_reporting (boolean)` - (Optional) If true the Chef Client will not try to send * `disable_reporting (boolean)` - (Optional) If `true` the Chef Client will not try to send
reporting data (used by Chef Reporting) to the Chef Server (defaults false) reporting data (used by Chef Reporting) to the Chef Server (defaults to `false`).
* `environment (string)` - (Optional) The Chef environment the new node will be joining * `environment (string)` - (Optional) The Chef environment the new node will be joining
(defaults `_default`). (defaults to `_default`).
* `fetch_chef_certificates (boolean)` (Optional) If true the SSL certificates configured * `fetch_chef_certificates (boolean)` (Optional) If `true` the SSL certificates configured
on your Chef server will be fetched and trusted. See the knife [ssl_fetch](https://docs.chef.io/knife_ssl_fetch.html) on your Chef Server will be fetched and trusted. See the knife [ssl_fetch](https://docs.chef.io/knife_ssl_fetch.html)
documentation for more details. documentation for more details.
* `log_to_file (boolean)` - (Optional) If true, the output of the initial Chef Client run * `log_to_file (boolean)` - (Optional) If `true`, the output of the initial Chef Client run
will be logged to a local file instead of the console. The file will be created in a will be logged to a local file instead of the console. The file will be created in a
subdirectory called `logfiles` created in your current directory. The filename will be subdirectory called `logfiles` created in your current directory. The filename will be
the `node_name` of the new node. the `node_name` of the new node.
@ -89,14 +92,14 @@ The following arguments are supported:
[Ohai hints](https://docs.chef.io/ohai.html#hints) to upload to the node. [Ohai hints](https://docs.chef.io/ohai.html#hints) to upload to the node.
* `os_type (string)` - (Optional) The OS type of the node. Valid options are: `linux` and * `os_type (string)` - (Optional) The OS type of the node. Valid options are: `linux` and
`windows`. If not supplied the connection type will be used to determine the OS type (`ssh` `windows`. If not supplied, the connection type will be used to determine the OS type (`ssh`
will assume `linux` and `winrm` will assume `windows`). will assume `linux` and `winrm` will assume `windows`).
* `prevent_sudo (boolean)` - (Optional) Prevent the use of sudo while installing, configuring * `prevent_sudo (boolean)` - (Optional) Prevent the use of the `sudo` command while installing, configuring
and running the initial Chef Client run. This option is only used with `ssh` type and running the initial Chef Client run. This option is only used with `ssh` type
[connections](/docs/provisioners/connection.html). [connections](/docs/provisioners/connection.html).
* `recreate_client (boolean)` - (Optional) If true, first delete the existing Chef Node and * `recreate_client (boolean)` - (Optional) If `true`, first delete any existing Chef Node and
Client before registering the new Chef Client. Client before registering the new Chef Client.
* `run_list (array)` - (Required) A list with recipes that will be invoked during the initial * `run_list (array)` - (Required) A list with recipes that will be invoked during the initial
@ -104,8 +107,8 @@ The following arguments are supported:
initial run. initial run.
* `secret_key (string)` - (Optional) The contents of the secret key that is used * `secret_key (string)` - (Optional) The contents of the secret key that is used
by the client to decrypt data bags on the Chef Server. The key will be uploaded to the remote by the Chef Client to decrypt data bags on the Chef Server. The key will be uploaded to the remote
machine. This can be loaded from a file on disk using the [`file()` interpolation machine. This can also be loaded from a file on disk using the [`file()` interpolation
function](/docs/configuration/interpolation.html#file_path_). function](/docs/configuration/interpolation.html#file_path_).
* `server_url (string)` - (Required) The URL to the Chef server. This includes the path to * `server_url (string)` - (Required) The URL to the Chef server. This includes the path to
@ -120,24 +123,24 @@ The following arguments are supported:
is available in the default Chef configuration directory when you run the `chef` is available in the default Chef configuration directory when you run the `chef`
provisioner. provisioner.
* `ssl_verify_mode (string)` - (Optional) Use to set the verify mode for Chef Client HTTPS * `ssl_verify_mode (string)` - (Optional) Used to set the verify mode for Chef Client HTTPS
requests. requests.
* `user_name (string)` - (Required) The name of an existing Chef user to use for registering * `user_name (string)` - (Required) The name of an existing Chef user to register
the new Chef Client and (optionally) configure Chef Vaults. the new Chef Client and optionally configure Chef Vaults.
* `user_key (string)` - (Required) The contents of the user key that will be used to * `user_key (string)` - (Required) The contents of the user key that will be used to
authenticate with the Chef Server. This can be loaded from a file on disk using the [`file()` authenticate with the Chef Server. This can also be loaded from a file on disk using the [`file()`
interpolation function](/docs/configuration/interpolation.html#file_path_). interpolation function](/docs/configuration/interpolation.html#file_path_).
* `vault_json (string)` - (Optional) A raw JSON string with Chef Vaults and Items to give * `vault_json (string)` - (Optional) A raw JSON string with Chef Vaults and Items to which the new node
the new node access to. These can also be loaded from a file on disk using the [`file() should have access. These can also be loaded from a file on disk using the
` interpolation function](/docs/configuration/interpolation.html#file_path_). [`file()` interpolation function](/docs/configuration/interpolation.html#file_path_).
* `version (string)` - (Optional) The Chef Client version to install on the remote machine. * `version (string)` - (Optional) The Chef Client version to install on the remote machine.
If not set the latest available version will be installed. If not set, the latest available version will be installed.
These are supported for backwards compatibility and may be removed in a These options are supported for backwards compatibility and may be removed in a
future version: future version:
* `validation_client_name (string)` - __Deprecated: please use `user_name` instead__. * `validation_client_name (string)` - __Deprecated: please use `user_name` instead__.