Update component intro
This commit is contained in:
parent
d66b285dbe
commit
5ee5bad12c
1 changed files with 23 additions and 1 deletions
|
@ -1,10 +1,16 @@
|
|||
|
||||
# Работа с фреймворком, обзор основных компонентов
|
||||
|
||||
- [Работа с фреймворком, основные компоненты](#работа-с-фреймворком-основные-компоненты)
|
||||
- [Работа с фреймворком, обзор основных компонентов](#работа-с-фреймворком-обзор-основных-компонентов)
|
||||
- [Модули](#модули)
|
||||
- [Структура базового модуля](#структура-базового-модуля)
|
||||
- [Репозиторий](#репозиторий)
|
||||
- [Образ Docker](#образ-docker)
|
||||
- [DataBox](#databox)
|
||||
- [MLComponent](#mlcomponent)
|
||||
- [ExperimentPipeline](#experimentpipeline)
|
||||
- [APIComponent](#apicomponent)
|
||||
- [Общие элементы компонентов](#общие-элементы-компонентов)
|
||||
|
||||
|
||||
## Модули
|
||||
|
@ -120,3 +126,19 @@
|
|||
Первые три вида APIComponent определяются похожим образом, и с точки зрения разработчика отличаются добавлением соответствующего поля в манифест.
|
||||
|
||||
APIComponent отдельного ExperimentPipeline определяет всю структуру взаимодействия с соответствующим пайплайном через API, то есть входные и выходные переменные, их типы данных и описания.
|
||||
|
||||
## Общие элементы компонентов
|
||||
|
||||
Манифесты компонентов имеют следующую структуру:
|
||||
|
||||
```yaml
|
||||
apiVersion: "unified-platform.cs.hse.ru/v1"
|
||||
kind: <Тип>
|
||||
metadata:
|
||||
name: <Название компонента>
|
||||
namespace: <Название приложения>
|
||||
spec:
|
||||
<Содержимое компонента>
|
||||
```
|
||||
|
||||
Все компоненты в репозитории являются частью одного и того же приложения, поэтому значение поля `metadata.namespace` у всех компонентов в одном репозитории должно совпадать.
|
||||
|
|
Loading…
Reference in a new issue