knife_configure.md

+++ title = "knife configure" draft = false

gh_repo = "chef-workstation"

aliases = ["/knife_configure.html", "/knife_configure/"]

[menu] [menu.workstation] title = "knife configure" identifier = "chef_workstation/chef_workstation_tools/knife/knife_configure.md knife configure" parent = "chef_workstation/chef_workstation_tools/knife" +++

{{< readfile file="content/workstation/reusable/md/knife_configure_summary.md" >}}

Syntax

This subcommand has the following syntax when creating a credentials file:

knife configure (options)

and the following syntax when creating a client.rb file:

knife configure client DIRECTORY

Options

{{< note >}}

{{< readfile file="content/workstation/reusable/md/knife_common_see_common_options_link.md" >}}

{{< /note >}}

This subcommand has the following options for use when configuring a config.rb file:

--admin-client-name NAME

: The name of the client, typically the name of the admin client.

--admin-client-key PATH

: The path to the private key used by the client, typically a file named admin.pem.

-i, --initial

: Create a API client, typically an administrator client on a freshly-installed Chef Infra Server.

-r REPO, --repository REPO

: The path to the chef-repo.

--validation-client-name NAME

: The name of the validation client, typically a client named chef-validator.

--validation-key PATH

: The path to the validation key used by the client, typically a file named chef-validator.pem.

{{< note >}}

{{< readfile file="content/workstation/reusable/md/knife_common_see_all_config_options.md" >}}

{{< /note >}}

Examples

The following examples show how to use this knife subcommand:

Configure credentials file

knife configure

Configure client.rb

knife configure client '/directory'