github.com/vtorhonen/terraform@v0.9.0-beta2.0.20170307220345-5d894e4ffda7/website/source/docs/provisioners/chef.html.markdown (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Provisioner: chef"
     4  sidebar_current: "docs-provisioners-chef"
     5  description: |-
     6    The `chef` provisioner installs, configures and runs the Chef client on a resource.
     7  ---
     8  
     9  # Chef Provisioner
    10  
    11  The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh`
    12  and `winrm` type [connections](/docs/provisioners/connection.html).
    13  
    14  ## Requirements
    15  
    16  The `chef` provisioner has some prerequisites for specific connection types:
    17  
    18  * For `ssh` type connections, `cURL` must be available on the remote host.
    19  * For `winrm` connections, `PowerShell 2.0` must be available on the remote host.
    20  
    21  Without these prerequisites, your provisioning execution will fail.
    22  
    23  ## Example usage
    24  
    25  ```
    26  # Start a initial chef run on a resource
    27  resource "aws_instance" "web" {
    28    # ...
    29    provisioner "chef" {
    30      attributes_json = <<-EOF
    31          {
    32              "key": "value",
    33              "app": {
    34                  "cluster1": {
    35                      "nodes": [
    36                          "webserver1",
    37                          "webserver2"
    38                      ]
    39                  }
    40              }
    41          }
    42          EOF
    43  
    44      environment     = "_default"
    45      run_list        = ["cookbook::recipe"]
    46      node_name       = "webserver1"
    47      secret_key      = "${file("../encrypted_data_bag_secret")}"
    48      server_url      = "https://chef.company.com/organizations/org1"
    49      recreate_client = true
    50      user_name       = "bork"
    51      user_key        = "${file("../bork.pem")}"
    52      version         = "12.4.1"
    53    }
    54  }
    55  ```
    56  
    57  ## Argument Reference
    58  
    59  The following arguments are supported:
    60  
    61  * `attributes_json (string)` - (Optional) A raw JSON string with initial node attributes
    62    for the new node. These can also be loaded from a file on disk using the [`file()`
    63    interpolation function](/docs/configuration/interpolation.html#file_path_).
    64  
    65  * `client_options (array)` - (Optional) A list of optional Chef Client configuration
    66    options. See the [Chef Client ](https://docs.chef.io/config_rb_client.html) documentation
    67    for all available options.
    68  
    69  * `disable_reporting (boolean)` - (Optional) If `true` the Chef Client will not try to send
    70    reporting data (used by Chef Reporting) to the Chef Server (defaults to `false`).
    71  
    72  * `environment (string)` - (Optional) The Chef environment the new node will be joining
    73    (defaults to `_default`).
    74  
    75  * `fetch_chef_certificates (boolean)` (Optional) If `true` the SSL certificates configured
    76    on your Chef Server will be fetched and trusted. See the knife [ssl_fetch](https://docs.chef.io/knife_ssl_fetch.html)
    77    documentation for more details.
    78  
    79  * `log_to_file (boolean)` - (Optional) If `true`, the output of the initial Chef Client run
    80    will be logged to a local file instead of the console. The file will be created in a
    81    subdirectory called `logfiles` created in your current directory. The filename will be
    82    the `node_name` of the new node.
    83  
    84  * `use_policyfile (boolean)` - (Optional) If `true`, use the policy files to bootstrap the
    85    node. Setting `policy_group` and `policy_name` are required if this is `true`. (defaults to
    86    `false`).
    87  
    88  * `policy_group (string)` - (Optional) The name of a policy group that exists on the Chef
    89    server. Required if `use_policyfile` is set; `policy_name` must also be specified.
    90  
    91  * `policy_name (string)` - (Optional) The name of a policy, as identified by the `name`
    92    setting in a Policyfile.rb file. Required if `use_policyfile` is set; `policy_group`
    93    must also be specified.
    94  
    95  * `http_proxy (string)` - (Optional) The proxy server for Chef Client HTTP connections.
    96  
    97  * `https_proxy (string)` - (Optional) The proxy server for Chef Client HTTPS connections.
    98  
    99  * `named_run_list (string)` - (Optional) The name of an alternate run-list to invoke during the
   100    initial Chef Client run. The run-list must already exist in the Policyfile that defines
   101    `policy_name`. Only applies when `use_policyfile` is `true`.
   102  
   103  * `no_proxy (array)` - (Optional) A list of URLs that should bypass the proxy.
   104  
   105  * `node_name (string)` - (Required) The name of the node to register with the Chef Server.
   106  
   107  * `ohai_hints (array)` - (Optional) A list with
   108    [Ohai hints](https://docs.chef.io/ohai.html#hints) to upload to the node.
   109  
   110  * `os_type (string)` - (Optional) The OS type of the node. Valid options are: `linux` and
   111    `windows`. If not supplied, the connection type will be used to determine the OS type (`ssh`
   112    will assume `linux` and `winrm` will assume `windows`).
   113  
   114  * `prevent_sudo (boolean)` - (Optional) Prevent the use of the `sudo` command while installing, configuring
   115    and running the initial Chef Client run. This option is only used with `ssh` type
   116    [connections](/docs/provisioners/connection.html).
   117  
   118  * `recreate_client (boolean)` - (Optional) If `true`, first delete any existing Chef Node and
   119    Client before registering the new Chef Client.
   120  
   121  * `run_list (array)` - (Optional) A list with recipes that will be invoked during the initial
   122    Chef Client run. The run-list will also be saved to the Chef Server after a successful
   123    initial run. Required if `use_policyfile` is `false`; ignored when `use_policyfile` is `true`
   124    (see `named_run_list` to specify a run-list defined in a Policyfile).
   125  
   126  * `secret_key (string)` - (Optional) The contents of the secret key that is used
   127    by the Chef Client to decrypt data bags on the Chef Server. The key will be uploaded to the remote
   128    machine. This can also be loaded from a file on disk using the [`file()` interpolation
   129    function](/docs/configuration/interpolation.html#file_path_).
   130  
   131  * `server_url (string)` - (Required) The URL to the Chef server. This includes the path to
   132    the organization. See the example.
   133  
   134  * `skip_install (boolean)` - (Optional) Skip the installation of Chef Client on the remote
   135    machine. This assumes Chef Client is already installed when you run the `chef`
   136    provisioner.
   137  
   138  * `skip_register (boolean)` - (Optional) Skip the registration of Chef Client on the remote
   139    machine. This assumes Chef Client is already registered and the private key (`client.pem`)
   140    is available in the default Chef configuration directory when you run the `chef`
   141    provisioner.
   142  
   143  * `ssl_verify_mode (string)` - (Optional) Used to set the verify mode for Chef Client HTTPS
   144    requests.
   145  
   146  * `user_name (string)` - (Required) The name of an existing Chef user to register
   147    the new Chef Client and optionally configure Chef Vaults.
   148  
   149  * `user_key (string)` - (Required) The contents of the user key that will be used to
   150    authenticate with the Chef Server. This can also be loaded from a file on disk using the [`file()`
   151    interpolation function](/docs/configuration/interpolation.html#file_path_).
   152  
   153  * `vault_json (string)` - (Optional) A raw JSON string with Chef Vaults and Items to which the new node
   154    should have access. These can also be loaded from a file on disk using the
   155    [`file()` interpolation function](/docs/configuration/interpolation.html#file_path_).
   156  
   157  * `version (string)` - (Optional) The Chef Client version to install on the remote machine.
   158    If not set, the latest available version will be installed.
   159  
   160  These options are supported for backwards compatibility and may be removed in a
   161  future version:
   162  
   163  * `validation_client_name (string)` - __Deprecated: please use `user_name` instead__.
   164  * `validation_key (string)` - __Deprecated: please use `user_key` instead__.