chef-server-ctl (исполняемый файл)

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

Сервер Chef Infra включает утилиту командной строки chef-server-ctl. Эта утилита командной строки используется для запуска и остановки отдельных служб, переконфигурации сервера Chef Infra, запуска chef-pedant и просмотра журналов сервера Chef Infra.

Резервное копирование/восстановление

Используйте следующие команды для управления резервными копиями данных сервера Chef Infra и их восстановления.

backup

Подкоманда backup используется для резервного копирования всех данных сервера Chef Infra. Эта подкоманда:

• Требует установки rsync на сервере Chef Infra перед выполнением команды
• Требует chef-server-ctl reconfigure перед выполнением команды
• Не должна выполняться в конфигурации сервера Chef Infra с внешней базой данных PostgreSQL; используйте knife ec backup вместо этого
• Сохраняет начальную резервную копию в каталоге /var/opt/chef-backup в формате tar.gz; переместите эту резервную копию в новое место для безопасного хранения

Параметры

Эта подкоманда имеет следующие параметры:

-y, --yes

Используется для указания, может ли сервер Chef Infra быть отключён во время создания резервных копий в формате tar.gz.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl backup

restore

Подкоманда restore используется для восстановления данных сервера Chef Infra из резервной копии, созданной подкомандой backup. Эта подкоманда также может использоваться для добавления данных сервера Chef Infra на новый установленный сервер. Не выполняйте эту команду в конфигурации сервера Chef Infra, использующей внешнюю базу данных PostgreSQL; используйте knife ec backup вместо этого. Эта подкоманда:

• Требует установленного rsync на сервере Chef Infra перед выполнением команды
• Требует chef-server-ctl reconfigure перед выполнением команды

В идеале, сервер восстановления должен иметь тот же FQDN, что и сервер, с которого создавалась резервная копия. Если сервер восстановления имеет другой FQDN, то:

1. Замените FQDN в /etc/opscode/chef-server.rb.
2. Замените FQDN в /etc/opscode/chef-server-running.json.
3. Удалите старый сертификат SSL, ключ и файл -ssl.conf из /var/opt/opscode/nginx/ca.
4. Если вы используете выданный CA-сертификат вместо самоподписанного, скопируйте выданный CA-сертификат и ключ в /var/opt/opscode/nginx/ca.
5. Обновите файл /etc/chef/client.rb на каждом клиенте, чтобы указать новый FQDN сервера.
6. Выполните chef-server-ctl reconfigure.
7. Выполните ``chef-server-ctl restore`.

Параметры

Эта подкоманда имеет следующие параметры:

-c, --cleanse

Используется для удаления всех существующих данных на сервере Chef Infra; они будут заменены данными из резервной копии.

-d DIRECTORY, --staging-dir DIRECTORY

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

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl restore PATH_TO_BACKUP (options)

Примеры

chef-server-ctl restore /path/to/tar/archive.tar.gz

очистка

Подкоманда cleanse используется для сброса состояния сервера Chef Infra до состояния, в котором он был до первого выполнения подкоманды reconfigure. Эта команда уничтожит все данные, файлы конфигурации и журналы. Программное обеспечение, установленное на диске при установке пакета, останется; запустите chef-server-ctl reconfigure повторно, чтобы воссоздать стандартные данные и файлы конфигурации.

Параметры

Эта подкоманда имеет следующие параметры:

--with-external

Используется для указания, что данные сервера Chef Infra в внешней базе данных PostgreSQL должны быть удалены.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl cleanse

сбор журналов

Подкоманда gather-logs используется для сбора файлов журналов сервера Chef Infra в tarball, содержащий все важные файлы журналов и системную информацию.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl gather-logs

справка

Подкоманда help используется для вывода списка всех доступных команд chef-server-ctl.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl help

установка

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

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl install name_of_addon (options)

где name_of_addon представляет собой значение командной строки, связанное с дополнением или премиум-функцией.

Параметры

Эта подкоманда имеет следующие параметры:

--path PATH

Используется для указания местоположения пакета. Этот параметр не требуется, когда пакеты загружаются из https://packages.chef.io/.

Использование загрузок

Подкоманда install по умолчанию загружает пакеты из https://downloads.chef.io. Для систем, которые не находятся за брандмауэром (и имеют подключение к https://downloads.chef.io), эти пакеты можно установить, как описано ниже.

1. Установка дополнительных модулей

   Установите Chef Manage с помощью:

   sudo chef-server-ctl install chef-manage
   

2. Переконфигурация сервера

   sudo chef-server-ctl reconfigure
   

3. Переконфигурация дополнительных модулей

   Переконфигурируйте Chef Manage с помощью:

   sudo chef-manage-ctl reconfigure
   

Наконец, примите Лицензию Chef:

sudo chef-manage-ctl reconfigure --accept-license

Использование локальных пакетов

Используйте подкоманду install с параметром --path для установки модуля Chef Manage (chef-manage) для сервера Chef Infra.

sudo chef-server-ctl install PACKAGE_NAME --path /path/to/package/directory

Например:

sudo chef-server-ctl install chef-manage --path /root/packages

Команда chef-server-ctl установит первый пакет chef-manage, найденный в каталоге /root/packages.

Вращение ключей

Используйте следующие команды для управления вращением открытых и закрытых ключей для пользователей и клиентов.

add-client-key

Используйте подкоманду add-client-key для добавления ключа клиента.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl add-client-key ORG_NAME CLIENT_NAME [--public-key-path PATH] [--expiration-date DATE] [--key-name NAME]

Параметры

Эта подкоманда имеет следующие параметры:

CLIENT_NAME

Имя клиента, для которого требуется добавить ключ.

-e DATE --expiration-date DATE

Строка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ. Например: 2013-12-24T21:00:00Z. Если не указано, срок действия будет неограниченным.

-k NAME --key-name NAME

Строка, определяющая имя нового ключа для этого клиента. Если не указано, он будет по умолчанию равен отпечатку открытого ключа.

ORG_NAME

Короткое имя организации, к которой принадлежит клиент.

-p PATH --public-key-path PATH

Путь к файлу, содержащему действительный открытый ключ PKCS#1 для добавления. Если не указано, сервер сгенерирует новый и вернёт закрытый ключ в стандартный вывод.

add-user-key

Используйте подкоманду add-user-key для добавления ключа пользователя.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl add-user-key USER_NAME [--public-key-path PATH] [--expiration-date DATE] [--key-name NAME]

Параметры

Эта подкоманда имеет следующие параметры:

-e DATE --expiration-date DATE

Строка в формате ISO 8601: YYYY-MM-DDTHH:MM:SSZ. Например: 2013-12-24T21:00:00Z. Если не указано, срок действия будет неограниченным.

-k NAME --key-name NAME

Строка, определяющая имя нового ключа для этого пользователя. Если не указано, он будет по умолчанию равен отпечатку открытого ключа.

-p PATH --public-key-path PATH

Путь к файлу, содержащему действительный открытый ключ PKCS#1 для добавления. Если не указано, сервер сгенерирует новый и вернёт закрытый ключ в стандартный вывод.

USER_NAME

Имя пользователя, для которого добавляется ключ.

delete-client-key

Используйте подкоманду delete-client-key для удаления ключа клиента.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl delete-client-key ORG_NAME CLIENT_NAME KEY_NAME

Параметры

Эта подкоманда имеет следующие аргументы:

ORG_NAME

Короткое имя организации, к которой принадлежит клиент.

CLIENT_NAME

Имя клиента.

KEY_NAME

Уникальное имя, которое должно быть назначено ключу, который вы хотите удалить.

delete-user-key

Используйте подкоманду delete-user-key для удаления ключа пользователя.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl delete-user-key USER_NAME KEY_NAME

Параметры

Эта подкоманда имеет следующие аргументы:

USER_NAME

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

KEY_NAME

Уникальное имя, которое необходимо присвоить ключу, который вы хотите удалить.

list-client-keys

Используйте подкоманду list-client-keys для отображения ключей клиента.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl list-client-keys ORG_NAME CLIENT_NAME [--verbose]

Параметры

Эта подкоманда имеет следующие параметры:

CLIENT_NAME

Имя клиента.

ORG_NAME

Короткое имя организации, к которой принадлежит клиент.

--verbose

Используйте для отображения полных строк открытых ключей в выводе команд.

list-user-keys

Используйте подкоманду list-user-keys для отображения ключей клиента.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl list-user-keys USER_NAME [--verbose]

Параметры

Эта подкоманда имеет следующие параметры:

USER_NAME

Имя пользователя, для которого вы хотите отобразить ключи.

--verbose

Используйте для отображения полных строк открытых ключей в выводе команд.

Пример

Для просмотра списка ключей пользователя (включая вывод открытого ключа):

chef-server-ctl list-user-keys applejack --verbose

Возвращает:

2 total key(s) found for user applejack

key_name: test-key
expires_at: Infinity
public_key:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4q9Dh+bwJSjhU/VI4Y8s
9WsbIPfpmBpoZoZVPL7V6JDfIaPUkdcSdZpynhRLhQwv9ScTFh65JwxC7wNhVspB
4bKZeW6vugNGwCyBIemMfxMlpKZQDOc5dnBiRMMOgXSIimeiFtL+NmMXnGBBHDaE
b+XXI8oCZRx5MTnzEs90mkaCRSIUlWxOUFzZvnv4jBrhWsd/yBM/h7YmVfmwVAjL
VST0QG4MnbCjNtbzToMj55NAGwSdKHCzvvpWYkd62ZOquY9f2UZKxYCX0bFPNVQM
EvBQGdNG39XYSEeF4LneYQKPHEZDdqe7TZdVE8ooU/syxlZgADtvkqEoc4zp1Im3
2wIDAQAB
-----END PUBLIC KEY-----

key_name: default
expires_at: Infinity
public_key:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4q9Dh+bwJSjhU/VI4Y8s
9WsbIPfpmBpoZoZVPL7V6JDfIaPUkdcSdZpynhRLhQwv9ScTFh65JwxC7wNhVspB
4bKZeW6vugNGwCyBIemMfxMlpKZQDOc5dnBiRMMOgXSIimeiFtL+NmMXnGBBHDaE
b+XXI8oCZRx5MTnzEs90mkaCRSIUlWxOUFzZvnv4jBrhWsd/yBM/h7YmVfmwVAjL
VST0QG4MnbCjNtbzToMj55NAGwSdKHCzvvpWYkd62ZOquY9f2UZKxYCX0bFPNVQM
EvBQGdNG39XYSEeF4LneYQKPHEZDdqe7TZdVE8ooU/syxlZgADtvkqEoc4zp1Im3
2wIDAQAB
-----END PUBLIC KEY-----

Управление секретами

Используйте следующие команды для управления и вращения общих секретов и учетных данных сервисов. Файл секретов, используемый для хранения этих данных, расположен по адресу /etc/opscode/private-chef-secrets.json на вашем сервере Chef Infra. Он должен принадлежать и быть доступен только для root.

set-secret

Подкоманда set-secret позволяет хранить общие секреты и учетные данные сервисов. Хранить могут только секреты, известные серверу Chef Infra.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl set-secret GROUP NAME

Существует несколько способов передачи секрета этой команде:

1. в качестве третьего аргумента:

   chef-server-ctl set-secret ldap bind_password secretpassword
   

2. через переменную среды:

   export LDAP.BIND_PASSWORD="secretpassword"
   chef-server-ctl set-secret ldap bind_password
   

3. через интерактивный ввод:

   chef-server-ctl set-secret ldap bind_password
   Enter ldap bind_password:    (no terminal output)
   Re-enter ldap bind_password: (no terminal output)
   

Параметры

Эта подкоманда имеет следующие параметры:

--with-restart

Если какие-либо службы зависят от изменения секрета, попытайтесь перезапустить их после изменения секрета. Добавлен в Chef Infra Server 12.16.2.

remove-secret

Подкоманда remove-secret позволяет удалить сохраненный общий секрет и учетные данные сервиса.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl remove-secret GROUP NAME

Пример

chef-server-ctl remove-secret ldap bind_password

show-secret

Подкоманда show-secret позволяет просмотреть сохранённый общий секрет и учетные данные сервиса.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl show-secret GROUP NAME

set-db-superuser-password

Подкоманда set-db-superuser-password позволяет сохранить пароль суперпользователя базы данных.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl set-db-superuser-password

Аналогично set-secret, пароль суперпользователя также можно указать через переменную окружения DB_PASSWORD.

set-actions-password

Подкоманда set-actions-password позволяет сохранить пароль RabbitMQ Actions.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl set-actions-password

Аналогично set-secret, пароль действия также можно указать через переменную среды ACTIONS_PASSWORD.

oc-id-show-app

Подкоманда oc-id-show-app позволяет получить идентификатор клиента и секрет клиента для приложений, известных oc-id. Обратите внимание, что с insecure_addon_compat отключенным, эти данные больше не будут записываться в /etc/opscode/oc-id-applications/APP.json.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl oc-id-show-app APP

Пример

chef-server-ctl oc-id-show-app supermarket
{
  "name": "supermarket",
  "uid": "0bad0f2eb04e935718e081fb71asdfec3681c81acb9968a8e1e32451d08b",
  "secret": "17cf1141cc971a10ce307611beda7ffadstr4f1bc98d9f9ca76b9b127879",
  "redirect_uri": "https://supermarket.mycompany.com/auth/chef_oauth2/callback"
}

требовать смену учетных данных

Подкоманда require-credential-rotation выводит сервер Chef Infra Server в автономный режим и требует полной смены учетных данных сервиса, прежде чем серверы Chef Infra Server в вашем кластере смогут снова перезапуститься. Запустите rotate-shared-secrets, чтобы создать новый общий секрет, соль и сгенерировать новые учетные данные сервиса. Затем скопируйте файл секретов на каждый сервер Chef Infra Server и запустите sudo chef-server-ctl reconfigure на каждом сервере, чтобы завершить процесс вращения.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl require-credential-rotation (options)

Параметры

Эта подкоманда имеет следующие параметры:

-y, --yes

Пропустить запрос в терминале и согласиться с тем, что вы хотите отключить сервер Chef Infra Server и потребовать смену учетных данных.

rotate-all-credentials

Подкоманда rotate-all-credentials генерирует новые значения учетных данных для всех учетных данных сервиса, увеличивая номер версии учетных данных и создавая новое значение хэша. Вы можете выбрать, копировать ли обновленный файл секретов на каждый узел в кластере и перенастраивать его или запустить эту подкоманду на всех узлах.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl rotate-all-credentials

rotate-credentials

Подкоманда rotate-credentials генерирует новые значения учетных данных для всех учетных данных данного сервиса, увеличивая значение и создавая новое значение хеша. Вы можете выбрать, копировать ли обновленный файл секретов на каждый узел в кластере и перенастраивать его или запустить эту подкоманду для этого конкретного сервиса на всех узлах.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl rotate-credentials SERVICE_NAME

rotate-shared-secrets

Подкоманда rotate-shared-secrets создает новый общий секрет и соль, а также генерирует новые учетные данные сервиса. Также она сбрасывает номер credential_version для сервисов до 0. После выполнения этой подкоманды был создан новый общий секрет, поэтому вам необходимо скопировать файл секретов на каждый сервер Chef Infra и запустить sudo chef-server-ctl reconfigure на них, чтобы завершить процесс вращения.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl rotate-shared-secrets

show-service-credentials

Подкоманда show-service-credentials отображает все учетные данные сервиса для служб, работающих на локальном сервере Chef Infra.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl show-service-credentials

cleanup-bifrost

Подкоманда cleanup-bifrost удаляет неиспользуемые объекты авторизации из базы данных авторизации (называемой bifrost). Эти неиспользуемые объекты могут накапливаться на серверах Chef Infra Server с длительным сроком службы в результате неудачных запросов на создание объектов. Для большинства пользователей неиспользуемые объекты авторизации не существенно влияют на производительность сервера Chef Infra Server; однако в некоторых ситуациях их удаление может быть полезно. Эта команда предназначена в первую очередь для использования службой поддержки Chef.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl cleanup-bifrost OPTIONS

Параметры

Эта подкоманда имеет следующие параметры:

--estimate-only

Предоставляет оценку количества неиспользуемых объектов, которые будут удалены, без удаления чего-либо.

--wait-time SECONDS

Количество секунд ожидания завершения активных запросов. Уменьшайте это значение только если вы выполняете команду, когда сервер Chef Infra Server не принимает запросы.

--force-cleanup

Удаляет внутренние таблицы отслеживания, используемые во время процесса очистки. Ручная очистка этих таблиц необходима только в том случае, если команда очистки была неожиданно прервана.

--batch-size

Количество удаляемых за раз заброшенных агентов авторизации.

Управление организациями

Используйте команды org-create, org-delete, org-list, org-show, org-user-add и org-user-remove для управления организациями.

org-create

Подкоманда org-create используется для создания организации. (Ключ проверки для организации возвращается STDOUT при создании организации с помощью этой команды.)

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl org-create ORG_NAME "ORG_FULL_NAME" (options)

где:

• Имя должно начинаться с строчной буквы или цифры, может содержать только строчные буквы, цифры, дефисы и символы подчеркивания и должно иметь длину от 1 до 255 символов. Например: chef.
• Полное имя должно начинаться с не пробельного символа и должно иметь длину от 1 до 1023 символов. Например: "Chef Software, Inc.".

Параметры

Эта подкоманда имеет следующие параметры:

-a USER_NAME, --association_user USER_NAME

Привязывает пользователя к организации и добавляет его в группы безопасности admins и billing_admins.

-f FILE_NAME, --filename FILE_NAME

Записывает ORGANIZATION-validator.pem в FILE_NAME вместо вывода его в STDOUT.

Примеры

chef-server-ctl org-create prod Production

chef-server-ctl org-create staging Staging -a chef-admin

chef-server-ctl org-create dev Development -f /tmp/id-dev.key

chef-server-ctl org-create dev Development --association_user grantmc

Удаление организации

Подкоманда org-delete используется для удаления организации.

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl org-delete ORG_NAME

Примеры

chef-server-ctl org-delete infra-testing-20140909

chef-server-ctl org-delete pedant-testing-org

Список организаций

Подкоманда org-list используется для отображения списка всех организаций, присутствующих на сервере Chef Infra.

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl org-list (options)

Параметры

Данная подкоманда имеет следующие параметры:

-a, --all-orgs

Отобразить все организации.

-w, --with-uri

Отобразить соответствующие URI.

Просмотр организации

Подкоманда org-show используется для отображения подробной информации об организации.

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl org-show ORG_NAME

Добавление пользователя в организацию

Подкоманда org-user-add используется для добавления пользователя в организацию.

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl org-user-add ORG_NAME USER_NAME (options)

Параметры

Данная подкоманда имеет следующие параметры:

--admin

Добавить пользователя в группу admins.

Примеры

chef-server-ctl org-user-add prod john_smith

chef-server-ctl org-user-add preprod testmaster

chef-server-ctl org-user-add dev grantmc --admin

Удаление пользователя из организации

Подкоманда org-user-remove используется для удаления пользователя из организации.

EDITOR=vi knife edit /groups/admins.json

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl org-user-remove ORG_NAME USER_NAME (options)

Параметры

Данная подкоманда имеет следующие параметры:

--force

Принудительно удалить пользователя из групп admins и billing-admins организации.

Примеры

chef-server-ctl org-user-remove prod john_smith

chef-server-ctl org-user-remove prod testmaster

chef-server-ctl org-user-remove grantmc --force

Пароль

Подкоманда password используется для смены пароля пользователя. При включении Active Directory или LDAP эта команда включает (или отключает) пароль восстановления системы для этого пользователя. Например:

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl password USERNAME

Данная подкоманда имеет следующие параметры:

--disable

Используйте этот параметр для отключения пароля восстановления системы пользователя.

Примеры

Например, для смены пароля пользователя введите:

chef-server-ctl password adamjacobs

а затем введите пароль и подтвердите его:

Enter the new password:  ******
Enter the new password again:  ******

в результате:

Password for adamjacobs successfully set.

Для отключения пароля восстановления системы:

chef-server-ctl password adamjacobs --disable

в результате:

Password for adamjacobs successfully disabled for System Recovery.

psql

Подкоманда psql используется для входа в базу данных PostgreSQL, связанную с указанной службой. Данная подкоманда:

• Использует psql (интерактивный терминал для PostgreSQL)
• Имеет только чтение по умолчанию
• Рекомендуется для взаимодействия с любой базой данных PostgreSQL, которая является частью сервера Chef Infra
• Автоматически обрабатывает аутентификацию

Синтаксис

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl psql SERVICE_NAME (options)

Параметры

Данная подкоманда имеет следующие параметры:

--write

Используйте для включения записи в базу данных PostgreSQL.

Переконфигурация

Подкоманда reconfigure используется при внесении изменений в файл chef-server.rb для переконфигурации сервера. Внесенные изменения в файл chef-server.rb не будут применены к конфигурации сервера Chef Infra до тех пор, пока не будет выполнена эта команда. Данная подкоманда также перезапустит любые службы, для которых параметр service_name['enabled'] установлен на значение true.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl reconfigure

Переиндексация

Подкоманда reindex используется для перезагрузки данных сервера Chef Infra из PostgreSQL в Elasticsearch.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl reindex

Параметры

Данная подкоманда имеет следующие параметры:

-a, --all-orgs

Используется для переиндексации всех организаций на сервере Chef Infra. Этот параметр переопределит любую указанную организацию в рамках команды, т.е. chef-server-ctl reindex ORG_NAME -a переиндексирует все организации, а не только указанную.

-d, --disable-api

Используйте для отключения API сервера Chef Infra для предотвращения записи во время переиндексации.

-t, --with-timing

Используйте для вывода временных данных для процессов переиндексации.

-w, --wait

Используйте для ожидания очистки очереди переиндексации перед выходом. Этот параметр работает только при запуске на автономном сервере Chef Infra или на первичном бэкенд-сервере Chef в старой иерархии.

Администраторы сервера

Группа server-admins — это глобальная группа, которая предоставляет своим членам разрешение на создание, чтение, обновление и удаление учетных записей пользователей, за исключением суперпользователей. Группа server-admins полезна для пользователей, ответственных за ежедневное администрирование сервера Chef Infra, особенно для управления пользователями через подкоманду knife user. Прежде чем добавить членов в группу server-admins, они должны иметь учетную запись пользователя на сервере Chef Infra.

Пример

На сервере Chef Infra существуют следующие учетные записи пользователей: pivotal (суперпользователь), alice, bob, carol, и dan. Выполните следующую команду для просмотра списка пользователей на сервере Chef Infra:

chef-server-ctl user-list

и она возвращает тот же список пользователей:

pivotal
alice
bob
carol
dan

Алиса — член команды IT, чьи обязанности включают ежедневное администрирование сервера Chef Infra, в частности, управление учетными записями пользователей на сервере Chef Infra, используемыми остальной организацией. С рабочей станции Алиса выполняет следующую команду:

knife user list -c ~/.chef/alice.rb

и она возвращает следующую ошибку:

ERROR: You authenticated successfully to <chef_server_url> as alice
       but you are not authorized for this action
Response: Missing read permission

Алиса не является суперпользователем и не имеет разрешений на других пользователей, так как учетные записи пользователей являются глобальными для организаций в сервере Chef Infra. Давайте добавим Алису в группу server-admins:

chef-server-ctl grant-server-admin-permissions alice

и она возвращает следующий ответ:

User alice was added to server-admins.

Теперь Алиса может создавать, читать, обновлять и удалять учетные записи пользователей на сервере Chef Infra, даже для организаций, членами которых она не является. С рабочей станции Алиса повторно выполняет следующую команду:

knife user list -c ~/.chef/alice.rb

которая теперь возвращает:

pivotal
alice
bob
carol
dan

Алиса теперь является администратором сервера и может использовать следующие подкоманды knife для управления пользователями на сервере Chef Infra:

• knife user-create
• knife user-delete
• knife user-edit
• knife user-list
• knife user-show

Например, Алиса выполняет следующую команду:

knife user edit carol -c ~/.chef/alice.rb

и $EDITOR открывается, где Алиса вносит изменения и сохраняет их.

Суперпользователи

Учетные записи суперпользователей не могут управляться пользователями, входящими в группу server-admins. Например, Алиса пытается удалить учетную запись суперпользователя pivotal:

knife user delete pivotal -c ~/.chef/alice.rb

и возвращается следующая ошибка:

ERROR: You authenticated successfully to <chef_server_url> as user1
       but you are not authorized for this action
Response: Missing read permission

Действие Алисы несанкционировано даже при членстве в группе server-admins.

Управление группой серверных администраторов

Членство в группе server-admins управляется набором подкоманд chef-server-ctl:

• chef-server-ctl grant-server-admin-permissions
• chef-server-ctl list-server-admins
• chef-server-ctl remove-server-admin-permissions

Добавление членов

Подкоманда grant-server-admin-permissions используется для добавления пользователя в группу server-admins. Выполняйте команду для каждого добавляемого пользователя.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl grant-server-admin-permissions USER_NAME

где USER_NAME — пользователь, который должен быть добавлен в список администраторов сервера.

Например:

chef-server-ctl grant-server-admin-permissions bob

возвращает:

User bob was added to server-admins. This user can now list,
read, and create users (even for orgs they are not members of)
for this Chef Infra Server.

Удаление членов

Подкоманда remove-server-admin-permissions используется для удаления пользователя из группы server-admins. Выполняйте команду для каждого удаляемого пользователя.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl remove-server-admin-permissions USER_NAME

где USER_NAME — пользователь, который должен быть удален из списка администраторов сервера.

Например:

chef-server-ctl remove-server-admin-permissions bob

возвращает:

User bob was removed from server-admins. This user can no longer
list, read, and create users for this Chef Infra Server except for where
they have default permissions (such as within an org).

Членство в списке

Подкоманда list-server-admins используется для возвращения списка пользователей, которые являются членами группы server-admins.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl list-server-admins

и вернет список пользователей, аналогичный следующему:

pivotal
alice
bob
carol
dan

show-config

Подкоманда show-config используется для просмотра конфигурации, которая будет сгенерирована подкомандой reconfigure. Эта команда наиболее полезна на ранних этапах развертывания, чтобы убедиться, что всё построено правильно перед установкой.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl show-config

uninstall

Подкоманда uninstall используется для удаления приложения Chef Infra Server, но без удаления данных. Эта подкоманда остановит все службы (включая диспетчер процессов runit).

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl uninstall

upgrade

Подкоманда upgrade используется для обновления Chef Infra Server.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl upgrade (options)

Параметры

Эта подкоманда имеет следующие параметры:

-d DIRECTORY, --chef11-data-dir DIRECTORY

Директория, в которой хранятся данные Chef Infra Server 11. Значение по умолчанию: временная директория.

-e DIRECTORY, --chef12-data-dir DIRECTORY

Директория, в которой хранятся данные Chef Infra Server 12. Значение по умолчанию: временная директория.

-f FULL_NAME, --full-org-name FULL_NAME

Полное имя организации Chef Infra Server. Полное имя должно начинаться с символа, отличного от пробела, и содержать от 1 до 1023 символов. Например: Chef Software, Inc.. Если этот параметр не указан, команда upgrade запросит его.

-h, --help

Показать справку по подкоманде chef-server-ctl upgrade.

-k KEY_PATH, --key KEY_PATH

Ключ admin.pem Chef Infra Server 11 для API-клиента. Этот ключ используется для скачивания данных Chef Infra Server 11. Значение по умолчанию: /etc/chef-server/admin.pem.

-o ORG_NAME, --org-name ORG_NAME

Название организации Chef Infra Server. Имя должно начинаться с строчной буквы или цифры, содержать только строчные буквы, цифры, дефисы и символы нижнего подчеркивания и иметь длину от 1 до 255 символов. Например: chef. Если этот параметр не указан, команда upgrade запросит его.

-s URL, --chef11-server-url URL

URL для Chef Infra Server версии 11. Значение по умолчанию: https://localhost.

-t NUMBER, --upload-threads NUMBER

Количество потоков для миграции кулинарных книг. Значение по умолчанию: 10.

-u USER, --user

Создать клиента как администратора. Это необходимо для доступа любого пользователя к Chef в качестве администратора.

-x URL, --chef12-server-url URL

URL для Chef Infra Server версии 12. Значение по умолчанию: https://localhost.

-y, --yes

Пропустить запросы подтверждения во время процесса обновления.

Управление пользователями

Используйте подкоманды user-create, user-delete, user-edit, user-list и user-show для управления пользователями.

user-create

Подкоманда user-create используется для создания пользователя. (Ключ проверки для организации может быть возвращен в STDOUT при создании пользователя с помощью этой команды.)

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl user-create USER_NAME FIRST_NAME [MIDDLE_NAME] LAST_NAME EMAIL 'PASSWORD' (options)

Параметры

Эта подкоманда имеет следующие параметры:

-f FILE_NAME, --filename FILE_NAME

Записать USER.pem в файл вместо STDOUT.

Примеры

chef-server-ctl user-create john_smith John Smith john_smith@example.com p@s5w0rD!

chef-server-ctl user-create jane_doe Jane Doe jane_doe@example.com p@s5w0rD! -f /tmp/jane_doe.key

chef-server-ctl user-create waldendude Henry David Thoreau waldendude@example.com excursions

user-delete

Подкоманда user-delete используется для удаления пользователя.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl user-delete USER_NAME

Примеры

chef-server-ctl user-delete john_smith

chef-server-ctl user-delete jane_doe

Параметры

Эта подкоманда имеет следующие параметры:

-R, --remove-from-admin-groups

Удаляет пользователя, который входит в одну или несколько групп «администратор», если этот пользователь не является единственным членом группы(и) «администратор».

user-edit

Подкоманда user-edit используется для редактирования данных пользователя. Данные будут доступны в $EDITOR для редактирования.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl user-edit USER_NAME

Примеры

chef-server-ctl user-edit john_smith

chef-server-ctl user-edit jane_doe

user-list

Подкоманда user-list используется для просмотра списка пользователей.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl user-list (options)

Параметры

Эта подкоманда имеет следующие параметры:

-w, --with-uri

Показать соответствующие URI.

user-show

Подкоманда user-show используется для отображения данных пользователя.

Синтаксис

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl user-show USER_NAME (options)

Параметры

Эта подкоманда имеет следующие параметры:

-l, --with-orgs

Показать все организации.

Подкоманды служб

Эта команда имеет встроенный диспетчер процессов, который гарантирует, что все необходимые службы находятся в соответствующем состоянии в любой момент времени. Диспетчер запускает по две задачи на каждую службу и предоставляет следующие подкоманды для управления службами: hup, int, kill, once, restart, service-list, start, status, stop, tail, и term.

hup

Подкоманда hup используется для отправки SIGHUP всем службам. Эту команду также можно выполнить для отдельной службы, указав имя службы в команде.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl hup SERVICE_NAME

где SERVICE_NAME представляет имя любой службы, указанной после выполнения подкоманды service-list.

int

Подкоманда int используется для отправки SIGINT всем службам. Эту команду также можно выполнить для отдельной службы, указав имя службы в команде.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl int SERVICE_NAME

где SERVICE_NAME представляет имя любой службы, указанной после выполнения подкоманды service-list.

kill

Подкоманда kill используется для отправки SIGKILL всем службам. Эту команду также можно выполнить для отдельной службы, указав имя службы в команде.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl kill SERVICE_NAME

где SERVICE_NAME представляет имя любой службы, указанной после выполнения подкоманды service-list.

once

Диспетчер процессов Chef Infra Server настроен на перезапуск любой службы, которая завершается неудачно, если эта служба не была попрошена изменить свое состояние. Подкоманда once используется для того, чтобы диспетчер не пытался перезапустить любую службу, которая завершилась неудачно.

Эта команда полезна при устранении неполадок в конфигурации, которые препятствуют запуску службы. Выполните подкоманду once и затем подкоманду status для поиска служб в состоянии «остановлены» и/или для определения проблемных служб. Эту команду также можно выполнить для отдельной службы, указав имя службы в команде.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl once SERVICE_NAME

где SERVICE_NAME представляет имя любой службы, указанной после выполнения подкоманды service-list.

restart

Подкоманда restart используется для перезапуска всех служб, включенных в Chef Infra Server, или для перезапуска отдельной службы, указав имя этой службы в команде.

Эта подкоманда имеет следующий синтаксис:

chef-server-ctl restart SERVICE_NAME

где SERVICE_NAME представляет имя любой службы, указанной после выполнения подкоманды service-list. После успешного перезапуска службы вывод должен быть подобным:

ok: run: service_name: (pid 12345) 1s

список-сервисов

Подкоманда service-list используется для отображения списка всех доступных сервисов. Сервис, который включен, помечается звёздочкой (*).

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl service-list

запуск

Подкоманда start используется для запуска всех включенных сервисов в Chef Infra Server. Эта команда также может быть выполнена для отдельного сервиса, указав имя сервиса в команде.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl start SERVICE_NAME

где SERVICE_NAME представляет имя любого сервиса, перечисленного после выполнения подкоманды service-list. При успешном запуске сервиса вывод должен быть похожим на:

ok: run: service_name: (pid 12345) 1s

Supervisory для Chef Infra Server настроен на ожидание семь секунд, чтобы сервис ответил на команду от Supervisor. Если вы видите вывод, содержащий ссылку на таймаут, это означает, что процессу был отправлен сигнал, но процесс ещё не выполнил его. В целом, процессы, которые превысили таймаут, не являются большой проблемой, если они вообще не реагируют на сигналы. Если процесс не отвечает, используйте команду, подобную подкоманде kill, для остановки процесса, расследуйте причину (при необходимости), а затем используйте подкоманду start для его повторного включения.

статус

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

chef-server-ctl status

и вернёт статус всех сервисов. Статус можно получить для отдельных сервисов, указав имя сервиса в команде:

chef-server-ctl status SERVICE_NAME

где SERVICE_NAME представляет имя любого сервиса, перечисленного после выполнения подкоманды service-list.

Когда запрашивается статус сервиса, вывод должен быть похожим на:

run: service_name: (pid 12345) 12345s; run: log: (pid 1234) 67890s

где

• run: — состояние сервиса (run: или down:)
• service_name: — имя сервиса, для которого возвращается статус
• (pid 12345) — идентификатор процесса
• 12345s — время работы сервиса в секундах

Например:

down: opscode-erchef: (pid 35546) 10s

По умолчанию, runit автоматически перезапустит сервисы при их сбоях. Поэтому runit может отобразить статус сервиса как run:, даже если с этим сервисом есть проблемы. При расследовании причины, по которой определённый сервис не работает должным образом, обратите внимание на сервисы с самым коротким временем работы. Например, список ниже указывает, что следует более подробно изучить opscode-erchef:

run: oc-id
run: opscode-chef: (pid 4327) 13671s; run: log: (pid 4326) 13671s
run: opscode-erchef: (pid 5383) 5s; run: log: (pid 4382) 13669s

Файлы журналов

Типичная строка статуса сервиса, выполняющего любой из сервисов переднего плана Chef Infra Server, похожа на следующую:

run: name_of_service: (pid 1486) 7819s; run: log: (pid 1485) 7819s

где:

• run описывает состояние, в котором Supervisor пытается поддерживать процессы. Это состояние может быть run или down. Если сервис находится в состоянии down, его следует остановить
• name_of_service — имя сервиса, например: opscode-erchef
• (pid 1486) 7819s; — идентификатор процесса, за которым следует количество времени (в секундах), в течение которого сервис работает
• run: log: (pid 1485) 7819s — процесс журнала. Типично, что процесс журнала работает дольше, чем сервис; это потому, что Supervisor не должен перезапускать процесс журнала, чтобы подключиться к контролируемому процессу

Если сервис остановлен, строка статуса будет похожа на следующую:

down: opscode-erchef: 3s, normally up; run: log: (pid 1485) 8526s

где

• down указывает, что сервис находится в состоянии остановки
• 3s, normally up; указывает, что сервис обычно находится в рабочем состоянии и Supervisor попытается перезапустить этот сервис после перезагрузки

остановка

Подкоманда stop используется для остановки всех включенных сервисов на Chef Infra Server. Эта команда также может быть выполнена для отдельного сервиса, указав имя сервиса в команде.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl stop SERVICE_NAME

где SERVICE_NAME представляет имя любого сервиса, перечисленного после выполнения подкоманды service-list. При успешной остановке сервиса вывод должен быть похожим на:

ok: down: service_name: 0s, normally up

Например:

chef-server-ctl stop

вернёт что-то подобное:

ok: down: nginx: 393s, normally up
ok: down: opscode-chef: 391s, normally up
ok: down: opscode-erchef: 391s, normally up
ok: down: opscode-solr4: 389s, normally up
ok: down: postgresql: 388s, normally up
ok: down: redis_lb: 387s, normally up

последовательное чтение

Подкоманда tail используется для слежения за всеми логами Chef Infra Server для всех сервисов. Эта команда также может быть выполнена для отдельного сервиса, указав имя сервиса в команде.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl tail SERVICE_NAME

где SERVICE_NAME представляет имя любого сервиса, перечисленного после выполнения подкоманды service-list.

терминал

Подкоманда term используется для отправки SIGTERM всем сервисам. Эта команда также может быть выполнена для отдельного сервиса, указав имя сервиса в команде.

Данная подкоманда имеет следующий синтаксис:

chef-server-ctl term SERVICE_NAME

где SERVICE_NAME представляет имя любого сервиса, перечисленного после выполнения подкоманды service-list.