config.rb

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

Файл config.rb используется для указания параметров конфигурации для knife.

Файл config.rb:

• Загружается каждый раз при запуске исполняемого файла knife
• По умолчанию не создается
• По умолчанию расположен по адресу ~/.chef/config.rb (платформы macOS и Linux) или c:\Users\username\.chef\config.rb (платформа Microsoft Windows), для изменения этого расположения используйте опцию --config из командной строки
• Перезапишет значения по умолчанию, если файл config.rb существует в пути по умолчанию или в пути, указанном опцией --config

Настройки

В этом файле конфигурации содержатся следующие настройки:

bootstrap_template

Путь к файлу шаблона, используемому при операции bootstrap.

chef_server_url

URL сервера Chef Infra. Например:

chef_server_url 'https://localhost/organizations/ORG_NAME'

Примечание

Если требуется внести изменения в какие-либо глобальные конечные точки, такие как пользователь или ключи пользователя, используйте knife exec с флагом --server-url для установки chef_server_url на значение https://localhost/.

chef_zero.enabled

Включить chef-zero. Эта настройка требует, чтобы local_mode было установлено в значение true. Значение по умолчанию: false. Например:

chef_zero.enabled true

chef_zero[:port]

Порт, на котором должен слушать chef-zero. Значение по умолчанию: 8889. Например:

chef_zero[:port] 8889

client_d_dir

Директория, содержащая дополнительные скрипты конфигурации для загрузки в Chef Infra Client.

client_key

Расположение файла с клиентом ключом, как абсолютный путь. Значение по умолчанию: /etc/chef/client.pem. Например:

client_key '/etc/chef/client.pem'

cookbook_copyright

Название правообладателя авторских прав. Эта опция размещает в каждом предварительно созданном файле заметку об авторском праве, содержащую имя правообладателя. Если эта опция не указана, используется имя правообладателя «COMPANY_NAME»; его можно легко изменить позже.

cookbook_email

Адрес электронной почты лица, поддерживающего кулинарию. Эта опция размещает в каждом предварительно созданном файле адрес электронной почты. Если не указано, используется имя электронной почты «YOUR_EMAIL»; его можно легко изменить позже.

cookbook_license

Тип лицензии, под которой распространяется кулинария: apachev2, gplv2, gplv3, mit или none (по умолчанию). Эта опция размещает соответствующую лицензионную информацию в предварительно созданных файлах: Apache v2.0 (для apachev2), GPL v2 (для gplv2), GPL v3 (для gplv3), MIT (для mit) или license 'Proprietary - All Rights Reserved (для none). Учитывайте лицензии файлов внутри кулинарии и обязательно соблюдайте любые ограничения, описанные в них.

cookbook_path

Подкаталог Chef Infra Client для хранения кулинарий. Это значение может быть строкой или массивом файловых расположений, обработанных в указанном порядке. Последняя кулинария считается переписывающей локальные изменения. Например:

cookbook_path [
  '/var/chef/cookbooks',
  '/var/chef/site-cookbooks'
]

data_bag_encrypt_version

Минимальная требуемая версия шифрования мешков данных. Возможные значения: 1 или 2. Когда все машины в организации работают под управлением Chef Client 11.6 (или выше), рекомендуется установить это значение в 2. Например:

data_bag_encrypt_version 2

fips

Позволяет OpenSSL принудительно применять проверенную по стандарту FIPS безопасность при запуске Chef Infra Client. Установите значение true, чтобы включить безопасность, проверенную по стандарту FIPS.

Поддерживаются следующие операционные системы:

• Red Hat Enterprise Linux
• Oracle Enterprise Linux
• CentOS
• Windows

local_mode

Запуск Chef Infra Client в локальном режиме. Это позволяет всем командам, работающим с сервером Chef Infra, работать также с локальным chef-repo. Например:

local_mode true

node_name

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

node_name 'user_name'

или:

node_name 'machine_name'

no_proxy

Список URL-адресов, для которых не требуется прокси-сервер, разделенный запятыми. Значение по умолчанию: nil. Например:

no_proxy 'localhost, 10.0.1.35, *.example.com, *.dev.example.com'

ssh_agent_signing

Новинка в версии 14.2 Используйте ssh-agent для аутентификации. При использовании этой опции укажите расположение открытого ключа в client_key. Значение по умолчанию: false. Убедитесь, что открытый ключ находится в формате PKCS#1. Вы можете преобразовать открытый ключ OpenSSH, используя ssh-keygen. Например:

ssh-keygen -f key.pub -e -m pem > key.pem

ssh_timeout

Время ожидания подключения SSH (в секундах) до истечения времени ожидания.

ssl_verify_mode

Установка режима проверки для HTTPS-запросов.

• Используйте :verify_none, чтобы не проверять сертификаты SSL.
• Используйте :verify_peer, чтобы проверить все сертификаты SSL, включая подключения к серверу Chef Infra, подключения к S3 и любые URL-адреса HTTPS remote_file-ресурса, используемые при запуске Chef Infra Client. Это рекомендуемое значение.

В зависимости от настроек OpenSSL, может потребоваться указать ssl_ca_path. Значение по умолчанию: :verify_peer.

tmux_split

Разделить окно Tmux. Значение по умолчанию: false.

validation_client_name

Имя ключа chef-validator, используемого Chef Infra Client для доступа к серверу Chef Infra при первоначальном запуске Chef Infra Client, если не используется беспроверочный bootstrap. Например:

validation_client_name 'chef-validator'

validation_key

Расположение файла с ключом, используемым при регистрации Chef Infra Client на сервере Chef Infra. Ключ проверки подписывается с использованием validation_client_name для аутентификации. Значение по умолчанию: /etc/chef/validation.pem. Например:

validation_key '/etc/chef/validation.pem'

verify_api_cert

Проверка сертификата SSL на сервере Chef Infra. При значении true Chef Infra Client всегда проверяет сертификат SSL. При значении false Chef Infra Client использует значение ssl_verify_mode для определения необходимости проверки сертификата SSL. Значение по умолчанию: false.

versioned_cookbooks

Добавление версий кулинарий к кулинариям. Установите значение false, чтобы скрыть версии кулинарий: cookbooks/apache. Установите значение true, чтобы показать версии кулинарий: cookbooks/apache-1.0.0 и/или cookbooks/apache-1.0.1. При значении true, knife download загружает ВСЕ версии кулинарий, что может быть полезно, если требуется полная резервная копия данных на сервере Chef Infra. Например:

versioned_cookbooks true

config_log_level

Устанавливает значение по умолчанию для log_level в файле client.rb узла, который проходит процесс bootstrap. Возможные значения: :debug, :info, :warn, :error и :fatal. Например:

config_log_level :debug

config_log_location

Устанавливает значение по умолчанию для log_location в файле client.rb узла, который проходит процесс bootstrap. Возможные значения: /path/to/log_location, STDOUT, STDERR, :win_evt и :syslog. Например:

config_log_location "/path/to/log_location"   # Please make sure that the path exists

Настройки прокси

В некоторых ситуациях прокси-сервер, используемый сервером Chef Infra, требует аутентификации. В этом случае необходимо добавить три настройки в файл конфигурации. Какие настройки добавить, зависит от протокола доступа к серверу Chef Infra: HTTP или HTTPS.

Если сервер Chef Infra настроен на использование HTTP, добавьте следующие настройки:

http_proxy

Прокси-сервер для HTTP-соединений. Значение по умолчанию: nil. Например:

http_proxy 'http://proxy.example.com:3128'

http_proxy_user

Имя пользователя для прокси-сервера, когда прокси-сервер использует соединение HTTP. Значение по умолчанию: nil.

http_proxy_pass

Пароль для прокси-сервера, когда прокси-сервер использует соединение HTTP. Значение по умолчанию: nil.

Настройки прокси HTTPS (например, размещённый сервер Chef Infra)

https_proxy

Прокси-сервер для HTTPS-соединений. (Размещённый сервер Chef Infra использует HTTPS-соединение.) Значение по умолчанию: nil.

https_proxy_user

Имя пользователя для прокси-сервера, когда прокси-сервер использует соединение HTTPS. Значение по умолчанию: nil.

https_proxy_pass

Пароль для прокси-сервера, когда прокси-сервер использует соединение HTTPS. Значение по умолчанию: nil.

Настройки для URL-адресов без прокси

no_proxy

Список URL-адресов, для которых не требуется прокси, разделённых запятыми. Значение по умолчанию: nil.

.d Директории

Клиент Chef Infra поддерживает чтение нескольких конфигурационных файлов, помещая их в директорию конфигурации .d. Например: /etc/chef/client.d. Все файлы, заканчивающиеся на .rb в директории .d, загружаются; другие файлы, не являющиеся .rb, игнорируются.

Директории .d могут находиться в любой точке, где присутствуют файлы client.rb, config.rb или solo.rb, например:

• /etc/chef/client.d
• /etc/chef/config.d
• ~/chef/solo.d

(Нет поддержки директории knife.d; используйте config.d вместо неё.)

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

• ~/.chef/config.rb
• ~/.chef/config.d/company_settings.rb
• ~/.chef/config.d/ec2_configuration.rb
• ~/.chef/config.d/old_settings.rb.bak

Файл old_settings.rb.bak игнорируется, так как он не является конфигурационным файлом. Файлы config.rb, company_settings.rb и ec2_configuration объединяются, как если бы они были одним конфигурационным файлом.

Дополнительные настройки

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

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

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

• Проверьте настройки, изучив документацию по подкомандам knife и/или плагинам knife
• Проверьте случаи использования, имеющиеся в вашей организации

Также обратите внимание на:

• Настраиваемые плагины могут быть сконфигурированы для использования тех же настроек, что и основные подкоманды knife
• Многие из этих настроек используются более чем одной подкомандой и/или плагином
• Некоторые настройки включены только потому, что knife проверяет значение в файле config.rb

Для добавления настроек в файл config.rb используйте следующий синтаксис:

knife[:setting_name] = value

где value может потребовать кавычек (' ‘), если это строковое значение. Например:

knife[:ssh_port] = 22
knife[:bootstrap_template] = 'ubuntu14.04-gems'
knife[:bootstrap_version] = ''
knife[:bootstrap_proxy] = ''

Часто используемые

Некоторые дополнительные настройки config.rb используются часто, например, файл шаблона, используемый в операции bootstrap. Частота использования любого параметра варьируется в зависимости от организации, поэтому, хотя следующие настройки часто добавляются в файл config.rb, они могут не подойти для каждой организации:

knife[:bootstrap_proxy]

Сервер прокси для узла, являющегося целевым в операции bootstrap.

knife[:bootstrap_template]

Путь к файлу шаблона, который будет использоваться во время операции bootstrap.

knife[:bootstrap_version]

Версия Chef Infra Client для установки.

knife[:editor]

Редактор $EDITOR, используемый для всех интерактивных команд.

knife[:ssh_gateway]

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

knife[:ssh_port]

Порт SSH.

Дополнительные настройки SSH

Другие настройки SSH, которые иногда полезно добавить в файл config.rb:

knife[:forward_agent]

Включить перенаправление SSH-агента.

knife[:ssh_attribute]

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

knife[:ssh_password]

Пароль SSH. Это можно использовать для непосредственной передачи пароля в командной строке. Если этот параметр не указан (и требуется пароль), knife запросит пароль.

knife[:ssh_user]

Имя пользователя SSH.

Настройки мешка данных

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

knife[:secret]

Ключ шифрования, используемый для значений, содержащихся в элементе мешка данных.

knife[:secret_file]

Путь к файлу, содержащему ключ шифрования.

Настройки Ohai (не рекомендуется)

Некоторые настройки лучше оставить Ohai, который получает значение в начале выполнения Chef Infra Client:

knife[:server_name]

То же самое, что и node_name. Рекомендуемая конфигурация — позволить Ohai собирать это значение во время каждого выполнения Chef Infra Client.

node_name

То же самое, что и knife[:server_name]. Рекомендуемая конфигурация — позволить Ohai собирать это значение во время каждого выполнения Chef Infra Client.