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

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

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

1. Значение, переданное через командную строку
2. Значение, содержащееся в файле config.rb
3. Значение по умолчанию

Значение, переданное через командную строку, переопределит значение в файле 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 Server 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 Client.

knife[:ssh_attribute]

Атрибут, используемый при открытии подключения SSH.

knife[:ssh_gateway]

SSH-туннель или шлюз, используемый для выполнения действия bootstrap на машине, недоступной из рабочей станции.

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]

Выполнить операцию bootstrap с sudo.

knife[:use_sudo_password]

knife[:user] и/или knife[:user_home]

Имя пользователя, используемое knife для подписи запросов, отправляемых клиентом API на Chef Infra Server. Аутентификация завершается неудачей, если имя пользователя не соответствует закрытому ключу.

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 параметр.

client create

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

knife[:file]

Добавляет --file параметр.

client reregister

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

knife[:file]

Добавляет --file параметр.

настройка

Следующие 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 параметр.

массовое удаление кулинарных книг

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

knife[:purge]

Добавляет --purge параметр.

knife[:yes]

Добавляет --yes параметр.

создание кулинарной книги

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

knife[:readme_format]

Добавляет --readme-format параметр.

удаление кулинарной книги

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

knife[:all]

Добавляет --all параметр.

knife[:print_after]

Добавляет --print-after параметр.

knife[:purge]

Добавляет --purge параметр.

скачивание кулинарной книги

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

knife[:download_directory]

Добавляет --dir параметр.

knife[:force]

Добавляет --force параметр.

knife[:latest]

Добавляет --latest параметр.

список кулинарных книг

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

knife[:all]

Добавляет --all параметр.

knife[:environment]

Добавляет --environment параметр.

метаданные кулинарной книги

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

knife[:all]

Добавляет --all параметр.

показать кулинарную книгу

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

knife[:fqdn]

Добавляет --fqdn параметр.

knife[:platform]

Добавляет --platform параметр.

knife[:platform_version]

Добавляет --platform-version параметр.

загрузка кулинарной книги

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

knife[:all]

Добавляет --all параметр.

knife[:depends]

Добавляет --include-dependencies параметр.

knife[:environment]

Добавляет --environment параметр.

knife[:force]

Добавляет --force параметр.

knife[:freeze]

Добавляет --freeze параметр.

скачивание из supermarket

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

knife[:file]

Добавляет --file параметр.

knife[:force]

Добавляет --force параметр.

knife[:supermarket_site]

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

установка из supermarket

Следующие 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.

размещение в supermarket

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

knife[:cookbook_path]

Добавляет --cookbook-path параметр.

knife[:supermarket_site]

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

создание пакета данных

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

knife[:secret]

Добавляет опцию --secret.

knife[:secret_file]

Добавляет опцию --secret-file.

Редактирование хранилища данных

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

knife[:print_after]

Добавляет опцию --print-after.

knife[:secret]

Добавляет опцию --secret.

knife[:secret_file]

Добавляет опцию --secret-file.

Хранилище данных из файла

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

knife[:all]

Добавляет опцию --all.

knife[:secret]

Добавляет опцию --secret.

knife[:secret_file]

Добавляет опцию --secret-file.

Отображение хранилища данных

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

knife[:secret]

Добавляет опцию --secret.

knife[:secret_file]

Добавляет опцию --secret-file.

Удаление

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

knife[:chef_repo_path]

Добавляет опцию --chef-repo-path.

knife[:concurrency]

Добавляет опцию --concurrency.

knife[:recurse]

Добавляет опцию --recurse.

knife[:repo_mode]

Добавляет опцию --repo-mode.

Зависимости

Следующие 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.

Разница

Следующие 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.

Загрузка

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

knife[:chef_repo_path]

Добавляет опцию --chef-repo-path.

knife[:concurrency]

Добавляет опцию --concurrency.

knife[:recurse]

Добавляет опцию --recurse.

knife[:repo_mode]

Добавляет опцию --repo-mode.

Редактировать

Следующие 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.

Создание среды

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

knife[:description]

Добавляет опцию --description.

Среда из файла

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

knife[:all]

Добавляет опцию --all.

knife[:print_after]

Добавляет опцию --print-after.

Выполнение

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

knife[:exec]

Добавляет опцию --exec.

knife[:script_path]

Добавляет опцию --script-path.

Список

Следующие 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.

Узел из файла

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

knife[:print_after]

Добавляет опцию --print-after.

Список узлов

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

knife[:environment]

Добавляет опцию --environment.

Добавление узла в список выполнения

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

knife[:after]

Добавляет опцию --after.

knife[:run_list]

Список выполнения, переданный как часть самого команды.

Удаление узла из списка выполнения

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

knife[:run_list]

Список выполнения, переданный как часть самого команды.

Необработанные данные

Следующие 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.

Создание роли

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

knife[:description]

Добавляет опцию --description.

Роль из файла

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

knife[:print_after]

Добавляет опцию --print-after.

Отображение роли

Следующие 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.

Статус

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

knife[:hide_by_mins]

Добавляет опцию --hide-by-mins.

knife[:run_list]

Добавляет опцию --run-list.

knife[:sort_reverse]

Добавляет опцию --sort-reverse.

Загрузка

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

knife[:chef_repo_path]

Добавляет опцию --chef-repo-path.

knife[:concurrency]

Добавляет опцию --concurrency.

knife[:recurse]

Добавляет опцию --recurse.

knife[:repo_mode]

Добавляет опцию --repo-mode.

Создание пользователя

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

knife[:file]

Добавляет опцию --file.

knife[:user_key]

Добавляет опцию --user-key.

knife[:user_password]

Добавляет опцию --password.

Перерегистрация пользователя

Следующие 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.