Обновление Лаборатории: 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 перед запуском лаборатории апгрейда.

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

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

Ваши учётные данные настроены с помощью профилей 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

Подключить обновлённый узел к новому серверу

Выдать новую команду Bootstrap

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

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

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

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