Облачная платформаEvolution

Использование кеширующего реестра для пакетов PyPI

Эта статья полезна?

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

Вы будете использовать следующие инструменты:

  • Artifact Registry для хранения, совместного использования и управления Docker-образами, Deb-пакетами, RPM-пакетами, Helm-чартами и файлами любого типа (generic).

  • Pip — система управления пакетами в языке программирования Python.

Шаги:

  1. Создайте кеширующий реестр.

  2. Пройдите аутентификацию (для приватного реестра).

  3. Настройте систему управления пакетами для работы с PyPI-пакетами через Artifact Registry.

  4. Проверьте работу кеширующего реестра.

Перед началом работы

  1. Зарегистрируйтесь в личном кабинете Cloud.ru.

    Если вы уже зарегистрированы, войдите под своей учетной записью.

  2. Подключите сервис Secret Management и укажите в нем данные для авторизации в стороннем хранилище.

    Данные нужно указать, если в стороннем хранилище есть приватные артефакты, которые доступны только при вводе имени пользователя и токена или пароля.

1. Создайте кеширующий реестр

  1. На верхней панели слева нажмите Кнопка с изображением девяти точек и выберите Контейнеры → Artifact Registry.

  2. Нажмите Создать реестр.

  3. Выберите формат реестра PyPI.

  4. Укажите название реестра.

    Название реестра станет частью URI реестра, который будет использоваться для аутентификации и работы с образами.

  5. Выберите Публичный или Приватный тип доступа к реестру.

  6. Выберите тип реестра Кеширующий.

  7. В поле Источник выберите каталог пресетов или укажите адрес удаленного хранилища.

    Например, pypi.org.

  8. (Опционально) В полях Логин и Пароль выберите авторизационные данные для доступа к стороннему хранилищу.

    Данные нужно указать, если в стороннем хранилище есть приватные артефакты, которые доступны только при вводе имени пользователя и токена или пароля.

  9. Нажмите Создать.

2. Пройдите аутентификацию (для приватного реестра)

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

3. Настройте систему управления пакетами для работы с PyPI-пакетами через Artifact Registry

Настройте работу системы управления пакетами, чтобы запрашиваемый артефакт проходил через кеширующий реестр Artifact Registry. Это можно сделать несколькими способами:

  • через разовый запрос определенного артефакта;

  • изменение файла pip;

  • переменные окружения.

Разовый запрос артефакта

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

pip install \
--index-url https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/ \
<package_name>

Где:

  • <registry_name> — название реестра в Artifact Registry;

  • <key_id> — логин ключа доступа к приватному реестру;

  • <key_secret> — пароль ключа доступа к приватному реестру;

  • <package_name> — название запрашиваемого артефакта.

Если хотите, чтобы пакеты, которых еще нет в кеше или которые публично не проксируются, загружались напрямую с pypi.org, используйте дополнительно команду --extra-index-url:

pip install \
--index-url https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/ \
--extra-index-url https://pypi.org/simple \
<package_name>

Где:

  • <registry_name> — название реестра в Artifact Registry;

  • <key_id> — логин ключа доступа к приватному реестру;

  • <key_secret> — пароль ключа доступа к приватному реестру;

  • <package_name> — название запрашиваемого артефакта.

Изменение файла pip

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

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

pip config set global.index-url "https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/"

Где:

  • <registry_name> — название реестра в Artifact Registry;

  • <key_id> — логин ключа доступа к приватному реестру;

  • <key_secret> — пароль ключа доступа к приватному реестру.

Также можно отредактировать файл вручную:

  1. Откройте файл pip.

    Если у вас ОС Windows, файл pip.ini находится в директории %APPDATA%\pip\.

    Если у вас ОС Linux или MacOS файл pip.conf находится в директории ~/.config/pip.

  2. Добавьте строки:

    [global]
    index-url = https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/

    Где:

    • <registry_name> — название реестра в Artifact Registry;

    • <key_id> — логин ключа доступа к приватному реестру;

    • <key_secret> — пароль ключа доступа к приватному реестру.

Настройка через переменные окружения

Выполните команды последовательно:

export PIP_INDEX_URL="https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/"
pip install <package_name>

Где:

  • <registry_name> — название реестра в Artifact Registry;

  • <key_id> — логин ключа доступа к приватному реестру;

  • <key_secret> — пароль ключа доступа к приватному реестру;

  • <package_name> — название запрашиваемого артефакта.

4. Проверьте работу кеширующего реестра

Запросите список артефактов через кеширующий реестр, выполнив запрос:

curl https://<key_id>:<key_secret>@<registry_name>-pypi.ar.cloud.ru/simple/

Где:

  • <registry_name> — название реестра в Artifact Registry;

  • <key_id> — логин ключа доступа к приватному реестру;

  • <key_secret> — пароль ключа доступа к приватному реестру.

Если список загрузился, кеширующий реестр работает.

Результат

Вы научились:

  • создавать кеширующий реестр Artifact Registry;

  • настраивать кеширующий реестр для работы с PyPI-пакетами.