Managed Services for Kubernetes API, gRPC: ClusterService
- Calls ClusterService
- Get
- List
- ListClustersRequest
- ListClustersResponse
- Cluster
- Master
- ZonalMaster
- RegionalMaster
- Location
- MasterEndpoints
- MasterAuth
- VersionInfo
- MasterMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- MasterLogging
- IPAllocationPolicy
- NetworkPolicy
- KMSProvider
- Cilium
- Create
- CreateClusterRequest
- MasterSpec
- ZonalMasterSpec
- InternalAddressSpec
- RegionalMasterSpec
- MasterLocation
- LocationSpec
- ExternalAddressSpec
- MasterMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- MasterLogging
- IPAllocationPolicy
- NetworkPolicy
- KMSProvider
- Cilium
- Operation
- CreateClusterMetadata
- Cluster
- Master
- ZonalMaster
- RegionalMaster
- Location
- MasterEndpoints
- MasterAuth
- VersionInfo
- Update
- UpdateClusterRequest
- MasterUpdateSpec
- UpdateVersionSpec
- MasterMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- MasterLogging
- LocationSpec
- NetworkPolicy
- IPAllocationPolicy
- Operation
- UpdateClusterMetadata
- Cluster
- Master
- ZonalMaster
- RegionalMaster
- Location
- MasterEndpoints
- MasterAuth
- VersionInfo
- KMSProvider
- Cilium
- Delete
- Stop
- StopClusterRequest
- Operation
- StopClusterMetadata
- Cluster
- Master
- ZonalMaster
- RegionalMaster
- Location
- MasterEndpoints
- MasterAuth
- VersionInfo
- MasterMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- MasterLogging
- IPAllocationPolicy
- NetworkPolicy
- KMSProvider
- Cilium
- Start
- StartClusterRequest
- Operation
- StartClusterMetadata
- Cluster
- Master
- ZonalMaster
- RegionalMaster
- Location
- MasterEndpoints
- MasterAuth
- VersionInfo
- MasterMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- MasterLogging
- IPAllocationPolicy
- NetworkPolicy
- KMSProvider
- Cilium
- ListNodeGroups
- ListClusterNodeGroupsRequest
- ListClusterNodeGroupsResponse
- NodeGroup
- NodeTemplate
- NetworkSettings
- ContainerRuntimeSettings
- ContainerNetworkSettings
- ResourcesSpec
- DiskSpec
- NodeAddressSpec
- OneToOneNatSpec
- DnsRecordSpec
- SchedulingPolicy
- NetworkInterfaceSpec
- PlacementPolicy
- GpuSettings
- ScalePolicy
- FixedScale
- AutoScale
- NodeGroupAllocationPolicy
- NodeGroupLocation
- DeployPolicy
- VersionInfo
- NodeGroupMaintenancePolicy
- MaintenanceWindow
- AnytimeMaintenanceWindow
- DailyMaintenanceWindow
- WeeklyMaintenanceWindow
- DaysOfWeekMaintenanceWindow
- Taint
- ListOperations
- ListNodes
A set of methods for managing Kubernetes cluster.
Call | Description |
---|---|
Get | Returns the specified Kubernetes cluster. |
List | Retrieves the list of Kubernetes cluster in the specified folder. |
Create | Creates a Kubernetes cluster in the specified folder. |
Update | Updates the specified Kubernetes cluster. |
Delete | Deletes the specified Kubernetes cluster. |
Stop | Stops the specified Kubernetes cluster. |
Start | Starts the specified Kubernetes cluster. |
ListNodeGroups | Lists nodegroup for the specified Kubernetes cluster. |
ListOperations | Lists operations for the specified Kubernetes cluster. |
ListNodes | Lists cluster's nodes. |
Calls ClusterService
Get
Returns the specified Kubernetes cluster.
To get the list of available Kubernetes cluster, make a List request.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to return. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
List
Retrieves the list of Kubernetes cluster in the specified folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list Kubernetes cluster in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of Kubernetes cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
Create
Creates a Kubernetes cluster in the specified folder.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a Kubernetes cluster in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
name | string Name of the Kubernetes cluster. The name must be unique within the folder. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the Kubernetes cluster. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
network_id | string Required. ID of the network. |
master_spec | MasterSpec Required. Master specification of the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy IP allocation policy of the Kubernetes cluster. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. |
service_account_id | string Required. Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides. |
node_service_account_id | string Required. Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel Release channel for the master.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
network_implementation | oneof: cilium |
cilium | Cilium |
MasterSpec
Field | Description |
---|---|
master_type | oneof: zonal_master_spec or regional_master_spec |
zonal_master_spec | ZonalMasterSpec Specification of the zonal master. |
regional_master_spec | RegionalMasterSpec Specification of the regional master. |
locations[] | LocationSpec Locations specification for Kubernetes control-plane (master) instances. Works in conjunction with etcd_cluster_size . See it's documentation for details. Possible combinations:
|
etcd_cluster_size | int64 Number of etcd nodes in cluster. Works in conjunction with locations . See it's documentation for details. Optional. If not set, will be assumed equal to the number of locations. Value must be equal to 0,1,3. |
external_v4_address_spec | ExternalAddressSpec Specification of parameters for external IPv4 networking. |
external_v6_address_spec | ExternalAddressSpec Specification of parameters for external IPv6 networking. |
version | string Version of Kubernetes components that runs on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMasterSpec
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone. |
internal_v4_address_spec | InternalAddressSpec Specification of parameters for internal IPv4 networking. |
external_v4_address_spec | ExternalAddressSpec Specification of parameters for external IPv4 networking. |
InternalAddressSpec
Field | Description |
---|---|
subnet_id | string ID of the subnet. If no ID is specified, and there only one subnet in specified zone, an address in this subnet will be allocated. |
RegionalMasterSpec
Field | Description |
---|---|
region_id | string Required. ID of the availability zone where the master resides. |
locations[] | MasterLocation List of locations where the master will be allocated. |
external_v4_address_spec | ExternalAddressSpec Specify to allocate a static public IP for the master. |
external_v6_address_spec | ExternalAddressSpec Specification of parameters for external IPv6 networking. |
MasterLocation
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone. |
internal_v4_address_spec | InternalAddressSpec If not specified and there is a single subnet in specified zone, address in this subnet will be allocated. |
LocationSpec
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. If not specified and there is a single subnet in specified zone, address in this subnet will be allocated. |
ExternalAddressSpec
Field | Description |
---|---|
address | string IP address. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Kubernetes cluster that is being created. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
Update
Updates the specified Kubernetes cluster.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to update. To get the Kubernetes cluster ID use a ClusterService.List request. |
update_mask | google.protobuf.FieldMask |
name | string Name of the Kubernetes cluster. The name must be unique within the folder. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the Kubernetes cluster. The maximum string length in characters is 256. |
labels | map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
master_spec | MasterUpdateSpec Specification of the master update. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
network_policy | NetworkPolicy |
ip_allocation_policy | IPAllocationPolicy |
MasterUpdateSpec
Field | Description |
---|---|
version | UpdateVersionSpec Specification of the master update. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
locations[] | LocationSpec Update master instance locations. |
UpdateVersionSpec
Field | Description |
---|---|
specifier | oneof: version or latest_revision |
version | string Request update to a newer version of Kubernetes (1.x -> 1.y). |
latest_revision | bool Request update to the latest revision for the current version. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
LocationSpec
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. If not specified and there is a single subnet in specified zone, address in this subnet will be allocated. |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Kubernetes cluster that is being updated. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
Delete
Deletes the specified Kubernetes cluster.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to delete. To get Kubernetes cluster ID use a ClusterService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Kubernetes cluster that is being deleted. |
Stop
Stops the specified Kubernetes cluster.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to stop. To get Kubernetes cluster ID use a ClusterService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Kubernetes cluster that is being stopped. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
Start
Starts the specified Kubernetes cluster.
rpc Start (StartClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to start. To get Kubernetes cluster ID use a ClusterService.List request. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Kubernetes cluster that is being started. |
Cluster
Field | Description |
---|---|
id | string ID of the Kubernetes cluster. |
folder_id | string ID of the folder that the Kubernetes cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the Kubernetes cluster. |
description | string Description of the Kubernetes cluster. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the Kubernetes cluster.
|
health | enum Health Health of the Kubernetes cluster.
|
network_id | string ID of the network the Kubernetes cluster belongs to. |
master | Master Properties of the master for the Kubernetes cluster. |
ip_allocation_policy | IPAllocationPolicy Allocation policy for IP addresses of services and pods inside the Kubernetes cluster in different availability zones. |
internet_gateway | oneof: gateway_ipv4_address |
gateway_ipv4_address | string Gateway IPv4 address. The maximum string length in characters is 15. |
service_account_id | string Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. |
node_service_account_id | string Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics. |
release_channel | enum ReleaseChannel When creating a Kubernetes cluster, you should specify one of three release channels. The release channel contains several Kubernetes versions. Channels differ in the set of available versions, the management of auto-updates, and the updates received. You can't change the channel once the Kubernetes cluster is created, you can only recreate the Kubernetes cluster and specify a new release channel. For more details see documentation.
|
network_policy | NetworkPolicy |
kms_provider | KMSProvider KMS provider configuration. |
log_group_id | string Log group where cluster stores cluster system logs, like audit, events, or controlplane logs. |
network_implementation | oneof: cilium |
cilium | Cilium |
Master
Field | Description |
---|---|
master_type | oneof: zonal_master or regional_master |
zonal_master | ZonalMaster Parameters of the availability zone for the master. |
regional_master | RegionalMaster Parameters of the region for the master. |
locations[] | Location Locations specification for Kubernetes control-plane (master) instances. |
etcd_cluster_size | int64 Number of etcd nodes in cluster. |
version | string Version of Kubernetes components that runs on the master. |
endpoints | MasterEndpoints Endpoints of the master. Endpoints constitute of scheme and port (i.e. https://ip-address:port ) and can be used by the clients to communicate with the Kubernetes API of the Kubernetes cluster. |
master_auth | MasterAuth Master authentication parameters are used to establish trust between the master and a client. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the master. |
maintenance_policy | MasterMaintenancePolicy Maintenance policy of the master. |
security_group_ids[] | string Master security groups. |
master_logging | MasterLogging Cloud Logging for master components. |
ZonalMaster
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
RegionalMaster
Field | Description |
---|---|
region_id | string ID of the region where the master resides. |
internal_v4_address | string IPv4 internal network address that is assigned to the master. |
external_v4_address | string IPv4 external network address that is assigned to the master. |
external_v6_address | string IPv6 external network address that is assigned to the master. |
Location
Field | Description |
---|---|
zone_id | string ID of the availability zone where the master resides. |
subnet_id | string ID of the VPC network's subnet where the master resides. |
MasterEndpoints
Field | Description |
---|---|
internal_v4_endpoint | string Internal endpoint that can be used to connect to the master from cloud networks. |
external_v4_endpoint | string External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
external_v6_endpoint | string External IPv6 endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud). |
MasterAuth
Field | Description |
---|---|
cluster_ca_certificate | string PEM-encoded public certificate that is the root of trust for the Kubernetes cluster. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
MasterMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
MasterLogging
Field | Description |
---|---|
enabled | bool Identifies whether Cloud Logging is enabled for master components. |
destination | oneof: log_group_id or folder_id The destination of master components' logs. |
log_group_id | string ID of the log group where logs of master components should be stored. Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
folder_id | string ID of the folder where logs should be stored (in default group). Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})? . |
audit_enabled | bool Identifies whether Cloud Logging is enabled for audit logs. |
cluster_autoscaler_enabled | bool Identifies whether Cloud Logging is enabled for cluster-autoscaler. |
kube_apiserver_enabled | bool Identifies whether Cloud Logging is enabled for kube-apiserver. |
events_enabled | bool Identifies whether Cloud Logging is enabled for events. |
IPAllocationPolicy
Field | Description |
---|---|
cluster_ipv4_cidr_block | string CIDR block. IP range for allocating pod addresses. It should not overlap with any subnet in the network the Kubernetes cluster located in. Static routes will be set up for this CIDR blocks in node subnets. |
node_ipv4_cidr_mask_size | int64 Size of the masks that are assigned for each node in the cluster. If not specified, 24 is used. Value must be equal to 0,24,25,26,27,28. |
service_ipv4_cidr_block | string CIDR block. IP range Kubernetes service Kubernetes cluster IP addresses will be allocated from. It should not overlap with any subnet in the network the Kubernetes cluster located in. |
cluster_ipv6_cidr_block | string IPv6 range for allocating pod IP addresses. |
service_ipv6_cidr_block | string IPv6 range for allocating Kubernetes service IP addresses |
NetworkPolicy
Field | Description |
---|---|
provider | enum Provider |
KMSProvider
Field | Description |
---|---|
key_id | string KMS key ID for secrets encryption. To obtain a KMS key ID use a yandex.cloud.kms.v1.SymmetricKeyService.List request. |
Cilium
Field | Description |
---|---|
routing_mode | enum RoutingMode |
ListNodeGroups
Lists nodegroup for the specified Kubernetes cluster.
rpc ListNodeGroups (ListClusterNodeGroupsRequest) returns (ListClusterNodeGroupsResponse)
ListClusterNodeGroupsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to list node groups in. To get the Kubernetes cluster ID use a ClusterService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterNodeGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterNodeGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on Cluster.name field. The maximum string length in characters is 1000. |
ListClusterNodeGroupsResponse
Field | Description |
---|---|
node_groups[] | NodeGroup List of node groups for the specified Kubernetes cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterNodeGroupsRequest.page_size, use the next_page_token as the value for the ListClusterNodeGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
NodeGroup
Field | Description |
---|---|
id | string ID of the node group. |
cluster_id | string ID of the cluster that the node group belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp. |
name | string Name of the node group. The name is unique within the folder. |
description | string Description of the node group. 0-256 characters long. |
labels | map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource. |
status | enum Status Status of the node group.
|
node_template | NodeTemplate Node template that specifies parameters of the compute instances for the node group. |
scale_policy | ScalePolicy Scale policy of the node group. For more information, see Scaling policy. |
allocation_policy | NodeGroupAllocationPolicy Allocation policy by which resources for node group are allocated to zones and regions. |
deploy_policy | DeployPolicy Deploy policy according to which the updates are rolled out. |
instance_group_id | string ID of the managed instance group associated with this node group. |
node_version | string Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version. |
version_info | VersionInfo Detailed information about the Kubernetes version that is running on the node. |
maintenance_policy | NodeGroupMaintenancePolicy Maintenance policy of the node group. |
allowed_unsafe_sysctls[] | string Support for unsafe sysctl parameters. For more details see documentation |
node_taints[] | Taint Taints that are applied to the nodes of the node group at creation time. |
node_labels | map<string,string> Labels that are assigned to the nodes of the node group at creation time. |
NodeTemplate
Field | Description |
---|---|
name | string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128. |
labels | map<string,string> these labels will be assigned to compute nodes (instances), created by the nodegroup No more than 32 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]* . |
platform_id | string ID of the hardware platform configuration for the node. |
resources_spec | ResourcesSpec Computing resources of the node such as the amount of memory and number of cores. |
boot_disk_spec | DiskSpec Specification for the boot disk that will be attached to the node. |
metadata | map<string,string> The metadata as key:value pairs assigned to this instance template. Only SSH keys are supported as metadata. For more information, see Connecting to a node over SSH. No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
v4_address_spec | NodeAddressSpec Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs. |
scheduling_policy | SchedulingPolicy Scheduling policy configuration. |
network_interface_specs[] | NetworkInterfaceSpec New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec' |
placement_policy | PlacementPolicy |
network_settings | NetworkSettings this parameter allows to specify type of network acceleration used on nodes (instances) |
container_runtime_settings | ContainerRuntimeSettings |
container_network_settings | ContainerNetworkSettings |
gpu_settings | GpuSettings GPU settings |
NetworkSettings
Field | Description |
---|---|
type | enum Type Required. |
ContainerRuntimeSettings
Field | Description |
---|---|
type | enum Type Required. |
ContainerNetworkSettings
Field | Description |
---|---|
pod_mtu | int64 |
ResourcesSpec
Field | Description |
---|---|
memory | int64 Amount of memory available to the node, specified in bytes. The minimum value is 0. |
cores | int64 Number of cores available to the node. The minimum value is 0. |
core_fraction | int64 Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Acceptable values are 0 to 100, inclusive. |
gpus | int64 Number of GPUs available to the node. The minimum value is 0. |
DiskSpec
Field | Description |
---|---|
disk_type_id | string ID of the disk type. Value must match the regular expression |network-ssd|network-hdd|network-ssd-nonreplicated|network-ssd-io-m3 . |
disk_size | int64 Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive. |
NodeAddressSpec
Field | Description |
---|---|
one_to_one_nat_spec | OneToOneNatSpec One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up. |
dns_record_specs[] | DnsRecordSpec Internal DNS configuration. |
OneToOneNatSpec
Field | Description |
---|---|
ip_version | enum IpVersion IP version for the public IP address.
|
DnsRecordSpec
Field | Description |
---|---|
fqdn | string Required. FQDN (required). |
dns_zone_id | string DNS zone id (optional, if not set, private zone is used). |
ttl | int64 DNS record ttl, values in 0-86400 (optional). Acceptable values are 0 to 86400, inclusive. |
ptr | bool When set to true, also create PTR DNS record (optional). |
SchedulingPolicy
Field | Description |
---|---|
preemptible | bool True for preemptible compute instances. Default value is false. Preemptible compute instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines. |
NetworkInterfaceSpec
Field | Description |
---|---|
subnet_ids[] | string IDs of the subnets. |
primary_v4_address_spec | NodeAddressSpec Primary IPv4 address that is assigned to the instance for this network interface. |
primary_v6_address_spec | NodeAddressSpec Primary IPv6 address that is assigned to the instance for this network interface. |
security_group_ids[] | string IDs of security groups. |
PlacementPolicy
Field | Description |
---|---|
placement_group_id | string Identifier of placement group |
GpuSettings
Field | Description |
---|---|
gpu_cluster_id | string GPU cluster id, that mk8s node will join. |
gpu_environment | enum GpuEnvironment GPU environment configured on node.
|
ScalePolicy
Field | Description |
---|---|
scale_type | oneof: fixed_scale or auto_scale |
fixed_scale | FixedScale Fixed scale policy of the node group. |
auto_scale | AutoScale Auto scale policy of the node group. |
FixedScale
Field | Description |
---|---|
size | int64 Number of nodes in the node group. Acceptable values are 0 to 100, inclusive. |
AutoScale
Field | Description |
---|---|
min_size | int64 Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive. |
max_size | int64 Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive. |
initial_size | int64 Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive. |
NodeGroupAllocationPolicy
Field | Description |
---|---|
locations[] | NodeGroupLocation List of locations where resources for the node group will be allocated. |
NodeGroupLocation
Field | Description |
---|---|
zone_id | string Required. ID of the availability zone where the nodes may reside. |
subnet_id | string ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted. |
DeployPolicy
Field | Description |
---|---|
max_unavailable | int64 The maximum number of running instances that can be taken offline (i.e., stopped or deleted) at the same time during the update process. If max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
max_expansion | int64 The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive. |
VersionInfo
Field | Description |
---|---|
current_version | string Current Kubernetes version, format: major.minor (e.g. 1.15). |
new_revision_available | bool Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes. |
new_revision_summary | string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false. |
version_deprecated | bool The current version is on the deprecation schedule, component (master or node group) should be upgraded. |
NodeGroupMaintenancePolicy
Field | Description |
---|---|
auto_upgrade | bool If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled. |
auto_repair | bool If set to true, automatic repairs are enabled. Default value is false. |
maintenance_window | MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime , daily_maintenance_window or weekly_maintenance_window Maintenance policy. |
anytime | AnytimeMaintenanceWindow Updating the master at any time. |
daily_maintenance_window | DailyMaintenanceWindow Updating the master on any day during the specified time window. |
weekly_maintenance_window | WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. |
AnytimeMaintenanceWindow
Empty.
DailyMaintenanceWindow
Field | Description |
---|---|
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
WeeklyMaintenanceWindow
Field | Description |
---|---|
days_of_week[] | DaysOfWeekMaintenanceWindow Days of the week and the maintenance window for these days when automatic updates are allowed. The number of elements must be in the range 1-7. |
DaysOfWeekMaintenanceWindow
Field | Description |
---|---|
days[] | google.type.DayOfWeek Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. |
start_time | google.type.TimeOfDay Required. Window start time, in the UTC timezone. |
duration | google.protobuf.Duration Window duration. Acceptable values are 1h to 24h, inclusive. |
Taint
Field | Description |
---|---|
key | string The taint key to be applied to a node. |
value | string The taint value corresponding to the taint key. |
effect | enum Effect The effect of the taint on pods that do not tolerate the taint.
|
ListOperations
Lists operations for the specified Kubernetes cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to list operations for. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. Currently you can use filtering only on Cluster.name field. The maximum string length in characters is 1000. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified Kubernetes cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |
ListNodes
Lists cluster's nodes.
rpc ListNodes (ListClusterNodesRequest) returns (ListClusterNodesResponse)
ListClusterNodesRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Kubernetes cluster to list nodes in. To get the Kubernetes cluster ID use a ClusterService.List request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterNodesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterNodeGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListClusterNodesResponse
Field | Description |
---|---|
nodes[] | Node List of nodes for the specified Kubernetes cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterNodesRequest.page_size, use the next_page_token as the value for the ListClusterNodesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Node
Field | Description |
---|---|
status | enum Status Computed node status.
|
spec | Spec Node specificaion. |
cloud_status | CloudStatus Cloud instance status. Not available in MISSING status. |
kubernetes_status | KubernetesStatus Kubernetes node status. Not available in PROVISIONING and NOT_CONNECTED states. |
KubernetesStatus
Field | Description |
---|---|
id | string Node id (and instance name) |
conditions[] | Condition Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition |
taints[] | Taint If specified, the node's taints. |
attached_volumes[] | AttachedVolume List of volumes that are attached to the node. |
CloudStatus
Field | Description |
---|---|
id | string Compute instance id |
status | string IG instance status |
status_message | string IG instance status message |
Spec
Field | Description |
---|---|
resources | ResourcesSpec Node group specified resources. |
disk | DiskSpec Node group specified disk. |
Condition
Field | Description |
---|---|
type | string Type of node condition. |
status | string Status is the status of the condition. |
message | string Human-readable message indicating details about last transition. |
last_heartbeat_time | google.protobuf.Timestamp Last time we got an update on a given condition. |
last_transition_time | google.protobuf.Timestamp Last time the condition transit from one status to another. |
Taint
Field | Description |
---|---|
key | string The taint key to be applied to a node. |
value | string The taint value corresponding to the taint key. |
effect | enum Effect The effect of the taint on pods that do not tolerate the taint.
|
AttachedVolume
Field | Description |
---|---|
driver_name | string Name of the driver which has attached the volume |
volume_handle | string Volume handle (cloud disk id) |
ResourcesSpec
Field | Description |
---|---|
memory | int64 Amount of memory available to the node, specified in bytes. The minimum value is 0. |
cores | int64 Number of cores available to the node. The minimum value is 0. |
core_fraction | int64 Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Acceptable values are 0 to 100, inclusive. |
gpus | int64 Number of GPUs available to the node. The minimum value is 0. |
DiskSpec
Field | Description |
---|---|
disk_type_id | string ID of the disk type. Value must match the regular expression |network-ssd|network-hdd|network-ssd-nonreplicated|network-ssd-io-m3 . |
disk_size | int64 Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive. |