Варианты и сценарии использования XFTP#

Варианты использования#

@startuml
left to right direction
actor :Legacy Application: as legacyApp
actor :Customer: as Customer
actor :System Administrator: as admin

package XFTP {
  usecase "1. Configure" as UC1
  usecase "2. Transfer data with S3/FileSystem" as UC2
  usecase "3. Activity Monitor" as UC3
  usecase "4. Authorize with Certificate" as UC4
}

Customer --> (Execute operations)
(Execute operations) --> legacyApp
legacyApp --> UC4
legacyApp --> UC2
admin --> UC1
admin --> UC3
@enduml

Сценарии использования#

Use-Case «1. Configure»#

Администратор инсталляции конфигурирует компонент XFTP:

  • Создание пользователей и назначение идентификаторов сертификатов, используемых для аутентификации пользователей.

  • Указание и назначение для каждого профиля пользователя каталога с СХД, с которым пользователь будет осуществлять работу по протоколу FTP.

Use-Case «2. Transfer data with S3/FileSystem»#

Администратор инсталляции имеет возможность передавать подключающимся пользователям данные посредством размещения данных в каталогах СХД, согласно профилям пользователя.

Use-Case «3. Activity Monitor»#

Администратор инсталляции имеет возможность мониторинга состояния компонента XFTP. Компонент XFTP предоставляет следующие метрики, в формате Prometheus.

Кроме стандартных метрик приложение предоставляет метрики для мониторинга событий компонента XFTP, полный список которых приведен в таблице ниже.

Название метрики

Описание

active-connection

Общее количество активных соединений

total-download-files

Общее попыток загрузки файлов

success-download-files

Удачные попытки загрузки файлов в хранилище

total-upload-files

Общее количество попыток загрузки файлов из хранилища

success-upload-files

Удачные попытки выгрузки файлов из хранилища

total-execution-command

Общее количество поступивших команд

total-success-execution-command

Общее количество успешно выхоленных команд

users-total-download-files

Общее попыток загрузки файлов по пользователям

users-success-download-files

Удачные попытки загрузки файлов в хранилище по пользователям

users-total-upload-files

Общее количество попыток загрузки файлов из хранилища по пользователям

users-success-upload-files

Удачные попытки выгрузки файлов из хранилища по пользователям

users-total-execution-command

Общее количество поступивших команд по пользователям

users-total-success-execution-command

Общее количество успешно выхоленных команд по пользователям

Use-Case «4. Authorize with Certificate»#

В режиме FTPS происходит проверка клиента на соответствие его сертификата и сертификата, указанного для подключения в конфигурации компонента XFTP.

Исключительные и альтернативные сценарии не предусмотрены.