Дополнительные параметры config.rb

[редактировать на GitHub]

Помимо стандартных параметров в файле knife config.rb, существуют дополнительные параметры, специфичные для определённых подкоманд. При запуске подкоманды knife будет использовать:

Значение, переданное через командную строку
Значение из файла config.rb
Значение по умолчанию

Значение, переданное через командную строку, переопределяет значение из файла config.rb; значение из файла config.rb переопределяет значение по умолчанию.

Предупреждение

Не следует добавлять многие дополнительные параметры в файл config.rb. Причины могут различаться. Например, использование --yes в качестве значения по умолчанию в файле config.rb заставит knife всегда считать, что ответ на любой запрос — «Y», что может привести к нежелательным последствиям. Другие параметры, такие как --hide-by-mins (используется только с подкомандой knife status) или --bare-directories (используется только с подкомандой knife list) вероятно, не используются достаточно часто (и одинаково), чтобы оправдать добавление их в файл config.rb. В общем случае, если дополнительные параметры не указаны в основной теме config.rb, добавляйте их только после тщательного рассмотрения. Не используйте дополнительные параметры в рабочей среде до тех пор, пока их производительность не будет подтверждена в безопасной тестовой среде.

Следующий список описывает все дополнительные параметры, которые можно добавить в конфигурационный файл:

knife[:admin]: Создать клиента как административного клиента.

knife[:admin_client_key]

knife[:admin_client_name]

knife[:after]: Добавить элемент списка выполнения после указанного элемента списка выполнения.
knife[:all]: Указывает, что все среды, кулинарные книги, версии кулинарных книг, метаданные и/или пакеты данных будут загружены, удалены, сгенерированы или протестированы. Контекст зависит от используемой подкоманды и аргументов knife.
knife[:all_versions]: Возвращает все доступные версии для каждой кулинарной книги.
knife[:attribute]: Атрибут (или атрибуты) для отображения.

knife[:attribute_from_cli]

knife[:authentication_protocol_version]

Устанавливает протокол аутентификации, используемый для связи с сервером Chef Infra. Например, укажите протокол версии 1.3, чтобы включить поддержку алгоритмов SHA-256:

knife[:authentication_protocol_version] = '1.3'

Обратите внимание, что протокол аутентификации 1.3 поддерживается только на серверах Chef версии 12.4.0 и выше.

knife[:bare_directories]

Запрещает отображение дочерних элементов директории, когда директория соответствует шаблону.

knife[:before]

knife[:bootstrap_curl_options]: Произвольные параметры, которые будут добавлены к команде bootstrap при использовании cURL. Этот параметр нельзя использовать в той же команде с --bootstrap-install-command.
knife[:bootstrap_install_command]: Выполнение пользовательской последовательности команд установки для Chef Infra Client. Этот параметр нельзя использовать в той же команде с --bootstrap-curl-options, --bootstrap-install-sh, или --bootstrap-wget-options.
knife[:bootstrap_no_proxy]: URL или IP-адрес, указывающий местоположение, которое не должно проксироваться.
knife[:bootstrap_proxy]: Прокси-сервер для узла, являющегося целевым объектом операции bootstrap.
knife[:bootstrap_template]: Путь к файлу шаблона, который будет использоваться во время операции bootstrap.
knife[:bootstrap_vault_file]: Путь к JSON-файлу, содержащему список хранилищ и элементов, которые должны быть обновлены.
knife[:bootstrap_vault_item]: Одно хранилище и элемент для обновления как vault:item.
knife[:bootstrap_vault_json]: Строка JSON, содержащая список хранилищ и элементов, которые должны быть обновлены.
knife[:bootstrap_version]: Версия Chef Infra Client, которую необходимо установить.
knife[:bootstrap_wget_options]: Произвольные параметры, которые будут добавлены к команде bootstrap при использовании GNU Wget. Этот параметр нельзя использовать в той же команде с --bootstrap-install-command.
knife[:both]: Удалить локальные и удалённые копии объекта.

knife[:chef_node_name]

knife[:chef_repo_path]: Путь к chef-repo.

knife[:chef_server_url]

knife[:chef_zero_host]: Переопределить хост, на котором chef-zero прослушивает.
knife[:chef_zero_post]: Порт, на котором chef-zero прослушивает.

knife[:client_key]

knife[:color]

knife[:concurrency]: Количество разрешённых одновременных подключений.
knife[:config_file]: Конфигурационный файл для использования.

knife[:cookbook_copyright]

knife[:cookbook_email]

knife[:cookbook_license]

knife[:cookbook_path]

knife[:delete_validators]

knife[:depends]: Убедиться, что при наличии у кулинарной книги зависимости от одной (или нескольких) кулинарных книг, эти кулинарные книги также загружаются.
knife[:description]: Описание среды и/или роли.

knife[:diff]

knife[:diff_filter]: Выбрать только файлы, которые были добавлены (A), удалены (D), изменены (M) и/или изменили свой тип (T). Можно использовать любую комбинацию фильтров, включая отсутствие фильтров. Используйте * для выбора всех путей, если файл соответствует другим критериям сравнения.
knife[:disable_editing]: Запретить открытие $EDITOR и принять данные как есть.

knife[:distro]

knife[:download_directory]: Директория, в которой расположены кулинарные книги.
knife[:dry_run]: Не выполнять никаких действий, а только выводить результаты.
knife[:editor]: $EDITOR, используемый для всех интерактивных команд.

knife[:encrypt]

knife[:env_run_list]

knife[:environment]: Имя среды.
knife[:exec]: Строка кода, которая должна быть выполнена.
knife[:file]: Сохранить закрытый ключ в указанном имени файла.

knife[:filter_result]

knife[:first_boot_attributes]

knife[:flat]: Отобразить список имён файлов. Установить в false для просмотра результата в формате ls.
knife[:force]: Перезаписать существующую директорию.

knife[:format]

knife[:forward_agent]: Включить перенаправление SSH-агента.
knife[:fqdn]: FQDN
knife[:freeze]: Требовать, чтобы изменения в кулинарной книге были включены как новая версия. Только параметр --force может переопределить это значение.

knife[:help]

knife[:hide_healthy]: Скрыть узлы, на которых выполнение Chef Infra Client произошло в течение последнего часа.
knife[:hints]: Подсказка Ohai для целевого узла.
knife[:host_key_verify]: Используйте --no-host-key-verify для отключения проверки ключа хоста.

knife[:id_only]

knife[:identity_file]: Файл SSH-идентификатора, используемый для аутентификации. Рекомендуется использовать аутентификацию на основе ключей.
knife[:initial]: Создать клиента API, обычно административного клиента на свежеустановленном сервере Chef Infra.
knife[:input]: Имя файла, который будет использован с запросом PUT или POST.
knife[:latest]: Загрузить последнюю версию кулинарной книги.
knife[:local]: Возвратить только содержимое локальной директории.

knife[:local_mode]

knife[:log_level]

knife[:log_location]

knife[:manual]: Определить поисковый запрос как список серверов, разделённых пробелами.

knife[:max_arguments_per_command]

knife[:max_command_line]

knife[:method]: Метод запроса: DELETE, GET, POST, или PUT.

knife[:mismatch]

knife[:name_only]

Отобразить только имена изменённых файлов.

knife[:name_status]

Отобразить только имена файлов со статусом Added, Deleted, Modified, или Type Changed.

knife[:no_deps]

Убедиться, что все кулинарные книги, от которых зависит установленная кулинарная книга, не установлены.

knife[:node_name]

Уникальный идентификатор узла. Это может быть имя пользователя с разрешением на аутентификацию на сервере Chef Infra, или имя машины, с которой запускается knife. Например:

node_name 'user_name'

или:

node_name 'machine_name'

knife[:null_separator]

knife[:on_error]

knife[:one_column]: Отобразить только один столбец результатов.

knife[:patterns]

knife[:platform]: Платформа, для которой предназначена кулинарная книга.
knife[:platform_version]: Версия платформы.
knife[:pretty]: Используйте --no-pretty для отключения красивой печати вывода JSON.
knife[:print_after]: Показать данные после разрушительной операции.
knife[:proxy_auth]: Включить аутентификацию прокси для веб-интерфейса сервера Chef Infra.
knife[:purge]: Полностью удалить кулинарную книгу (или версию кулинарной книги) с сервера Chef Infra. Используйте этот параметр осторожно, поскольку на сервере Chef Infra хранится только одна копия любого файла. Следовательно, очистка кулинарной книги отключает любые другие кулинарные книги, которые ссылаются на один или несколько файлов из очищенной кулинарной книги.

knife[:query]

knife[:readme_format]: Формат документа readme-файла: md (markdown) и rdoc (Ruby docs).
knife[:recurse]: Используйте --recurse для рекурсивного удаления директорий.

knife[:recursive]

knife[:remote]

knife[:replace_all]

knife[:replace_first]

knife[:repo_mode]: Разметка локального chef-repo. Возможные значения: static, everything, или hosted_everything. Используйте static только для ролей, сред, поваренных книг и пакетов данных. По умолчанию, everything и hosted_everything динамически выбираются в зависимости от типа сервера.
knife[:repository]: Путь к chef-repo.

knife[:rows]

knife[:run_list]: Список ролей и/или рецептов, разделённый запятыми, которые необходимо применить.
knife[:script_path]: Путь, разделённый двоеточиями, по которому расположены скрипты Ruby.
knife[:secret]: Ключ шифрования, который используется для значений, содержащихся в элементе пакета данных.
knife[:secret_file]: Путь к файлу, содержащему ключ шифрования.
knife[:server_name]: То же, что и node_name. Рекомендуемая конфигурация — разрешить Ohai собирать это значение во время каждого запуска клиента Chef Infra.
knife[:ssh_attribute]: Атрибут, используемый при открытии SSH-соединения.
knife[:ssh_gateway]: SSH-туннель или шлюз, используемый для выполнения операции загрузки на машине, которая недоступна с рабочей станции.
knife[:ssh_password]: SSH-пароль. Может использоваться для передачи пароля непосредственно в командной строке. Если этот параметр не указан (и требуется пароль), knife запрашивает пароль.

knife[:ssh_password_ng]

knife[:ssh_port]: SSH-порт.
knife[:ssh_user]: Имя пользователя SSH.

knife[:start]

knife[:supermarket_site]: URL, по которому расположен Chef Supermarket. Значение по умолчанию: https://supermarket.chef.io.

knife[:template_file]

knife[:trailing_slashes]

knife[:tree]: Показать зависимости в виде визуального дерева (включая дубликаты, если они существуют).
knife[:use current_branch]: Убедитесь, что используется текущая ветка.
knife[:use_sudo]: Выполнить операцию загрузки с помощью sudo.

knife[:use_sudo_password]

knife[:user] и/или knife[:user_home]: Имя пользователя, используемое knife для подписи запросов, отправляемых клиентом API на сервер Chef Infra. Аутентификация завершается неудачей, если имя пользователя не соответствует закрытому ключу.
knife[:user_key]: Сохранить открытый ключ в указанный файл.
knife[:user_password]: Пароль пользователя.

knife[:validation_client_name]

knife[:validation_key]

knife[:validator]

knife[:verbose_commands]

knife[:verbosity]

knife[:with_uri]

knife[:yes]: Ответить на все запросы подтверждения «Да».

По подкоманде

В следующих разделах показаны дополнительные параметры для файла config.rb, отсортированные по подкоманде.

bootstrap

Следующие knife bootstrap параметры могут быть добавлены в файл config.rb:

knife[:bootstrap_curl_options]: Добавляет параметр --bootstrap-curl-options.
knife[:bootstrap_install_command]: Добавляет параметр --bootstrap-install-command.
knife[:bootstrap_no_proxy]: Добавляет параметр --bootstrap-no-proxy.
knife[:bootstrap_proxy]: Добавляет параметр --bootstrap-proxy.
knife[:bootstrap_template]: Добавляет параметр --bootstrap-template.
knife[:bootstrap_url]: Добавляет параметр --bootstrap-url.
knife[:bootstrap_vault_item]: Добавляет параметр --bootstrap-vault-item.
knife[:bootstrap_version]: Добавляет параметр --bootstrap-version.
knife[:bootstrap_wget_options]: Добавляет параметр --bootstrap-wget-options.
knife[:run_list]: Добавляет параметр --run-list.
knife[:template_file]: Добавляет параметр --bootstrap-template.
knife[:use_sudo]: Добавляет параметр --sudo.

Примечание

Подкоманда knife bootstrap зависит от ряда параметров, связанных с SSH, которые обрабатываются подкомандой knife ssh.

client create

Следующие knife client create параметры могут быть добавлены в файл config.rb:

knife[:admin]: Добавляет параметр --admin.
knife[:file]: Добавляет параметр --file.

client reregister

Следующие knife client reregister параметры могут быть добавлены в файл config.rb:

knife[:file]: Добавляет параметр --file.

configure

Следующие knife configure параметры могут быть добавлены в файл config.rb:

knife[:admin_client_name]: Имя административного клиента, передаваемое как часть самой команды.
knife[:config_file]: Добавляет параметр --config.
knife[:disable_editing]: Добавляет параметр --disable-editing.
knife[:file]: Добавляет параметр --file.
knife[:initial]: Добавляет параметр --initial.
knife[:repository]: Добавляет параметр --repository.
knife[:user_home]: Добавляет параметр --user.
knife[:user_password]: Добавляет параметр --password.
knife[:yes]: Добавляет параметр --yes.

cookbook bulk delete

Следующие knife cookbook bulk delete параметры могут быть добавлены в файл config.rb:

knife[:purge]: Добавляет параметр --purge.
knife[:yes]: Добавляет параметр --yes.

cookbook create

Следующие knife cookbook create параметры могут быть добавлены в файл config.rb:

knife[:readme_format]: Добавляет параметр --readme-format.

cookbook delete

Следующие knife cookbook delete параметры могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.
knife[:print_after]: Добавляет параметр --print-after.
knife[:purge]: Добавляет параметр --purge.

cookbook download

Следующие knife cookbook download параметры могут быть добавлены в файл config.rb:

knife[:download_directory]: Добавляет параметр --dir.
knife[:force]: Добавляет параметр --force.
knife[:latest]: Добавляет параметр --latest.

cookbook list

Следующие knife cookbook list параметры могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.
knife[:environment]: Добавляет параметр --environment.

cookbook metadata

Следующие knife cookbook metadata параметры могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.

cookbook show

Следующие knife cookbook show параметры могут быть добавлены в файл config.rb:

knife[:fqdn]: Добавляет параметр --fqdn.
knife[:platform]: Добавляет параметр --platform.
knife[:platform_version]: Добавляет параметр --platform-version.

cookbook upload

Следующие knife cookbook upload параметры могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.
knife[:depends]: Добавляет параметр --include-dependencies.
knife[:environment]: Добавляет параметр --environment.
knife[:force]: Добавляет параметр --force.
knife[:freeze]: Добавляет параметр --freeze.

supermarket download

Следующие knife supermarket download параметры могут быть добавлены в файл config.rb:

knife[:file]: Добавляет параметр --file.
knife[:force]: Добавляет параметр --force.
knife[:supermarket_site]: URL, по которому расположен Chef Supermarket. Значение по умолчанию: https://supermarket.chef.io.

supermarket install

Следующие knife supermarket install параметры могут быть добавлены в файл config.rb:

knife[:cookbook_path]: Добавляет параметр --cookbook-path.
knife[:file]: Добавляет параметр --file.
knife[:no_deps]: Добавляет параметр --skip-dependencies.
knife[:use_current_branch]: Добавляет параметр --use-current-branch.
knife[:supermarket_site]: URL, по которому расположен Chef Supermarket. Значение по умолчанию: https://supermarket.chef.io.

Следующие knife supermarket share параметры могут быть добавлены в файл config.rb:

knife[:cookbook_path]: Добавляет параметр --cookbook-path.
knife[:supermarket_site]: URL, по которому расположен Chef Supermarket. Значение по умолчанию: https://supermarket.chef.io.

data bag create

Следующие knife data bag create параметры могут быть добавлены в файл config.rb:

knife[:secret]: Добавляет параметр --secret.
knife[:secret_file]: Добавляет параметр --secret-file.

data bag edit

Следующие параметры knife data bag edit могут быть добавлены в файл config.rb:

knife[:print_after]: Добавляет параметр --print-after.
knife[:secret]: Добавляет параметр --secret.
knife[:secret_file]: Добавляет параметр --secret-file.

data bag from file

Следующие параметры knife data bag from file могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.
knife[:secret]: Добавляет параметр --secret.
knife[:secret_file]: Добавляет параметр --secret-file.

data bag show

Следующие параметры knife data bag show могут быть добавлены в файл config.rb:

knife[:secret]: Добавляет параметр --secret.
knife[:secret_file]: Добавляет параметр --secret-file.

delete

Следующие параметры knife delete могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:recurse]: Добавляет параметр --recurse.
knife[:repo_mode]: Добавляет параметр --repo-mode.

deps

Следующие параметры knife deps могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:recurse]: Добавляет параметр --recurse.
knife[:remote]: Добавляет параметр --remote.
knife[:repo_mode]: Добавляет параметр --repo-mode.
knife[:tree]: Добавляет параметр --tree.

diff

Следующие параметры knife diff могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:name_only]: Добавляет параметр --name-only.
knife[:name_status]: Добавляет параметр --name-status.
knife[:recurse]: Добавляет параметр --recurse.
knife[:repo_mode]: Добавляет параметр --repo-mode.

download

Следующие параметры knife download могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:recurse]: Добавляет параметр --recurse.
knife[:repo_mode]: Добавляет параметр --repo-mode.

edit

Следующие параметры knife edit могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:disable_editing]: Добавляет параметр --disable-editing.
knife[:editor]: Добавляет параметр --editor.
knife[:local]: Добавляет параметр --local.
knife[:repo_mode]: Добавляет параметр --repo-mode.

environment create

Следующие параметры knife environment create могут быть добавлены в файл config.rb:

knife[:description]: Добавляет параметр --description.

environment from file

Следующие параметры knife environment from file могут быть добавлены в файл config.rb:

knife[:all]: Добавляет параметр --all.
knife[:print_after]: Добавляет параметр --print-after.

exec

Следующие параметры knife exec могут быть добавлены в файл config.rb:

knife[:exec]: Добавляет параметр --exec.
knife[:script_path]: Добавляет параметр --script-path.

list

Следующие параметры knife list могут быть добавлены в файл config.rb:

knife[:bare_directories]: Добавляет параметр -d.
knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:recursive]: Добавляет параметр -R.
knife[:repo_mode]: Добавляет параметр --repo-mode.

node from file

Следующие параметры knife node from file могут быть добавлены в файл config.rb:

knife[:print_after]: Добавляет параметр --print-after.

node list

Следующие параметры knife node list могут быть добавлены в файл config.rb:

knife[:environment]: Добавляет параметр --environment.

node run list add

Следующие параметры knife node run list add могут быть добавлены в файл config.rb:

knife[:after]: Добавляет параметр --after.
knife[:run_list]: Список запусков, передаваемый как часть самой команды.

node run list remove

Следующие параметры knife node run list remove могут быть добавлены в файл config.rb:

knife[:run_list]: Список запусков, передаваемый как часть самой команды.

raw

Следующие параметры knife raw могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:input]: Добавляет параметр --input.
knife[:method]: Добавляет параметр --method.
knife[:pretty]: Добавляет параметр --[no-]pretty.
knife[:repo_mode]: Добавляет параметр --repo-mode.

role create

Следующие параметры knife role create могут быть добавлены в файл config.rb:

knife[:description]: Добавляет параметр --description.

role from file

Следующие параметры knife role from file могут быть добавлены в файл config.rb:

knife[:print_after]: Добавляет параметр --print-after.

role show

Следующие параметры knife role show могут быть добавлены в файл config.rb:

knife[:environment]: Добавляет параметр --environment.

ssh

Следующие параметры knife ssh могут быть добавлены в файл config.rb:

knife[:concurrency]: Добавляет параметр --concurrency.
knife[:identity_file]: Добавляет параметр --identity-file.
knife[:host_key_verify]: Добавляет параметр --[no-]host-key-verify.
knife[:manual]: Добавляет параметр --manual-list.
knife[:ssh_attribute]: Добавляет параметр --attribute.
knife[:ssh_gateway]: Добавляет параметр --ssh-gateway.
knife[:ssh_password]: Добавляет параметр --ssh-password.
knife[:ssh_port]: Добавляет параметр --ssh-port.
knife[:ssh_user]: Добавляет параметр --ssh-user.

status

Следующие параметры knife status могут быть добавлены в файл config.rb:

knife[:hide_by_mins]: Добавляет параметр --hide-by-mins.
knife[:run_list]: Добавляет параметр --run-list.
knife[:sort_reverse]: Добавляет параметр --sort-reverse.

upload

Следующие параметры knife upload могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет параметр --chef-repo-path.
knife[:concurrency]: Добавляет параметр --concurrency.
knife[:recurse]: Добавляет параметр --recurse.
knife[:repo_mode]: Добавляет параметр --repo-mode.

user create

Следующие параметры knife user create могут быть добавлены в файл config.rb:

knife[:admin]: Добавляет параметр --admin.
knife[:file]: Добавляет параметр --file.
knife[:user_key]: Добавляет параметр --user-key.
knife[:user_password]: Добавляет параметр --password.

user reregister

Следующие параметры knife user reregister могут быть добавлены в файл config.rb:

knife[:file]: Добавляет параметр --file.

xargs

Следующие параметры knife delete могут быть добавлены в файл config.rb:

knife[:chef_repo_path]: Добавляет опцию --chef-repo-path.
knife[:concurrency]: Добавляет опцию --concurrency.
knife[:diff]: Добавляет опцию --diff.
knife[:dry_run]: Добавляет опцию --dry-run.
knife[:force]: Добавляет опцию --force.
knife[:local]: Добавляет опцию --local.
knife[:max_arguments_per_command]: Добавляет опцию --max-args.
knife[:max_command_line]: Добавляет опцию --max-chars.
knife[:null_separator]: Добавляет опцию -0.
knife[:patterns]: Добавляет опцию --pattern.
knife[:replace_all]: Добавляет опцию --replace.
knife[:replace_first]: Добавляет опцию --replace-first.
knife[:repo_mode]: Добавляет опцию --repo-mode.
knife[:verbose_commands]: Добавляет опцию -t.

© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs.chef.io/workstation/config_rb_optional_settings/