Конфигурирование PL с помощью Makefile — различия между версиями

Материал из SRNS
Перейти к: навигация, поиск
(С чего начать?)
Строка 22: Строка 22:
 
== С чего начать? ==
 
== С чего начать? ==
  
Прежде всего необходимо получить токен Gitlab API. Для этого заходим на вебморду Gitlab, далее "User Settings(Preferences)" -> "Access Tokens".
+
Прежде всего необходимо получить токен Gitlab API. Для этого заходим на вебморду Gitlab в раздел выдачи токенов, ткнув по ссылке: [https://gitlab.srns.ru:8080/-/profile/personal_access_tokens Access Tokens].
  
 
[[File:2021_09_27_api_token.png|800px]]
 
[[File:2021_09_27_api_token.png|800px]]

Версия 16:08, 27 сентября 2021

Makefile проекта src содержит в себе цель cd_pl, задача которой найти последний успешно собранный bit-файл прошивки ПЛИС для заданной ветки с заданной стратегией сборки и прошить плату.

Содержание

Как это работает?

Gitlab сервер содержит в себе сервис CI/CD, в котором назначены job'ы сборки прошивки ПЛИС при получении нового коммита и/или по расписанию. На сегодняшний день таких job'ов существует два:

  • is_PL_compilable - стратегия сборки прошивки с минимальным количеством модулей ("напопробовать").
  • is_PL_compilable_max - стратегия сборки прошивки с некоторым рабочим количеством модулей ("ничетак")

В результате успешного выполнения job'а формируются артефакты (artifacts), в которых, в частности, лежит bit-файл прошивки ПЛИС.

Получение артефактов возможно при помощи Gitlab API, доступ к которому осуществляется по токену.

Итого, для успешного выполнения задачи проводятся следущие действия:

  1. Получение списка последних job'ов.
  2. Поиск последнего успешного job'а.
  3. Скачивание артефактов.
  4. Распаковка архива и копирование bit-файла на плату.
  5. Прошивка ПЛИС

С чего начать?

Прежде всего необходимо получить токен Gitlab API. Для этого заходим на вебморду Gitlab в раздел выдачи токенов, ткнув по ссылке: Access Tokens.

2021 09 27 api token.png

  1. Даем имя токену и срок его действия.
  2. Нажимаем на кнопку "Создать токен".
  3. Копируем токен куда-нибудь, в вебморде он больше отображаться не будет.
  4. Вставляем токен в personal.conf (токен имеет вид ряда случайных символов, например eB8raLLzs-LqS-qXmRxU)
 GITLAB_TOKEN ?= put_your_Gitlab_token_here

Готово!

Синтаксис

В общем случае:

 make cd_pl BRANCH=<branch_name> PLJOB=<job_name> PLARTIFACTSDIR=<path_to_dest> PLARTIFACTSFILE=<art_filename> PLARTIFACTBITFILEPATH=<archive_path> PLARTIFACTBITFILE=<bitname>

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

PLJOB                 ?= is_PL_compilable_max
BRANCH                ?= develop
PLARTIFACTSDIR        ?= /tmp/develop_artifacts
PLARTIFACTSFILE       ?= artifacts.zip
PLARTIFACTBITFILEPATH ?= qa/built
PLARTIFACTBITFILE     ?= clonicus.bit

Примеры использования

Прошиваться будет тот девайс, который указан в personal.conf!

  • Хочу битник с кучей каналов из девелопа.
 make cd_pl
  • Хочу битник с кучей каналов из ветки test.
 make cd_pl BRANCH=test
  • Хочу битник напопробовать из ветки test.
 make cd_pl BRANCH=test PLJOB=is_PL_compilable

Выводимая информация

При успешном выполнении отобразиться информация о коммите, из которого сварена прошивка, статус копирования на плату и т.п.

2021 09 27 good result.png

Возможные проблемы

  • Работа указанной фичи основана на python-скрипте с стандартным пакетом модулей, проверено на python 3.8, 3.9.
  • Если поднимать древнюю ветку, то возможно не найти job, т.к. в скрипте qa/getartifacts.py список job'ов (всех, в т.ч. не для PL) ограничен последними 5000 job'ами:

2021 09 27 notfound.png

Поправить можно в этом месте (qa/getartifacts.py) увеличив max_pagenum:

2021 09 27 getartifacts limitation.png

  • Некорректный токен:

2021 09 27 token err.png

Персональные инструменты
Пространства имён

Варианты
Действия
SRNS Wiki
Рабочие журналы
Приватный файлсервер
QNAP Сервер
Инструменты