knife-deps(1) · carta

NAME

knife-deps - The man page for the knife deps subcommand.

The knife deps subcommand is used to identify dependencies for a node, role, or cookbook.

Syntax

This subcommand has the following syntax:

$ knife deps (options)

Options

This subcommand has the following options:

--chef-repo-path PATH: The path to the chef-repo. This setting will override the default path to the chef-repo. Default: same as specified by chef_repo_path in config.rb.

-d, --disable-editing: Use to prevent the $EDITOR from being opened and to accept data as-is.

--defaults: Use to have knife use the default value instead of asking a user to provide one.

-e EDITOR, --editor EDITOR: The $EDITOR that is used for all interactive commands.

-E ENVIRONMENT, --environment ENVIRONMENT: The name of the environment. When this option is added to a command, the command will run only against the named environment.

-F FORMAT, --format FORMAT: The output format: summary (default), text, json, yaml, and pp.

-k KEY, --key KEY: The private key that knife will use to sign requests made by the API client to the Chef server.

--[no-]recurse: Use --recurse to list dependencies recursively. This option can only be used when --tree is set to true. Default: --no-recurse.

--remote: Use to determine dependencies from objects located on the Chef server instead of in the local chef-repo. Default: false.

--repo-mode MODE: The layout of the local chef-repo. Possible values: static, everything, or hosted_everything. Use static for just roles, environments, cookbooks, and data bags. By default, everything and hosted_everything are dynamically selected depending on the server type. Default: everything / hosted_everything.

--tree: Use to show dependencies in a visual tree structure (including duplicates, if they exist). Default: false.

-u USER, --user USER: The user name used by knife to sign requests made by the API client to the Chef server. Authentication will fail if the user name does not match the private key.

-V, --verbose: Set for more verbose outputs. Use -VV for maximum verbosity.

-y, --yes: Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation.

-z, --local-mode: Use to run the chef-client in local mode. This allows all commands that work against the Chef server to also work against the local chef-repo.

Examples

$ knife deps nodes/node_name.json

$ knife deps roles/role_name.json

$ knife deps cookbooks/cookbook_name.json

$ knife deps environments/environment_name.json

To find the dependencies for a combination of nodes, cookbooks, roles, and/or environments:

$ knife deps cookbooks/git.json cookbooks/github.json roles/base.json environments/desert.json nodes/mynode.json

A wildcard can be used to return all of the child nodes. For example, all of the environments:

$ knife deps environments/*.json

Use the --tree option to view the results with structure:

$ knife deps roles/webserver.json

to return something like:

roles/webserver.json
  roles/base.json
    cookbooks/github
      cookbooks/git
    cookbooks/users
  cookbooks/apache2

The output of knife deps can be passed to knife upload:

$ knife upload `knife deps nodes/*.json

The output of knife deps can be passed to knife xargs:

$ knife deps nodes/*.json | xargs knife upload

Chef