Управление пользователями

Модуль управления пользователями предоставляет платформе EdgeGallery такие функции как регистрация и авторизация пользователей, восстановление пароля, центр учетных записей, управление списками пользователей, верификацию электронной почты и мобильных телефонов.## Определение ролей Модуль управления пользователями определяет модель роли и разрешений пользователя, включая:

• Арендатор Обычные пользователи системы могут создавать проекты/загружать приложения и выполнять другие операции. Данные между арендаторами не могут взаимодействовать друг с другом.
• Администратор Системный администратор может управлять и поддерживать данные приложений системы.
• Гость При прямом доступе к порталу по умолчанию используется разрешение гостя, которое позволяет только просматривать базовые функции каждой платформы, но не позволяет выполнять действия создания, редактирования и удаления.
• Суперадминистратор В системе имеется встроенный по умолчанию пользователь: admin, который является суперадминистратором платформы. Этот пользователь может управлять другими пользователями, управлять всеми зарегистрированными пользователями на платформе, деактивировать/активировать пользователей и устанавливать права доступа пользователей. Для новых зарегистрированных пользователей по умолчанию используются права "арендатор". Привилегия "администратор" может быть получена только суперадминистратором admin через функцию управления списками пользователей путем повышения уровня привилегий для арендатора.## Основные возможности Основные возможности, предоставляемые модулем управления пользователями, можно просмотреть, нажав: Проект управления пользователями: дизайн функциональности

Локальное запуск службы управления пользователями

Управление пользователями предоставляет внешний RESTful интерфейс, разработанное на основе открытого микросервисного фреймворка ServiceComb и интегрированное с фреймворком Spring Boot. Это позволяет компилировать и запускать микросервисы локально, что удобно для локальной отладки пользователей.

Подготовка окружения и конфигурация

1. Подготовка окружения: Инструменты для установки и их адреса скачивания показаны в таблице ниже.

2. Загрузка исходного кода: Используйте git clone или скачайте сжатый пакет для загрузки исходного кода управления пользователями на локальную машину. По умолчанию используется ветка master.Сначала вам потребуется скачать родительский проект pom и скомпилировать его:

git clone https://gitee.com/edgegallery/eg-parent.git
mvn install

Затем загрузите текущий проект управления пользователями:

git clone https://gitee.com/edgegallery/user-mgmt.git

Настройка ServiceCenter: Управление пользователями использует открытую платформу ServiceComb для разработки. При запуске сервис будет автоматически регистрироваться в указанном ServiceCenter, а ServiceCenter предоставляет возможности регистрации и открытия других микросервисов.

Перед запуском управления пользователями необходимо запустить ServiceCenter локально.

• Сначала скачайте ServiceCenter, например, для системы Windows можно выбрать версию [Binary], после завершения загрузки распакуйте;
• Дважды щелкните мышью для запуска файла start-service-center.bat и start-frontend.bat, чтобы запустить ServiceCenter и панель визуализации локально, затем откройте браузер и перейдите по адресу http://127.0.0.1:30103 для просмотра. По умолчанию порт запуска ServiceCenter — это 30100;
• Чтобы запустить сервис управления пользователями локально, вам потребуется добавить следующие переменные окружения для подключения к SC (Service Center):

SC_ADDRESS: Адрес подключения к SC. По умолчанию локальный запущенный SC имеет адрес: http://127.0.0.1:30100
```**4. Настройка базы данных PostgreSQL:** Управление пользователями использует открытую базу данных [PostgreSQL](https://www.postgresql.org/) для хранения информации о пользователях, и при локальной установке PostgreSQL должна быть установлена заранее.- Рекомендуется обратиться к этой статье [Установка и запуск PostgreSQL](https://www.runoob.com/postgresql/windows-install-postgresql.html), рекомендовано выбирать версию 9.6 или выше;
- Используйте файл `/src/main/resources/usermgmtdb`. Для инициализации структуры таблиц базы данных используйте файл `schema.sql`. Для инициализации информации по умолчанию для пользователя используйте файл `/src/main/resources/usermgmtdb-data.sql`.

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

POSTGRES_IP: IP-адрес для подключения к базе данных. Для базы данных, запущенной локально, обычно используется адрес обратной связи: 127.0.0.1 POSTGRES_PORT: Порт для подключения к базе данных. Настраивается автоматически, значение по умолчанию — 5432 POSTGRES_USERNAME: имя пользователя базы данных POSTGRES_PASSWORD: пароль пользователя базы данных

- Рекомендуется ознакомиться с [Установкой и запуском Redis](https://www.runoob.com/redis/redis-install.html);
- Чтобы запустить локально сервис управления пользователями, вам потребуется добавить следующие переменные окружения для подключения к Redis:

REDIS_IP: IP-адрес для подключения к Redis. Для Redis, запущенного локально, обычно используется адрес обратной связи: 127.0.0.1 REDIS_PORT: Порт для подключения к Redis. Устанавливается автоматически, значение по умолчанию — 6379 REDIS_PASSWORD: Пароль для подключения к Redis. Если пароль для Redis не установлен, его можно не указывать

**6. Конфигурация клиента бизнес-платформы:** Сервис управления пользователями выступает в роли сервера аутентификации для единого входа, а каждая бизнес-платформа — в роли клиента аутентификации. Для бизнес-платформ, запускаемых локально, управлению пользователями также требуются соответствующие конфигурационные данные для клиентской части бизнес-платформы.- Если требуется запустить платформу AppStore локально, администрированию пользователям следует настроить следующие переменные окружения:

OAUTH_APPSTORE_CLIENT_ID: ID клиента для бизнес-платформы AppStore, настроен как фиксированное значение appstore-fe. Это поле может быть не указано, значение по умолчанию — appstore-fe. OAUTH_APPSTORE_CLIENT_SECRET: Секрет клиента для бизнес-платформы AppStore, который можно самостоятельно определить, но важно отметить, что секрет клиента, установленный при запуске бизнес-платформы AppStore, должен совпадать с этим значением. OAUTH_APPSTORE_CLIENT_URL: URL для подключения к бизнес-платформе AppStore, например http://x.x.x.x:30091

OAUTH_APPSTORE_CLIENT_ACCESS_URL: Это конфигурация, определяемая для режима прокси-доступа. В обычном режиме доступа она может совпадать с OAUTH_APPSTORE_CLIENT_URL.

- Аналогично, если вы хотите запустить платформы Developer, MECM, ATP и другие локально, обратитесь к вышеописанным инструкциям по конфигурации для добавления соответствующей конфигурации переменной окружения. Для названий переменных окружения, соответствующих каждой платформе, обратитесь к разделу `oauth2.clients` в файле конфигурации `/src/main/resources/application.yaml`.
- ### Копирование ресурсов фронтенда
  Текущий проект представляет собой фоновый проект управления пользователями, и вам потребуется скопировать ресурсы фронтенда в директорию ресурсов фонового проекта.    - Обратитесь к следующей ссылке для компиляции ресурсов фронтенда управления пользователями:
       [https://gitee.com/edgegallery/user-mgmt-fe/blob/master/README.md](https://gitee.com/edgegallery/user-mgmt-fe/blob/master/README.md)
     - После успешной компиляции скопируйте содержимое папки `dist` в директорию `/src/main/resources/static` фонового проекта.
   - ### Запуск локально
     Управление пользователями можно запустить, выполнив основную функцию в файле `/src/main/java/org/edgegallery/user/auth/MainServer.java`.
     После успешного запуска вы можете отдельно получить доступ к интерфейсу управления пользователями:
       http://x.x.x.x:8067/index.html
   ## Развертывание в среде Kubernetes
     Вы также можете сделать сервис управления пользователями как образ Docker и развернуть его для выполнения в среде Linux и кластере Kubernetes.
     Обратитесь к проекту [helm_charts](https://gitee.com/edgegallery/helm-charts/tree/master/edgegallery)