diff --git a/07.1-Resource-функция-decort_resgroup:-управление-ресурсными-группами..md b/07.1-Resource-функция-decort_resgroup:-управление-ресурсными-группами..md index aa330ae..197776b 100644 --- a/07.1-Resource-функция-decort_resgroup:-управление-ресурсными-группами..md +++ b/07.1-Resource-функция-decort_resgroup:-управление-ресурсными-группами..md @@ -3,16 +3,16 @@ _Resource_ функция **decort_resgroup** служит для управле ## Аргументы _Resource_ функция **decort_resgroup** принимает следующие аргументы: -| Аргумент | Тип | Описание | -| --- | --- | --- | -| account_id | int | Обязательный параметр, не равен 0.
Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. | +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. | | name | string | Обязательный параметр.
Имя ресурсной группы. Должно быть уникальным в рамках одного и того же подписчика ("account"), не может быть пустым. | -| def_net_type | string | Опциональный параметр.
Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`
* "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.
* "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | -| description | string | Опциональный параметр.
Текстовое описание данной ресурсной группы.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | -| ext_ip | string | Опциональный параметр.
IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.
Если заданный `ext_ip` уже используется, платформа вернёт ошибку. | -| ext_net_id | int | Опциональный параметр.
Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. | -| ipcidr | string | Опциональный параметр.
Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`
Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. | -| quota | dict | Опциональный параметр.
Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу.
Данный параметр не является обязательным, значение по умолчанию - отсутствие лимитов на потребление ресурсов. | +| def_net_type | string | :x: | Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`
* "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.
* "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| description | string | :x: | Текстовое описание данной ресурсной группы.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | +| ext_ip | string | :x: | IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.
Если заданный `ext_ip` уже используется, платформа вернёт ошибку. | +| ext_net_id | int | :x: | Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. | +| ipcidr | string | :x: | Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`
Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. | +| quota | dict | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу.
Данный параметр не является обязательным, значение по умолчанию - отсутствие лимитов на потребление ресурсов. | Для создания ресурсной группы пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа.