Лабораторное обновление: Chef Infra Client 12 до 16

[edit on 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-15
  • Минимально 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 по адресу http://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 за учебными материалами и свяжитесь с службой поддержки клиентов Chef Software, когда будете готовы модернизировать свою систему.

------------------------ 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 и так далее, пока не достигнете версии 16 клиента Chef Infra.

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

Сохраните файл и протестируйте его в каталоге 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 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

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

Счастливого слияния!