This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
cluster_service.proto
4246 lines (3526 loc) · 159 KB
/
cluster_service.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.container.v1beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/rpc/code.proto";
import "google/rpc/status.proto";
import "google/type/date.proto";
option csharp_namespace = "Google.Cloud.Container.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/container/v1beta1;container";
option java_multiple_files = true;
option java_outer_classname = "ClusterServiceProto";
option java_package = "com.google.container.v1beta1";
option php_namespace = "Google\\Cloud\\Container\\V1beta1";
option ruby_package = "Google::Cloud::Container::V1beta1";
option (google.api.resource_definition) = {
type: "pubsub.googleapis.com/Topic"
pattern: "projects/{project}/topics/{topic}"
};
// Google Kubernetes Engine Cluster Manager v1beta1
service ClusterManager {
option (google.api.default_host) = "container.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Lists all clusters owned by a project in either the specified zone or all
// zones.
rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/clusters"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters"
}
};
option (google.api.method_signature) = "project_id,zone";
}
// Gets the details for a specific cluster.
rpc GetCluster(GetClusterRequest) returns (Cluster) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id";
}
// Creates a cluster, consisting of the specified number and type of Google
// Compute Engine instances.
//
// By default, the cluster is created in the project's
// [default
// network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks).
//
// One firewall is added for the cluster. After cluster creation,
// the Kubelet creates routes for each node to allow the containers
// on that node to communicate with all other instances in the
// cluster.
//
// Finally, an entry is added to the project's global metadata indicating
// which CIDR range the cluster is using.
rpc CreateCluster(CreateClusterRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*}/clusters"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,cluster";
}
// Updates the settings for a specific cluster.
rpc UpdateCluster(UpdateClusterRequest) returns (Operation) {
option (google.api.http) = {
put: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
body: "*"
additional_bindings {
put: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id,update";
}
// Updates the version and/or image type of a specific node pool.
rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation) {
option (google.api.http) = {
put: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/update"
body: "*"
}
};
}
// Sets the autoscaling settings of a specific node pool.
rpc SetNodePoolAutoscaling(SetNodePoolAutoscalingRequest)
returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setAutoscaling"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/autoscaling"
body: "*"
}
};
}
// Sets the logging service for a specific cluster.
rpc SetLoggingService(SetLoggingServiceRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLogging"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/logging"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,logging_service";
}
// Sets the monitoring service for a specific cluster.
rpc SetMonitoringService(SetMonitoringServiceRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMonitoring"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/monitoring"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,monitoring_service";
}
// Sets the addons for a specific cluster.
rpc SetAddonsConfig(SetAddonsConfigRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setAddons"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/addons"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,addons_config";
}
// Sets the locations for a specific cluster.
// Deprecated. Use
// [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)
// instead.
rpc SetLocations(SetLocationsRequest) returns (Operation) {
option deprecated = true;
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLocations"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/locations"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,locations";
}
// Updates the master for a specific cluster.
rpc UpdateMaster(UpdateMasterRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:updateMaster"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/master"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,master_version";
}
// Sets master auth materials. Currently supports changing the admin password
// or a specific cluster, either via password generation or explicitly setting
// the password.
rpc SetMasterAuth(SetMasterAuthRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMasterAuth"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setMasterAuth"
body: "*"
}
};
}
// Deletes the cluster, including the Kubernetes endpoint and all worker
// nodes.
//
// Firewalls and routes that were configured during cluster creation
// are also deleted.
//
// Other Google Compute Engine resources that might be in use by the cluster,
// such as load balancer resources, are not deleted if they weren't present
// when the cluster was initially created.
rpc DeleteCluster(DeleteClusterRequest) returns (Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
additional_bindings {
delete: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id";
}
// Lists all operations in a project in the specified zone or all zones.
rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/operations"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/operations"
}
};
option (google.api.method_signature) = "project_id,zone";
}
// Gets the specified operation.
rpc GetOperation(GetOperationRequest) returns (Operation) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/operations/*}"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/operations/{operation_id}"
}
};
option (google.api.method_signature) = "project_id,zone,operation_id";
}
// Cancels the specified operation.
rpc CancelOperation(CancelOperationRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/operations/*}:cancel"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/operations/{operation_id}:cancel"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,operation_id";
}
// Returns configuration info about the Google Kubernetes Engine service.
rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*}/serverConfig"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/serverconfig"
}
};
option (google.api.method_signature) = "project_id,zone";
}
// Lists the node pools for a cluster.
rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id";
}
// Gets the public component of the cluster signing keys in
// JSON Web Key format.
// This API is not yet intended for general use, and is not available for all
// clusters.
rpc GetJSONWebKeys(GetJSONWebKeysRequest) returns (GetJSONWebKeysResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/jwks"
};
}
// Retrieves the requested node pool.
rpc GetNodePool(GetNodePoolRequest) returns (NodePool) {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
additional_bindings {
get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,node_pool_id";
}
// Creates a node pool for a cluster.
rpc CreateNodePool(CreateNodePoolRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,node_pool";
}
// Deletes a node pool from a cluster.
rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
additional_bindings {
delete: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,node_pool_id";
}
// Rolls back a previously Aborted or Failed NodePool upgrade.
// This makes no changes if the last upgrade successfully completed.
rpc RollbackNodePoolUpgrade(RollbackNodePoolUpgradeRequest)
returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:rollback"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}:rollback"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,node_pool_id";
}
// Sets the NodeManagement options for a node pool.
rpc SetNodePoolManagement(SetNodePoolManagementRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setManagement"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/setManagement"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,node_pool_id,management";
}
// Sets labels on a cluster.
rpc SetLabels(SetLabelsRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setResourceLabels"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/resourceLabels"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,resource_labels,label_fingerprint";
}
// Enables or disables the ABAC authorization mechanism on a cluster.
rpc SetLegacyAbac(SetLegacyAbacRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLegacyAbac"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/legacyAbac"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id,enabled";
}
// Starts master IP rotation.
rpc StartIPRotation(StartIPRotationRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:startIpRotation"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:startIpRotation"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id";
}
// Completes master IP rotation.
rpc CompleteIPRotation(CompleteIPRotationRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:completeIpRotation"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:completeIpRotation"
body: "*"
}
};
option (google.api.method_signature) = "project_id,zone,cluster_id";
}
// SetNodePoolSizeRequest sets the size of a node pool. The new size will be
// used for all replicas, including future replicas created by modifying
// [NodePool.locations][google.container.v1beta1.NodePool.locations].
rpc SetNodePoolSize(SetNodePoolSizeRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setSize"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/setSize"
body: "*"
}
};
}
// Enables or disables Network Policy for a cluster.
rpc SetNetworkPolicy(SetNetworkPolicyRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setNetworkPolicy"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setNetworkPolicy"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,network_policy";
}
// Sets the maintenance policy for a cluster.
rpc SetMaintenancePolicy(SetMaintenancePolicyRequest) returns (Operation) {
option (google.api.http) = {
post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMaintenancePolicy"
body: "*"
additional_bindings {
post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setMaintenancePolicy"
body: "*"
}
};
option (google.api.method_signature) =
"project_id,zone,cluster_id,maintenance_policy";
}
// Lists subnetworks that can be used for creating clusters in a project.
rpc ListUsableSubnetworks(ListUsableSubnetworksRequest)
returns (ListUsableSubnetworksResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*}/aggregated/usableSubnetworks"
};
option (google.api.method_signature) = "parent";
}
// Fetches locations that offer Google Kubernetes Engine.
rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*}/locations"
};
option (google.api.method_signature) = "parent";
}
}
// Parameters that can be configured on Linux nodes.
message LinuxNodeConfig {
// The Linux kernel parameters to be applied to the nodes and all pods running
// on the nodes.
//
// The following parameters are supported.
//
// net.core.netdev_max_backlog
// net.core.rmem_max
// net.core.wmem_default
// net.core.wmem_max
// net.core.optmem_max
// net.core.somaxconn
// net.ipv4.tcp_rmem
// net.ipv4.tcp_wmem
// net.ipv4.tcp_tw_reuse
map<string, string> sysctls = 1;
}
// Node kubelet configs.
message NodeKubeletConfig {
// Control the CPU management policy on the node.
// See
// https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
//
// The following values are allowed.
// * "none": the default, which represents the existing scheduling behavior.
// * "static": allows pods with certain resource characteristics to be granted
// increased CPU affinity and exclusivity on the node.
// The default value is 'none' if unspecified.
string cpu_manager_policy = 1;
// Enable CPU CFS quota enforcement for containers that specify CPU limits.
//
// This option is enabled by default which makes kubelet use CFS quota
// (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
// enforce container CPU limits. Otherwise, CPU limits will not be enforced at
// all.
//
// Disable this option to mitigate CPU throttling problems while still having
// your pods to be in Guaranteed QoS class by specifying the CPU limits.
//
// The default value is 'true' if unspecified.
google.protobuf.BoolValue cpu_cfs_quota = 2;
// Set the CPU CFS quota period value 'cpu.cfs_period_us'.
//
// The string must be a sequence of decimal numbers, each with optional
// fraction and a unit suffix, such as "300ms".
// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
// The value must be a positive duration.
string cpu_cfs_quota_period = 3;
}
// Parameters that describe the nodes in a cluster.
message NodeConfig {
// The name of a Google Compute Engine [machine
// type](https://cloud.google.com/compute/docs/machine-types).
//
// If unspecified, the default machine type is
// `e2-medium`.
string machine_type = 1;
// Size of the disk attached to each node, specified in GB.
// The smallest allowed disk size is 10GB.
//
// If unspecified, the default disk size is 100GB.
int32 disk_size_gb = 2;
// The set of Google API scopes to be made available on all of the
// node VMs under the "default" service account.
//
// The following scopes are recommended, but not required, and by default are
// not included:
//
// * `https://www.googleapis.com/auth/compute` is required for mounting
// persistent storage on your nodes.
// * `https://www.googleapis.com/auth/devstorage.read_only` is required for
// communicating with **gcr.io**
// (the [Google Container
// Registry](https://cloud.google.com/container-registry/)).
//
// If unspecified, no scopes are added, unless Cloud Logging or Cloud
// Monitoring are enabled, in which case their required scopes will be added.
repeated string oauth_scopes = 3;
// The Google Cloud Platform Service Account to be used by the node VMs.
// Specify the email address of the Service Account; otherwise, if no Service
// Account is specified, the "default" service account is used.
string service_account = 9;
// The metadata key/value pairs assigned to instances in the cluster.
//
// Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes
// in length. These are reflected as part of a URL in the metadata server.
// Additionally, to avoid ambiguity, keys must not conflict with any other
// metadata keys for the project or be one of the reserved keys:
// - "cluster-location"
// - "cluster-name"
// - "cluster-uid"
// - "configure-sh"
// - "containerd-configure-sh"
// - "enable-oslogin"
// - "gci-ensure-gke-docker"
// - "gci-metrics-enabled"
// - "gci-update-strategy"
// - "instance-template"
// - "kube-env"
// - "startup-script"
// - "user-data"
// - "disable-address-manager"
// - "windows-startup-script-ps1"
// - "common-psm1"
// - "k8s-node-setup-psm1"
// - "install-ssh-psm1"
// - "user-profile-psm1"
//
// Values are free-form strings, and only have meaning as interpreted by
// the image running in the instance. The only restriction placed on them is
// that each value's size must be less than or equal to 32 KB.
//
// The total size of all keys and values must be less than 512 KB.
map<string, string> metadata = 4;
// The image type to use for this node. Note that for a given image type,
// the latest version of it will be used.
string image_type = 5;
// The map of Kubernetes labels (key/value pairs) to be applied to each node.
// These will added in addition to any default label(s) that
// Kubernetes may apply to the node.
// In case of conflict in label keys, the applied set may differ depending on
// the Kubernetes version -- it's best to assume the behavior is undefined
// and conflicts should be avoided.
// For more information, including usage and the valid values, see:
// https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
map<string, string> labels = 6;
// The number of local SSD disks to be attached to the node.
//
// The limit for this value is dependent upon the maximum number of
// disks available on a machine per zone. See:
// https://cloud.google.com/compute/docs/disks/local-ssd
// for more information.
int32 local_ssd_count = 7;
// The list of instance tags applied to all nodes. Tags are used to identify
// valid sources or targets for network firewalls and are specified by
// the client during cluster or node pool creation. Each tag within the list
// must comply with RFC1035.
repeated string tags = 8;
// Whether the nodes are created as preemptible VM instances. See:
// https://cloud.google.com/compute/docs/instances/preemptible for more
// inforamtion about preemptible VM instances.
bool preemptible = 10;
// A list of hardware accelerators to be attached to each node.
// See https://cloud.google.com/compute/docs/gpus for more information about
// support for GPUs.
repeated AcceleratorConfig accelerators = 11;
// Sandbox configuration for this node.
SandboxConfig sandbox_config = 17;
// Setting this field will assign instances of this
// pool to run on the specified node group. This is useful for running
// workloads on [sole tenant
// nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
string node_group = 18;
// The optional reservation affinity. Setting this field will apply
// the specified [Zonal Compute
// Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
// to this node pool.
ReservationAffinity reservation_affinity = 19;
// Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or
// 'pd-balanced')
//
// If unspecified, the default disk type is 'pd-standard'
string disk_type = 12;
// Minimum CPU platform to be used by this instance. The instance may be
// scheduled on the specified or newer CPU platform. Applicable values are the
// friendly names of CPU platforms, such as
// `minCpuPlatform: "Intel Haswell"` or
// `minCpuPlatform: "Intel Sandy Bridge"`. For more
// information, read [how to specify min CPU
// platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
string min_cpu_platform = 13;
// The workload metadata configuration for this node.
WorkloadMetadataConfig workload_metadata_config = 14;
// List of kubernetes taints to be applied to each node.
//
// For more information, including usage and the valid values, see:
// https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
repeated NodeTaint taints = 15;
//
// The Customer Managed Encryption Key used to encrypt the boot disk attached
// to each node in the node pool. This should be of the form
// projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
// For more information about protecting resources with Cloud KMS Keys please
// see:
// https://cloud.google.com/compute/docs/disks/customer-managed-encryption
string boot_disk_kms_key = 23;
// Shielded Instance options.
ShieldedInstanceConfig shielded_instance_config = 20;
// Parameters that can be configured on Linux nodes.
LinuxNodeConfig linux_node_config = 21;
// Node kubelet configs.
NodeKubeletConfig kubelet_config = 22;
// Parameters for the ephemeral storage filesystem.
// If unspecified, ephemeral storage is backed by the boot disk.
EphemeralStorageConfig ephemeral_storage_config = 24;
// Enable or disable gvnic on the node pool.
VirtualNIC gvnic = 29;
}
// Parameters for node pool-level network config.
message NodeNetworkConfig {
// Input only. Whether to create a new range for pod IPs in this node pool.
// Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they
// are not specified.
//
// If neither `create_pod_range` or `pod_range` are specified, the
// cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is
// used.
//
// Only applicable if `ip_allocation_policy.use_ip_aliases` is true.
//
// This field cannot be changed after the node pool has been created.
bool create_pod_range = 4 [(google.api.field_behavior) = INPUT_ONLY];
// The ID of the secondary range for pod IPs.
// If `create_pod_range` is true, this ID is used for the new range.
// If `create_pod_range` is false, uses an existing secondary range with this
// ID.
//
// Only applicable if `ip_allocation_policy.use_ip_aliases` is true.
//
// This field cannot be changed after the node pool has been created.
string pod_range = 5;
// The IP address range for pod IPs in this node pool.
//
// Only applicable if `create_pod_range` is true.
//
// Set to blank to have a range chosen with the default size.
//
// Set to /netmask (e.g. `/14`) to have a range chosen with a specific
// netmask.
//
// Set to a
// [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
// notation (e.g. `10.96.0.0/14`) to pick a specific range to use.
//
// Only applicable if `ip_allocation_policy.use_ip_aliases` is true.
//
// This field cannot be changed after the node pool has been created.
string pod_ipv4_cidr_block = 6;
}
// A set of Shielded Instance options.
message ShieldedInstanceConfig {
// Defines whether the instance has Secure Boot enabled.
//
// Secure Boot helps ensure that the system only runs authentic software by
// verifying the digital signature of all boot components, and halting the
// boot process if signature verification fails.
bool enable_secure_boot = 1;
// Defines whether the instance has integrity monitoring enabled.
//
// Enables monitoring and attestation of the boot integrity of the instance.
// The attestation is performed against the integrity policy baseline. This
// baseline is initially derived from the implicitly trusted boot image when
// the instance is created.
bool enable_integrity_monitoring = 2;
}
// SandboxConfig contains configurations of the sandbox to use for the node.
message SandboxConfig {
// Possible types of sandboxes.
enum Type {
// Default value. This should not be used.
UNSPECIFIED = 0;
// Run sandbox using gvisor.
GVISOR = 1;
}
// Type of the sandbox to use for the node (e.g. 'gvisor')
string sandbox_type = 1 [deprecated = true];
// Type of the sandbox to use for the node.
Type type = 2;
}
// EphemeralStorageConfig contains configuration for the ephemeral storage
// filesystem.
message EphemeralStorageConfig {
// Number of local SSDs to use to back ephemeral storage. Uses NVMe
// interfaces. Each local SSD is 375 GB in size.
// If zero, it means to disable using local SSDs as ephemeral storage.
int32 local_ssd_count = 1;
}
// [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
// is the configuration of desired reservation which instances could take
// capacity from.
message ReservationAffinity {
// Indicates whether to consume capacity from a reservation or not.
enum Type {
// Default value. This should not be used.
UNSPECIFIED = 0;
// Do not consume from any reserved capacity.
NO_RESERVATION = 1;
// Consume any reservation available.
ANY_RESERVATION = 2;
// Must consume from a specific reservation. Must specify key value fields
// for specifying the reservations.
SPECIFIC_RESERVATION = 3;
}
// Corresponds to the type of reservation consumption.
Type consume_reservation_type = 1;
// Corresponds to the label key of a reservation resource. To target a
// SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
// the key and specify the name of your reservation as its value.
string key = 2;
// Corresponds to the label value(s) of reservation resource(s).
repeated string values = 3;
}
// Kubernetes taint is comprised of three fields: key, value, and effect. Effect
// can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
//
// See
// [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)
// for more information, including usage and the valid values.
message NodeTaint {
// Possible values for Effect in taint.
enum Effect {
// Not set
EFFECT_UNSPECIFIED = 0;
// NoSchedule
NO_SCHEDULE = 1;
// PreferNoSchedule
PREFER_NO_SCHEDULE = 2;
// NoExecute
NO_EXECUTE = 3;
}
// Key for taint.
string key = 1;
// Value for taint.
string value = 2;
// Effect for taint.
Effect effect = 3;
}
// Collection of Kubernetes [node
// taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration).
message NodeTaints {
// List of node taints.
repeated NodeTaint taints = 1;
}
// Collection of node-level [Kubernetes
// labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels).
message NodeLabels {
// Map of node label keys and node label values.
map<string, string> labels = 1;
}
// Collection of Compute Engine network tags that can be applied to a node's
// underlying VM instance. (See `tags` field in
// [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)).
message NetworkTags {
// List of network tags.
repeated string tags = 1;
}
// The authentication information for accessing the master endpoint.
// Authentication can be done using HTTP basic auth or using client
// certificates.
message MasterAuth {
// The username to use for HTTP basic authentication to the master endpoint.
// For clusters v1.6.0 and later, basic authentication can be disabled by
// leaving username unspecified (or setting it to the empty string).
//
// Warning: basic authentication is deprecated, and will be removed in GKE
// control plane versions 1.19 and newer. For a list of recommended
// authentication methods, see:
// https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
string username = 1 [deprecated = true];
// The password to use for HTTP basic authentication to the master endpoint.
// Because the master endpoint is open to the Internet, you should create a
// strong password. If a password is provided for cluster creation, username
// must be non-empty.
//
// Warning: basic authentication is deprecated, and will be removed in GKE
// control plane versions 1.19 and newer. For a list of recommended
// authentication methods, see:
// https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
string password = 2 [deprecated = true];
// Configuration for client certificate authentication on the cluster. For
// clusters before v1.12, if no configuration is specified, a client
// certificate is issued.
ClientCertificateConfig client_certificate_config = 3;
string cluster_ca_certificate = 100;
// [Output only] Base64-encoded public certificate used by clients to
// authenticate to the cluster endpoint.
string client_certificate = 101;
// [Output only] Base64-encoded private key used by clients to authenticate
// to the cluster endpoint.
string client_key = 102;
}
// Configuration for client certificates on the cluster.
message ClientCertificateConfig {
// Issue a client certificate.
bool issue_client_certificate = 1;
}
// Configuration for the addons that can be automatically spun up in the
// cluster, enabling additional functionality.
message AddonsConfig {
// Configuration for the HTTP (L7) load balancing controller addon, which
// makes it easy to set up HTTP load balancers for services in a cluster.
HttpLoadBalancing http_load_balancing = 1;
// Configuration for the horizontal pod autoscaling feature, which
// increases or decreases the number of replica pods a replication controller
// has based on the resource usage of the existing pods.
HorizontalPodAutoscaling horizontal_pod_autoscaling = 2;
// Configuration for the Kubernetes Dashboard.
// This addon is deprecated, and will be disabled in 1.15. It is recommended
// to use the Cloud Console to manage and monitor your Kubernetes clusters,
// workloads and applications. For more information, see:
// https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
KubernetesDashboard kubernetes_dashboard = 3 [deprecated = true];
// Configuration for NetworkPolicy. This only tracks whether the addon
// is enabled or not on the Master, it does not track whether network policy
// is enabled for the nodes.
NetworkPolicyConfig network_policy_config = 4;
// Configuration for Istio, an open platform to connect, manage, and secure
// microservices.
IstioConfig istio_config = 5;
// Configuration for the Cloud Run addon. The `IstioConfig` addon must be
// enabled in order to enable Cloud Run addon. This option can only be enabled
// at cluster creation time.
CloudRunConfig cloud_run_config = 7;
// Configuration for NodeLocalDNS, a dns cache running on cluster nodes
DnsCacheConfig dns_cache_config = 8;
// Configuration for the ConfigConnector add-on, a Kubernetes
// extension to manage hosted GCP services through the Kubernetes API
ConfigConnectorConfig config_connector_config = 10;
// Configuration for the Compute Engine Persistent Disk CSI driver.
GcePersistentDiskCsiDriverConfig gce_persistent_disk_csi_driver_config = 11;
// Configuration for the KALM addon, which manages the lifecycle of k8s
// applications.
KalmConfig kalm_config = 12 [deprecated = true];
}
// Configuration options for the HTTP (L7) load balancing controller addon,
// which makes it easy to set up HTTP load balancers for services in a cluster.
message HttpLoadBalancing {
// Whether the HTTP Load Balancing controller is enabled in the cluster.
// When enabled, it runs a small pod in the cluster that manages the load
// balancers.
bool disabled = 1;
}
// Configuration options for the horizontal pod autoscaling feature, which
// increases or decreases the number of replica pods a replication controller
// has based on the resource usage of the existing pods.
message HorizontalPodAutoscaling {
// Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.