v1.7.0

2023-11-09 10:27:14 +03:00
parent e6440bc4a3
commit 823dfb49bc
5 changed files with 209 additions and 68 deletions
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ Decort SDK - это библиотека, написанная на языке G
    - Версия 1.4.x Decort-SDK соответствует 3.8.6 версии платформы
    - Версия 1.5.x Decort-SDK соответствует 3.8.7 версии платформы
    - Версия 1.6.x Decort-SDK соответствует 3.8.8 версии платформы
+    - Версия 1.7.х Decort-SDK соответствует 3.8.9 версии платформы

 ## Оглавление

@@ -936,6 +937,7 @@ func main() {
    legacyCfg := config.LegacyConfig{
        Username:  "<USERNAME>",
        Password:  "<PASSWORD>",
+        Domain:    "dynamix",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }
@@ -961,3 +963,176 @@ func main() {

    fmt.Println(res)
 }
+```
+
+## Работа с BVS клиентом
+
+Работа с BVS клиентом применяется для пользователей, которые используют для авторизации BVS.
+
+### Настройка конфигурации BVS клиента
+
+Сначала, необходимо создать переменную конфигурации клиента. Конфигурация состоит как из обязательных, так и необязательных полей.
+
+| Поле          | Тип    | Обязательный | Описание                                                           |
+| ------------- | ------ | ------------ | ------------------------------------------------------------------ |
+| Username      | string | Да           | username legacy пользователя                                       |
+| Password      | string | Да           | пароль legacy пользователя                                         |
+| DecortURL     | string | Да           | URL адрес платформы, с которой будет осуществляться взаимодействие |
+| SSOURL        | string | Да           | URL адрес сервиса аутентификации и авторизации                     |
+| Domain        | string | Да           | Имя домена                                                         |
+| Retries       | uint   | Нет          | Кол-во неудачных попыток выполнения запроса, по умолчанию - 5      |
+| Timeout       | config.Duration | Нет | Таймаут HTTP клиента, по умолчанию - без ограничений               |
+| SSLSkipVerify | bool   | Нет          | Пропуск проверки подлинности сертификата                           |
+
+
+#### Пример конфигурации BVS клиента
+
+```go
+import (
+    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
+)
+
+func main(){
+    // Настройка конфигурации
+    BvsCfg := config.BVSConfig{
+        AppID:     "<APP_ID>",
+        AppSecret: "<APP_SECRET>",
+        Username:  "<USERNAME>",
+        Password:  "<PASSWORD>",
+        SSOURL:    "https://bvs-delta.qa.loc:8443"
+        DecortURL: "https://delta.qa.loc",
+        Domain:    "dynamix"
+        Retries:   5,
+    }
+
+    BvsCfg.SetTimeout(5 * time.Minute)
+}
+```
+
+#### Парсинг BVS конфигурации из файла
+
+Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию `ParseConfigBVSJSON` (или `ParseConfigBVSYAML`) из пакета config.
+<br>
+*См. пример файлов конфигурации ниже и в директории `samples/`.*
+
+```go
+import (
+	"repository.basistech.ru/BASIS/decort-golang-sdk/config"
+)
+
+func main() {
+	// Парсинг конфигурации из YAML-файла
+	BVSCfg := config.ParseConfigBVSYAML("<PATH>")
+}
+```
+
+#### Пример BVS JSON конфигурации
+
+```json
+{
+    "username": "<USERNAME>",
+    "password": "<PASSWORD>",
+    "appId": "<APP_ID>",
+    "appSecret": "<APP_SECRET>",
+    "ssoUrl": "https://bvs-delta.qa.loc:8443",
+    "decortUrl": "https://delta.qa.loc",
+    "domain":    "dynamix",
+    "retries": 5,
+    "timeout": "5m",
+    "sslSkipVerify": false
+}
+```
+
+#### Пример BVS YAML конфигурации
+```yaml
+    username: <USERNAME>
+    password: <PASSWORD>
+    appId: <APP_ID>
+    appSecret: <APP_SECRET>
+    ssoUrl: https://bvs-delta.qa.loc:8443
+    decortUrl: https://delta.qa.loc
+    domain:    dynamix,
+    retries: 5
+    timeout: 5m
+    sslSkipVerify: false
+```
+### Создание BVS клиента
+
+Создание клиента происходит с помощью функции-строителя `NewBVS` из основного пакета `decort-sdk`, для избежания проблем с именами, пакету можно присвоить алиас `decort`. Функция принимает конфигурацию, возвращает структуру `DecortClient`, с помощью которой можно взаимодействовать с платформой.
+
+#### Пример создания BVS клиента
+
+```go
+package main
+
+import (
+    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
+    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
+)
+
+func main() {
+    // Настройка конфигурации
+    BVSCfg := config.BVSConfig{
+        Username:  "<USERNAME>",
+        Password:  "<PASSWORD>",
+        AppID:     "<APPID>",
+        AppSecret: "<APPSECRET>",
+        SSOURL:    "https://bvs-delta.qa.loc:8443"
+        DecortURL: "https://mr4.digitalenergy.online",
+        Domain:    "dynamix",
+        Retries:   5,
+    }
+
+    BVSCfg.SetTimeout(5 * time.Minute)
+
+    // Создание клиента
+    BVSClient := decort.NewBVS(cfg)
+}
+```
+
+#### Пример выполнения запроса
+
+```go
+package main
+
+import (
+	"fmt"
+
+    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
+    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
+)
+
+func main() {
+    // Настройка конфигурации
+    BVSCfg := config.config.BVSConfig{
+        Username:  "<USERNAME>",
+        Password:  "<PASSWORD>",
+        AppID:     "<APPID>",
+        AppSecret: "<APPSECRET>",
+        SSOURL:    "https://bvs-delta.qa.loc:8443"
+        DecortURL: "https://mr4.digitalenergy.online",
+        Domain:    "dynamix",
+        Retries:   5,
+    }
+
+    // Создание клиента
+    BVSClient := decort.NewBVS(cfg)
+    
+    // Создание структуры запроса
+    // CreateRequest - реквест на создание виртуальной машины
+    req := kvmx86.CreateRequest{
+        RGID:    123,
+        Name:    "compute",
+        CPU:     4,
+        RAM:     4096,
+        ImageID: 321,
+    }
+
+    // Выполнение запроса
+    res, err := client.CloudAPI().KVMX86().Create(context.Background(), req)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    fmt.Println(res)
+}