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 на новый установленный сервер. Эта подкоманда:

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

Параметры

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

-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

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

Параметры

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

--with-external

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

Синтаксис

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

chef-server-ctl cleanse

gather-logs

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

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

chef-server-ctl gather-logs

help

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

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

chef-server-ctl help

install

Подкоманда install используется для установки премиум-функций сервера Chef Infra: консоль управления Chef, отчетность о выполнении задач Chef Infra Client, конфигурации высокой доступности, задания Chef Push Jobs и репликация сервера 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
   

   Установите Push Jobs с:

   sudo chef-server-ctl install opscode-push-jobs-server-ctl
   

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

   sudo chef-server-ctl reconfigure
   

3. Переконфигурация дополнений

   Переконфигурируйте Chef Manage с:

   sudo chef-manage-ctl reconfigure
   

   Переконфигурируйте Push Jobs с:

   sudo opscode-push-jobs-server reconfigure
   

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

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

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

Используйте подкоманду install с параметром --path для установки дополнений Chef Manage (chef-manage) и Push Jobs (opscode-push-jobs-server) для сервера 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 12.14

Синтаксис

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

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 Server 12.16.2.

remove-secret

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

Новое в Chef Server 12.14

Синтаксис

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

chef-server-ctl remove-secret GROUP NAME

Пример

chef-server-ctl remove-secret ldap bind_password

show-secret

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

Новое в Chef Server 12.14

Синтаксис

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

chef-server-ctl show-secret GROUP NAME

set-db-superuser-password

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

Новое в Chef Server 12.14

Синтаксис

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

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

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

set-actions-password

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

Новое в Chef Server 12.14

Синтаксис

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

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 12.14

Синтаксис

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

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 в автономный режим и требует полного вращения учетных данных службы, прежде чем серверы Chef в вашем кластере смогут перезапуститься снова. Запустите rotate-shared-secrets для создания нового общего секрета, соли и генерации новых учетных данных службы. Затем скопируйте файл секретов на каждый сервер Chef Infra и запустите sudo chef-server-ctl reconfigure на каждом сервере для завершения процесса вращения.

Новое в Chef Server 12.7

Синтаксис

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

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

Параметры

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

-y, --yes

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

вращать все учетные данные

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

Новое в Chef Server 12.7

Синтаксис

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

chef-server-ctl rotate-all-credentials

вращать учетные данные

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

Новое в Chef Server 12.7

Синтаксис

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

chef-server-ctl rotate-credentials SERVICE_NAME

вращать общие секреты

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

Новое в Chef Server 12.7

Синтаксис

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

chef-server-ctl rotate-shared-secrets

show-service-credentials

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

Новое в Chef Server 12.7

Синтаксис

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

chef-server-ctl show-service-credentials

cleanup-bifrost

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

Новое в Chef Server 12.16.9

Синтаксис

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

chef-server-ctl cleanup-bifrost OPTIONS

Параметры

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

--estimate-only

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

--wait-time SECONDS

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

--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

Подкоманда 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

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

Синтаксис

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

chef-server-ctl org-list (options)

Параметры

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

-a, --all-orgs

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

-w, --with-uri

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

org-show

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

Синтаксис

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

chef-server-ctl org-show ORG_NAME

org-user-add

Подкоманда 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

Подкоманда 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

Подкоманда 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
• Автоматически обрабатывает аутентификацию

Синтаксис

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

chef-server-ctl psql SERVICE_NAME (options)

Параметры

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

--write

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

reconfigure

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

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

chef-server-ctl reconfigure

reindex

Подкоманда 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 backend в рамках устаревшего уровня.

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

Группа 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

Членство в группе 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 Server 11. Значение по умолчанию: временная директория.

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

Директория, в которой находятся данные Chef 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 Server 11 для API-клиента. Этот ключ используется для загрузки данных Chef 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 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

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

Новое в Chef Server 12.9.

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

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

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

chef-server-ctl service-list

start

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

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

chef-server-ctl start SERVICE_NAME

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

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

Наблюдатель для Chef Infra Server настроен ожидать семь секунд, чтобы служба ответила на команду от наблюдателя. Если вы видите вывод, который ссылается на таймаут, это означает, что процессу был отправлен сигнал, но процесс еще не выполнил его. В общем случае, процессы с таймаутом не представляют большой проблемы, если только они вообще не отвечают на сигналы. Если процесс не отвечает, используйте команду, подобную подкоманде 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 описывает состояние, в котором наблюдатель пытается сохранить процессы. Это состояние либо run, либо down. Если служба находится в состоянии down, её следует остановить
• name_of_service - имя службы, например: opscode-erchef
• (pid 1486) 7819s; - идентификатор процесса, за которым следует количество времени (в секундах), которое служба работает
• run: log: (pid 1485) 7819s - процесс логов. Типично, что процесс логов работает дольше, чем служба; это потому, что наблюдателю не нужно перезапускать процесс логов, чтобы подключиться к контролируемому процессу

Если служба выключена, строка состояния будет выглядеть примерно так:

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

где

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

stop

Подкоманда 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

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

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

chef-server-ctl tail SERVICE_NAME

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

term

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

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

chef-server-ctl term SERVICE_NAME

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