Официальный репозиторий примеров EdgeX Foundry

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

Примеры, которые работают с последней версией EdgeX, можно найти в разделе «Релизы» (Releases) по ссылке: https://github.com/edgexfoundry/edgex-examples/releases. Перейдите к последнему тегу (x.y).

Цель этого репозитория — предоставить централизованные примеры и образцы кода для пользователей и последователей EdgeX. Папки помогают организовать примеры, чтобы было легче находить образцы, связанные с различными частями EdgeX.

Примеры «Правила»

• TSC будет рассматривать эти примеры с каждым выпуском.
• Проект поддерживает код в этом репозитории (пожалуйста, создайте проблему для любого неработающего кода).
• Пример удаляется, когда он больше не используется, не поддерживается или не синхронизируется с текущим выпуском по решению TSC.
• Для новых папок в этом репозитории требуется одобрение TSC.
• SDK, расположенные в соответствующих репозиториях, также могут содержать небольшую папку с примерами или образцами кода, чтобы показать разработчикам, как использовать SDK или функцию SDK.
  • Примеры SDK включают в себя создание простого сервиса приложения или сервиса устройства.
  • В примерах SDK также может быть руководство по использованию определённых функций (например, как реализовать функцию приложения или как обрабатывать автоматическое / динамическое предоставление ресурсов).
  • Примеры SDK должны оставаться небольшими, чтобы не раздувать сервисы, созданные на основе SDK.
  • Наличие кода в SDK побуждает сопровождающих поддерживать его в актуальном состоянии, что критически важно для внедрения.
  • Цель проекта — в будущем провести автоматизированное тестирование примеров в SDK (что проще сделать, когда код находится в том же репозитории, что и SDK).
• Holding (http://github.com/edgexfoundry-holding) будет преобразован в область «стадии» для кода. Поместите примеры в holding во время проверки.
  • Как и другой код проекта, цель примера кода в holding — получить в конечном итоге одобрение и перейти в этот репозиторий.
• Разработчики и авторы EdgeX должны минимизировать количество примеров в документации и ссылаться на код в этом репо.
• Члены TSC автоматически являются коммиттерами в репозитории.
• Члены TSC могут запросить права коммиттера для другого участника см. процесс утверждения коммиттеров.
  • Требуется одобрение 2 других членов TSC, как и для других репозиториев.
• По мере продвижения проекта примеры будут помечены.
  • Проект обновит этот README, чтобы узнать, как обращаться с примером кода относительно выпусков.
• Код примеров в этом репозитории не тестируется в рамках процесса CI/CD.
  • Примеры тестируются разработчиками, но предоставляются без регулярного (еженощного) тестирования, как в остальной части EdgeX.
• Модули в этих примерах освобождены от проверки третьей стороной согласно https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=46760301.

Организация папок с примерами

• application-services — примеры сервисов приложений для передачи данных в облачные или корпоративные системы.
• analytics — примеры, связанные с механизмом правил или интеграцией или использованием других аналитических пакетов.
• device-services — части сервиса устройств или сервиса. Сервис для устройств, которые обычно не используются в продакшене: — примеры развёртывания и оркестрации с помощью Kubernetes, Swarm и т. д.; — проекты хакатонов EdgeX (могут быть временными, так как их, скорее всего, не будут поддерживать); — прочее: примеры и образцы, которые не относятся к другим папкам. Например, скрипты, make-файлы и т. п.; — платформенные решения: примеры запуска EdgeX или его части на определённых платформах, таких как Raspberry Pi, Arduino; — интеграция продукта: примеры интеграции с другими продуктами, как проприетарными, так и открытыми (например, ObjectBox, Redis Streams, Foghorn и др.), или использования EdgeX совместно с ними.