v1.12.2
This commit is contained in:
32
README.md
32
README.md
@@ -1,6 +1,3 @@
|
||||
# Внимание
|
||||
Данная версия предназначена только для версии платформы 4.4.0 build 963!
|
||||
|
||||
# Decort SDK
|
||||
|
||||
Decort SDK - это библиотека, написанная на языке GO, позволяющая взаимодействовать с API облачной платформы **DECORT**. Библиотека содержит в себе структуры и методы, необходимые для отправки запросов. Decort SDK имеет встроенный http-клиент и поддерживает разные способы авторизации на платформе. Библиотека так же содержит в себе модели ответов от платформы.
|
||||
@@ -100,6 +97,7 @@ go get -u repository.basistech.ru/BASIS/decort-golang-sdk
|
||||
|
||||
- `cloudapi` - пользовательская группа, которая позволяет воспользоваться всем стардартным функционалом платформы;
|
||||
- `cloudbroker` - административная группа, которая позволяет воспользоваться всем стандартным функционалом платформы и расширенными возможностями, включающими в себя управление пользователями, ресурсами, платформами размещения ресурсов и т.д.
|
||||
- `sdn` - группа для работы с SDN;
|
||||
|
||||
### Cloudapi
|
||||
|
||||
@@ -122,8 +120,10 @@ go get -u repository.basistech.ru/BASIS/decort-golang-sdk
|
||||
- `Locations` - получение информации о grid площадки;
|
||||
- `Prometheus` - получение статистики prometheus;
|
||||
- `RG` - управление ресурсными группами аккаунта;
|
||||
- `Security group` – управление группами безопасности;
|
||||
- `SEP` - управление storage endpoint (sep);
|
||||
- `Stack` - получение информации о вычислительных узлах;
|
||||
- `Storage policy` – получение информации о политиках хранения;
|
||||
- `Tasks` - получение информации о ходе выполнения асинхронных задач (например, создание кластера);
|
||||
- `Trunk` - получение информации о транковых портах;
|
||||
- `VFPool` - управление пулом виртуальных сетевых функций;
|
||||
@@ -157,8 +157,10 @@ go get -u repository.basistech.ru/BASIS/decort-golang-sdk
|
||||
- `Prometheus` - получение статистики prometheus;
|
||||
- `Resmon` - получение статистики resource monitoring;
|
||||
- `RG` - управление ресурсными группами аккаунта;
|
||||
- `Security group` – управление группами безопасности;
|
||||
- `SEP` - управление storage endpoint (sep);
|
||||
- `Stack` - получение информации о вычислительных узлах;
|
||||
- `Storage policy` – управление политиками хранения;
|
||||
- `Tasks` - получение информации о ходе выполнения асинхронных задач (например, создание кластера);
|
||||
- `Trunk` - управление транковыми портами;
|
||||
- `User` - управление пользователями (индивидуально);
|
||||
@@ -167,6 +169,13 @@ go get -u repository.basistech.ru/BASIS/decort-golang-sdk
|
||||
- `VINS` - управление виртуальными изолированными сетями.
|
||||
- `Zone` - управление зонами.
|
||||
|
||||
### SDN
|
||||
|
||||
`SDN` позволяет выполнять запросы к группе пользовательских конечных точек
|
||||
Данная группа ручек позволяет выполнять следующие операции в платформе:
|
||||
|
||||
- `AccessGroup` - управление группами доступа
|
||||
|
||||
## Работа с библиотекой
|
||||
|
||||
Алгоритм работы с библиотекой выглядит следующим образом:
|
||||
@@ -293,6 +302,7 @@ func main() {
|
||||
|
||||
- `pkg/cloudapi` - для `cloudapi`
|
||||
- `pkg/cloudbroker` - для `cloudbroker`
|
||||
- `pkg/sdn` - для `sdn`
|
||||
|
||||
В каждом пакете находятся пакеты групп API:
|
||||
|
||||
@@ -313,8 +323,10 @@ func main() {
|
||||
- `pkg/cloudapi/locations` - для `Locations`
|
||||
- `pkg/cloudapi/prometheus` - для `Prometheus`
|
||||
- `pkg/cloudapi/rg` - для `RG`
|
||||
- `pkg/cloudapi/security_group` - для `Security group`
|
||||
- `pkg/cloudapi/sep` - для `SEP`
|
||||
- `pkg/cloudapi/stack` - для `Stack`
|
||||
- `pkg/cloudapi/storage_policy` - для `Storage policy`
|
||||
- `pkg/cloudapi/tasks` - для `Tasks`
|
||||
- `pkg/cloudapi/trunk` - для `Trunk`
|
||||
- `pkg/cloudapi/vfpool` - для `VFPool`
|
||||
@@ -343,8 +355,10 @@ func main() {
|
||||
- `pkg/cloudbroker/prometheus` - для `Prometheus`
|
||||
- `pkg/cloudbroker/resmon` - для `Resmon`
|
||||
- `pkg/cloudbroker/rg` - для `RG`
|
||||
- `pkg/cloudbroker/security_group` - для `Security group`
|
||||
- `pkg/cloudbroker/sep` - для `SEP`
|
||||
- `pkg/cloudbroker/stack` - для `Stack`
|
||||
- `pkg/cloudbroker/storage_policy` - для `Storage policy`
|
||||
- `pkg/cloudbroker/tasks` - для `Tasks`
|
||||
- `pkg/cloudbroker/trunk` - для `Trunk`
|
||||
- `pkg/cloudbroker/user` - для `User`
|
||||
@@ -352,6 +366,8 @@ func main() {
|
||||
- `pkg/cloudbroker/vfpool` - для `VFPool`
|
||||
- `pkg/cloudbroker/vins` - для `VINS`
|
||||
- `pkg/cloudbroker/zone` - для `Zone`
|
||||
- **sdn**:
|
||||
- `pkg/sdn/access_groups` - для `AccessGroups`
|
||||
|
||||
Все поля структуры имеют описание, в которых содержится:
|
||||
|
||||
@@ -485,7 +501,7 @@ func main() {
|
||||
|
||||
Чтобы выполнить запрос, необходимо:
|
||||
|
||||
1. Вызвать у клиента метод, отвечаеющий за определение группы API для взаимодействия, это может быть `.CloudAPI()`, либо `.CloudBroker()`. Данные методы возвращаеют соответствующие структуры, с помощью которых можно совершать запросы.
|
||||
1. Вызвать у клиента метод, отвечающий за определение группы API для взаимодействия, это может быть `.CloudAPI()`, `.CloudBroker()` или `.SDN()`. Данные методы возвращают соответствующие структуры, с помощью которых можно совершать запросы.
|
||||
2. Вызвать у возвращенной структуры метод, определяющий группу ручек для взаимодействия.
|
||||
|
||||
Доступные методы для `.CloudAPI()`:
|
||||
@@ -506,8 +522,10 @@ func main() {
|
||||
- `.Locations()` - для работы с `Locations`
|
||||
- `.Prometheus()` - для работы с `Prometheus`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.SecurityGroup()` - для работы с `Security Group`
|
||||
- `.SEP()` - для работы с `SEP`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.StoragePolicy()` - для работы с `Storage Policy`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.Trunk()` - для работы с `Trunk`
|
||||
- `.VFPool()` - для работы с `VFPool`
|
||||
@@ -538,8 +556,10 @@ func main() {
|
||||
- `.Prometheus()` - для работы с `Prometheus`
|
||||
- `.Resmon()` - для работы с `Resmon`
|
||||
- `.RG()` - для работы с `RG`
|
||||
- `.SecurityGroup()` - для работы с `Security Group`
|
||||
- `.SEP()` - для работы с `SEP`
|
||||
- `.Stack()` - для работы с `Stack`
|
||||
- `.StoragePolicy()` - для работы с `Storage Policy`
|
||||
- `.Tasks()` - для работы с `Tasks`
|
||||
- `.Trunk()` - для работы с `Trunk`
|
||||
- `.User()` - для работы с `User`
|
||||
@@ -548,6 +568,10 @@ func main() {
|
||||
- `.VINS()` - для работы с `VINS`
|
||||
- `.Zone()` - для работы с `Zone`
|
||||
|
||||
Доступные методы для `.SDN()`:
|
||||
|
||||
- `.AccessGroup()` - для работы с `AccessGroup`
|
||||
|
||||
3. Вызвать метод, отвечающий за выполнение запроса и передать в него:
|
||||
|
||||
- контекст;
|
||||
|
||||
Reference in New Issue
Block a user