mlops_platform/documentation
7
0
Fork 0
Code Issues 12 Pull requests Projects Releases Packages Wiki Activity

fix: lk-manual

Browse source
This commit is contained in:
Максим Галынчик 2025-05-28 18:41:32 +03:00
parent 44af872e6c
commit b5777c6e08
1 changed files with 28 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
pages/lk-manual.md
View file

@ -3,9 +3,10 @@
Данная инструкция описывает создание приложения через Личный Кабинет Разработчика (далее используется краткая версия `ЛК`): `https://platform.stratpro.hse.ru/cabinet/` Данная инструкция описывает создание приложения через Личный Кабинет Разработчика (далее используется краткая версия `ЛК`): `https://platform.stratpro.hse.ru/cabinet/`
Инструкция охватывает этапы от создания шаблонного приложения в ЛК до развертывания собственного кода. Инструкция охватывает этапы от создания шаблонного приложения в ЛК до развертывания собственного кода.
Инструкция предполагает что все необходимые доступы уже получены: Инструкция предполагает, что все необходимые доступы уже получены:
- аккаунт в KeyCloack: `https://platform-sso.stratpro.hse.ru` - аккаунт в KeyCloack: `https://platform-sso.stratpro.hse.ru`
Проверьте что у Вас есть доступ к ресурсам:
Проверьте, что у вас есть доступ к ресурсам:
- доступ в Forgejo: `https://platform-forgejo.stratpro.hse.ru` - доступ в Forgejo: `https://platform-forgejo.stratpro.hse.ru`
- доступ в Harbor: `https://platform-reg.stratpro.hse.ru` - доступ в Harbor: `https://platform-reg.stratpro.hse.ru`
@ -13,7 +14,7 @@
Оглавление: Оглавление:
- [1. Управление командами](lk-manual.md#1-управление-командами) - [1. Управление командами](lk-manual.md#1-управление-командами)
- [2. Создание приложения](lk-manual.md#2-создание-приложения) - [2. Создание приложения](lk-manual.md#2-создание-приложения)
- [3. Развертывание своего приложение на основе шаблона](lk-manual.md#3-развертывание-своего-приложение-на-основе-шаблона) - [3. Развертывание своего приложения на основе шаблона](lk-manual.md#3-развертывание-своего-приложения-на-основе-шаблона)
## 0. Перейдите в Личный Кабинет ## 0. Перейдите в Личный Кабинет
@ -27,19 +28,19 @@
![alt text](../images/image-2.png) ![alt text](../images/image-2.png)
После перехода Вы увидете страницу управления Вашими командами. После перехода вы увидите страницу управления вашими командами.
![alt text](../images/image-3.png) ![alt text](../images/image-3.png)
Здесь вы можете: Здесь вы можете:
- добавить разработчика в свою команду - добавить разработчика в свою команду
- изменить роль разработчика в Вашей команде - изменить роль разработчика в вашей команде
- удалить разработчика из своей команды - удалить разработчика из своей команды
- создать новую команду - создать новую команду
### 1.1. Добавление разработчика в команду ### 1.1. Добавление разработчика в команду
нажмите на свою команду, вы перейдете на страницу управления командой: Нажмите на свою команду - вы перейдёте на страницу управления командой:
![alt text](../images/image-4.png) ![alt text](../images/image-4.png)
@ -47,27 +48,27 @@
![alt text](../images/image-5.png) ![alt text](../images/image-5.png)
Введите email и роль участника Введите e-mail и роль участника.
### 1.2. Изменить роль разработчика в команде ### 1.2. Изменить роль разработчика в команде
В экране управления командой наведите мышь на разработчика, появится кнопка редактирования: В экране управления командой наведите мышь на разработчика — появится кнопка редактирования:
![alt text](../images/image-7.png) ![alt text](../images/image-7.png)
После нажатие откроется окно редактирования: После нажатия откроется окно редактирования:
![alt text](../images/image-8.png) ![alt text](../images/image-8.png)
### 1.3. Удалить разработчика из команды ### 1.3. Удалить разработчика из команды
В экране управления командой наведите мышь на разработчика, появится кнопка удаления: В экране управления командой наведите мышь на разработчика — появится кнопка удаления:
![alt text](../images/image-9.png) ![alt text](../images/image-9.png)
#### 1.4. Создание команды #### 1.4. Создание команды
В основной панели управления командами нажмите кнопку `Добавить команду` В основной панели управления командами нажмите кнопку `Добавить команду`.
![alt text](../images/image-10.png) ![alt text](../images/image-10.png)
@ -83,7 +84,7 @@
![alt text](../images/image-12.png) ![alt text](../images/image-12.png)
Вы перейдёте на страницу создания приложения. вы перейдёте на страницу создания приложения.
![alt text](../images/image-13.png) ![alt text](../images/image-13.png)
@ -133,18 +134,21 @@
Приложение развернуто! Теперь вы можете проверить, что оно действительно работает, запросив OpenAPI-схему развернутого echo-примера: Приложение развернуто! Теперь вы можете проверить, что оно действительно работает, запросив OpenAPI-схему развернутого echo-примера:
``` ```
https://platform.stratpro.hse.ru/{код приложения}/{код приложения}-hello/modelversion https://platform.stratpro.hse.ru/{код приложения}/{путь к api сервиса}/modelversion
``` ```
- `код приложения` можно увидеть под `Именем приложения` в ЛК или в манифестах из app/ в поле namespace
- `путь к api сервиса` можно найти в манифесте api вашего mlcmp (в шаблонном приложении это файл `mlcmp-api.template.yaml`). В манифесте API `путь к api сервиса` указан в поле `spec/restfulApi/path`.
Для приложения, которое было развернуто в этой инструкции, это: Для приложения, которое было развернуто в этой инструкции, это:
``` ```
https://platform.stratpro.hse.ru/pu-msgalynchik-pa-manual-1/pu-msgalynchik-pa-manual-1-hello/modelversion https://platform.stratpro.hse.ru/pu-msgalynchik-pa-manual-1/pu-msgalynchik-pa-manual-1-hello/modelversion
``` ```
## 3. Развертывание своего приложение на основе шаблона ## 3. Развертывание своего приложения на основе шаблона
> Выполнгяйте только после проверки что предыдущий пункт выполнен успешно и ссылка возвращает OpenAPI схему > выполняйте только после проверки, что предыдущий пункт выполнен успешно и ссылка возвращает OpenAPI-схему.
Склонируйте себе репозиторий приложения. Для примера: Склонируйте себе репозиторий приложения. Для примера:
@ -152,29 +156,28 @@ https://platform.stratpro.hse.ru/pu-msgalynchik-pa-manual-1/pu-msgalynchik-pa-ma
git clone https://platform-forgejo.stratpro.hse.ru/pu-msgalynchik-pa-manual-1/pu-msgalynchik-pa-manual-1-user.git git clone https://platform-forgejo.stratpro.hse.ru/pu-msgalynchik-pa-manual-1/pu-msgalynchik-pa-manual-1-user.git
``` ```
Добавьте свой код. Здесь для примера используется mnist Добавьте свой код. Здесь в качестве примера используется mnist.
![alt text](../images/image-20.png) ![alt text](../images/image-20.png)
Отправьте изменения в Forgejo: Отправьте изменения в репозиторий Forgejo:
```bash ```bash
git add --all git add --all
git commit -m "Add mnist" git commit -m "Add mnist"
git push git push
``` ```
Для того чтобы изменения попали в контейнер приложения необходимо создать тег: Для того, чтобы изменения попали в контейнер приложения, необходимо создать тег:
```bash ```bash
git tag v1.0.1 git tag v1.0.1
git push --tags git push --tags
``` ```
После этого проверьте, что контейнер собрался. Перейдите в Harbor по ссылке из ЛК. В разделе `Projects` нажмите на свой проект. Убедитесь что контейнер с указанным вами тегом появился: После этого проверьте, что контейнер был собран. Перейдите в Harbor по ссылке из ЛК. В разделе `Projects` нажмите на свой проект. Убедитесь, что контейнер с указанным вами тегом появился:
![alt text](../images/image-21.png) ![alt text](../images/image-21.png)
В репозиторие:
Добавьте `mnist-api.yaml` в папку `app/`. Пример для приложения инструкции: Добавьте `mnist-api.yaml` в папку `app/`. Пример для приложения инструкции:
@ -196,7 +199,7 @@ spec:
groups: ["/pu-msgalynchik-pa-manual-1"] groups: ["/pu-msgalynchik-pa-manual-1"]
``` ```
Этот компонент предоставляет API для ващего нового сервиса. Этот компонент предоставляет API для вашего нового сервиса.
Добавьте `mnist-mlcmp.yaml` в папку `app/`. Пример для приложения инструкции: Добавьте `mnist-mlcmp.yaml` в папку `app/`. Пример для приложения инструкции:
@ -239,7 +242,7 @@ spec:
copyS3Box: copyS3Box:
s3BoxName: users s3BoxName: users
``` ```
Этот компонент создате разворачивает контейнер с вашим кодом. Для подробной документации обратитесь к странице [Компонент MLComponent](./pages/mlcmp.md) Этот компонент создаёт и разворачивает контейнер из вашего Docker-образа. Для подробной документации обратитесь к странице [Компонент MLComponent](./pages/mlcmp.md).
Отправьте изменения в Forgejo: Отправьте изменения в Forgejo:
@ -249,4 +252,4 @@ git commit -m "Deploy mnist"
git push git push
``` ```
После этого Платформа развернет Ваше приложение! После этого Платформа развернёт ваше приложение!