decortsdk

package module

v1.4.2 Latest Latest Go to latest Published: May 15, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

README ¶

Decort SDK

Decort SDK - это библиотека, написанная на языке GO, позволяющая взаимодействовать с API облачной платформы DECORT. Библиотека содеражит в себе структуры и методы, необходимые для отправки запросов. Decort SDK имеет встроенный http-клиент и поддерживает разные способы авторизации на платформе. Библиотека так же содержит в себе модели ответов от платформы.

Версии

- Версия 1.0.x Decort-SDK соответствует 3.8.4 версии платформы
- Версия 1.1.x Decort-SDK соответствует 3.8.5 версии платформы
- Версия 1.2.x Decort-SDK соответствует 3.8.5 версии платформы
- Версия 1.3.x Decort-SDK соответствует 3.8.5 версии платформы
- Версия 1.4.x Decort-SDK соответствует 3.8.6 версии платформы

Установка

Выполните команду в терминале:

go get -u repository.basistech.ru/BASIS/decort-golang-sdk

Список API

Библиотека поддерживает две группы API платформы:

cloudapi - пользовательская группа, которая позволяет воспользоваться всем стардартным функционалом платформы;
cloudbroker - административная группа, которая позволяет воспользоваться всем стандартным функционалом платформы и расширенными возможностями, включающими в себя управление пользователями, ресурсами, платформами размещения ресурсов и т.д.

Cloudapi

Cloudapi позволяет выполнять запросы к группе пользовательских конечных точек Данная группа ручек позволяет выполнять следующие операции в платформе:

Account - управление аккаунтами - внутренними учетными записями платформы, которые являются владельцами вычислительных ресурсов;
BService - управление группами виртуальных машин (computes);
Compute - управление виртуальными машинами (индивидуально);
ComputeCI - управление конвейром для создания виртуальных машин;
Disks - управление виртуальными дисками;
ExtNet - управление виртуальными сетями, отвечающими за внешний доступ;
FLIPgroup - управление группами "плавающими" ip - адресами;
Image - управление образами операционных систем;
K8CI - управление конвейром для создания кластера;
K8S - управление кластерами kubernetes;
KVMPPC - создание виртуальной машины Power PC (IBM);
KVMx86 - создание виртуальной машины x86;
LB - управление балансировщиками нагрузки;
Locations - получение информации о grid площадки;
RG - управление ресурсными группами аккаунта;
Sizes - получение информации о потребляемых ресурсах виртуальными машинами и дисками;
Tasks - получение информации о ходе выполнения асинхронных задач (например, создание кластера);
VINS - управление виртуальными изолированными сетями.

Cloudbroker

Cloudbroker позволяет выполнять запросы к группе пользовательских конечных точек Данная группа ручек позволяет выполнять следующие операции в платформе:

Account - управление аккаунтами - внутренними учетными записями платформы, которые являются владельцами вычислительных ресурсов;
Compute - управление виртуальными машинами (индивидуально);
Disks - управление виртуальными дисками;
ExtNet - управление виртуальными сетями, отвечающими за внешний доступ;
Grid - управление площадками;
Image - управление образами операционных систем;
K8CI - управление конвейром для создания кластера;
K8S - управление кластерами kubernetes;
KVMPPC - создание виртуальной машины Power PC (IBM);
KVMx86 - создание виртуальной машины x86;
LB - управление балансировщиками нагрузки;
RG - управление ресурсными группами аккаунта;
SEP - управление storage endpoint (sep);
Tasks - получение информации о ходе выполнения асинхронных задач (например, создание кластера);
VINS - управление виртуальными изолированными сетями.

Работа с библиотекой

Алгоритм работы с библиотекой выглядит следующим образом:

Настройка конфигурации клиента.
Парсинг конфигурации из файла.
Создание клиента.
Создание структуры запроса.
Выполнение запроса.

Настройка конфигурации клиента

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

Поле	Тип	Обязательный	Описание
AppID	string	Да	app_id ключа для выполнения запросов
AppSecret	string	Да	app_secret ключ для выполнения запроса
SSOURL	string	Да	URL адрес сервиса аутентификации и авторизации
DecortURL	string	Да	URL адрес платформы, с которой будет осуществляться взаимодействие
Retries	uint	Нет	Кол-во неудачных попыток выполнения запроса, по умолчанию - 5
SSLSkipVerify	bool	Нет	Пропуск проверки подлинности сертификата, по умолчанию - true
Token	string	Нет	JWT токен

Пример конфигурации клиента

import (
    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
)
func main(){
    // Настройка конфигурации
    cfg := config.Config{
        AppID:     "<APP_ID>",
        AppSecret: "<APP_SECRET>",
        SSOURL:    "https://sso.digitalenergy.online",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }
}

Парсинг конфигурации из файла

Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию ParseConfigJSON (или ParseConfigYAML) из пакета config.
См. пример файлов конфигурации ниже и в директории samples/.

import (
	"repository.basistech.ru/BASIS/decort-golang-sdk/config"
)

func main() {
	// Парсинг конфигурации из JSON-файла
	cfg := config.ParseConfigJSON("<PATH>")
}

Пример JSON конфигурации

{
    "appId": "<APP_ID>",
    "appSecret": "<APP_SECRET>",
    "ssoUrl": "https://sso.digitalenergy.online",
    "decortUrl": "https://mr4.digitalenergy.online",
    "retries": 5,
    "sslSkipVerify": false
}

Пример YAML конфигурации

appId: <APP_ID>
appSecret: <APP_SECRET>
ssoUrl: https://sso.digitalenergy.online
decortUrl: https://mr4.digitalenergy.online
retries: 5
sslSkipVerify: false

Создание клиента

Создание клиента происходит с помощью функции-строителя New из основного пакета decort-sdk, для избежания проблем с именами, пакету можно присвоить алиас decort. Функция принимает конфигурацию, возвращает структуру DecortClient, с помощью которой можно взаимодействовать с платформой.

Пример

package main

import (
    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
)

func main() {
    // Настройка конфигурации
    cfg := config.Config{
        AppID:     "<APPID>",
        AppSecret: "<APPSECRET>",
        SSOURL:    "https://sso.digitalenergy.online",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }

    // Создание клиента
    client := decort.New(cfg)
}

Создание структуры запроса

Структуры запросов определены в пакетах:

pkg/cloudapi - для cloudapi
pkg/cloudbroker - для cloudbroker

В каждом пакете находятся пакеты групп API:

cloudapi:
- pkg/cloudapi/account - для Account
- pkg/cloudapi/bservice - для Basic Service
- pkg/cloudapi/compute - для Compute
- pkg/cloudapi/computeci - для ComputeCI
- pkg/cloudapi/disks - для Disks
- pkg/cloudapi/extnet - для ExtNet
- pkg/cloudapi/flipgroup - для FLIPGroup
- pkg/cloudapi/image - для Image
- pkg/cloudapi/k8ci - для K8CI
- pkg/cloudapi/k8s - для K8S
- pkg/cloudapi/kvmppc - для KVMPPC
- pkg/cloudapi/kvmx86 - для KVMX86
- pkg/cloudapi/lb - для LB
- pkg/cloudapi/locations - для Locations
- pkg/cloudapi/rg - для RG
- pkg/cloudapi/sizes - для RG
- pkg/cloudapi/tasks - для Tasks
- pkg/cloudapi/vins - для VINS
cloudbroker:
- pkg/cloudbroker/account - для Account
- pkg/cloudbroker/compute - для Compute
- pkg/cloudbroker/disks - для Disks
- pkg/cloudbroker/extnet - для ExtNet
- pkg/cloudbroker/grid - для Grid
- pkg/cloudbroker/image - для Image
- pkg/cloudbroker/k8ci - для K8CI
- pkg/cloudbroker/k8s - для K8S
- pkg/cloudbroker/kvmppc - для KVMPPC
- pkg/cloudbroker/kvmx86 - для KVMX86
- pkg/cloudbroker/lb - для LB
- pkg/cloudbroker/rg - для RG
- pkg/cloudbroker/sep - для SEP
- pkg/cloudbroker/tasks - для Tasks
- pkg/cloudbroker/vins - для VINS

Все поля структуры имеют описание, в которых содержится:

Их назначение;
Обязательный или нет - поле required в комментариях;
Доп. информация (допустимые значения, значения по умолчанию).

Пример комментариев структуры

type CreateRequest struct {
	// ID of the resource group, which will own this VM
	// Required: true
	RGID uint64 `url:"rgId" json:"rgId"` 

	// Name of this VM.
	// Must be unique among all VMs (including those in DELETED state) in target resource group
	// Required: true
	Name string `url:"name" json:"name"`

	// Number CPUs to allocate to this VM
	// Required: true
	CPU uint64 `url:"cpu" json:"cpu"`

	// Volume of RAM in MB to allocate to this VM
	// Required: true
	RAM uint64 `url:"ram" json:"ram"`

	// ID of the OS image to base this VM on;
	// Could be boot disk image or CD-ROM image
	// Required: true
	ImageID uint64 `url:"imageId" json:"imageId"`

	// Size of the boot disk in GB
	// Required: false
	BootDisk uint64 `url:"bootDisk,omitempty" json:"bootDisk,omitempty"`

	// ID of SEP to create boot disk on.
	// Uses images SEP ID if not set
	// Required: false
	SEPID uint64 `url:"sepId,omitempty" json:"sepId,omitempty"`

	// Pool to use if SEP ID is set, can be also empty if needed to be chosen by system
	// Required: false
	Pool string `url:"pool,omitempty" json:"pool,omitempty"`

	// Network type
	// Should be one of:
	//	- VINS
	//	- EXTNET
	//	- NONE
	// Required: false
	NetType string `url:"netType,omitempty" json:"netType,omitempty"`

	// Network ID for connect to,
	// for EXTNET - external network ID,
	// for VINS - VINS ID,
	// when network type is not "NONE"
	// Required: false
	NetID uint64 `url:"netId,omitempty" json:"netId,omitempty"`

	// IP address to assign to this VM when connecting to the specified network
	// Required: false
	IPAddr string `url:"ipAddr,omitempty" json:"ipAddr,omitempty"`

	// Input data for cloud-init facility
	// Required: false
	Userdata string `url:"userdata,omitempty" json:"userdata,omitempty"`

	// Text description of this VM
	// Required: false
	Description string `url:"desc,omitempty" json:"desc,omitempty"`

	// Start VM upon success
	// Required: false
	Start bool `url:"start,omitempty" json:"start,omitempty"`

	// Stack ID
	// Required: false
	StackID uint64 `url:"stackId,omitempty" json:"stackId,omitempty"`

	// System name
	// Required: false
	IS string `url:"IS,omitempty" json:"IS,omitempty"`

	// Compute purpose
	// Required: false
	IPAType string `url:"ipaType,omitempty" json:"ipaType,omitempty"`

	// Reason for action
	// Required: false
	Reason string `url:"reason,omitempty" json:"reason,omitempty"`
}

Пример создания запроса для развертывания виртуальной машины:

package main

import (
    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
    "repository.basistech.ru/BASIS/decort-golang-sdk/pkg/cloudapi/kvmx86"
)

func main() {
    // Настройка конфигурации
    cfg := config.Config{
        AppID:     "<APPID>",
        AppSecret: "<APPSECRET>",
        SSOURL:    "https://sso.digitalenergy.online",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }

    // Создание клиента
    client := decort.New(cfg)

    // Создание структуры запроса
    // CreateRequest - реквест на создание виртуальной машины
    req := kvmx86.CreateRequest{
        RGID:    123,
        Name:    "compute",
        CPU:     4,
        RAM:     4096,
        ImageID: 321,
    }
}

Выполнение запроса

Чтобы выполнить запрос, необходимо:

Вызвать у клиента метод, отвечаеющий за определение группы API для взаимодействия, это может быть .CloudAPI(), либо .CloudBroker(). Данные методы возвращаеют соответствующие структуры, с помощью которых можно соверать запросы.
Вызвать у возвращенной структуры метод, определяющий группу ручек для взаимодействия.

Доступные методы для .CloudAPI():
- .Account() - для работы с Account
- .BService() - для работы с BService
- .Compute() - для работы с Compute
- .ComputeCI() - для работы с ComputeCI
- .Disks() - для работы с Disks
- .ExtNet() - для работы с ExtNet
- .FLIPgroup() - для работы с FLIPGroup
- .Image() - для работы с Image
- .K8CI() - для работы с K8CI
- .K8S() - для работы с K8S
- .KVMPPC() - для работы с KVMPPC
- .KVMx86() - для работы с KVMX86
- .LB() - для работы с LB
- .Locations() - для работы с Locations
- .RG() - для работы с RG
- .Sizes() - для работы с Sizes
- .Tasks() - для работы с Tasks
- .VINS() - для работы с VINS
Доступные методы для .CloudBroker():
- .Account() - для работы с Account
- .Compute() - для работы с Compute
- .Disks() - для работы с Disks
- .ExtNet() - для работы с ExtNet
- .Grid() - для работы с Grid
- .Image() - для работы с Image
- .K8CI() - для работы с K8CI
- .K8S() - для работы с K8S
- .KVMPPC() - для работы с KVMPPC
- .KVMx86() - для работы с KVMX86
- .LB() - для работы с LB
- .RG() - для работы с RG
- .SEP() - для работы с SEP
- .Tasks() - для работы с Tasks
- .VINS() - для работы с VINS
Вызвать метод, отвечающий за выполнение запроса и передать в него:

контекст;
структуру запроса. У кождой группы ручек API имеются свои доступные методы, которые определяются платформой.

Обработать результат и ошибки.

Т.к. все вызовы методов идут последовательно, можно их объеденить в конвейер: Общий вид вонвейра будет выглядеть так:

  client.<API>.<группа>.<метод>

Пример выполнения запроса

package main

import (
    "log"
    "fmt"

    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
    "repository.basistech.ru/BASIS/decort-golang-sdk/pkg/cloudapi/kvmx86"
)

func main() {
    // Настройка конфигурации
    cfg := config.Config{
        AppID:     "<APPID>",
        AppSecret: "<APPSECRET>",
        SSOURL:    "https://sso.digitalenergy.online",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }

    // Создание клиента
    client := decort.New(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)
}

Фильтрация

Для каждого ListRequest в SDK есть группа функций для фильтрации ответа платформы. Для того чтобы произвести фильтрацию по заданным полям, достаточно описать анонимную функцию (предикат) в .FilterFunc(), например:

// Создание запроса account/list
req := account.ListRequest{}

resp, err := client.CloudAPI().Account().List(context.Background(), req)
if err != nil {
	log.Fatal(err)
}

// Тип filtered - ListAccount, тот же, что и у ответа платформы.
filtered := resp.
	FilterFunc(func(ia account.ItemAccount) bool {
	// ItemAccount открывает доступ к полям модели ответа платформы.
		for _, itemAcl := range ia.ACL {
			if itemAcl.UgroupID == "<UserGroupID>" { // Фильтр по ACL/UgroupID
				return true
			}
		}
		return false
	})

Для удобства пользователей, особенно важные фильтры вынесены в отдельные функции, что облегчает фильтрацию сразу по нескольким полям:

// Создание запроса account/list
req := account.ListRequest{}

resp, err := client.CloudAPI().Account().List(context.Background(), req)
if err != nil {
	log.Fatal(err)
}

// Несколько фильтров объединены в конвейер
filtered := resp.
	FilterByName("<NAME>").
	FilterByStatus("<STATUS>")
	// ....

Также у compute, disks, и lb присутствуют специфические функции фильтрации, отправляющие дополнительные запросы. В качестве параметров принимают:

context.Context - контекст для доп. запроса
id (или другое поле, по которому производится фильтрация)
interfaces.Caller - DECORT-клиент для запроса

Так как эти функции возвращают не только результирующий слайс, но и возможную ошибку - конвейер придется прервать для обработки ошибки.

Использование на примере `compute.FilterByK8SID`:

func main() {
    // Чтение конфигурации из файла
    cfg := config.ParseConfigJSON("<PATH>")

    // Создание клиента
    client := decort.New(cfg)

    // Создание структуры запроса compute/list
    req := compute.ListRequest{}

    // Запрос
    resp, err := client.CloudAPI().Compute().List(context.Background(), req)
    if err != nil {
        log.Fatal(err)
    }

    // Фильтрация по id кластера.
    // Первый аргумент - контекст
    // Второй - ID кластера
    // Третий - DECORT-клиент
    filtered, err := resp.FilterByK8SID(context.Background(), <k8sID>, client)
    if err != nil {
        log.Fatal(err) // Возможная ошибка запроса
    }

    // Доп. фильтрация и сортировка результата - worker ноды кластера
    workers := filtered.FilterByK8SWorkers().SortByCreatedTime(false)

    // Доп. фильтрация и сортировка результата - master ноды кластера
    masters := filtered.FilterByK8SMasters().SortByCreatedTime(true)

    // ....
}

Сортировка

Функции сортировки так же могут быть объединены в конвейер:

// Создание запроса compute/list
req := compute.ListRequest{}

resp, err := client.CloudAPI().Compute().List(context.Background(), req)
if err != nil {
	log.Fatal(err)
}

// Функции сортировки имеют параметр inverse (bool):
// При значении false -> сортировка по возрастанию
// При true -> сортировка по убыванию
sorted := resp.
	SortByCPU(false).
	SortByRAM(false).
	SortByCreatedTime(true)
	// ....

Сериализация

Результат преобразований легко сериализовать в JSON при помощи функции .Serialize(). Она принимает в себя 2 необязательных аргумента: префикс (prefix) и отступ (Indent).

В случае если функция вызывается без аргументов, то маршализация пройдет успешно, но без отступов и префиксов.

// Сериализация данных с префиксом "" и отступом "\t"
serialized, err := filtered.Serialize("", "\t")
if err != nil {
	log.Fatal(err)
}

// Запись сериализованных данных в файл
err = serialized.WriteToFile("<PATH>")
if err != nil {
	log.Fatal(err)
}

Комплексный пример

package main

import (
	"context"
	"log"

	decort "repository.basistech.ru/BASIS/decort-golang-sdk"
	"repository.basistech.ru/BASIS/decort-golang-sdk/config"
	"repository.basistech.ru/BASIS/decort-golang-sdk/pkg/cloudbroker/compute"
)

func main() {
	cfg := config.Config{
		AppID:         "<APP_ID>",
		AppSecret:     "<APP_SECRET>",
		SSOURL:        "<SSO_URL>",
		DecortURL:     "<DECORT_URL>",
		Retries:       5,
	}
	
	// Создание клиента
	client := decort.New(cfg)

	// Создание запроса compute/list
	req := compute.ListRequest{}

	resp, err := client.CloudBroker().Compute().List(context.Background(), req)
	if err != nil {
		log.Fatal(err)
	}

	// Цепь преобразований.
	filtered, _ := resp.
        FilterFunc(func(ic compute.ItemCompute) bool {
            return ic.GUID == 123 // Фильтр по GUID
        }).
        FilterByName("<NAME>"). // Фильтр по имени
        SortByCPU(false). // Сортировка по кол-ву ядер CPU по возрастанию
        SortByCreatedTime(true). // Сортировка по времени создания по убыванию
        Serialize("", "\t") // Сериализация с префиксом "" и отступом "\t"
        // Serialize - терминальная функция, возвращает Serialized (обертку над []byte)

	// Запись данных в файл
    err = filtered.WriteToFile("<PATH>")
	if err != nil {
		log.Fatal(err)
	}
}

Работа с legacy клиентом

Работа с legacy клиентом применяется для пользователей, которые не используют для авторизации decs3o.

Настройка конфигурации legacy клиента

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

Поле	Тип	Обязательный	Описание
Username	string	Да	username legacy пользователя
Password	string	Да	пароль legacy пользователя
DecortURL	string	Да	URL адрес платформы, с которой будет осуществляться взаимодействие
Retries	uint	Нет	Кол-во неудачных попыток выполнения запроса, по умолчанию - 5
SSLSkipVerify	bool	Нет	Пропуск проверки подлинности сертификата, по умолчанию - true
Token	string	Нет	JWT токен

Пример конфигурации legacy клиента

import (
    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
)

func main(){
    // Настройка конфигурации
    legacyCfg := config.LegacyConfig{
        Username:  "<USERNAME>",
        Password:  "<PASSWORD>",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }
}

Парсинг legacy конфигурации из файла

Также возможно создать переменную конфигурации из JSON или YAML файла, используя функцию ParseLegacyConfigJSON (или ParseLegacyConfigYAML) из пакета config.
См. пример файлов конфигурации ниже и в директории samples/.

import (
	"repository.basistech.ru/BASIS/decort-golang-sdk/config"
)

func main() {
	// Парсинг конфигурации из YAML-файла
	legacyCfg := config.ParseLegacyConfigYAML("<PATH>")
}

Пример legacy JSON конфигурации

{
    "username": "<USERNAME>",
    "password": "<PASSWORD>",
    "decortUrl": "https://mr4.digitalenergy.online",
    "retries": 5,
    "sslSkipVerify": true
}

Пример legacy YAML конфигурации

username: <USERNAME>
password: <PASSWORD>
decortUrl: https://mr4.digitalenergy.online
retries: 5
sslSkipVerify: true

Создание legacy клиента

Создание клиента происходит с помощью функции-строителя NewLegacy из основного пакета decort-sdk, для избежания проблем с именами, пакету можно присвоить алиас decort. Функция принимает конфигурацию, возвращает структуру DecortClient, с помощью которой можно взаимодействовать с платформой.

Пример создания legacy клиента

package main

import (
    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
)

func main() {
    // Настройка конфигурации
    legacyCfg := config.LegacyConfig{
        Username:  "<USERNAME>",
        Password:  "<PASSWORD>",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }

    // Создание клиента
    legacyClient := decort.NewLegacy(cfg)
}

Пример выполнения запроса

package main

import (
	"fmt"

    "repository.basistech.ru/BASIS/decort-golang-sdk/config"
    decort "repository.basistech.ru/BASIS/decort-golang-sdk"
)

func main() {
    // Настройка конфигурации
    legacyCfg := config.LegacyConfig{
        Username:  "<USERNAME>",
        Password:  "<PASSWORD>",
        DecortURL: "https://mr4.digitalenergy.online",
        Retries:   5,
    }

    // Создание клиента
    legacyClient := decort.NewLegacy(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)
}

Documentation ¶

Index ¶

type DecortClient
- func New(cfg config.Config) *DecortClient
type LegacyDecortClient
- func NewLegacy(cfg config.LegacyConfig) *LegacyDecortClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DecortClient ¶

type DecortClient struct {
	// contains filtered or unexported fields
}

HTTP-client for platform

func New ¶

func New(cfg config.Config) *DecortClient

Сlient builder

func (*DecortClient) CloudAPI ¶

func (dc *DecortClient) CloudAPI() *cloudapi.CloudAPI

CloudAPI builder

func (*DecortClient) CloudBroker ¶

func (dc *DecortClient) CloudBroker() *cloudbroker.CloudBroker

CloudBroker builder

func (*DecortClient) DecortApiCall ¶

func (dc *DecortClient) DecortApiCall(ctx context.Context, method, url string, params interface{}) ([]byte, error)

DecortApiCall method for sending requests to the platform

type LegacyDecortClient ¶

type LegacyDecortClient struct {
	// contains filtered or unexported fields
}

Legacy HTTP-client for platform

func NewLegacy ¶

func NewLegacy(cfg config.LegacyConfig) *LegacyDecortClient

Legacy client builder

func (*LegacyDecortClient) CloudAPI ¶

func (ldc *LegacyDecortClient) CloudAPI() *cloudapi.CloudAPI

CloudAPI builder

func (*LegacyDecortClient) CloudBroker ¶

func (ldc *LegacyDecortClient) CloudBroker() *cloudbroker.CloudBroker

CloudBroker builder

func (*LegacyDecortClient) DecortApiCall ¶

func (ldc *LegacyDecortClient) DecortApiCall(ctx context.Context, method, url string, params interface{}) ([]byte, error)

DecortApiCall method for sending requests to the platform

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
config
interfaces
internal
client
serialization
validators
pkg
cloudapi List of method groups for the user	List of method groups for the user
cloudapi/account API Actor API for managing account	API Actor API for managing account
cloudapi/bservice API Actor for managing Compute Group.	API Actor for managing Compute Group.
cloudapi/compute API Actor for managing Compute.	API Actor for managing Compute.
cloudapi/computeci API Actor for managing ComputeCI.	API Actor for managing ComputeCI.
cloudapi/disks API Actor api, this actor is the final api a enduser uses to manage his resources	API Actor api, this actor is the final api a enduser uses to manage his resources
cloudapi/extnet API Actor for use external networks	API Actor for use external networks
cloudapi/flipgroup API to manage FLIPGroup instances	API to manage FLIPGroup instances
cloudapi/image Lists all the images.	Lists all the images.
cloudapi/k8ci API to manage K8CI instances	API to manage K8CI instances
cloudapi/k8s API for Kubernetes clusters management	API for Kubernetes clusters management
cloudapi/kvmppc API to manage KVM PowerPC compute instances (PPC VMs)	API to manage KVM PowerPC compute instances (PPC VMs)
cloudapi/kvmx86 API to manage KVM x86 compute instances (x86 VMs)	API to manage KVM x86 compute instances (x86 VMs)
cloudapi/lb API to manage load balancer instance	API to manage load balancer instance
cloudapi/locations API Actor api for managing locations	API Actor api for managing locations
cloudapi/rg API Actors for managing resource groups.	API Actors for managing resource groups.
cloudapi/sizes Lists all the configured flavors available.	Lists all the configured flavors available.
cloudapi/tasks User API tasks interface	User API tasks interface
cloudapi/vins API Actor for managing VINS.	API Actor for managing VINS.
cloudbroker List of method groups for the admin	List of method groups for the admin
cloudbroker/account API Actor API for managing account	API Actor API for managing account
cloudbroker/compute API Actor for managing Compute.	API Actor for managing Compute.
cloudbroker/disks API Actor for managing Disk.	API Actor for managing Disk.
cloudbroker/extnet API Actor for configure and use external networks	API Actor for configure and use external networks
cloudbroker/grid Operator actions for handling interventions on a grid	Operator actions for handling interventions on a grid
cloudbroker/image Lists all the images.	Lists all the images.
cloudbroker/k8ci API to manage K8CI instances	API to manage K8CI instances
cloudbroker/k8s API for kubernetes clusters management	API for kubernetes clusters management
cloudbroker/kvmppc API to manage KVM PowerPC compute instances (PPC VMs)	API to manage KVM PowerPC compute instances (PPC VMs)
cloudbroker/kvmx86 API to manage KVM x86 compute instances (x86 VMs)	API to manage KVM x86 compute instances (x86 VMs)
cloudbroker/lb API to manage load balancer instance	API to manage load balancer instance
cloudbroker/pcidevice
cloudbroker/rg API Actors for managing resource groups.	API Actors for managing resource groups.
cloudbroker/sep Operator actions for handling interventions on a storage endpoint provider	Operator actions for handling interventions on a storage endpoint provider
cloudbroker/tasks User API tasks interface	User API tasks interface
cloudbroker/vgpu
cloudbroker/vins API Actor for managing VINS.	API Actor for managing VINS.

README ¶

Decort SDK

Версии

Оглавление

Установка

Список API

Cloudapi

Cloudbroker

Работа с библиотекой

Настройка конфигурации клиента

Пример конфигурации клиента

Парсинг конфигурации из файла

Пример JSON конфигурации

Пример YAML конфигурации

Создание клиента

Пример

Создание структуры запроса

Пример комментариев структуры

Пример создания запроса для развертывания виртуальной машины:

Выполнение запроса

Пример выполнения запроса

Фильтрация

Использование на примере compute.FilterByK8SID:

Сортировка

Сериализация

Комплексный пример

Работа с legacy клиентом

Настройка конфигурации legacy клиента

Пример конфигурации legacy клиента

Парсинг legacy конфигурации из файла

Пример legacy JSON конфигурации

Пример legacy YAML конфигурации

Создание legacy клиента

Пример создания legacy клиента

Пример выполнения запроса

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type DecortClient ¶

func New ¶

func (*DecortClient) CloudAPI ¶

func (*DecortClient) CloudBroker ¶

func (*DecortClient) DecortApiCall ¶

type LegacyDecortClient ¶

func NewLegacy ¶

func (*LegacyDecortClient) CloudAPI ¶

func (*LegacyDecortClient) CloudBroker ¶

func (*LegacyDecortClient) DecortApiCall ¶

Source Files ¶

Directories ¶

Использование на примере `compute.FilterByK8SID`: