Обновление Лаборатории: Chef Infra Client 12 до последней версии

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

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

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

Об этом руководстве

Это руководство охватывает простой способ обновления с Chef Infra Client 12 до Chef Infra Client 16, включая обновление Chef Infra Server по мере необходимости. Хотя мы считаем, что это руководство – наиболее простой путь, оно не призвано исключать другие подходы.

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

Требования к лаборатории обновления Chef

Требования к архитектуре системы

Лаборатория обновления Chef делает некоторые базовые предположения о вашей существующей системе:

• Два Chef Infra Server
  • Chef Infra Server, работающий на какой-то старой версии
  • Новый установленный Chef Infra Server, работающий на последнем программном обеспечении, настроенный и сконфигурированный для knife, но в противном случае пустой
• Один или несколько узлов
  • Работающие с Chef Infra Client 12 или новее
  • Минимальный объём ОЗУ 512 МБ
  • Рекомендуемый объём дискового пространства 5 ГБ
  • Запущенные с помощью старого Chef Infra Server
  • sudo разрешения на узле
  • Подключение SSH между узлами и рабочей станцией администратора/разработчика
• Рабочая станция администратора/разработчика
  • 64-битная архитектура
  • Минимальный объём ОЗУ 4 ГБ
  • Рекомендуемый объём доступного дискового пространства 10 ГБ для установки Chef Workstation и работы с лабораторией обновления Chef

Требования к программному обеспечению

• Просмотрите требования к платформе и системе для Chef Workstation
• Установите или обновите до последней версии Chef Workstation последнюю версию

Chef не предписывает какой-либо конкретный редактор. Однако расширение Chef Infra для Visual Studio Code включает несколько генераторов кода и полезных функций, таких как запуск Cookstyle каждый раз при сохранении рецепта.

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

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

Требования к инфраструктуре

Учетные данные

Ваши учетные данные настраиваются с помощью профилей knife. Этот метод позволяет хранить ключи в файле credentials, и облегчает переключение между учетными данными.

Например, в .chef/credentials:

[old-server]
client_name = "user_name"
chef_server_url = "https://old-chef-server.dev/organizations/my-org"
client_key = """
-----BEGIN RSA PRIVATE KEY-----
MMM+some+key+goes+here+MMM
-----END RSA PRIVATE KEY-----
"""
[new-server]
client_name = "user_name"
chef_server_url = "https://new-chef-server.dev/organizations/my-org"
client_key = """
-----BEGIN RSA PRIVATE KEY-----
MMM+another+key+goes+here+MMM
-----END RSA PRIVATE KEY-----
"""

Подключение

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

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

chef exec knife user list --profile old-server
user_name
chef exec knife user list --profile new-server
user_name

Сходимость

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

Проверьте работоспособность узлов, выполнив:

chef exec knife status --profile old-server

Вывод должен быть похожим на:

42 minutes ago, node-01, ubuntu 18.04.

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

Cookbook CI/CD

Хотя мы не предписываем определённый выбор технологии или деталей процессов, лаборатория обновления Chef ожидает непрерывную интеграцию и систему непрерывной доставки (CI/CD) для развертывания кулинарных книг.

Лаборатория обновления предполагает, но не требует наличия системы непрерывной интеграции (CI) для ваших кулинарных книг с:

• Системой управления версиями (например, git)
• Определённым уровнем автоматизированного тестирования предлагаемых изменений
• Системой непрерывной доставки (CD), управляющей выпуском кулинарных книг; CD – это механизм обновления версий кулинарных книг и их загрузки на Chef Infra Server(ы)

Если у вас нет системы управления версиями и CI/CD конвейера, обратитесь к вашей команде по работе с клиентами за помощью или свяжитесь с нами по адресу sales@chef.io.

Вы также можете задавать вопросы в каналах сообщества Chef:

• Сервер Slack сообщества Chef по адресу https://community-slack.chef.io/.
• Список рассылки Chef по адресу https://discourse.chef.io/

Лаборатория обновления

Инвентаризация вашей системы с помощью отчётов Chef

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

chef report nodes

Команда chef report nodes -p PROFILE будет:

• создать отчёт об узлах в вашей системе из данных Ohai
• вывести сводку отчёта на экран
• сохранить отчёт в директории .chef-workstation/reports/

Создайте отчёт об узле со своей рабочей станции разработчика, выполнив:

chef report nodes -p old-server

Что выводит отчёт об узле:

Analyzing nodes...

-- REPORT SUMMARY --

            Node Name             Chef Version    Operating System     Number Cookbooks
--------------------------------+--------------+---------------------+-------------------
  node-01                         12.22.5        windows v10.0.14393                 18
  node-02                         12.22.5        windows v10.0.14393                 18
  node-03                         12.22.5        windows v10.0.14393                  5
  node-04                         12.18.31       windows v6.3.9600                    5
Nodes report saved to /Users/user_name/.chef-workstation/reports/nodes-20200324135111.txt

chef report cookbooks

Команда chef report cookbooks -p PROFILE будет:

• создать отчёт о кулинарных книгах в вашей системе из данных Ohai
• вывести сводку отчёта на экран
• сохранить отчёт в директории .chef-workstation/reports/

Этот отчёт показывает, что на сервере две кулинарные книги. Он анализирует кулинарные книги, ища проблемы кулинарных книг, которые будут проблематичными в более поздних версиях Chef Infra Client, выполняя программу cookstyle. Здесь мы видим, что кулинарная книга cron имеет одно нарушение, которое можно автоматически исправить с помощью cookstyle.

Создайте отчёт о кулинарных книгах со своей рабочей станции разработчика, выполнив:

chef report cookbooks -V -p old-server

Что выводит отчёт о кулинарных книгах:

        Cookbook         Version   Violations   Auto-correctable   Nodes Affected
-----------------------+---------+------------+------------------+-----------------
  cron                   1.7.5              1                  1                1
  upgrade_labs_problems  0.1.0              2                  2                1

Cookbooks report saved to /Users/user_name/.chef-workstation/reports/cookbooks-20200504155204.txt

Создайте среду обновления с помощью chef capture

Команда chef capture NODE будет:

• Создать репозиторий для этого узла в текущем каталоге
• Помочь вам получить и организовать кулинарные книги, необходимые для сходимости узла
• Создать kitchen.yml, что позволит использовать Test Kitchen для выполнения локального разработки

Выполните команду:

chef capture NODE

Вывод на экран описывает процесс захвата:

 - Setting up local repository
 - Capturing node object ''
 - Capturing cookbooks...
 - Capturing environment...
 - Capturing roles...
 - Writing kitchen configuration...

Repository has been created in './node-NODE-repo'.

Добавление местоположений исходных кулинарных книг

После создания репозитория, chef capture NODE попросит вас извлечь кулинарные книги из их исходных местоположений.

Обновление узла означает обновление его кулинарных книг, чтобы он мог запускать последнюю версию Chef Infra Client. В идеале, вы можете получить кулинарные книги из их канонического источника (то есть git clone или другой аналогичной операции управления версиями). Если вы работаете с системой управления версиями, вы можете вносить и тестировать свои изменения локально, а затем отправить изменения обратно в исходный код кулинарной книги. Это полностью использует преимущества вашего конвейера CI/CD для кулинарных книг, позволяя вашим изменениям пройти через надлежащее управление версиями, проверку код, автоматизированное тестирование и автоматизированное развертывание.

Если вы не можете найти кулинарную книгу, не загружайте её из внешнего источника, такого как общедоступный Chef Supermarket. Версия кулинарной книги в вашей среде разработки должна соответствовать версии на вашем узле. В крайнем случае, лаборатория обновления может получить копии ваших кулинарных книг с Chef Infra Server во время фазы capture.

Вероятные места расположения кулинарных книг:

• Зафиксированы в вашей системе управления версиями
• На установке частного Supermarket
• В существующем каталоге разработки кулинарных книг

Структура каталогов кулинарных книг

Если у вас есть доступ к исходным кулинарным книгам, хранение кулинарных книг в одном родительском каталоге проще, примерно так:

/Users/user_name/my_cookbooks/
--- cron
    -- .git/   # Or other version control bookkeeping
    -- recipes/
    -- ...
    -- metadata.rb
--- chef-client
    -- .cvs/   # Or other version control bookkeeping
    -- recipes/
    -- ...
    -- metadata.rb
--- my_custom_cookbook
    -- .git/   # Or other version control bookkeeping
    -- recipes/
    -- ...
    -- metadata.rb

Лаборатория обновления работает, если у вас есть кулинарные книги в разных местах, но это требует больше запросов из командной строки.

Основное местоположение разработки кулинарных книг

Команда chef capture сначала попросит указать основное местоположение исходного кода кулинарных книг:

Next, locate version-controlled copies of the cookbooks. This is
important so that you can track changes to the cookbooks as you
edit them. You may have one or more existing paths where you have
checked out cookbooks. If not, now is a good time to open a
separate terminal and clone or check out the cookbooks.

If all cookbooks are not available in the same base location,
you will have a chance to provide additional locations.

Press Enter to Continue:

Please clone or check out the following cookbooks locally
from their original sources, and provide the base path
for the checkout:

  - cron (v1.6.1)
  - chef-client (v4.3.0)
  - logrotate (v1.9.2)
  - windows (v1.44.1)
  - chef_handler (v1.4.0)

If sources are not available for these cookbooks, leave this blank.

Checkout Location [none]:

На этом этапе введите путь к вашему каталогу разработки кулинарных книг, например /Users/user_name/my_cookbooks в приглашении.

chef capture сканирует этот путь и находит кулинарные книги, которые ему нужны. Команда завершается, когда она учитывает все источники кулинарных книг; но если какие-либо отсутствуют, она запросит их на следующем шаге.

Checkout Location [none]: /src/my_cookbooks
  Using your checked-out cookbook: cron
  using your checked-out cookbook: chef-client

Альтернативные местоположения исходного кода кулинарных книг

Предположим, что ваш узел требует 5 кулинарных книг:

• cron (v1.6.1)
• chef-client (v4.3.0)
• logrotate (v1.9.2)
• windows (v1.44.1)
• chef_handler (v1.4.0)

Если каталог, который вы указали в первоначальном запросе, содержит только cron и chef-client, тогда chef capture попросит вас добавить местоположения источников для оставшихся трёх:

Please provide the base checkout path for the following
cookbooks, or leave blank if no more cookbooks are checked out:

  - logrotate (v1.9.2)
  - windows (v1.44.1)
  - chef_handler (v1.4.0)

Checkout Location [none]:

chef capture сканирует предоставленный путь и находит необходимые кулинарные книги. Команда завершается, как только учитываются все источники кулинарных книг; она запросит у вас другой путь, если потребуются дополнительные источники кулинарных книг.

Загрузка кулинарных книг с сервера Chef Infra

Если у вас нет доступа к исходному контролируемому источнику кулинарной книги, нажмите Enter в запросе для chef capture для использования копии кулинарной книги, загруженной с сервера Chef Infra.

Обновление кулинарных книг с сервера Chef Infra не является идеальной практикой. Вы будете вносить изменения в свои кулинарные книги в процессе обновления. Внесение изменений в кулинарные книги без возможности отслеживания изменений в системе управления версиями практически неизбежно приводит к конфликтам между источниками кулинарных книг. Примирение кулинарных книг с неотслеженными изменениями — это сложный и трудоёмкий процесс. Если вы используете много кулинарных книг — или сложные кулинарные книги — загруженные с сервера Chef Infra, в долгосрочной перспективе будет полезно постараться отследить их контролируемые источники.

Отслеживание и тестирование изменений в конвейере CI/CD является важной частью управления вашей инфраструктурой Chef, но выходят за рамки этого руководства. Обратитесь к Learn Chef Rally для получения учебных пособий и свяжитесь со своей службой поддержки клиентов, когда вы готовы модернизировать свою систему.

------------------------ WARNING ---------------------------
Changes made to the following cookbooks in ./node-MY_NODE-repo/cookbooks
cannot be saved to the cookbook's source, though they can still be uploaded
to a Chef Server:
  - logrotate (v1.9.2)
  - windows (v1.44.1)
  - chef_handler (v1.4.0)
-----------------------------------------------------------
You're ready to begin!

Start with 'kitchen converge'. As you identify issues, you
can modify cookbooks in their original checkout locations or
in the repository's cookbooks directory and they will be picked
up on subsequent runs of 'kitchen converge'.

Обнаружение и исправление ошибок в кулинарных книгах

Увеличение версии клиента Chef Infra

В файле kitchen.yml измените строку product_version на 16:

provisioner:name:chef_zeroproduct_name:chefproduct_version:16# Change this line

При необходимости вы можете «перейти» к новым версиям, сначала перейдя с 12 на 13, исправив любые проблемы, а затем увеличив с 13 до 14 и т. д., пока не достигнете версии Chef Infra Client 16.

Попытка слияния и проверка на наличие ошибок

Сохраните файл и протестируйте его в каталоге node-MY_NODE-repo, выполнив команду:

chef exec kitchen converge

Обращайте внимание на ошибки Chef Infra. Если они возникнут, исправьте их.

Тестирование и исправление с помощью Cookstyle

Чтобы проверить наличие проблем при обновлении версии, выполните команду:

chef exec cookstyle cookbooks/my_cookbook

Повторите этот процесс для каждой кулинарной книги для данного узла.

Использование автоматической коррекции Cookstyle

Воспользуйтесь функцией автоматической коррекции Cookstyle для исправления стилистических ошибок, добавив флаг -a (для автоматической коррекции):

chef exec cookstyle -a cookbooks/my_cookbook

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

Копирование пакетов данных

Если ваш сервер Chef Infra использует пакеты данных, вам нужно будет загрузить каталог data_bags в свой репозиторий chef с помощью команды chef exec knife download data_bags. Эта команда не поддерживает встроенные ключи в файлах с данными для аутентификации. Если вы используете встроенные ключи, переместите ключ в отдельный файл ключа.

cd node-node-01-repo
chef exec knife download data_bags --chef-repo-path . --profile old-server --key my-old-key.pem

Развертывание обновлений вашей лаборатории Chef

Зафиксировать обновления кулинарных книг

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

Необязательно загрузить обновления кулинарных книг на новый сервер

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

cd node-node-01-repo
chef exec knife upload cookbooks --chef-repo-path . --profile new-server --key ../keys/my-new-key.pem

Загрузка дополнительных данных на новый сервер

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

Данные узла

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

chef exec knife upload nodes --chef-repo-path . --profile new-server --key ../keys/my-new-key.pem

Роли

Если вы используете роли, загрузите их на новый сервер:

chef exec knife upload roles --chef-repo-path . --profile new-server --key ../keys/my-new-key.pem

Среды

Если вы используете среды, загрузите их на новый сервер:

chef exec knife upload environments --chef-repo-path . --profile new-server --key ../keys/my-new-key.pem

Пакеты данных

Если вы использовали пакеты данных, загрузите их на новый сервер:

chef exec knife upload data_bags --chef-repo-path . --profile new-server --key ../keys/my-new-key.pem

Подключение обновлённого узла к новому серверу

Выполнение новой команды загрузки

Перемените свой узел на новый сервер, выполнив команду загрузки, похожую на:

chef exec knife bootstrap \
    --profile new-server --chef-license accept \
    -r cookbook::recipe,another_cookbook::recipe \
    -N node-01 -y --sudo \
    --bootstrap-version 16 \
    user@somehost.example

Загрузка узлов таким образом обновляет установленный клиент Chef Infra до версии 16. Поздравляем!

Необязательно, удалите запись узла со старого сервера, используя:

chef exec knife node delete node-01 --profile old-server

Повторить при необходимости

Приятного слияния!