NodeGroupService
- Вызовы NodeGroupService
- Get
- GetNodeGroupRequest
- NodeGroup
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- VersionInfo
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- List
- ListNodeGroupsRequest
- ListNodeGroupsResponse
- NodeGroup
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- VersionInfo
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Create
- CreateNodeGroupRequest
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Operation
- CreateNodeGroupMetadata
- NodeGroup
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- VersionInfo
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Update
- UpdateNodeGroupRequest
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- UpdateVersionSpec
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Operation
- UpdateNodeGroupMetadata
- NodeGroup
- NodeTemplate
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- SchedulingPolicy
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- VersionInfo
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Delete
- ListOperations
Набор методов для управления группами узлов.
Вызов | Описание |
---|---|
Get | Возвращает указанную группу узлов. |
List | Возвращает список групп узлов в указанном кластере Kubernetes. |
Create | Создает группу узлов в указанном кластере Kubernetes. |
Update | Изменяет указанную группу узлов. |
Delete | Удаляет указанную группу узлов. |
ListOperations | Возвращает список операций для указанной группы узлов. |
Вызовы NodeGroupService
Get
Возвращает указанную группу узлов.
Чтобы получить список доступных групп узлов, выполните запрос List.
rpc Get (GetNodeGroupRequest) returns (NodeGroup)
GetNodeGroupRequest
Поле | Описание |
---|---|
node_group_id | string Обязательное поле. Идентификатор возвращаемой группы узлов. Чтобы получить идентификатор группы узлов, используйте запрос NodeGroupService.List. |
NodeGroup
Поле | Описание |
---|---|
id | string Идентификатор группы узлов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа узлов. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Новое имя группы узлов. Имя уникально в рамках каталога. |
description | string Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
status | enum Status Статус группы узлов.
|
node_template | NodeTemplate Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов. |
scale_policy | ScalePolicy Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам. |
instance_group_id | string Идентификатор группы виртуальных машин, связанной с этой группой узлов. |
node_version | string Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version. |
version_info | VersionInfo Подробная информация о версии Kubernetes, которая запущена на мастере. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
VersionInfo
Поле | Описание |
---|---|
current_version | string Текущая версия Kubernetes, формат: major.minor (например, 1.15). |
new_revision_available | bool Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах. |
new_revision_summary | string Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false . |
version_deprecated | bool Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
List
Возвращает список групп узлов в указанном кластере Kubernetes.
rpc List (ListNodeGroupsRequest) returns (ListNodeGroupsResponse)
ListNodeGroupsRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка групп узлов. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListNodeGroupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListNodeGroupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListNodeGroupsResponse
Поле | Описание |
---|---|
node_groups[] | NodeGroup Список групп узлов. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNodeGroupsRequest.page_size, используйте next_page_token в качестве значения параметра ListNodeGroupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
NodeGroup
Поле | Описание |
---|---|
id | string Идентификатор группы узлов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа узлов. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Новое имя группы узлов. Имя уникально в рамках каталога. |
description | string Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
status | enum Status Статус группы узлов.
|
node_template | NodeTemplate Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов. |
scale_policy | ScalePolicy Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам. |
instance_group_id | string Идентификатор группы виртуальных машин, связанной с этой группой узлов. |
node_version | string Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version. |
version_info | VersionInfo Подробная информация о версии Kubernetes, которая запущена на мастере. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
VersionInfo
Поле | Описание |
---|---|
current_version | string Текущая версия Kubernetes, формат: major.minor (например, 1.15). |
new_revision_available | bool Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах. |
new_revision_summary | string Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false . |
version_deprecated | bool Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
Create
Создает группу узлов в указанном кластере Kubernetes.
rpc Create (CreateNodeGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateNodeGroupMetadata
Operation.response:NodeGroup
CreateNodeGroupRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера Kubernetes, в котором следует создать группу узлов. Чтобы получить идентификатор кластера Kubernetes, используйте ClusterService.List запрос. |
name | string Новое имя группы узлов. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Новое описание группы узлов. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
node_template | NodeTemplate Обязательное поле. Шаблон узла для создания группы узлов. |
scale_policy | ScalePolicy Обязательное поле. Политика масштабирования группы узлов. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения группы узлов по зонам и регионам. |
version | string Версия компонентов Kubernetes, которая запущена на узлах. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в документации. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateNodeGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<NodeGroup> в случае успешного выполнения операции. |
CreateNodeGroupMetadata
Поле | Описание |
---|---|
node_group_id | string Идентификатор создаваемой группы узлов. |
NodeGroup
Поле | Описание |
---|---|
id | string Идентификатор группы узлов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа узлов. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Новое имя группы узлов. Имя уникально в рамках каталога. |
description | string Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
status | enum Status Статус группы узлов.
|
node_template | NodeTemplate Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов. |
scale_policy | ScalePolicy Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам. |
instance_group_id | string Идентификатор группы виртуальных машин, связанной с этой группой узлов. |
node_version | string Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version. |
version_info | VersionInfo Подробная информация о версии Kubernetes, которая запущена на мастере. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
VersionInfo
Поле | Описание |
---|---|
current_version | string Текущая версия Kubernetes, формат: major.minor (например, 1.15). |
new_revision_available | bool Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах. |
new_revision_summary | string Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false . |
version_deprecated | bool Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
Update
Изменяет указанную группу узлов.
rpc Update (UpdateNodeGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateNodeGroupMetadata
Operation.response:NodeGroup
UpdateNodeGroupRequest
Поле | Описание |
---|---|
node_group_id | string Обязательное поле. Идентификатор изменяемой группы узлов. Чтобы получить идентификатор группы узлов, используйте запрос NodeGroupService.List. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля группы узлов будут изменены. |
name | string Новое имя группы узлов. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Новое описание группы узлов. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
node_template | NodeTemplate Шаблон узла для создания группы узлов. Изменение может вызвать перезагрузку или повторное создание узлов. |
scale_policy | ScalePolicy Политика масштабирования группы узлов. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения группы узлов по зонам и регионам. |
version | UpdateVersionSpec Версия компонентов Kubernetes, которая запущена на узлах. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в документации. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
UpdateVersionSpec
Поле | Описание |
---|---|
specifier | oneof: version или latest_revision |
version | string Запрос обновления до более новой версии Kubernetes (1.x - > 1.y). |
latest_revision | bool Запрос минорного обновления, содержащего новую функциональность и улучшения, для текущей версии Kubernetes. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateNodeGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<NodeGroup> в случае успешного выполнения операции. |
UpdateNodeGroupMetadata
Поле | Описание |
---|---|
node_group_id | string Обязательное поле. Идентификатор группы узлов, которая изменяется. |
NodeGroup
Поле | Описание |
---|---|
id | string Идентификатор группы узлов. |
cluster_id | string Идентификатор кластера, к которому принадлежит группа узлов. |
created_at | google.protobuf.Timestamp Время создания. |
name | string Новое имя группы узлов. Имя уникально в рамках каталога. |
description | string Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 метки на ресурс. |
status | enum Status Статус группы узлов.
|
node_template | NodeTemplate Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов. |
scale_policy | ScalePolicy Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy. |
allocation_policy | NodeGroupAllocationPolicy Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам. |
instance_group_id | string Идентификатор группы виртуальных машин, связанной с этой группой узлов. |
node_version | string Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version. |
version_info | VersionInfo Подробная информация о версии Kubernetes, которая запущена на мастере. |
maintenance_policy | NodeGroupMaintenancePolicy Политика обновления группы узлов. |
allowed_unsafe_sysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation. |
NodeTemplate
Поле | Описание |
---|---|
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources_spec | ResourcesSpec Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
boot_disk_spec | DiskSpec Спецификация загрузочного диска, который будет подключен к узлу. |
metadata | map<string,string> Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value . Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
scheduling_policy | SchedulingPolicy Политика планирования. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
cores | int64 Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100. |
DiskSpec
Поле | Описание |
---|---|
disk_type_id | string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd . |
disk_size | int64 Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
NodeAddressSpec
Поле | Описание |
---|---|
one_to_one_nat_spec | OneToOneNatSpec Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false . Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines. |
ScalePolicy
Поле | Описание |
---|---|
scale_type | oneof: fixed_scale или auto_scale |
fixed_scale | FixedScale Политика масштабирования группы узлов. |
auto_scale | AutoScale Политика масштабирования группы узлов. |
FixedScale
Поле | Описание |
---|---|
size | int64 Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
AutoScale
Поле | Описание |
---|---|
min_size | int64 Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
max_size | int64 Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
initial_size | int64 Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
NodeGroupAllocationPolicy
Поле | Описание |
---|---|
locations[] | NodeGroupLocation Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
NodeGroupLocation
Поле | Описание |
---|---|
zone_id | string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
subnet_id | string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
VersionInfo
Поле | Описание |
---|---|
current_version | string Текущая версия Kubernetes, формат: major.minor (например, 1.15). |
new_revision_available | bool Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах. |
new_revision_summary | string Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false . |
version_deprecated | bool Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен. |
NodeGroupMaintenancePolicy
Поле | Описание |
---|---|
auto_upgrade | bool Если установлено значение true , автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false , автоматическое обновление отключено. |
auto_repair | bool Если установлено значение true , автоматическое восстановление включено. Значение по умолчанию: false . |
maintenance_window | MaintenanceWindow Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
MaintenanceWindow
Поле | Описание |
---|---|
policy | oneof: anytime , daily_maintenance_window или weekly_maintenance_window Политика обновления. |
anytime | AnytimeMaintenanceWindow Обновление мастера в любое время. |
daily_maintenance_window | DailyMaintenanceWindow Обновление мастера в любой день в течение указанного временного окна. |
weekly_maintenance_window | WeeklyMaintenanceWindow Обновление мастера в выбранные дни в течение указанного временного окна. |
AnytimeMaintenanceWindow
DailyMaintenanceWindow
Поле | Описание |
---|---|
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
WeeklyMaintenanceWindow
Поле | Описание |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
DaysOfWeekMaintenanceWindow
Поле | Описание |
---|---|
days[] | google.type.DayOfWeek Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
start_time | google.type.TimeOfDay Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. |
duration | google.protobuf.Duration Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно. |
Delete
Удаляет указанную группу узлов.
rpc Delete (DeleteNodeGroupRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteNodeGroupMetadata
Operation.response:google.protobuf.Empty
DeleteNodeGroupRequest
Поле | Описание |
---|---|
node_group_id | string Обязательное поле. Идентификатор удаляемой группы узлов. Чтобы получить идентификатор группы узлов, используйте запрос NodeGroupService.List. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteNodeGroupMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteNodeGroupMetadata
Поле | Описание |
---|---|
node_group_id | string Идентификатор группы узлов, которая удаляется. |
ListOperations
Возвращает список операций для указанной группы узлов.
rpc ListOperations (ListNodeGroupOperationsRequest) returns (ListNodeGroupOperationsResponse)
ListNodeGroupOperationsRequest
Поле | Описание |
---|---|
node_group_id | string Обязательное поле. Идентификатор группы узлов, для которой запрашивается список операций. |
page_size | int64 Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size , сервис вернет значение ListNodeGroupOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListNodeGroupOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю NodeGroup.name. Максимальная длина строки в символах — 1000. |
ListNodeGroupOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанной группы узлов. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNodeGroupOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListNodeGroupOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |