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