cluster_service.proto 148 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084
  1. // Copyright 2021 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.container.v1beta1;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. import "google/protobuf/empty.proto";
  21. import "google/protobuf/timestamp.proto";
  22. import "google/protobuf/wrappers.proto";
  23. import "google/rpc/code.proto";
  24. import "google/rpc/status.proto";
  25. option csharp_namespace = "Google.Cloud.Container.V1Beta1";
  26. option go_package = "google.golang.org/genproto/googleapis/container/v1beta1;container";
  27. option java_multiple_files = true;
  28. option java_outer_classname = "ClusterServiceProto";
  29. option java_package = "com.google.container.v1beta1";
  30. option php_namespace = "Google\\Cloud\\Container\\V1beta1";
  31. option ruby_package = "Google::Cloud::Container::V1beta1";
  32. option (google.api.resource_definition) = {
  33. type: "pubsub.googleapis.com/Topic"
  34. pattern: "projects/{project}/topics/{topic}"
  35. };
  36. // Google Kubernetes Engine Cluster Manager v1beta1
  37. service ClusterManager {
  38. option (google.api.default_host) = "container.googleapis.com";
  39. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
  40. // Lists all clusters owned by a project in either the specified zone or all
  41. // zones.
  42. rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
  43. option (google.api.http) = {
  44. get: "/v1beta1/{parent=projects/*/locations/*}/clusters"
  45. additional_bindings {
  46. get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters"
  47. }
  48. };
  49. option (google.api.method_signature) = "project_id,zone";
  50. }
  51. // Gets the details for a specific cluster.
  52. rpc GetCluster(GetClusterRequest) returns (Cluster) {
  53. option (google.api.http) = {
  54. get: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
  55. additional_bindings {
  56. get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
  57. }
  58. };
  59. option (google.api.method_signature) = "project_id,zone,cluster_id";
  60. }
  61. // Creates a cluster, consisting of the specified number and type of Google
  62. // Compute Engine instances.
  63. //
  64. // By default, the cluster is created in the project's
  65. // [default
  66. // network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks).
  67. //
  68. // One firewall is added for the cluster. After cluster creation,
  69. // the Kubelet creates routes for each node to allow the containers
  70. // on that node to communicate with all other instances in the
  71. // cluster.
  72. //
  73. // Finally, an entry is added to the project's global metadata indicating
  74. // which CIDR range the cluster is using.
  75. rpc CreateCluster(CreateClusterRequest) returns (Operation) {
  76. option (google.api.http) = {
  77. post: "/v1beta1/{parent=projects/*/locations/*}/clusters"
  78. body: "*"
  79. additional_bindings {
  80. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters"
  81. body: "*"
  82. }
  83. };
  84. option (google.api.method_signature) = "project_id,zone,cluster";
  85. }
  86. // Updates the settings for a specific cluster.
  87. rpc UpdateCluster(UpdateClusterRequest) returns (Operation) {
  88. option (google.api.http) = {
  89. put: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
  90. body: "*"
  91. additional_bindings {
  92. put: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
  93. body: "*"
  94. }
  95. };
  96. option (google.api.method_signature) = "project_id,zone,cluster_id,update";
  97. }
  98. // Updates the version and/or image type of a specific node pool.
  99. rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation) {
  100. option (google.api.http) = {
  101. put: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
  102. body: "*"
  103. additional_bindings {
  104. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/update"
  105. body: "*"
  106. }
  107. };
  108. }
  109. // Sets the autoscaling settings of a specific node pool.
  110. rpc SetNodePoolAutoscaling(SetNodePoolAutoscalingRequest) returns (Operation) {
  111. option (google.api.http) = {
  112. post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setAutoscaling"
  113. body: "*"
  114. additional_bindings {
  115. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/autoscaling"
  116. body: "*"
  117. }
  118. };
  119. }
  120. // Sets the logging service for a specific cluster.
  121. rpc SetLoggingService(SetLoggingServiceRequest) returns (Operation) {
  122. option (google.api.http) = {
  123. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLogging"
  124. body: "*"
  125. additional_bindings {
  126. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/logging"
  127. body: "*"
  128. }
  129. };
  130. option (google.api.method_signature) = "project_id,zone,cluster_id,logging_service";
  131. }
  132. // Sets the monitoring service for a specific cluster.
  133. rpc SetMonitoringService(SetMonitoringServiceRequest) returns (Operation) {
  134. option (google.api.http) = {
  135. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMonitoring"
  136. body: "*"
  137. additional_bindings {
  138. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/monitoring"
  139. body: "*"
  140. }
  141. };
  142. option (google.api.method_signature) = "project_id,zone,cluster_id,monitoring_service";
  143. }
  144. // Sets the addons for a specific cluster.
  145. rpc SetAddonsConfig(SetAddonsConfigRequest) returns (Operation) {
  146. option (google.api.http) = {
  147. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setAddons"
  148. body: "*"
  149. additional_bindings {
  150. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/addons"
  151. body: "*"
  152. }
  153. };
  154. option (google.api.method_signature) = "project_id,zone,cluster_id,addons_config";
  155. }
  156. // Sets the locations for a specific cluster.
  157. // Deprecated. Use
  158. // [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update)
  159. // instead.
  160. rpc SetLocations(SetLocationsRequest) returns (Operation) {
  161. option deprecated = true;
  162. option (google.api.http) = {
  163. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLocations"
  164. body: "*"
  165. additional_bindings {
  166. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/locations"
  167. body: "*"
  168. }
  169. };
  170. option (google.api.method_signature) = "project_id,zone,cluster_id,locations";
  171. }
  172. // Updates the master for a specific cluster.
  173. rpc UpdateMaster(UpdateMasterRequest) returns (Operation) {
  174. option (google.api.http) = {
  175. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:updateMaster"
  176. body: "*"
  177. additional_bindings {
  178. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/master"
  179. body: "*"
  180. }
  181. };
  182. option (google.api.method_signature) = "project_id,zone,cluster_id,master_version";
  183. }
  184. // Sets master auth materials. Currently supports changing the admin password
  185. // or a specific cluster, either via password generation or explicitly setting
  186. // the password.
  187. rpc SetMasterAuth(SetMasterAuthRequest) returns (Operation) {
  188. option (google.api.http) = {
  189. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMasterAuth"
  190. body: "*"
  191. additional_bindings {
  192. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setMasterAuth"
  193. body: "*"
  194. }
  195. };
  196. }
  197. // Deletes the cluster, including the Kubernetes endpoint and all worker
  198. // nodes.
  199. //
  200. // Firewalls and routes that were configured during cluster creation
  201. // are also deleted.
  202. //
  203. // Other Google Compute Engine resources that might be in use by the cluster,
  204. // such as load balancer resources, are not deleted if they weren't present
  205. // when the cluster was initially created.
  206. rpc DeleteCluster(DeleteClusterRequest) returns (Operation) {
  207. option (google.api.http) = {
  208. delete: "/v1beta1/{name=projects/*/locations/*/clusters/*}"
  209. additional_bindings {
  210. delete: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}"
  211. }
  212. };
  213. option (google.api.method_signature) = "project_id,zone,cluster_id";
  214. }
  215. // Lists all operations in a project in the specified zone or all zones.
  216. rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) {
  217. option (google.api.http) = {
  218. get: "/v1beta1/{parent=projects/*/locations/*}/operations"
  219. additional_bindings {
  220. get: "/v1beta1/projects/{project_id}/zones/{zone}/operations"
  221. }
  222. };
  223. option (google.api.method_signature) = "project_id,zone";
  224. }
  225. // Gets the specified operation.
  226. rpc GetOperation(GetOperationRequest) returns (Operation) {
  227. option (google.api.http) = {
  228. get: "/v1beta1/{name=projects/*/locations/*/operations/*}"
  229. additional_bindings {
  230. get: "/v1beta1/projects/{project_id}/zones/{zone}/operations/{operation_id}"
  231. }
  232. };
  233. option (google.api.method_signature) = "project_id,zone,operation_id";
  234. }
  235. // Cancels the specified operation.
  236. rpc CancelOperation(CancelOperationRequest) returns (google.protobuf.Empty) {
  237. option (google.api.http) = {
  238. post: "/v1beta1/{name=projects/*/locations/*/operations/*}:cancel"
  239. body: "*"
  240. additional_bindings {
  241. post: "/v1beta1/projects/{project_id}/zones/{zone}/operations/{operation_id}:cancel"
  242. body: "*"
  243. }
  244. };
  245. option (google.api.method_signature) = "project_id,zone,operation_id";
  246. }
  247. // Returns configuration info about the Google Kubernetes Engine service.
  248. rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig) {
  249. option (google.api.http) = {
  250. get: "/v1beta1/{name=projects/*/locations/*}/serverConfig"
  251. additional_bindings {
  252. get: "/v1beta1/projects/{project_id}/zones/{zone}/serverconfig"
  253. }
  254. };
  255. option (google.api.method_signature) = "project_id,zone";
  256. }
  257. // Lists the node pools for a cluster.
  258. rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse) {
  259. option (google.api.http) = {
  260. get: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools"
  261. additional_bindings {
  262. get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools"
  263. }
  264. };
  265. option (google.api.method_signature) = "project_id,zone,cluster_id";
  266. }
  267. // Gets the public component of the cluster signing keys in
  268. // JSON Web Key format.
  269. // This API is not yet intended for general use, and is not available for all
  270. // clusters.
  271. rpc GetJSONWebKeys(GetJSONWebKeysRequest) returns (GetJSONWebKeysResponse) {
  272. option (google.api.http) = {
  273. get: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/jwks"
  274. };
  275. }
  276. // Retrieves the requested node pool.
  277. rpc GetNodePool(GetNodePoolRequest) returns (NodePool) {
  278. option (google.api.http) = {
  279. get: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
  280. additional_bindings {
  281. get: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}"
  282. }
  283. };
  284. option (google.api.method_signature) = "project_id,zone,cluster_id,node_pool_id";
  285. }
  286. // Creates a node pool for a cluster.
  287. rpc CreateNodePool(CreateNodePoolRequest) returns (Operation) {
  288. option (google.api.http) = {
  289. post: "/v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools"
  290. body: "*"
  291. additional_bindings {
  292. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools"
  293. body: "*"
  294. }
  295. };
  296. option (google.api.method_signature) = "project_id,zone,cluster_id,node_pool";
  297. }
  298. // Deletes a node pool from a cluster.
  299. rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation) {
  300. option (google.api.http) = {
  301. delete: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}"
  302. additional_bindings {
  303. delete: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}"
  304. }
  305. };
  306. option (google.api.method_signature) = "project_id,zone,cluster_id,node_pool_id";
  307. }
  308. // Rolls back a previously Aborted or Failed NodePool upgrade.
  309. // This makes no changes if the last upgrade successfully completed.
  310. rpc RollbackNodePoolUpgrade(RollbackNodePoolUpgradeRequest) returns (Operation) {
  311. option (google.api.http) = {
  312. post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:rollback"
  313. body: "*"
  314. additional_bindings {
  315. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}:rollback"
  316. body: "*"
  317. }
  318. };
  319. option (google.api.method_signature) = "project_id,zone,cluster_id,node_pool_id";
  320. }
  321. // Sets the NodeManagement options for a node pool.
  322. rpc SetNodePoolManagement(SetNodePoolManagementRequest) returns (Operation) {
  323. option (google.api.http) = {
  324. post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setManagement"
  325. body: "*"
  326. additional_bindings {
  327. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/setManagement"
  328. body: "*"
  329. }
  330. };
  331. option (google.api.method_signature) = "project_id,zone,cluster_id,node_pool_id,management";
  332. }
  333. // Sets labels on a cluster.
  334. rpc SetLabels(SetLabelsRequest) returns (Operation) {
  335. option (google.api.http) = {
  336. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setResourceLabels"
  337. body: "*"
  338. additional_bindings {
  339. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/resourceLabels"
  340. body: "*"
  341. }
  342. };
  343. option (google.api.method_signature) = "project_id,zone,cluster_id,resource_labels,label_fingerprint";
  344. }
  345. // Enables or disables the ABAC authorization mechanism on a cluster.
  346. rpc SetLegacyAbac(SetLegacyAbacRequest) returns (Operation) {
  347. option (google.api.http) = {
  348. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setLegacyAbac"
  349. body: "*"
  350. additional_bindings {
  351. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/legacyAbac"
  352. body: "*"
  353. }
  354. };
  355. option (google.api.method_signature) = "project_id,zone,cluster_id,enabled";
  356. }
  357. // Starts master IP rotation.
  358. rpc StartIPRotation(StartIPRotationRequest) returns (Operation) {
  359. option (google.api.http) = {
  360. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:startIpRotation"
  361. body: "*"
  362. additional_bindings {
  363. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:startIpRotation"
  364. body: "*"
  365. }
  366. };
  367. option (google.api.method_signature) = "project_id,zone,cluster_id";
  368. }
  369. // Completes master IP rotation.
  370. rpc CompleteIPRotation(CompleteIPRotationRequest) returns (Operation) {
  371. option (google.api.http) = {
  372. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:completeIpRotation"
  373. body: "*"
  374. additional_bindings {
  375. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:completeIpRotation"
  376. body: "*"
  377. }
  378. };
  379. option (google.api.method_signature) = "project_id,zone,cluster_id";
  380. }
  381. // Sets the size for a specific node pool.
  382. rpc SetNodePoolSize(SetNodePoolSizeRequest) returns (Operation) {
  383. option (google.api.http) = {
  384. post: "/v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setSize"
  385. body: "*"
  386. additional_bindings {
  387. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}/nodePools/{node_pool_id}/setSize"
  388. body: "*"
  389. }
  390. };
  391. }
  392. // Enables or disables Network Policy for a cluster.
  393. rpc SetNetworkPolicy(SetNetworkPolicyRequest) returns (Operation) {
  394. option (google.api.http) = {
  395. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setNetworkPolicy"
  396. body: "*"
  397. additional_bindings {
  398. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setNetworkPolicy"
  399. body: "*"
  400. }
  401. };
  402. option (google.api.method_signature) = "project_id,zone,cluster_id,network_policy";
  403. }
  404. // Sets the maintenance policy for a cluster.
  405. rpc SetMaintenancePolicy(SetMaintenancePolicyRequest) returns (Operation) {
  406. option (google.api.http) = {
  407. post: "/v1beta1/{name=projects/*/locations/*/clusters/*}:setMaintenancePolicy"
  408. body: "*"
  409. additional_bindings {
  410. post: "/v1beta1/projects/{project_id}/zones/{zone}/clusters/{cluster_id}:setMaintenancePolicy"
  411. body: "*"
  412. }
  413. };
  414. option (google.api.method_signature) = "project_id,zone,cluster_id,maintenance_policy";
  415. }
  416. // Lists subnetworks that can be used for creating clusters in a project.
  417. rpc ListUsableSubnetworks(ListUsableSubnetworksRequest) returns (ListUsableSubnetworksResponse) {
  418. option (google.api.http) = {
  419. get: "/v1beta1/{parent=projects/*}/aggregated/usableSubnetworks"
  420. };
  421. option (google.api.method_signature) = "parent";
  422. }
  423. // Fetches locations that offer Google Kubernetes Engine.
  424. rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse) {
  425. option (google.api.http) = {
  426. get: "/v1beta1/{parent=projects/*}/locations"
  427. };
  428. option (google.api.method_signature) = "parent";
  429. }
  430. }
  431. // Parameters that can be configured on Linux nodes.
  432. message LinuxNodeConfig {
  433. // The Linux kernel parameters to be applied to the nodes and all pods running
  434. // on the nodes.
  435. //
  436. // The following parameters are supported.
  437. //
  438. // net.core.netdev_max_backlog
  439. // net.core.rmem_max
  440. // net.core.wmem_default
  441. // net.core.wmem_max
  442. // net.core.optmem_max
  443. // net.core.somaxconn
  444. // net.ipv4.tcp_rmem
  445. // net.ipv4.tcp_wmem
  446. // net.ipv4.tcp_tw_reuse
  447. map<string, string> sysctls = 1;
  448. }
  449. // Node kubelet configs.
  450. message NodeKubeletConfig {
  451. // Control the CPU management policy on the node.
  452. // See
  453. // https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/
  454. //
  455. // The following values are allowed.
  456. // - "none": the default, which represents the existing scheduling behavior.
  457. // - "static": allows pods with certain resource characteristics to be
  458. // granted increased CPU affinity and exclusivity on the node.
  459. // The default value is 'none' if unspecified.
  460. string cpu_manager_policy = 1;
  461. // Enable CPU CFS quota enforcement for containers that specify CPU limits.
  462. //
  463. // This option is enabled by default which makes kubelet use CFS quota
  464. // (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to
  465. // enforce container CPU limits. Otherwise, CPU limits will not be enforced at
  466. // all.
  467. //
  468. // Disable this option to mitigate CPU throttling problems while still having
  469. // your pods to be in Guaranteed QoS class by specifying the CPU limits.
  470. //
  471. // The default value is 'true' if unspecified.
  472. google.protobuf.BoolValue cpu_cfs_quota = 2;
  473. // Set the CPU CFS quota period value 'cpu.cfs_period_us'.
  474. //
  475. // The string must be a sequence of decimal numbers, each with optional
  476. // fraction and a unit suffix, such as "300ms".
  477. // Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
  478. // The value must be a positive duration.
  479. string cpu_cfs_quota_period = 3;
  480. }
  481. // Parameters that describe the nodes in a cluster.
  482. message NodeConfig {
  483. // The name of a Google Compute Engine [machine
  484. // type](https://cloud.google.com/compute/docs/machine-types).
  485. //
  486. // If unspecified, the default machine type is
  487. // `e2-medium`.
  488. string machine_type = 1;
  489. // Size of the disk attached to each node, specified in GB.
  490. // The smallest allowed disk size is 10GB.
  491. //
  492. // If unspecified, the default disk size is 100GB.
  493. int32 disk_size_gb = 2;
  494. // The set of Google API scopes to be made available on all of the
  495. // node VMs under the "default" service account.
  496. //
  497. // The following scopes are recommended, but not required, and by default are
  498. // not included:
  499. //
  500. // * `https://www.googleapis.com/auth/compute` is required for mounting
  501. // persistent storage on your nodes.
  502. // * `https://www.googleapis.com/auth/devstorage.read_only` is required for
  503. // communicating with **gcr.io**
  504. // (the [Google Container
  505. // Registry](https://cloud.google.com/container-registry/)).
  506. //
  507. // If unspecified, no scopes are added, unless Cloud Logging or Cloud
  508. // Monitoring are enabled, in which case their required scopes will be added.
  509. repeated string oauth_scopes = 3;
  510. // The Google Cloud Platform Service Account to be used by the node VMs.
  511. // Specify the email address of the Service Account; otherwise, if no Service
  512. // Account is specified, the "default" service account is used.
  513. string service_account = 9;
  514. // The metadata key/value pairs assigned to instances in the cluster.
  515. //
  516. // Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes
  517. // in length. These are reflected as part of a URL in the metadata server.
  518. // Additionally, to avoid ambiguity, keys must not conflict with any other
  519. // metadata keys for the project or be one of the reserved keys:
  520. // - "cluster-location"
  521. // - "cluster-name"
  522. // - "cluster-uid"
  523. // - "configure-sh"
  524. // - "containerd-configure-sh"
  525. // - "enable-oslogin"
  526. // - "gci-ensure-gke-docker"
  527. // - "gci-metrics-enabled"
  528. // - "gci-update-strategy"
  529. // - "instance-template"
  530. // - "kube-env"
  531. // - "startup-script"
  532. // - "user-data"
  533. // - "disable-address-manager"
  534. // - "windows-startup-script-ps1"
  535. // - "common-psm1"
  536. // - "k8s-node-setup-psm1"
  537. // - "install-ssh-psm1"
  538. // - "user-profile-psm1"
  539. //
  540. // The following keys are reserved for Windows nodes:
  541. // - "serial-port-logging-enable"
  542. //
  543. // Values are free-form strings, and only have meaning as interpreted by
  544. // the image running in the instance. The only restriction placed on them is
  545. // that each value's size must be less than or equal to 32 KB.
  546. //
  547. // The total size of all keys and values must be less than 512 KB.
  548. map<string, string> metadata = 4;
  549. // The image type to use for this node. Note that for a given image type,
  550. // the latest version of it will be used.
  551. string image_type = 5;
  552. // The map of Kubernetes labels (key/value pairs) to be applied to each node.
  553. // These will added in addition to any default label(s) that
  554. // Kubernetes may apply to the node.
  555. // In case of conflict in label keys, the applied set may differ depending on
  556. // the Kubernetes version -- it's best to assume the behavior is undefined
  557. // and conflicts should be avoided.
  558. // For more information, including usage and the valid values, see:
  559. // https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
  560. map<string, string> labels = 6;
  561. // The number of local SSD disks to be attached to the node.
  562. //
  563. // The limit for this value is dependent upon the maximum number of
  564. // disks available on a machine per zone. See:
  565. // https://cloud.google.com/compute/docs/disks/local-ssd
  566. // for more information.
  567. int32 local_ssd_count = 7;
  568. // The list of instance tags applied to all nodes. Tags are used to identify
  569. // valid sources or targets for network firewalls and are specified by
  570. // the client during cluster or node pool creation. Each tag within the list
  571. // must comply with RFC1035.
  572. repeated string tags = 8;
  573. // Whether the nodes are created as preemptible VM instances. See:
  574. // https://cloud.google.com/compute/docs/instances/preemptible for more
  575. // inforamtion about preemptible VM instances.
  576. bool preemptible = 10;
  577. // A list of hardware accelerators to be attached to each node.
  578. // See https://cloud.google.com/compute/docs/gpus for more information about
  579. // support for GPUs.
  580. repeated AcceleratorConfig accelerators = 11;
  581. // Sandbox configuration for this node.
  582. SandboxConfig sandbox_config = 17;
  583. // Setting this field will assign instances of this
  584. // pool to run on the specified node group. This is useful for running
  585. // workloads on [sole tenant
  586. // nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
  587. string node_group = 18;
  588. // The optional reservation affinity. Setting this field will apply
  589. // the specified [Zonal Compute
  590. // Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
  591. // to this node pool.
  592. ReservationAffinity reservation_affinity = 19;
  593. // Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or
  594. // 'pd-balanced')
  595. //
  596. // If unspecified, the default disk type is 'pd-standard'
  597. string disk_type = 12;
  598. // Minimum CPU platform to be used by this instance. The instance may be
  599. // scheduled on the specified or newer CPU platform. Applicable values are the
  600. // friendly names of CPU platforms, such as
  601. // `minCpuPlatform: "Intel Haswell"` or
  602. // `minCpuPlatform: "Intel Sandy Bridge"`. For more
  603. // information, read [how to specify min CPU
  604. // platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
  605. string min_cpu_platform = 13;
  606. // The workload metadata configuration for this node.
  607. WorkloadMetadataConfig workload_metadata_config = 14;
  608. // List of kubernetes taints to be applied to each node.
  609. //
  610. // For more information, including usage and the valid values, see:
  611. // https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
  612. repeated NodeTaint taints = 15;
  613. //
  614. // The Customer Managed Encryption Key used to encrypt the boot disk attached
  615. // to each node in the node pool. This should be of the form
  616. // projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
  617. // For more information about protecting resources with Cloud KMS Keys please
  618. // see:
  619. // https://cloud.google.com/compute/docs/disks/customer-managed-encryption
  620. string boot_disk_kms_key = 23;
  621. // Shielded Instance options.
  622. ShieldedInstanceConfig shielded_instance_config = 20;
  623. // Parameters that can be configured on Linux nodes.
  624. LinuxNodeConfig linux_node_config = 21;
  625. // Node kubelet configs.
  626. NodeKubeletConfig kubelet_config = 22;
  627. // Parameters for the ephemeral storage filesystem.
  628. // If unspecified, ephemeral storage is backed by the boot disk.
  629. EphemeralStorageConfig ephemeral_storage_config = 24;
  630. }
  631. // A set of Shielded Instance options.
  632. message ShieldedInstanceConfig {
  633. // Defines whether the instance has Secure Boot enabled.
  634. //
  635. // Secure Boot helps ensure that the system only runs authentic software by
  636. // verifying the digital signature of all boot components, and halting the
  637. // boot process if signature verification fails.
  638. bool enable_secure_boot = 1;
  639. // Defines whether the instance has integrity monitoring enabled.
  640. //
  641. // Enables monitoring and attestation of the boot integrity of the instance.
  642. // The attestation is performed against the integrity policy baseline. This
  643. // baseline is initially derived from the implicitly trusted boot image when
  644. // the instance is created.
  645. bool enable_integrity_monitoring = 2;
  646. }
  647. // SandboxConfig contains configurations of the sandbox to use for the node.
  648. message SandboxConfig {
  649. // Possible types of sandboxes.
  650. enum Type {
  651. // Default value. This should not be used.
  652. UNSPECIFIED = 0;
  653. // Run sandbox using gvisor.
  654. GVISOR = 1;
  655. }
  656. // Type of the sandbox to use for the node (e.g. 'gvisor')
  657. string sandbox_type = 1 [deprecated = true];
  658. // Type of the sandbox to use for the node.
  659. Type type = 2;
  660. }
  661. // EphemeralStorageConfig contains configuration for the ephemeral storage
  662. // filesystem.
  663. message EphemeralStorageConfig {
  664. // Number of local SSDs to use to back ephemeral storage. Uses NVMe
  665. // interfaces. Each local SSD is 375 GB in size.
  666. // If zero, it means to disable using local SSDs as ephemeral storage.
  667. int32 local_ssd_count = 1;
  668. }
  669. // [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
  670. // is the configuration of desired reservation which instances could take
  671. // capacity from.
  672. message ReservationAffinity {
  673. // Indicates whether to consume capacity from a reservation or not.
  674. enum Type {
  675. // Default value. This should not be used.
  676. UNSPECIFIED = 0;
  677. // Do not consume from any reserved capacity.
  678. NO_RESERVATION = 1;
  679. // Consume any reservation available.
  680. ANY_RESERVATION = 2;
  681. // Must consume from a specific reservation. Must specify key value fields
  682. // for specifying the reservations.
  683. SPECIFIC_RESERVATION = 3;
  684. }
  685. // Corresponds to the type of reservation consumption.
  686. Type consume_reservation_type = 1;
  687. // Corresponds to the label key of a reservation resource. To target a
  688. // SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as
  689. // the key and specify the name of your reservation as its value.
  690. string key = 2;
  691. // Corresponds to the label value(s) of reservation resource(s).
  692. repeated string values = 3;
  693. }
  694. // Kubernetes taint is comprised of three fields: key, value, and effect. Effect
  695. // can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
  696. //
  697. // See
  698. // [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)
  699. // for more information, including usage and the valid values.
  700. message NodeTaint {
  701. // Possible values for Effect in taint.
  702. enum Effect {
  703. // Not set
  704. EFFECT_UNSPECIFIED = 0;
  705. // NoSchedule
  706. NO_SCHEDULE = 1;
  707. // PreferNoSchedule
  708. PREFER_NO_SCHEDULE = 2;
  709. // NoExecute
  710. NO_EXECUTE = 3;
  711. }
  712. // Key for taint.
  713. string key = 1;
  714. // Value for taint.
  715. string value = 2;
  716. // Effect for taint.
  717. Effect effect = 3;
  718. }
  719. // The authentication information for accessing the master endpoint.
  720. // Authentication can be done using HTTP basic auth or using client
  721. // certificates.
  722. message MasterAuth {
  723. // The username to use for HTTP basic authentication to the master endpoint.
  724. // For clusters v1.6.0 and later, basic authentication can be disabled by
  725. // leaving username unspecified (or setting it to the empty string).
  726. //
  727. // Warning: basic authentication is deprecated, and will be removed in GKE
  728. // control plane versions 1.19 and newer. For a list of recommended
  729. // authentication methods, see:
  730. // https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
  731. string username = 1 [deprecated = true];
  732. // The password to use for HTTP basic authentication to the master endpoint.
  733. // Because the master endpoint is open to the Internet, you should create a
  734. // strong password. If a password is provided for cluster creation, username
  735. // must be non-empty.
  736. //
  737. // Warning: basic authentication is deprecated, and will be removed in GKE
  738. // control plane versions 1.19 and newer. For a list of recommended
  739. // authentication methods, see:
  740. // https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
  741. string password = 2 [deprecated = true];
  742. // Configuration for client certificate authentication on the cluster. For
  743. // clusters before v1.12, if no configuration is specified, a client
  744. // certificate is issued.
  745. ClientCertificateConfig client_certificate_config = 3;
  746. string cluster_ca_certificate = 100;
  747. // [Output only] Base64-encoded public certificate used by clients to
  748. // authenticate to the cluster endpoint.
  749. string client_certificate = 101;
  750. // [Output only] Base64-encoded private key used by clients to authenticate
  751. // to the cluster endpoint.
  752. string client_key = 102;
  753. }
  754. // Configuration for client certificates on the cluster.
  755. message ClientCertificateConfig {
  756. // Issue a client certificate.
  757. bool issue_client_certificate = 1;
  758. }
  759. // Configuration for the addons that can be automatically spun up in the
  760. // cluster, enabling additional functionality.
  761. message AddonsConfig {
  762. // Configuration for the HTTP (L7) load balancing controller addon, which
  763. // makes it easy to set up HTTP load balancers for services in a cluster.
  764. HttpLoadBalancing http_load_balancing = 1;
  765. // Configuration for the horizontal pod autoscaling feature, which
  766. // increases or decreases the number of replica pods a replication controller
  767. // has based on the resource usage of the existing pods.
  768. HorizontalPodAutoscaling horizontal_pod_autoscaling = 2;
  769. // Configuration for the Kubernetes Dashboard.
  770. // This addon is deprecated, and will be disabled in 1.15. It is recommended
  771. // to use the Cloud Console to manage and monitor your Kubernetes clusters,
  772. // workloads and applications. For more information, see:
  773. // https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
  774. KubernetesDashboard kubernetes_dashboard = 3 [deprecated = true];
  775. // Configuration for NetworkPolicy. This only tracks whether the addon
  776. // is enabled or not on the Master, it does not track whether network policy
  777. // is enabled for the nodes.
  778. NetworkPolicyConfig network_policy_config = 4;
  779. // Configuration for Istio, an open platform to connect, manage, and secure
  780. // microservices.
  781. IstioConfig istio_config = 5;
  782. // Configuration for the Cloud Run addon. The `IstioConfig` addon must be
  783. // enabled in order to enable Cloud Run addon. This option can only be enabled
  784. // at cluster creation time.
  785. CloudRunConfig cloud_run_config = 7;
  786. // Configuration for NodeLocalDNS, a dns cache running on cluster nodes
  787. DnsCacheConfig dns_cache_config = 8;
  788. // Configuration for the ConfigConnector add-on, a Kubernetes
  789. // extension to manage hosted GCP services through the Kubernetes API
  790. ConfigConnectorConfig config_connector_config = 10;
  791. // Configuration for the Compute Engine Persistent Disk CSI driver.
  792. GcePersistentDiskCsiDriverConfig gce_persistent_disk_csi_driver_config = 11;
  793. // Configuration for the KALM addon, which manages the lifecycle of k8s
  794. // applications.
  795. KalmConfig kalm_config = 12;
  796. }
  797. // Configuration options for the HTTP (L7) load balancing controller addon,
  798. // which makes it easy to set up HTTP load balancers for services in a cluster.
  799. message HttpLoadBalancing {
  800. // Whether the HTTP Load Balancing controller is enabled in the cluster.
  801. // When enabled, it runs a small pod in the cluster that manages the load
  802. // balancers.
  803. bool disabled = 1;
  804. }
  805. // Configuration options for the horizontal pod autoscaling feature, which
  806. // increases or decreases the number of replica pods a replication controller
  807. // has based on the resource usage of the existing pods.
  808. message HorizontalPodAutoscaling {
  809. // Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
  810. // When enabled, it ensures that metrics are collected into Stackdriver
  811. // Monitoring.
  812. bool disabled = 1;
  813. }
  814. // Configuration for the Kubernetes Dashboard.
  815. message KubernetesDashboard {
  816. // Whether the Kubernetes Dashboard is enabled for this cluster.
  817. bool disabled = 1;
  818. }
  819. // Configuration for NetworkPolicy. This only tracks whether the addon
  820. // is enabled or not on the Master, it does not track whether network policy
  821. // is enabled for the nodes.
  822. message NetworkPolicyConfig {
  823. // Whether NetworkPolicy is enabled for this cluster.
  824. bool disabled = 1;
  825. }
  826. // Configuration for NodeLocal DNSCache
  827. message DnsCacheConfig {
  828. // Whether NodeLocal DNSCache is enabled for this cluster.
  829. bool enabled = 1;
  830. }
  831. // Configuration options for the KALM addon.
  832. message KalmConfig {
  833. // Whether KALM is enabled for this cluster.
  834. bool enabled = 1;
  835. }
  836. // Configuration options for the Config Connector add-on.
  837. message ConfigConnectorConfig {
  838. // Whether Cloud Connector is enabled for this cluster.
  839. bool enabled = 1;
  840. }
  841. // Configuration for the Compute Engine PD CSI driver. This option can only be
  842. // enabled at cluster creation time.
  843. message GcePersistentDiskCsiDriverConfig {
  844. // Whether the Compute Engine PD CSI driver is enabled for this cluster.
  845. bool enabled = 1;
  846. }
  847. // Configuration for controlling master global access settings.
  848. message PrivateClusterMasterGlobalAccessConfig {
  849. // Whenever master is accessible globally or not.
  850. bool enabled = 1;
  851. }
  852. // Configuration options for private clusters.
  853. message PrivateClusterConfig {
  854. // Whether nodes have internal IP addresses only. If enabled, all nodes are
  855. // given only RFC 1918 private addresses and communicate with the master via
  856. // private networking.
  857. bool enable_private_nodes = 1;
  858. // Whether the master's internal IP address is used as the cluster endpoint.
  859. bool enable_private_endpoint = 2;
  860. // The IP range in CIDR notation to use for the hosted master network. This
  861. // range will be used for assigning internal IP addresses to the master or
  862. // set of masters, as well as the ILB VIP. This range must not overlap with
  863. // any other ranges in use within the cluster's network.
  864. string master_ipv4_cidr_block = 3;
  865. // Output only. The internal IP address of this cluster's master endpoint.
  866. string private_endpoint = 4;
  867. // Output only. The external IP address of this cluster's master endpoint.
  868. string public_endpoint = 5;
  869. // Output only. The peering name in the customer VPC used by this cluster.
  870. string peering_name = 7;
  871. // Controls master global access settings.
  872. PrivateClusterMasterGlobalAccessConfig master_global_access_config = 8;
  873. }
  874. // Configuration options for Istio addon.
  875. message IstioConfig {
  876. // Istio auth mode, https://istio.io/docs/concepts/security/mutual-tls.html
  877. enum IstioAuthMode {
  878. // auth not enabled
  879. AUTH_NONE = 0;
  880. // auth mutual TLS enabled
  881. AUTH_MUTUAL_TLS = 1;
  882. }
  883. // Whether Istio is enabled for this cluster.
  884. bool disabled = 1;
  885. // The specified Istio auth mode, either none, or mutual TLS.
  886. IstioAuthMode auth = 2;
  887. }
  888. // Configuration options for the Cloud Run feature.
  889. message CloudRunConfig {
  890. // Load balancer type of ingress service of Cloud Run.
  891. enum LoadBalancerType {
  892. // Load balancer type for Cloud Run is unspecified.
  893. LOAD_BALANCER_TYPE_UNSPECIFIED = 0;
  894. // Install external load balancer for Cloud Run.
  895. LOAD_BALANCER_TYPE_EXTERNAL = 1;
  896. // Install internal load balancer for Cloud Run.
  897. LOAD_BALANCER_TYPE_INTERNAL = 2;
  898. }
  899. // Whether Cloud Run addon is enabled for this cluster.
  900. bool disabled = 1;
  901. // Which load balancer type is installed for Cloud Run.
  902. LoadBalancerType load_balancer_type = 3;
  903. }
  904. // Configuration options for the master authorized networks feature. Enabled
  905. // master authorized networks will disallow all external traffic to access
  906. // Kubernetes master through HTTPS except traffic from the given CIDR blocks,
  907. // Google Compute Engine Public IPs and Google Prod IPs.
  908. message MasterAuthorizedNetworksConfig {
  909. // CidrBlock contains an optional name and one CIDR block.
  910. message CidrBlock {
  911. // display_name is an optional field for users to identify CIDR blocks.
  912. string display_name = 1;
  913. // cidr_block must be specified in CIDR notation.
  914. string cidr_block = 2;
  915. }
  916. // Whether or not master authorized networks is enabled.
  917. bool enabled = 1;
  918. // cidr_blocks define up to 10 external networks that could access
  919. // Kubernetes master through HTTPS.
  920. repeated CidrBlock cidr_blocks = 2;
  921. }
  922. // Configuration for the legacy Attribute Based Access Control authorization
  923. // mode.
  924. message LegacyAbac {
  925. // Whether the ABAC authorizer is enabled for this cluster. When enabled,
  926. // identities in the system, including service accounts, nodes, and
  927. // controllers, will have statically granted permissions beyond those
  928. // provided by the RBAC configuration or IAM.
  929. bool enabled = 1;
  930. }
  931. // Configuration options for the NetworkPolicy feature.
  932. // https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
  933. message NetworkPolicy {
  934. // Allowed Network Policy providers.
  935. enum Provider {
  936. // Not set
  937. PROVIDER_UNSPECIFIED = 0;
  938. // Tigera (Calico Felix).
  939. CALICO = 1;
  940. }
  941. // The selected network policy provider.
  942. Provider provider = 1;
  943. // Whether network policy is enabled on the cluster.
  944. bool enabled = 2;
  945. }
  946. // Configuration for controlling how IPs are allocated in the cluster.
  947. message IPAllocationPolicy {
  948. // Whether alias IPs will be used for pod IPs in the cluster.
  949. // This is used in conjunction with use_routes. It cannot
  950. // be true if use_routes is true. If both use_ip_aliases and use_routes are
  951. // false, then the server picks the default IP allocation mode
  952. bool use_ip_aliases = 1;
  953. // Whether a new subnetwork will be created automatically for the cluster.
  954. //
  955. // This field is only applicable when `use_ip_aliases` is true.
  956. bool create_subnetwork = 2;
  957. // A custom subnetwork name to be used if `create_subnetwork` is true. If
  958. // this field is empty, then an automatic name will be chosen for the new
  959. // subnetwork.
  960. string subnetwork_name = 3;
  961. // This field is deprecated, use cluster_ipv4_cidr_block.
  962. string cluster_ipv4_cidr = 4 [deprecated = true];
  963. // This field is deprecated, use node_ipv4_cidr_block.
  964. string node_ipv4_cidr = 5 [deprecated = true];
  965. // This field is deprecated, use services_ipv4_cidr_block.
  966. string services_ipv4_cidr = 6 [deprecated = true];
  967. // The name of the secondary range to be used for the cluster CIDR
  968. // block. The secondary range will be used for pod IP
  969. // addresses. This must be an existing secondary range associated
  970. // with the cluster subnetwork.
  971. //
  972. // This field is only applicable with use_ip_aliases and
  973. // create_subnetwork is false.
  974. string cluster_secondary_range_name = 7;
  975. // The name of the secondary range to be used as for the services
  976. // CIDR block. The secondary range will be used for service
  977. // ClusterIPs. This must be an existing secondary range associated
  978. // with the cluster subnetwork.
  979. //
  980. // This field is only applicable with use_ip_aliases and
  981. // create_subnetwork is false.
  982. string services_secondary_range_name = 8;
  983. // The IP address range for the cluster pod IPs. If this field is set, then
  984. // `cluster.cluster_ipv4_cidr` must be left blank.
  985. //
  986. // This field is only applicable when `use_ip_aliases` is true.
  987. //
  988. // Set to blank to have a range chosen with the default size.
  989. //
  990. // Set to /netmask (e.g. `/14`) to have a range chosen with a specific
  991. // netmask.
  992. //
  993. // Set to a
  994. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  995. // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
  996. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
  997. // to use.
  998. string cluster_ipv4_cidr_block = 9;
  999. // The IP address range of the instance IPs in this cluster.
  1000. //
  1001. // This is applicable only if `create_subnetwork` is true.
  1002. //
  1003. // Set to blank to have a range chosen with the default size.
  1004. //
  1005. // Set to /netmask (e.g. `/14`) to have a range chosen with a specific
  1006. // netmask.
  1007. //
  1008. // Set to a
  1009. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1010. // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
  1011. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
  1012. // to use.
  1013. string node_ipv4_cidr_block = 10;
  1014. // The IP address range of the services IPs in this cluster. If blank, a range
  1015. // will be automatically chosen with the default size.
  1016. //
  1017. // This field is only applicable when `use_ip_aliases` is true.
  1018. //
  1019. // Set to blank to have a range chosen with the default size.
  1020. //
  1021. // Set to /netmask (e.g. `/14`) to have a range chosen with a specific
  1022. // netmask.
  1023. //
  1024. // Set to a
  1025. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1026. // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
  1027. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
  1028. // to use.
  1029. string services_ipv4_cidr_block = 11;
  1030. // If true, allow allocation of cluster CIDR ranges that overlap with certain
  1031. // kinds of network routes. By default we do not allow cluster CIDR ranges to
  1032. // intersect with any user declared routes. With allow_route_overlap == true,
  1033. // we allow overlapping with CIDR ranges that are larger than the cluster CIDR
  1034. // range.
  1035. //
  1036. // If this field is set to true, then cluster and services CIDRs must be
  1037. // fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:
  1038. // 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and
  1039. // `services_ipv4_cidr_block` must be fully-specified.
  1040. // 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be
  1041. // fully-specified.
  1042. bool allow_route_overlap = 12;
  1043. // The IP address range of the Cloud TPUs in this cluster. If unspecified, a
  1044. // range will be automatically chosen with the default size.
  1045. //
  1046. // This field is only applicable when `use_ip_aliases` is true.
  1047. //
  1048. // If unspecified, the range will use the default size.
  1049. //
  1050. // Set to /netmask (e.g. `/14`) to have a range chosen with a specific
  1051. // netmask.
  1052. //
  1053. // Set to a
  1054. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1055. // notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.
  1056. // `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range
  1057. // to use.
  1058. // This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.
  1059. string tpu_ipv4_cidr_block = 13;
  1060. // Whether routes will be used for pod IPs in the cluster.
  1061. // This is used in conjunction with use_ip_aliases. It cannot be true if
  1062. // use_ip_aliases is true. If both use_ip_aliases and use_routes are false,
  1063. // then the server picks the default IP allocation mode
  1064. bool use_routes = 15;
  1065. }
  1066. // Configuration for Binary Authorization.
  1067. message BinaryAuthorization {
  1068. // Enable Binary Authorization for this cluster. If enabled, all container
  1069. // images will be validated by Google Binauthz.
  1070. bool enabled = 1;
  1071. }
  1072. // Configuration for the PodSecurityPolicy feature.
  1073. message PodSecurityPolicyConfig {
  1074. // Enable the PodSecurityPolicy controller for this cluster. If enabled, pods
  1075. // must be valid under a PodSecurityPolicy to be created.
  1076. bool enabled = 1;
  1077. }
  1078. // Configuration for returning group information from authenticators.
  1079. message AuthenticatorGroupsConfig {
  1080. // Whether this cluster should return group membership lookups
  1081. // during authentication using a group of security groups.
  1082. bool enabled = 1;
  1083. // The name of the security group-of-groups to be used. Only relevant
  1084. // if enabled = true.
  1085. string security_group = 2;
  1086. }
  1087. // Telemetry integration for the cluster.
  1088. message ClusterTelemetry {
  1089. // Type of the integration.
  1090. enum Type {
  1091. // Not set.
  1092. UNSPECIFIED = 0;
  1093. // Monitoring integration is disabled.
  1094. DISABLED = 1;
  1095. // Monitoring integration is enabled.
  1096. ENABLED = 2;
  1097. // Only system components are monitored and logged.
  1098. SYSTEM_ONLY = 3;
  1099. }
  1100. // Type of the integration.
  1101. Type type = 1;
  1102. }
  1103. // A Google Kubernetes Engine cluster.
  1104. message Cluster {
  1105. // The current status of the cluster.
  1106. enum Status {
  1107. // Not set.
  1108. STATUS_UNSPECIFIED = 0;
  1109. // The PROVISIONING state indicates the cluster is being created.
  1110. PROVISIONING = 1;
  1111. // The RUNNING state indicates the cluster has been created and is fully
  1112. // usable.
  1113. RUNNING = 2;
  1114. // The RECONCILING state indicates that some work is actively being done on
  1115. // the cluster, such as upgrading the master or node software. Details can
  1116. // be found in the `statusMessage` field.
  1117. RECONCILING = 3;
  1118. // The STOPPING state indicates the cluster is being deleted.
  1119. STOPPING = 4;
  1120. // The ERROR state indicates the cluster may be unusable. Details
  1121. // can be found in the `statusMessage` field.
  1122. ERROR = 5;
  1123. // The DEGRADED state indicates the cluster requires user action to restore
  1124. // full functionality. Details can be found in the `statusMessage` field.
  1125. DEGRADED = 6;
  1126. }
  1127. // The name of this cluster. The name must be unique within this project
  1128. // and location (e.g. zone or region), and can be up to 40 characters with
  1129. // the following restrictions:
  1130. //
  1131. // * Lowercase letters, numbers, and hyphens only.
  1132. // * Must start with a letter.
  1133. // * Must end with a number or a letter.
  1134. string name = 1;
  1135. // An optional description of this cluster.
  1136. string description = 2;
  1137. // The number of nodes to create in this cluster. You must ensure that your
  1138. // Compute Engine [resource quota](https://cloud.google.com/compute/quotas)
  1139. // is sufficient for this number of instances. You must also have available
  1140. // firewall and routes quota.
  1141. // For requests, this field should only be used in lieu of a
  1142. // "node_pool" object, since this configuration (along with the
  1143. // "node_config") will be used to create a "NodePool" object with an
  1144. // auto-generated name. Do not use this and a node_pool at the same time.
  1145. //
  1146. // This field is deprecated, use node_pool.initial_node_count instead.
  1147. int32 initial_node_count = 3 [deprecated = true];
  1148. // Parameters used in creating the cluster's nodes.
  1149. // For requests, this field should only be used in lieu of a
  1150. // "node_pool" object, since this configuration (along with the
  1151. // "initial_node_count") will be used to create a "NodePool" object with an
  1152. // auto-generated name. Do not use this and a node_pool at the same time.
  1153. // For responses, this field will be populated with the node configuration of
  1154. // the first node pool. (For configuration of each node pool, see
  1155. // `node_pool.config`)
  1156. //
  1157. // If unspecified, the defaults are used.
  1158. // This field is deprecated, use node_pool.config instead.
  1159. NodeConfig node_config = 4 [deprecated = true];
  1160. // The authentication information for accessing the master endpoint.
  1161. // If unspecified, the defaults are used:
  1162. // For clusters before v1.12, if master_auth is unspecified, `username` will
  1163. // be set to "admin", a random password will be generated, and a client
  1164. // certificate will be issued.
  1165. MasterAuth master_auth = 5;
  1166. // The logging service the cluster should use to write logs.
  1167. // Currently available options:
  1168. //
  1169. // * `logging.googleapis.com/kubernetes` - The Cloud Logging
  1170. // service with a Kubernetes-native resource model
  1171. // * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
  1172. // available as of GKE 1.15).
  1173. // * `none` - no logs will be exported from the cluster.
  1174. //
  1175. // If left as an empty string,`logging.googleapis.com/kubernetes` will be
  1176. // used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
  1177. string logging_service = 6;
  1178. // The monitoring service the cluster should use to write metrics.
  1179. // Currently available options:
  1180. //
  1181. // * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
  1182. // service with a Kubernetes-native resource model
  1183. // * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
  1184. // longer available as of GKE 1.15).
  1185. // * `none` - No metrics will be exported from the cluster.
  1186. //
  1187. // If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
  1188. // used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
  1189. string monitoring_service = 7;
  1190. // The name of the Google Compute Engine
  1191. // [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
  1192. // to which the cluster is connected. If left unspecified, the `default`
  1193. // network will be used. On output this shows the network ID instead of the
  1194. // name.
  1195. string network = 8;
  1196. // The IP address range of the container pods in this cluster, in
  1197. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1198. // notation (e.g. `10.96.0.0/14`). Leave blank to have
  1199. // one automatically chosen or specify a `/14` block in `10.0.0.0/8`.
  1200. string cluster_ipv4_cidr = 9;
  1201. // Configurations for the various addons available to run in the cluster.
  1202. AddonsConfig addons_config = 10;
  1203. // The name of the Google Compute Engine
  1204. // [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which
  1205. // the cluster is connected. On output this shows the subnetwork ID instead of
  1206. // the name.
  1207. string subnetwork = 11;
  1208. // The node pools associated with this cluster.
  1209. // This field should not be set if "node_config" or "initial_node_count" are
  1210. // specified.
  1211. repeated NodePool node_pools = 12;
  1212. // The list of Google Compute Engine
  1213. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  1214. // cluster's nodes should be located.
  1215. //
  1216. // This field provides a default value if
  1217. // [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations)
  1218. // are not specified during node pool creation.
  1219. //
  1220. // Warning: changing cluster locations will update the
  1221. // [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations)
  1222. // of all node pools and will result in nodes being added and/or removed.
  1223. repeated string locations = 13;
  1224. // Kubernetes alpha features are enabled on this cluster. This includes alpha
  1225. // API groups (e.g. v1beta1) and features that may not be production ready in
  1226. // the kubernetes version of the master and nodes.
  1227. // The cluster has no SLA for uptime and master/node upgrades are disabled.
  1228. // Alpha enabled clusters are automatically deleted thirty days after
  1229. // creation.
  1230. bool enable_kubernetes_alpha = 14;
  1231. // The resource labels for the cluster to use to annotate any related
  1232. // Google Compute Engine resources.
  1233. map<string, string> resource_labels = 15;
  1234. // The fingerprint of the set of labels for this cluster.
  1235. string label_fingerprint = 16;
  1236. // Configuration for the legacy ABAC authorization mode.
  1237. LegacyAbac legacy_abac = 18;
  1238. // Configuration options for the NetworkPolicy feature.
  1239. NetworkPolicy network_policy = 19;
  1240. // Configuration for cluster IP allocation.
  1241. IPAllocationPolicy ip_allocation_policy = 20;
  1242. // The configuration options for master authorized networks feature.
  1243. MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;
  1244. // Configure the maintenance policy for this cluster.
  1245. MaintenancePolicy maintenance_policy = 23;
  1246. // Configuration for Binary Authorization.
  1247. BinaryAuthorization binary_authorization = 24;
  1248. // Configuration for the PodSecurityPolicy feature.
  1249. PodSecurityPolicyConfig pod_security_policy_config = 25;
  1250. // Cluster-level autoscaling configuration.
  1251. ClusterAutoscaling autoscaling = 26;
  1252. // Configuration for cluster networking.
  1253. NetworkConfig network_config = 27;
  1254. // If this is a private cluster setup. Private clusters are clusters that, by
  1255. // default have no external IP addresses on the nodes and where nodes and the
  1256. // master communicate over private IP addresses.
  1257. // This field is deprecated, use private_cluster_config.enable_private_nodes
  1258. // instead.
  1259. bool private_cluster = 28 [deprecated = true];
  1260. // The IP prefix in CIDR notation to use for the hosted master network.
  1261. // This prefix will be used for assigning private IP addresses to the
  1262. // master or set of masters, as well as the ILB VIP.
  1263. // This field is deprecated, use
  1264. // private_cluster_config.master_ipv4_cidr_block instead.
  1265. string master_ipv4_cidr_block = 29 [deprecated = true];
  1266. // The default constraint on the maximum number of pods that can be run
  1267. // simultaneously on a node in the node pool of this cluster. Only honored
  1268. // if cluster created with IP Alias support.
  1269. MaxPodsConstraint default_max_pods_constraint = 30;
  1270. // Configuration for exporting resource usages. Resource usage export is
  1271. // disabled when this config unspecified.
  1272. ResourceUsageExportConfig resource_usage_export_config = 33;
  1273. // Configuration controlling RBAC group membership information.
  1274. AuthenticatorGroupsConfig authenticator_groups_config = 34;
  1275. // Configuration for private cluster.
  1276. PrivateClusterConfig private_cluster_config = 37;
  1277. // Cluster-level Vertical Pod Autoscaling configuration.
  1278. VerticalPodAutoscaling vertical_pod_autoscaling = 39;
  1279. // Shielded Nodes configuration.
  1280. ShieldedNodes shielded_nodes = 40;
  1281. // Release channel configuration.
  1282. ReleaseChannel release_channel = 41;
  1283. // Configuration for the use of Kubernetes Service Accounts in GCP IAM
  1284. // policies.
  1285. WorkloadIdentityConfig workload_identity_config = 43;
  1286. // Telemetry integration for the cluster.
  1287. ClusterTelemetry cluster_telemetry = 46;
  1288. // Configuration for Cloud TPU support;
  1289. TpuConfig tpu_config = 47;
  1290. // Notification configuration of the cluster.
  1291. NotificationConfig notification_config = 49;
  1292. // Configuration of Confidential Nodes
  1293. ConfidentialNodes confidential_nodes = 50;
  1294. // [Output only] Server-defined URL for the resource.
  1295. string self_link = 100;
  1296. // [Output only] The name of the Google Compute Engine
  1297. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1298. // cluster resides. This field is deprecated, use location instead.
  1299. string zone = 101 [deprecated = true];
  1300. // [Output only] The IP address of this cluster's master endpoint.
  1301. // The endpoint can be accessed from the internet at
  1302. // `https://username:password@endpoint/`.
  1303. //
  1304. // See the `masterAuth` property of this resource for username and
  1305. // password information.
  1306. string endpoint = 102;
  1307. // The initial Kubernetes version for this cluster. Valid versions are those
  1308. // found in validMasterVersions returned by getServerConfig. The version can
  1309. // be upgraded over time; such upgrades are reflected in
  1310. // currentMasterVersion and currentNodeVersion.
  1311. //
  1312. // Users may specify either explicit versions offered by
  1313. // Kubernetes Engine or version aliases, which have the following behavior:
  1314. //
  1315. // - "latest": picks the highest valid Kubernetes version
  1316. // - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  1317. // - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  1318. // - "1.X.Y-gke.N": picks an explicit Kubernetes version
  1319. // - "","-": picks the default Kubernetes version
  1320. string initial_cluster_version = 103;
  1321. // [Output only] The current software version of the master endpoint.
  1322. string current_master_version = 104;
  1323. // [Output only] Deprecated, use
  1324. // [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)
  1325. // instead. The current version of the node software components.
  1326. // If they are currently at multiple versions because they're in the process
  1327. // of being upgraded, this reflects the minimum version of all nodes.
  1328. string current_node_version = 105 [deprecated = true];
  1329. // [Output only] The time the cluster was created, in
  1330. // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  1331. string create_time = 106;
  1332. // [Output only] The current status of this cluster.
  1333. Status status = 107;
  1334. // [Output only] Deprecated. Use conditions instead.
  1335. // Additional information about the current status of this
  1336. // cluster, if available.
  1337. string status_message = 108 [deprecated = true];
  1338. // [Output only] The size of the address space on each node for hosting
  1339. // containers. This is provisioned from within the `container_ipv4_cidr`
  1340. // range. This field will only be set when cluster is in route-based network
  1341. // mode.
  1342. int32 node_ipv4_cidr_size = 109;
  1343. // [Output only] The IP address range of the Kubernetes services in
  1344. // this cluster, in
  1345. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1346. // notation (e.g. `1.2.3.4/29`). Service addresses are
  1347. // typically put in the last `/16` from the container CIDR.
  1348. string services_ipv4_cidr = 110;
  1349. // Deprecated. Use node_pools.instance_group_urls.
  1350. repeated string instance_group_urls = 111 [deprecated = true];
  1351. // [Output only] The number of nodes currently in the cluster. Deprecated.
  1352. // Call Kubernetes API directly to retrieve node information.
  1353. int32 current_node_count = 112 [deprecated = true];
  1354. // [Output only] The time the cluster will be automatically
  1355. // deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  1356. string expire_time = 113;
  1357. // [Output only] The name of the Google Compute Engine
  1358. // [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
  1359. // or
  1360. // [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
  1361. // in which the cluster resides.
  1362. string location = 114;
  1363. // Enable the ability to use Cloud TPUs in this cluster.
  1364. // This field is deprecated, use tpu_config.enabled instead.
  1365. bool enable_tpu = 115;
  1366. // [Output only] The IP address range of the Cloud TPUs in this cluster, in
  1367. // [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)
  1368. // notation (e.g. `1.2.3.4/29`).
  1369. string tpu_ipv4_cidr_block = 116;
  1370. // Configuration of etcd encryption.
  1371. DatabaseEncryption database_encryption = 38;
  1372. // Which conditions caused the current cluster state.
  1373. repeated StatusCondition conditions = 118;
  1374. // Configuration for master components.
  1375. Master master = 124;
  1376. }
  1377. // ClusterUpdate describes an update to the cluster. Exactly one update can
  1378. // be applied to a cluster with each request, so at most one field can be
  1379. // provided.
  1380. message ClusterUpdate {
  1381. // The Kubernetes version to change the nodes to (typically an
  1382. // upgrade).
  1383. //
  1384. // Users may specify either explicit versions offered by
  1385. // Kubernetes Engine or version aliases, which have the following behavior:
  1386. //
  1387. // - "latest": picks the highest valid Kubernetes version
  1388. // - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  1389. // - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  1390. // - "1.X.Y-gke.N": picks an explicit Kubernetes version
  1391. // - "-": picks the Kubernetes master version
  1392. string desired_node_version = 4;
  1393. // The monitoring service the cluster should use to write metrics.
  1394. // Currently available options:
  1395. //
  1396. // * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
  1397. // service with a Kubernetes-native resource model
  1398. // * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
  1399. // longer available as of GKE 1.15).
  1400. // * `none` - No metrics will be exported from the cluster.
  1401. //
  1402. // If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
  1403. // used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
  1404. string desired_monitoring_service = 5;
  1405. // Configurations for the various addons available to run in the cluster.
  1406. AddonsConfig desired_addons_config = 6;
  1407. // The node pool to be upgraded. This field is mandatory if
  1408. // "desired_node_version", "desired_image_family",
  1409. // "desired_node_pool_autoscaling", or "desired_workload_metadata_config"
  1410. // is specified and there is more than one node pool on the cluster.
  1411. string desired_node_pool_id = 7;
  1412. // The desired image type for the node pool.
  1413. // NOTE: Set the "desired_node_pool" field as well.
  1414. string desired_image_type = 8;
  1415. // Autoscaler configuration for the node pool specified in
  1416. // desired_node_pool_id. If there is only one pool in the
  1417. // cluster and desired_node_pool_id is not provided then
  1418. // the change applies to that single node pool.
  1419. NodePoolAutoscaling desired_node_pool_autoscaling = 9;
  1420. // The desired list of Google Compute Engine
  1421. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  1422. // cluster's nodes should be located.
  1423. //
  1424. // This list must always include the cluster's primary zone.
  1425. //
  1426. // Warning: changing cluster locations will update the locations of all node
  1427. // pools and will result in nodes being added and/or removed.
  1428. repeated string desired_locations = 10;
  1429. // The desired configuration options for master authorized networks feature.
  1430. MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12;
  1431. // The desired configuration options for the PodSecurityPolicy feature.
  1432. PodSecurityPolicyConfig desired_pod_security_policy_config = 14;
  1433. // Cluster-level autoscaling configuration.
  1434. ClusterAutoscaling desired_cluster_autoscaling = 15;
  1435. // The desired configuration options for the Binary Authorization feature.
  1436. BinaryAuthorization desired_binary_authorization = 16;
  1437. // The logging service the cluster should use to write logs.
  1438. // Currently available options:
  1439. //
  1440. // * `logging.googleapis.com/kubernetes` - The Cloud Logging
  1441. // service with a Kubernetes-native resource model
  1442. // * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
  1443. // available as of GKE 1.15).
  1444. // * `none` - no logs will be exported from the cluster.
  1445. //
  1446. // If left as an empty string,`logging.googleapis.com/kubernetes` will be
  1447. // used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
  1448. string desired_logging_service = 19;
  1449. // The desired configuration for exporting resource usage.
  1450. ResourceUsageExportConfig desired_resource_usage_export_config = 21;
  1451. // Cluster-level Vertical Pod Autoscaling configuration.
  1452. VerticalPodAutoscaling desired_vertical_pod_autoscaling = 22;
  1453. // The desired private cluster configuration.
  1454. PrivateClusterConfig desired_private_cluster_config = 25;
  1455. // The desired config of Intra-node visibility.
  1456. IntraNodeVisibilityConfig desired_intra_node_visibility_config = 26;
  1457. // The desired status of whether to disable default sNAT for this cluster.
  1458. DefaultSnatStatus desired_default_snat_status = 28;
  1459. // The desired telemetry integration for the cluster.
  1460. ClusterTelemetry desired_cluster_telemetry = 30;
  1461. // The desired release channel configuration.
  1462. ReleaseChannel desired_release_channel = 31;
  1463. // The desired Cloud TPU configuration.
  1464. TpuConfig desired_tpu_config = 38;
  1465. // The desired datapath provider for the cluster.
  1466. DatapathProvider desired_datapath_provider = 50;
  1467. // The desired notification configuration.
  1468. NotificationConfig desired_notification_config = 55;
  1469. // The Kubernetes version to change the master to. The only valid value is the
  1470. // latest supported version.
  1471. //
  1472. // Users may specify either explicit versions offered by
  1473. // Kubernetes Engine or version aliases, which have the following behavior:
  1474. //
  1475. // - "latest": picks the highest valid Kubernetes version
  1476. // - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  1477. // - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  1478. // - "1.X.Y-gke.N": picks an explicit Kubernetes version
  1479. // - "-": picks the default Kubernetes version
  1480. string desired_master_version = 100;
  1481. // Configuration of etcd encryption.
  1482. DatabaseEncryption desired_database_encryption = 46;
  1483. // Configuration for Workload Identity.
  1484. WorkloadIdentityConfig desired_workload_identity_config = 47;
  1485. // Configuration for Shielded Nodes.
  1486. ShieldedNodes desired_shielded_nodes = 48;
  1487. // Configuration for master components.
  1488. Master desired_master = 52;
  1489. // AuthenticatorGroupsConfig specifies the config for the cluster security
  1490. // groups settings.
  1491. AuthenticatorGroupsConfig desired_authenticator_groups_config = 63;
  1492. }
  1493. // This operation resource represents operations that may have happened or are
  1494. // happening on the cluster. All fields are output only.
  1495. message Operation {
  1496. // Current status of the operation.
  1497. enum Status {
  1498. // Not set.
  1499. STATUS_UNSPECIFIED = 0;
  1500. // The operation has been created.
  1501. PENDING = 1;
  1502. // The operation is currently running.
  1503. RUNNING = 2;
  1504. // The operation is done, either cancelled or completed.
  1505. DONE = 3;
  1506. // The operation is aborting.
  1507. ABORTING = 4;
  1508. }
  1509. // Operation type.
  1510. enum Type {
  1511. // Not set.
  1512. TYPE_UNSPECIFIED = 0;
  1513. // Cluster create.
  1514. CREATE_CLUSTER = 1;
  1515. // Cluster delete.
  1516. DELETE_CLUSTER = 2;
  1517. // A master upgrade.
  1518. UPGRADE_MASTER = 3;
  1519. // A node upgrade.
  1520. UPGRADE_NODES = 4;
  1521. // Cluster repair.
  1522. REPAIR_CLUSTER = 5;
  1523. // Cluster update.
  1524. UPDATE_CLUSTER = 6;
  1525. // Node pool create.
  1526. CREATE_NODE_POOL = 7;
  1527. // Node pool delete.
  1528. DELETE_NODE_POOL = 8;
  1529. // Set node pool management.
  1530. SET_NODE_POOL_MANAGEMENT = 9;
  1531. // Automatic node pool repair.
  1532. AUTO_REPAIR_NODES = 10;
  1533. // Automatic node upgrade.
  1534. AUTO_UPGRADE_NODES = 11;
  1535. // Set labels.
  1536. SET_LABELS = 12;
  1537. // Set/generate master auth materials
  1538. SET_MASTER_AUTH = 13;
  1539. // Set node pool size.
  1540. SET_NODE_POOL_SIZE = 14;
  1541. // Updates network policy for a cluster.
  1542. SET_NETWORK_POLICY = 15;
  1543. // Set the maintenance policy.
  1544. SET_MAINTENANCE_POLICY = 16;
  1545. }
  1546. // The server-assigned ID for the operation.
  1547. string name = 1;
  1548. // The name of the Google Compute Engine
  1549. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1550. // operation is taking place. This field is deprecated, use location instead.
  1551. string zone = 2 [deprecated = true];
  1552. // The operation type.
  1553. Type operation_type = 3;
  1554. // The current status of the operation.
  1555. Status status = 4;
  1556. // Detailed operation progress, if available.
  1557. string detail = 8;
  1558. // Output only. If an error has occurred, a textual description of the error.
  1559. // Deprecated. Use field error instead.
  1560. string status_message = 5 [
  1561. deprecated = true,
  1562. (google.api.field_behavior) = OUTPUT_ONLY
  1563. ];
  1564. // Server-defined URL for the resource.
  1565. string self_link = 6;
  1566. // Server-defined URL for the target of the operation.
  1567. string target_link = 7;
  1568. // [Output only] The name of the Google Compute Engine
  1569. // [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
  1570. // or
  1571. // [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available)
  1572. // in which the cluster resides.
  1573. string location = 9;
  1574. // [Output only] The time the operation started, in
  1575. // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  1576. string start_time = 10;
  1577. // [Output only] The time the operation completed, in
  1578. // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  1579. string end_time = 11;
  1580. // Output only. [Output only] Progress information for an operation.
  1581. OperationProgress progress = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
  1582. // Which conditions caused the current cluster state.
  1583. // Deprecated. Use field error instead.
  1584. repeated StatusCondition cluster_conditions = 13 [deprecated = true];
  1585. // Which conditions caused the current node pool state.
  1586. // Deprecated. Use field error instead.
  1587. repeated StatusCondition nodepool_conditions = 14 [deprecated = true];
  1588. // The error result of the operation in case of failure.
  1589. google.rpc.Status error = 15;
  1590. }
  1591. // Information about operation (or operation stage) progress.
  1592. message OperationProgress {
  1593. // Progress metric is (string, int|float|string) pair.
  1594. message Metric {
  1595. // Required. Metric name, e.g., "nodes total", "percent done".
  1596. string name = 1 [(google.api.field_behavior) = REQUIRED];
  1597. // Strictly one of the values is required.
  1598. oneof value {
  1599. // For metrics with integer value.
  1600. int64 int_value = 2;
  1601. // For metrics with floating point value.
  1602. double double_value = 3;
  1603. // For metrics with custom values (ratios, visual progress, etc.).
  1604. string string_value = 4;
  1605. }
  1606. }
  1607. // A non-parameterized string describing an operation stage.
  1608. // Unset for single-stage operations.
  1609. string name = 1;
  1610. // Status of an operation stage.
  1611. // Unset for single-stage operations.
  1612. Operation.Status status = 2;
  1613. // Progress metric bundle, for example:
  1614. // metrics: [{name: "nodes done", int_value: 15},
  1615. // {name: "nodes total", int_value: 32}]
  1616. // or
  1617. // metrics: [{name: "progress", double_value: 0.56},
  1618. // {name: "progress scale", double_value: 1.0}]
  1619. repeated Metric metrics = 3;
  1620. // Substages of an operation or a stage.
  1621. repeated OperationProgress stages = 4;
  1622. }
  1623. // CreateClusterRequest creates a cluster.
  1624. message CreateClusterRequest {
  1625. // Required. Deprecated. The Google Developers Console [project ID or project
  1626. // number](https://support.google.com/cloud/answer/6158840).
  1627. // This field has been deprecated and replaced by the parent field.
  1628. string project_id = 1 [
  1629. deprecated = true,
  1630. (google.api.field_behavior) = REQUIRED
  1631. ];
  1632. // Required. Deprecated. The name of the Google Compute Engine
  1633. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1634. // cluster resides. This field has been deprecated and replaced by the parent
  1635. // field.
  1636. string zone = 2 [
  1637. deprecated = true,
  1638. (google.api.field_behavior) = REQUIRED
  1639. ];
  1640. // Required. A [cluster
  1641. // resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
  1642. Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
  1643. // The parent (project and location) where the cluster will be created.
  1644. // Specified in the format `projects/*/locations/*`.
  1645. string parent = 5;
  1646. }
  1647. // GetClusterRequest gets the settings of a cluster.
  1648. message GetClusterRequest {
  1649. // Required. Deprecated. The Google Developers Console [project ID or project
  1650. // number](https://support.google.com/cloud/answer/6158840).
  1651. // This field has been deprecated and replaced by the name field.
  1652. string project_id = 1 [
  1653. deprecated = true,
  1654. (google.api.field_behavior) = REQUIRED
  1655. ];
  1656. // Required. Deprecated. The name of the Google Compute Engine
  1657. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1658. // cluster resides. This field has been deprecated and replaced by the name
  1659. // field.
  1660. string zone = 2 [
  1661. deprecated = true,
  1662. (google.api.field_behavior) = REQUIRED
  1663. ];
  1664. // Required. Deprecated. The name of the cluster to retrieve.
  1665. // This field has been deprecated and replaced by the name field.
  1666. string cluster_id = 3 [
  1667. deprecated = true,
  1668. (google.api.field_behavior) = REQUIRED
  1669. ];
  1670. // The name (project, location, cluster) of the cluster to retrieve.
  1671. // Specified in the format `projects/*/locations/*/clusters/*`.
  1672. string name = 5;
  1673. }
  1674. // UpdateClusterRequest updates the settings of a cluster.
  1675. message UpdateClusterRequest {
  1676. // Required. Deprecated. The Google Developers Console [project ID or project
  1677. // number](https://support.google.com/cloud/answer/6158840).
  1678. // This field has been deprecated and replaced by the name field.
  1679. string project_id = 1 [
  1680. deprecated = true,
  1681. (google.api.field_behavior) = REQUIRED
  1682. ];
  1683. // Required. Deprecated. The name of the Google Compute Engine
  1684. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1685. // cluster resides. This field has been deprecated and replaced by the name
  1686. // field.
  1687. string zone = 2 [
  1688. deprecated = true,
  1689. (google.api.field_behavior) = REQUIRED
  1690. ];
  1691. // Required. Deprecated. The name of the cluster to upgrade.
  1692. // This field has been deprecated and replaced by the name field.
  1693. string cluster_id = 3 [
  1694. deprecated = true,
  1695. (google.api.field_behavior) = REQUIRED
  1696. ];
  1697. // Required. A description of the update.
  1698. ClusterUpdate update = 4 [(google.api.field_behavior) = REQUIRED];
  1699. // The name (project, location, cluster) of the cluster to update.
  1700. // Specified in the format `projects/*/locations/*/clusters/*`.
  1701. string name = 5;
  1702. }
  1703. // SetNodePoolVersionRequest updates the version of a node pool.
  1704. message UpdateNodePoolRequest {
  1705. // Required. Deprecated. The Google Developers Console [project ID or project
  1706. // number](https://support.google.com/cloud/answer/6158840).
  1707. // This field has been deprecated and replaced by the name field.
  1708. string project_id = 1 [
  1709. deprecated = true,
  1710. (google.api.field_behavior) = REQUIRED
  1711. ];
  1712. // Required. Deprecated. The name of the Google Compute Engine
  1713. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1714. // cluster resides. This field has been deprecated and replaced by the name
  1715. // field.
  1716. string zone = 2 [
  1717. deprecated = true,
  1718. (google.api.field_behavior) = REQUIRED
  1719. ];
  1720. // Required. Deprecated. The name of the cluster to upgrade.
  1721. // This field has been deprecated and replaced by the name field.
  1722. string cluster_id = 3 [
  1723. deprecated = true,
  1724. (google.api.field_behavior) = REQUIRED
  1725. ];
  1726. // Required. Deprecated. The name of the node pool to upgrade.
  1727. // This field has been deprecated and replaced by the name field.
  1728. string node_pool_id = 4 [
  1729. deprecated = true,
  1730. (google.api.field_behavior) = REQUIRED
  1731. ];
  1732. // Required. The Kubernetes version to change the nodes to (typically an
  1733. // upgrade).
  1734. //
  1735. // Users may specify either explicit versions offered by Kubernetes Engine or
  1736. // version aliases, which have the following behavior:
  1737. //
  1738. // - "latest": picks the highest valid Kubernetes version
  1739. // - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  1740. // - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  1741. // - "1.X.Y-gke.N": picks an explicit Kubernetes version
  1742. // - "-": picks the Kubernetes master version
  1743. string node_version = 5 [(google.api.field_behavior) = REQUIRED];
  1744. // Required. The desired image type for the node pool.
  1745. string image_type = 6 [(google.api.field_behavior) = REQUIRED];
  1746. // The desired list of Google Compute Engine
  1747. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  1748. // node pool's nodes should be located. Changing the locations for a node pool
  1749. // will result in nodes being either created or removed from the node pool,
  1750. // depending on whether locations are being added or removed.
  1751. repeated string locations = 13;
  1752. // The desired workload metadata config for the node pool.
  1753. WorkloadMetadataConfig workload_metadata_config = 14;
  1754. // The name (project, location, cluster, node pool) of the node pool to
  1755. // update. Specified in the format
  1756. // `projects/*/locations/*/clusters/*/nodePools/*`.
  1757. string name = 8;
  1758. // Upgrade settings control disruption and speed of the upgrade.
  1759. NodePool.UpgradeSettings upgrade_settings = 15;
  1760. // Parameters that can be configured on Linux nodes.
  1761. LinuxNodeConfig linux_node_config = 19;
  1762. // Node kubelet configs.
  1763. NodeKubeletConfig kubelet_config = 20;
  1764. }
  1765. // SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
  1766. message SetNodePoolAutoscalingRequest {
  1767. // Required. Deprecated. The Google Developers Console [project ID or project
  1768. // number](https://support.google.com/cloud/answer/6158840).
  1769. // This field has been deprecated and replaced by the name field.
  1770. string project_id = 1 [
  1771. deprecated = true,
  1772. (google.api.field_behavior) = REQUIRED
  1773. ];
  1774. // Required. Deprecated. The name of the Google Compute Engine
  1775. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1776. // cluster resides. This field has been deprecated and replaced by the name
  1777. // field.
  1778. string zone = 2 [
  1779. deprecated = true,
  1780. (google.api.field_behavior) = REQUIRED
  1781. ];
  1782. // Required. Deprecated. The name of the cluster to upgrade.
  1783. // This field has been deprecated and replaced by the name field.
  1784. string cluster_id = 3 [
  1785. deprecated = true,
  1786. (google.api.field_behavior) = REQUIRED
  1787. ];
  1788. // Required. Deprecated. The name of the node pool to upgrade.
  1789. // This field has been deprecated and replaced by the name field.
  1790. string node_pool_id = 4 [
  1791. deprecated = true,
  1792. (google.api.field_behavior) = REQUIRED
  1793. ];
  1794. // Required. Autoscaling configuration for the node pool.
  1795. NodePoolAutoscaling autoscaling = 5 [(google.api.field_behavior) = REQUIRED];
  1796. // The name (project, location, cluster, node pool) of the node pool to set
  1797. // autoscaler settings. Specified in the format
  1798. // `projects/*/locations/*/clusters/*/nodePools/*`.
  1799. string name = 6;
  1800. }
  1801. // SetLoggingServiceRequest sets the logging service of a cluster.
  1802. message SetLoggingServiceRequest {
  1803. // Required. Deprecated. The Google Developers Console [project ID or project
  1804. // number](https://support.google.com/cloud/answer/6158840).
  1805. // This field has been deprecated and replaced by the name field.
  1806. string project_id = 1 [
  1807. deprecated = true,
  1808. (google.api.field_behavior) = REQUIRED
  1809. ];
  1810. // Required. Deprecated. The name of the Google Compute Engine
  1811. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1812. // cluster resides. This field has been deprecated and replaced by the name
  1813. // field.
  1814. string zone = 2 [
  1815. deprecated = true,
  1816. (google.api.field_behavior) = REQUIRED
  1817. ];
  1818. // Required. Deprecated. The name of the cluster to upgrade.
  1819. // This field has been deprecated and replaced by the name field.
  1820. string cluster_id = 3 [
  1821. deprecated = true,
  1822. (google.api.field_behavior) = REQUIRED
  1823. ];
  1824. // Required. The logging service the cluster should use to write logs.
  1825. // Currently available options:
  1826. //
  1827. // * `logging.googleapis.com/kubernetes` - The Cloud Logging
  1828. // service with a Kubernetes-native resource model
  1829. // * `logging.googleapis.com` - The legacy Cloud Logging service (no longer
  1830. // available as of GKE 1.15).
  1831. // * `none` - no logs will be exported from the cluster.
  1832. //
  1833. // If left as an empty string,`logging.googleapis.com/kubernetes` will be
  1834. // used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
  1835. string logging_service = 4 [(google.api.field_behavior) = REQUIRED];
  1836. // The name (project, location, cluster) of the cluster to set logging.
  1837. // Specified in the format `projects/*/locations/*/clusters/*`.
  1838. string name = 5;
  1839. }
  1840. // SetMonitoringServiceRequest sets the monitoring service of a cluster.
  1841. message SetMonitoringServiceRequest {
  1842. // Required. Deprecated. The Google Developers Console [project ID or project
  1843. // number](https://support.google.com/cloud/answer/6158840).
  1844. // This field has been deprecated and replaced by the name field.
  1845. string project_id = 1 [
  1846. deprecated = true,
  1847. (google.api.field_behavior) = REQUIRED
  1848. ];
  1849. // Required. Deprecated. The name of the Google Compute Engine
  1850. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1851. // cluster resides. This field has been deprecated and replaced by the name
  1852. // field.
  1853. string zone = 2 [
  1854. deprecated = true,
  1855. (google.api.field_behavior) = REQUIRED
  1856. ];
  1857. // Required. Deprecated. The name of the cluster to upgrade.
  1858. // This field has been deprecated and replaced by the name field.
  1859. string cluster_id = 3 [
  1860. deprecated = true,
  1861. (google.api.field_behavior) = REQUIRED
  1862. ];
  1863. // Required. The monitoring service the cluster should use to write metrics.
  1864. // Currently available options:
  1865. //
  1866. // * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring
  1867. // service with a Kubernetes-native resource model
  1868. // * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no
  1869. // longer available as of GKE 1.15).
  1870. // * `none` - No metrics will be exported from the cluster.
  1871. //
  1872. // If left as an empty string,`monitoring.googleapis.com/kubernetes` will be
  1873. // used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
  1874. string monitoring_service = 4 [(google.api.field_behavior) = REQUIRED];
  1875. // The name (project, location, cluster) of the cluster to set monitoring.
  1876. // Specified in the format `projects/*/locations/*/clusters/*`.
  1877. string name = 6;
  1878. }
  1879. // SetAddonsRequest sets the addons associated with the cluster.
  1880. message SetAddonsConfigRequest {
  1881. // Required. Deprecated. The Google Developers Console [project ID or project
  1882. // number](https://support.google.com/cloud/answer/6158840).
  1883. // This field has been deprecated and replaced by the name field.
  1884. string project_id = 1 [
  1885. deprecated = true,
  1886. (google.api.field_behavior) = REQUIRED
  1887. ];
  1888. // Required. Deprecated. The name of the Google Compute Engine
  1889. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1890. // cluster resides. This field has been deprecated and replaced by the name
  1891. // field.
  1892. string zone = 2 [
  1893. deprecated = true,
  1894. (google.api.field_behavior) = REQUIRED
  1895. ];
  1896. // Required. Deprecated. The name of the cluster to upgrade.
  1897. // This field has been deprecated and replaced by the name field.
  1898. string cluster_id = 3 [
  1899. deprecated = true,
  1900. (google.api.field_behavior) = REQUIRED
  1901. ];
  1902. // Required. The desired configurations for the various addons available to run in the
  1903. // cluster.
  1904. AddonsConfig addons_config = 4 [(google.api.field_behavior) = REQUIRED];
  1905. // The name (project, location, cluster) of the cluster to set addons.
  1906. // Specified in the format `projects/*/locations/*/clusters/*`.
  1907. string name = 6;
  1908. }
  1909. // SetLocationsRequest sets the locations of the cluster.
  1910. message SetLocationsRequest {
  1911. // Required. Deprecated. The Google Developers Console [project ID or project
  1912. // number](https://support.google.com/cloud/answer/6158840).
  1913. // This field has been deprecated and replaced by the name field.
  1914. string project_id = 1 [
  1915. deprecated = true,
  1916. (google.api.field_behavior) = REQUIRED
  1917. ];
  1918. // Required. Deprecated. The name of the Google Compute Engine
  1919. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1920. // cluster resides. This field has been deprecated and replaced by the name
  1921. // field.
  1922. string zone = 2 [
  1923. deprecated = true,
  1924. (google.api.field_behavior) = REQUIRED
  1925. ];
  1926. // Required. Deprecated. The name of the cluster to upgrade.
  1927. // This field has been deprecated and replaced by the name field.
  1928. string cluster_id = 3 [
  1929. deprecated = true,
  1930. (google.api.field_behavior) = REQUIRED
  1931. ];
  1932. // Required. The desired list of Google Compute Engine
  1933. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  1934. // cluster's nodes should be located. Changing the locations a cluster is in
  1935. // will result in nodes being either created or removed from the cluster,
  1936. // depending on whether locations are being added or removed.
  1937. //
  1938. // This list must always include the cluster's primary zone.
  1939. repeated string locations = 4 [(google.api.field_behavior) = REQUIRED];
  1940. // The name (project, location, cluster) of the cluster to set locations.
  1941. // Specified in the format `projects/*/locations/*/clusters/*`.
  1942. string name = 6;
  1943. }
  1944. // UpdateMasterRequest updates the master of the cluster.
  1945. message UpdateMasterRequest {
  1946. // Required. Deprecated. The Google Developers Console [project ID or project
  1947. // number](https://support.google.com/cloud/answer/6158840).
  1948. // This field has been deprecated and replaced by the name field.
  1949. string project_id = 1 [
  1950. deprecated = true,
  1951. (google.api.field_behavior) = REQUIRED
  1952. ];
  1953. // Required. Deprecated. The name of the Google Compute Engine
  1954. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  1955. // cluster resides. This field has been deprecated and replaced by the name
  1956. // field.
  1957. string zone = 2 [
  1958. deprecated = true,
  1959. (google.api.field_behavior) = REQUIRED
  1960. ];
  1961. // Required. Deprecated. The name of the cluster to upgrade.
  1962. // This field has been deprecated and replaced by the name field.
  1963. string cluster_id = 3 [
  1964. deprecated = true,
  1965. (google.api.field_behavior) = REQUIRED
  1966. ];
  1967. // Required. The Kubernetes version to change the master to.
  1968. //
  1969. // Users may specify either explicit versions offered by
  1970. // Kubernetes Engine or version aliases, which have the following behavior:
  1971. //
  1972. // - "latest": picks the highest valid Kubernetes version
  1973. // - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  1974. // - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  1975. // - "1.X.Y-gke.N": picks an explicit Kubernetes version
  1976. // - "-": picks the default Kubernetes version
  1977. string master_version = 4 [(google.api.field_behavior) = REQUIRED];
  1978. // The name (project, location, cluster) of the cluster to update.
  1979. // Specified in the format `projects/*/locations/*/clusters/*`.
  1980. string name = 7;
  1981. }
  1982. // SetMasterAuthRequest updates the admin password of a cluster.
  1983. message SetMasterAuthRequest {
  1984. // Operation type: what type update to perform.
  1985. enum Action {
  1986. // Operation is unknown and will error out.
  1987. UNKNOWN = 0;
  1988. // Set the password to a user generated value.
  1989. SET_PASSWORD = 1;
  1990. // Generate a new password and set it to that.
  1991. GENERATE_PASSWORD = 2;
  1992. // Set the username. If an empty username is provided, basic authentication
  1993. // is disabled for the cluster. If a non-empty username is provided, basic
  1994. // authentication is enabled, with either a provided password or a generated
  1995. // one.
  1996. SET_USERNAME = 3;
  1997. }
  1998. // Required. Deprecated. The Google Developers Console [project ID or project
  1999. // number](https://support.google.com/cloud/answer/6158840).
  2000. // This field has been deprecated and replaced by the name field.
  2001. string project_id = 1 [
  2002. deprecated = true,
  2003. (google.api.field_behavior) = REQUIRED
  2004. ];
  2005. // Required. Deprecated. The name of the Google Compute Engine
  2006. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2007. // cluster resides. This field has been deprecated and replaced by the name
  2008. // field.
  2009. string zone = 2 [
  2010. deprecated = true,
  2011. (google.api.field_behavior) = REQUIRED
  2012. ];
  2013. // Required. Deprecated. The name of the cluster to upgrade.
  2014. // This field has been deprecated and replaced by the name field.
  2015. string cluster_id = 3 [
  2016. deprecated = true,
  2017. (google.api.field_behavior) = REQUIRED
  2018. ];
  2019. // Required. The exact form of action to be taken on the master auth.
  2020. Action action = 4 [(google.api.field_behavior) = REQUIRED];
  2021. // Required. A description of the update.
  2022. MasterAuth update = 5 [(google.api.field_behavior) = REQUIRED];
  2023. // The name (project, location, cluster) of the cluster to set auth.
  2024. // Specified in the format `projects/*/locations/*/clusters/*`.
  2025. string name = 7;
  2026. }
  2027. // DeleteClusterRequest deletes a cluster.
  2028. message DeleteClusterRequest {
  2029. // Required. Deprecated. The Google Developers Console [project ID or project
  2030. // number](https://support.google.com/cloud/answer/6158840).
  2031. // This field has been deprecated and replaced by the name field.
  2032. string project_id = 1 [
  2033. deprecated = true,
  2034. (google.api.field_behavior) = REQUIRED
  2035. ];
  2036. // Required. Deprecated. The name of the Google Compute Engine
  2037. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2038. // cluster resides. This field has been deprecated and replaced by the name
  2039. // field.
  2040. string zone = 2 [
  2041. deprecated = true,
  2042. (google.api.field_behavior) = REQUIRED
  2043. ];
  2044. // Required. Deprecated. The name of the cluster to delete.
  2045. // This field has been deprecated and replaced by the name field.
  2046. string cluster_id = 3 [
  2047. deprecated = true,
  2048. (google.api.field_behavior) = REQUIRED
  2049. ];
  2050. // The name (project, location, cluster) of the cluster to delete.
  2051. // Specified in the format `projects/*/locations/*/clusters/*`.
  2052. string name = 4;
  2053. }
  2054. // ListClustersRequest lists clusters.
  2055. message ListClustersRequest {
  2056. // Required. Deprecated. The Google Developers Console [project ID or project
  2057. // number](https://support.google.com/cloud/answer/6158840).
  2058. // This field has been deprecated and replaced by the parent field.
  2059. string project_id = 1 [
  2060. deprecated = true,
  2061. (google.api.field_behavior) = REQUIRED
  2062. ];
  2063. // Required. Deprecated. The name of the Google Compute Engine
  2064. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2065. // cluster resides, or "-" for all zones. This field has been deprecated and
  2066. // replaced by the parent field.
  2067. string zone = 2 [
  2068. deprecated = true,
  2069. (google.api.field_behavior) = REQUIRED
  2070. ];
  2071. // The parent (project and location) where the clusters will be listed.
  2072. // Specified in the format `projects/*/locations/*`.
  2073. // Location "-" matches all zones and all regions.
  2074. string parent = 4;
  2075. }
  2076. // ListClustersResponse is the result of ListClustersRequest.
  2077. message ListClustersResponse {
  2078. // A list of clusters in the project in the specified zone, or
  2079. // across all ones.
  2080. repeated Cluster clusters = 1;
  2081. // If any zones are listed here, the list of clusters returned
  2082. // may be missing those zones.
  2083. repeated string missing_zones = 2;
  2084. }
  2085. // GetOperationRequest gets a single operation.
  2086. message GetOperationRequest {
  2087. // Required. Deprecated. The Google Developers Console [project ID or project
  2088. // number](https://support.google.com/cloud/answer/6158840).
  2089. // This field has been deprecated and replaced by the name field.
  2090. string project_id = 1 [
  2091. deprecated = true,
  2092. (google.api.field_behavior) = REQUIRED
  2093. ];
  2094. // Required. Deprecated. The name of the Google Compute Engine
  2095. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2096. // cluster resides. This field has been deprecated and replaced by the name
  2097. // field.
  2098. string zone = 2 [
  2099. deprecated = true,
  2100. (google.api.field_behavior) = REQUIRED
  2101. ];
  2102. // Required. Deprecated. The server-assigned `name` of the operation.
  2103. // This field has been deprecated and replaced by the name field.
  2104. string operation_id = 3 [
  2105. deprecated = true,
  2106. (google.api.field_behavior) = REQUIRED
  2107. ];
  2108. // The name (project, location, operation id) of the operation to get.
  2109. // Specified in the format `projects/*/locations/*/operations/*`.
  2110. string name = 5;
  2111. }
  2112. // ListOperationsRequest lists operations.
  2113. message ListOperationsRequest {
  2114. // Required. Deprecated. The Google Developers Console [project ID or project
  2115. // number](https://support.google.com/cloud/answer/6158840).
  2116. // This field has been deprecated and replaced by the parent field.
  2117. string project_id = 1 [
  2118. deprecated = true,
  2119. (google.api.field_behavior) = REQUIRED
  2120. ];
  2121. // Required. Deprecated. The name of the Google Compute Engine
  2122. // [zone](https://cloud.google.com/compute/docs/zones#available) to return
  2123. // operations for, or `-` for all zones. This field has been deprecated and
  2124. // replaced by the parent field.
  2125. string zone = 2 [
  2126. deprecated = true,
  2127. (google.api.field_behavior) = REQUIRED
  2128. ];
  2129. // The parent (project and location) where the operations will be listed.
  2130. // Specified in the format `projects/*/locations/*`.
  2131. // Location "-" matches all zones and all regions.
  2132. string parent = 4;
  2133. }
  2134. // CancelOperationRequest cancels a single operation.
  2135. message CancelOperationRequest {
  2136. // Required. Deprecated. The Google Developers Console [project ID or project
  2137. // number](https://support.google.com/cloud/answer/6158840).
  2138. // This field has been deprecated and replaced by the name field.
  2139. string project_id = 1 [
  2140. deprecated = true,
  2141. (google.api.field_behavior) = REQUIRED
  2142. ];
  2143. // Required. Deprecated. The name of the Google Compute Engine
  2144. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2145. // operation resides. This field has been deprecated and replaced by the name
  2146. // field.
  2147. string zone = 2 [
  2148. deprecated = true,
  2149. (google.api.field_behavior) = REQUIRED
  2150. ];
  2151. // Required. Deprecated. The server-assigned `name` of the operation.
  2152. // This field has been deprecated and replaced by the name field.
  2153. string operation_id = 3 [
  2154. deprecated = true,
  2155. (google.api.field_behavior) = REQUIRED
  2156. ];
  2157. // The name (project, location, operation id) of the operation to cancel.
  2158. // Specified in the format `projects/*/locations/*/operations/*`.
  2159. string name = 4;
  2160. }
  2161. // ListOperationsResponse is the result of ListOperationsRequest.
  2162. message ListOperationsResponse {
  2163. // A list of operations in the project in the specified zone.
  2164. repeated Operation operations = 1;
  2165. // If any zones are listed here, the list of operations returned
  2166. // may be missing the operations from those zones.
  2167. repeated string missing_zones = 2;
  2168. }
  2169. // Gets the current Kubernetes Engine service configuration.
  2170. message GetServerConfigRequest {
  2171. // Required. Deprecated. The Google Developers Console [project ID or project
  2172. // number](https://support.google.com/cloud/answer/6158840).
  2173. // This field has been deprecated and replaced by the name field.
  2174. string project_id = 1 [
  2175. deprecated = true,
  2176. (google.api.field_behavior) = REQUIRED
  2177. ];
  2178. // Required. Deprecated. The name of the Google Compute Engine
  2179. // [zone](https://cloud.google.com/compute/docs/zones#available) to return
  2180. // operations for. This field has been deprecated and replaced by the name
  2181. // field.
  2182. string zone = 2 [
  2183. deprecated = true,
  2184. (google.api.field_behavior) = REQUIRED
  2185. ];
  2186. // The name (project and location) of the server config to get,
  2187. // specified in the format `projects/*/locations/*`.
  2188. string name = 4;
  2189. }
  2190. // Kubernetes Engine service configuration.
  2191. message ServerConfig {
  2192. // ReleaseChannelConfig exposes configuration for a release channel.
  2193. message ReleaseChannelConfig {
  2194. // Deprecated.
  2195. message AvailableVersion {
  2196. option deprecated = true;
  2197. // Kubernetes version.
  2198. string version = 1;
  2199. // Reason for availability.
  2200. string reason = 2;
  2201. }
  2202. // The release channel this configuration applies to.
  2203. ReleaseChannel.Channel channel = 1;
  2204. // The default version for newly created clusters on the channel.
  2205. string default_version = 2;
  2206. // Deprecated.
  2207. // This field has been deprecated and replaced with the valid_versions
  2208. // field.
  2209. repeated AvailableVersion available_versions = 3 [deprecated = true];
  2210. // List of valid versions for the channel.
  2211. repeated string valid_versions = 4;
  2212. }
  2213. // Version of Kubernetes the service deploys by default.
  2214. string default_cluster_version = 1;
  2215. // List of valid node upgrade target versions, in descending order.
  2216. repeated string valid_node_versions = 3;
  2217. // Default image type.
  2218. string default_image_type = 4;
  2219. // List of valid image types.
  2220. repeated string valid_image_types = 5;
  2221. // List of valid master versions, in descending order.
  2222. repeated string valid_master_versions = 6;
  2223. // List of release channel configurations.
  2224. repeated ReleaseChannelConfig channels = 9;
  2225. }
  2226. // CreateNodePoolRequest creates a node pool for a cluster.
  2227. message CreateNodePoolRequest {
  2228. // Required. Deprecated. The Google Developers Console [project ID or project
  2229. // number](https://developers.google.com/console/help/new/#projectnumber).
  2230. // This field has been deprecated and replaced by the parent field.
  2231. string project_id = 1 [
  2232. deprecated = true,
  2233. (google.api.field_behavior) = REQUIRED
  2234. ];
  2235. // Required. Deprecated. The name of the Google Compute Engine
  2236. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2237. // cluster resides. This field has been deprecated and replaced by the parent
  2238. // field.
  2239. string zone = 2 [
  2240. deprecated = true,
  2241. (google.api.field_behavior) = REQUIRED
  2242. ];
  2243. // Required. Deprecated. The name of the cluster.
  2244. // This field has been deprecated and replaced by the parent field.
  2245. string cluster_id = 3 [
  2246. deprecated = true,
  2247. (google.api.field_behavior) = REQUIRED
  2248. ];
  2249. // Required. The node pool to create.
  2250. NodePool node_pool = 4 [(google.api.field_behavior) = REQUIRED];
  2251. // The parent (project, location, cluster id) where the node pool will be
  2252. // created. Specified in the format
  2253. // `projects/*/locations/*/clusters/*`.
  2254. string parent = 6;
  2255. }
  2256. // DeleteNodePoolRequest deletes a node pool for a cluster.
  2257. message DeleteNodePoolRequest {
  2258. // Required. Deprecated. The Google Developers Console [project ID or project
  2259. // number](https://developers.google.com/console/help/new/#projectnumber).
  2260. // This field has been deprecated and replaced by the name field.
  2261. string project_id = 1 [
  2262. deprecated = true,
  2263. (google.api.field_behavior) = REQUIRED
  2264. ];
  2265. // Required. Deprecated. The name of the Google Compute Engine
  2266. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2267. // cluster resides. This field has been deprecated and replaced by the name
  2268. // field.
  2269. string zone = 2 [
  2270. deprecated = true,
  2271. (google.api.field_behavior) = REQUIRED
  2272. ];
  2273. // Required. Deprecated. The name of the cluster.
  2274. // This field has been deprecated and replaced by the name field.
  2275. string cluster_id = 3 [
  2276. deprecated = true,
  2277. (google.api.field_behavior) = REQUIRED
  2278. ];
  2279. // Required. Deprecated. The name of the node pool to delete.
  2280. // This field has been deprecated and replaced by the name field.
  2281. string node_pool_id = 4 [
  2282. deprecated = true,
  2283. (google.api.field_behavior) = REQUIRED
  2284. ];
  2285. // The name (project, location, cluster, node pool id) of the node pool to
  2286. // delete. Specified in the format
  2287. // `projects/*/locations/*/clusters/*/nodePools/*`.
  2288. string name = 6;
  2289. }
  2290. // ListNodePoolsRequest lists the node pool(s) for a cluster.
  2291. message ListNodePoolsRequest {
  2292. // Required. Deprecated. The Google Developers Console [project ID or project
  2293. // number](https://developers.google.com/console/help/new/#projectnumber).
  2294. // This field has been deprecated and replaced by the parent field.
  2295. string project_id = 1 [
  2296. deprecated = true,
  2297. (google.api.field_behavior) = REQUIRED
  2298. ];
  2299. // Required. Deprecated. The name of the Google Compute Engine
  2300. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2301. // cluster resides. This field has been deprecated and replaced by the parent
  2302. // field.
  2303. string zone = 2 [
  2304. deprecated = true,
  2305. (google.api.field_behavior) = REQUIRED
  2306. ];
  2307. // Required. Deprecated. The name of the cluster.
  2308. // This field has been deprecated and replaced by the parent field.
  2309. string cluster_id = 3 [
  2310. deprecated = true,
  2311. (google.api.field_behavior) = REQUIRED
  2312. ];
  2313. // The parent (project, location, cluster id) where the node pools will be
  2314. // listed. Specified in the format `projects/*/locations/*/clusters/*`.
  2315. string parent = 5;
  2316. }
  2317. // GetNodePoolRequest retrieves a node pool for a cluster.
  2318. message GetNodePoolRequest {
  2319. // Required. Deprecated. The Google Developers Console [project ID or project
  2320. // number](https://developers.google.com/console/help/new/#projectnumber).
  2321. // This field has been deprecated and replaced by the name field.
  2322. string project_id = 1 [
  2323. deprecated = true,
  2324. (google.api.field_behavior) = REQUIRED
  2325. ];
  2326. // Required. Deprecated. The name of the Google Compute Engine
  2327. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2328. // cluster resides. This field has been deprecated and replaced by the name
  2329. // field.
  2330. string zone = 2 [
  2331. deprecated = true,
  2332. (google.api.field_behavior) = REQUIRED
  2333. ];
  2334. // Required. Deprecated. The name of the cluster.
  2335. // This field has been deprecated and replaced by the name field.
  2336. string cluster_id = 3 [
  2337. deprecated = true,
  2338. (google.api.field_behavior) = REQUIRED
  2339. ];
  2340. // Required. Deprecated. The name of the node pool.
  2341. // This field has been deprecated and replaced by the name field.
  2342. string node_pool_id = 4 [
  2343. deprecated = true,
  2344. (google.api.field_behavior) = REQUIRED
  2345. ];
  2346. // The name (project, location, cluster, node pool id) of the node pool to
  2347. // get. Specified in the format
  2348. // `projects/*/locations/*/clusters/*/nodePools/*`.
  2349. string name = 6;
  2350. }
  2351. // NodePool contains the name and configuration for a cluster's node pool.
  2352. // Node pools are a set of nodes (i.e. VM's), with a common configuration and
  2353. // specification, under the control of the cluster master. They may have a set
  2354. // of Kubernetes labels applied to them, which may be used to reference them
  2355. // during pod scheduling. They may also be resized up or down, to accommodate
  2356. // the workload.
  2357. message NodePool {
  2358. // These upgrade settings control the level of parallelism and the level of
  2359. // disruption caused by an upgrade.
  2360. //
  2361. // maxUnavailable controls the number of nodes that can be simultaneously
  2362. // unavailable.
  2363. //
  2364. // maxSurge controls the number of additional nodes that can be added to the
  2365. // node pool temporarily for the time of the upgrade to increase the number of
  2366. // available nodes.
  2367. //
  2368. // (maxUnavailable + maxSurge) determines the level of parallelism (how many
  2369. // nodes are being upgraded at the same time).
  2370. //
  2371. // Note: upgrades inevitably introduce some disruption since workloads need to
  2372. // be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0,
  2373. // this holds true. (Disruption stays within the limits of
  2374. // PodDisruptionBudget, if it is configured.)
  2375. //
  2376. // Consider a hypothetical node pool with 5 nodes having maxSurge=2,
  2377. // maxUnavailable=1. This means the upgrade process upgrades 3 nodes
  2378. // simultaneously. It creates 2 additional (upgraded) nodes, then it brings
  2379. // down 3 old (not yet upgraded) nodes at the same time. This ensures that
  2380. // there are always at least 4 nodes available.
  2381. message UpgradeSettings {
  2382. // The maximum number of nodes that can be created beyond the current size
  2383. // of the node pool during the upgrade process.
  2384. int32 max_surge = 1;
  2385. // The maximum number of nodes that can be simultaneously unavailable during
  2386. // the upgrade process. A node is considered available if its status is
  2387. // Ready.
  2388. int32 max_unavailable = 2;
  2389. }
  2390. // The current status of the node pool instance.
  2391. enum Status {
  2392. // Not set.
  2393. STATUS_UNSPECIFIED = 0;
  2394. // The PROVISIONING state indicates the node pool is being created.
  2395. PROVISIONING = 1;
  2396. // The RUNNING state indicates the node pool has been created
  2397. // and is fully usable.
  2398. RUNNING = 2;
  2399. // The RUNNING_WITH_ERROR state indicates the node pool has been created
  2400. // and is partially usable. Some error state has occurred and some
  2401. // functionality may be impaired. Customer may need to reissue a request
  2402. // or trigger a new update.
  2403. RUNNING_WITH_ERROR = 3;
  2404. // The RECONCILING state indicates that some work is actively being done on
  2405. // the node pool, such as upgrading node software. Details can
  2406. // be found in the `statusMessage` field.
  2407. RECONCILING = 4;
  2408. // The STOPPING state indicates the node pool is being deleted.
  2409. STOPPING = 5;
  2410. // The ERROR state indicates the node pool may be unusable. Details
  2411. // can be found in the `statusMessage` field.
  2412. ERROR = 6;
  2413. }
  2414. // The name of the node pool.
  2415. string name = 1;
  2416. // The node configuration of the pool.
  2417. NodeConfig config = 2;
  2418. // The initial node count for the pool. You must ensure that your
  2419. // Compute Engine [resource quota](https://cloud.google.com/compute/quotas)
  2420. // is sufficient for this number of instances. You must also have available
  2421. // firewall and routes quota.
  2422. int32 initial_node_count = 3;
  2423. // The list of Google Compute Engine
  2424. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  2425. // NodePool's nodes should be located.
  2426. //
  2427. // If this value is unspecified during node pool creation, the
  2428. // [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations)
  2429. // value will be used, instead.
  2430. //
  2431. // Warning: changing node pool locations will result in nodes being added
  2432. // and/or removed.
  2433. repeated string locations = 13;
  2434. // [Output only] Server-defined URL for the resource.
  2435. string self_link = 100;
  2436. // The version of the Kubernetes of this node.
  2437. string version = 101;
  2438. // [Output only] The resource URLs of the [managed instance
  2439. // groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances)
  2440. // associated with this node pool.
  2441. repeated string instance_group_urls = 102;
  2442. // [Output only] The status of the nodes in this pool instance.
  2443. Status status = 103;
  2444. // [Output only] Deprecated. Use conditions instead.
  2445. // Additional information about the current status of this
  2446. // node pool instance, if available.
  2447. string status_message = 104 [deprecated = true];
  2448. // Autoscaler configuration for this NodePool. Autoscaler is enabled
  2449. // only if a valid configuration is present.
  2450. NodePoolAutoscaling autoscaling = 4;
  2451. // NodeManagement configuration for this NodePool.
  2452. NodeManagement management = 5;
  2453. // The constraint on the maximum number of pods that can be run
  2454. // simultaneously on a node in the node pool.
  2455. MaxPodsConstraint max_pods_constraint = 6;
  2456. // Which conditions caused the current node pool state.
  2457. repeated StatusCondition conditions = 105;
  2458. // [Output only] The pod CIDR block size per node in this node pool.
  2459. int32 pod_ipv4_cidr_size = 7;
  2460. // Upgrade settings control disruption and speed of the upgrade.
  2461. UpgradeSettings upgrade_settings = 107;
  2462. }
  2463. // NodeManagement defines the set of node management services turned on for the
  2464. // node pool.
  2465. message NodeManagement {
  2466. // Whether the nodes will be automatically upgraded.
  2467. bool auto_upgrade = 1;
  2468. // Whether the nodes will be automatically repaired.
  2469. bool auto_repair = 2;
  2470. // Specifies the Auto Upgrade knobs for the node pool.
  2471. AutoUpgradeOptions upgrade_options = 10;
  2472. }
  2473. // AutoUpgradeOptions defines the set of options for the user to control how
  2474. // the Auto Upgrades will proceed.
  2475. message AutoUpgradeOptions {
  2476. // [Output only] This field is set when upgrades are about to commence
  2477. // with the approximate start time for the upgrades, in
  2478. // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  2479. string auto_upgrade_start_time = 1;
  2480. // [Output only] This field is set when upgrades are about to commence
  2481. // with the description of the upgrade.
  2482. string description = 2;
  2483. }
  2484. // MaintenancePolicy defines the maintenance policy to be used for the cluster.
  2485. message MaintenancePolicy {
  2486. // Specifies the maintenance window in which maintenance may be performed.
  2487. MaintenanceWindow window = 1;
  2488. // A hash identifying the version of this policy, so that updates to fields of
  2489. // the policy won't accidentally undo intermediate changes (and so that users
  2490. // of the API unaware of some fields won't accidentally remove other fields).
  2491. // Make a `get()` request to the cluster to get the current
  2492. // resource version and include it with requests to set the policy.
  2493. string resource_version = 3;
  2494. }
  2495. // MaintenanceWindow defines the maintenance window to be used for the cluster.
  2496. message MaintenanceWindow {
  2497. // Unimplemented, reserved for future use.
  2498. // HourlyMaintenanceWindow hourly_maintenance_window = 1;
  2499. oneof policy {
  2500. // DailyMaintenanceWindow specifies a daily maintenance operation window.
  2501. DailyMaintenanceWindow daily_maintenance_window = 2;
  2502. // RecurringWindow specifies some number of recurring time periods for
  2503. // maintenance to occur. The time windows may be overlapping. If no
  2504. // maintenance windows are set, maintenance can occur at any time.
  2505. RecurringTimeWindow recurring_window = 3;
  2506. }
  2507. // Exceptions to maintenance window. Non-emergency maintenance should not
  2508. // occur in these windows.
  2509. map<string, TimeWindow> maintenance_exclusions = 4;
  2510. }
  2511. // Represents an arbitrary window of time.
  2512. message TimeWindow {
  2513. // The time that the window first starts.
  2514. google.protobuf.Timestamp start_time = 1;
  2515. // The time that the window ends. The end time should take place after the
  2516. // start time.
  2517. google.protobuf.Timestamp end_time = 2;
  2518. }
  2519. // Represents an arbitrary window of time that recurs.
  2520. message RecurringTimeWindow {
  2521. // The window of the first recurrence.
  2522. TimeWindow window = 1;
  2523. // An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how
  2524. // this window reccurs. They go on for the span of time between the start and
  2525. // end time.
  2526. //
  2527. // For example, to have something repeat every weekday, you'd use:
  2528. // `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR`
  2529. //
  2530. // To repeat some window daily (equivalent to the DailyMaintenanceWindow):
  2531. // `FREQ=DAILY`
  2532. //
  2533. // For the first weekend of every month:
  2534. // `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU`
  2535. //
  2536. // This specifies how frequently the window starts. Eg, if you wanted to have
  2537. // a 9-5 UTC-4 window every weekday, you'd use something like:
  2538. // ```
  2539. // start time = 2019-01-01T09:00:00-0400
  2540. // end time = 2019-01-01T17:00:00-0400
  2541. // recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
  2542. // ```
  2543. //
  2544. // Windows can span multiple days. Eg, to make the window encompass every
  2545. // weekend from midnight Saturday till the last minute of Sunday UTC:
  2546. // ```
  2547. // start time = 2019-01-05T00:00:00Z
  2548. // end time = 2019-01-07T23:59:00Z
  2549. // recurrence = FREQ=WEEKLY;BYDAY=SA
  2550. // ```
  2551. //
  2552. // Note the start and end time's specific dates are largely arbitrary except
  2553. // to specify duration of the window and when it first starts.
  2554. // The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.
  2555. string recurrence = 2;
  2556. }
  2557. // Time window specified for daily maintenance operations.
  2558. message DailyMaintenanceWindow {
  2559. // Time within the maintenance window to start the maintenance operations.
  2560. // It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
  2561. string start_time = 2;
  2562. // [Output only] Duration of the time window, automatically chosen to be
  2563. // smallest possible in the given scenario.
  2564. string duration = 3;
  2565. }
  2566. // SetNodePoolManagementRequest sets the node management properties of a node
  2567. // pool.
  2568. message SetNodePoolManagementRequest {
  2569. // Required. Deprecated. The Google Developers Console [project ID or project
  2570. // number](https://support.google.com/cloud/answer/6158840).
  2571. // This field has been deprecated and replaced by the name field.
  2572. string project_id = 1 [
  2573. deprecated = true,
  2574. (google.api.field_behavior) = REQUIRED
  2575. ];
  2576. // Required. Deprecated. The name of the Google Compute Engine
  2577. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2578. // cluster resides. This field has been deprecated and replaced by the name
  2579. // field.
  2580. string zone = 2 [
  2581. deprecated = true,
  2582. (google.api.field_behavior) = REQUIRED
  2583. ];
  2584. // Required. Deprecated. The name of the cluster to update.
  2585. // This field has been deprecated and replaced by the name field.
  2586. string cluster_id = 3 [
  2587. deprecated = true,
  2588. (google.api.field_behavior) = REQUIRED
  2589. ];
  2590. // Required. Deprecated. The name of the node pool to update.
  2591. // This field has been deprecated and replaced by the name field.
  2592. string node_pool_id = 4 [
  2593. deprecated = true,
  2594. (google.api.field_behavior) = REQUIRED
  2595. ];
  2596. // Required. NodeManagement configuration for the node pool.
  2597. NodeManagement management = 5 [(google.api.field_behavior) = REQUIRED];
  2598. // The name (project, location, cluster, node pool id) of the node pool to set
  2599. // management properties. Specified in the format
  2600. // `projects/*/locations/*/clusters/*/nodePools/*`.
  2601. string name = 7;
  2602. }
  2603. // SetNodePoolSizeRequest sets the size a node
  2604. // pool.
  2605. message SetNodePoolSizeRequest {
  2606. // Required. Deprecated. The Google Developers Console [project ID or project
  2607. // number](https://support.google.com/cloud/answer/6158840).
  2608. // This field has been deprecated and replaced by the name field.
  2609. string project_id = 1 [
  2610. deprecated = true,
  2611. (google.api.field_behavior) = REQUIRED
  2612. ];
  2613. // Required. Deprecated. The name of the Google Compute Engine
  2614. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2615. // cluster resides. This field has been deprecated and replaced by the name
  2616. // field.
  2617. string zone = 2 [
  2618. deprecated = true,
  2619. (google.api.field_behavior) = REQUIRED
  2620. ];
  2621. // Required. Deprecated. The name of the cluster to update.
  2622. // This field has been deprecated and replaced by the name field.
  2623. string cluster_id = 3 [
  2624. deprecated = true,
  2625. (google.api.field_behavior) = REQUIRED
  2626. ];
  2627. // Required. Deprecated. The name of the node pool to update.
  2628. // This field has been deprecated and replaced by the name field.
  2629. string node_pool_id = 4 [
  2630. deprecated = true,
  2631. (google.api.field_behavior) = REQUIRED
  2632. ];
  2633. // Required. The desired node count for the pool.
  2634. int32 node_count = 5 [(google.api.field_behavior) = REQUIRED];
  2635. // The name (project, location, cluster, node pool id) of the node pool to set
  2636. // size.
  2637. // Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  2638. string name = 7;
  2639. }
  2640. // RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed
  2641. // NodePool upgrade. This will be an no-op if the last upgrade successfully
  2642. // completed.
  2643. message RollbackNodePoolUpgradeRequest {
  2644. // Required. Deprecated. The Google Developers Console [project ID or project
  2645. // number](https://support.google.com/cloud/answer/6158840).
  2646. // This field has been deprecated and replaced by the name field.
  2647. string project_id = 1 [
  2648. deprecated = true,
  2649. (google.api.field_behavior) = REQUIRED
  2650. ];
  2651. // Required. Deprecated. The name of the Google Compute Engine
  2652. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2653. // cluster resides. This field has been deprecated and replaced by the name
  2654. // field.
  2655. string zone = 2 [
  2656. deprecated = true,
  2657. (google.api.field_behavior) = REQUIRED
  2658. ];
  2659. // Required. Deprecated. The name of the cluster to rollback.
  2660. // This field has been deprecated and replaced by the name field.
  2661. string cluster_id = 3 [
  2662. deprecated = true,
  2663. (google.api.field_behavior) = REQUIRED
  2664. ];
  2665. // Required. Deprecated. The name of the node pool to rollback.
  2666. // This field has been deprecated and replaced by the name field.
  2667. string node_pool_id = 4 [
  2668. deprecated = true,
  2669. (google.api.field_behavior) = REQUIRED
  2670. ];
  2671. // The name (project, location, cluster, node pool id) of the node poll to
  2672. // rollback upgrade.
  2673. // Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
  2674. string name = 6;
  2675. }
  2676. // ListNodePoolsResponse is the result of ListNodePoolsRequest.
  2677. message ListNodePoolsResponse {
  2678. // A list of node pools for a cluster.
  2679. repeated NodePool node_pools = 1;
  2680. }
  2681. // ClusterAutoscaling contains global, per-cluster information
  2682. // required by Cluster Autoscaler to automatically adjust
  2683. // the size of the cluster and create/delete
  2684. // node pools based on the current needs.
  2685. message ClusterAutoscaling {
  2686. // Defines possible options for autoscaling_profile field.
  2687. enum AutoscalingProfile {
  2688. // No change to autoscaling configuration.
  2689. PROFILE_UNSPECIFIED = 0;
  2690. // Prioritize optimizing utilization of resources.
  2691. OPTIMIZE_UTILIZATION = 1;
  2692. // Use default (balanced) autoscaling configuration.
  2693. BALANCED = 2;
  2694. }
  2695. // Enables automatic node pool creation and deletion.
  2696. bool enable_node_autoprovisioning = 1;
  2697. // Contains global constraints regarding minimum and maximum
  2698. // amount of resources in the cluster.
  2699. repeated ResourceLimit resource_limits = 2;
  2700. // Defines autoscaling behaviour.
  2701. AutoscalingProfile autoscaling_profile = 3;
  2702. // AutoprovisioningNodePoolDefaults contains defaults for a node pool
  2703. // created by NAP.
  2704. AutoprovisioningNodePoolDefaults autoprovisioning_node_pool_defaults = 4;
  2705. // The list of Google Compute Engine
  2706. // [zones](https://cloud.google.com/compute/docs/zones#available) in which the
  2707. // NodePool's nodes can be created by NAP.
  2708. repeated string autoprovisioning_locations = 5;
  2709. }
  2710. // AutoprovisioningNodePoolDefaults contains defaults for a node pool created
  2711. // by NAP.
  2712. message AutoprovisioningNodePoolDefaults {
  2713. // The set of Google API scopes to be made available on all of the
  2714. // node VMs under the "default" service account.
  2715. //
  2716. // The following scopes are recommended, but not required, and by default are
  2717. // not included:
  2718. //
  2719. // * `https://www.googleapis.com/auth/compute` is required for mounting
  2720. // persistent storage on your nodes.
  2721. // * `https://www.googleapis.com/auth/devstorage.read_only` is required for
  2722. // communicating with **gcr.io**
  2723. // (the [Google Container
  2724. // Registry](https://cloud.google.com/container-registry/)).
  2725. //
  2726. // If unspecified, no scopes are added, unless Cloud Logging or Cloud
  2727. // Monitoring are enabled, in which case their required scopes will be added.
  2728. repeated string oauth_scopes = 1;
  2729. // The Google Cloud Platform Service Account to be used by the node VMs.
  2730. // Specify the email address of the Service Account; otherwise, if no Service
  2731. // Account is specified, the "default" service account is used.
  2732. string service_account = 2;
  2733. // Upgrade settings control disruption and speed of the upgrade.
  2734. NodePool.UpgradeSettings upgrade_settings = 3;
  2735. // NodeManagement configuration for this NodePool.
  2736. NodeManagement management = 4;
  2737. // Minimum CPU platform to be used by this instance. The instance may be
  2738. // scheduled on the specified or newer CPU platform. Applicable values are the
  2739. // friendly names of CPU platforms, such as
  2740. // `minCpuPlatform: "Intel Haswell"` or
  2741. // `minCpuPlatform: "Intel Sandy Bridge"`. For more
  2742. // information, read [how to specify min CPU
  2743. // platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
  2744. // To unset the min cpu platform field pass "automatic"
  2745. // as field value.
  2746. string min_cpu_platform = 5;
  2747. // Size of the disk attached to each node, specified in GB.
  2748. // The smallest allowed disk size is 10GB.
  2749. //
  2750. // If unspecified, the default disk size is 100GB.
  2751. int32 disk_size_gb = 6;
  2752. // Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or
  2753. // 'pd-balanced')
  2754. //
  2755. // If unspecified, the default disk type is 'pd-standard'
  2756. string disk_type = 7;
  2757. // Shielded Instance options.
  2758. ShieldedInstanceConfig shielded_instance_config = 8;
  2759. //
  2760. // The Customer Managed Encryption Key used to encrypt the boot disk attached
  2761. // to each node in the node pool. This should be of the form
  2762. // projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME].
  2763. // For more information about protecting resources with Cloud KMS Keys please
  2764. // see:
  2765. // https://cloud.google.com/compute/docs/disks/customer-managed-encryption
  2766. string boot_disk_kms_key = 9;
  2767. // The image type to use for node created by NodeAutoprovisioning.
  2768. string image_type = 10;
  2769. }
  2770. // Contains information about amount of some resource in the cluster.
  2771. // For memory, value should be in GB.
  2772. message ResourceLimit {
  2773. // Resource name "cpu", "memory" or gpu-specific string.
  2774. string resource_type = 1;
  2775. // Minimum amount of the resource in the cluster.
  2776. int64 minimum = 2;
  2777. // Maximum amount of the resource in the cluster.
  2778. int64 maximum = 3;
  2779. }
  2780. // NodePoolAutoscaling contains information required by cluster autoscaler to
  2781. // adjust the size of the node pool to the current cluster usage.
  2782. message NodePoolAutoscaling {
  2783. // Is autoscaling enabled for this node pool.
  2784. bool enabled = 1;
  2785. // Minimum number of nodes in the NodePool. Must be >= 1 and <=
  2786. // max_node_count.
  2787. int32 min_node_count = 2;
  2788. // Maximum number of nodes in the NodePool. Must be >= min_node_count. There
  2789. // has to enough quota to scale up the cluster.
  2790. int32 max_node_count = 3;
  2791. // Can this node pool be deleted automatically.
  2792. bool autoprovisioned = 4;
  2793. }
  2794. // SetLabelsRequest sets the Google Cloud Platform labels on a Google Container
  2795. // Engine cluster, which will in turn set them for Google Compute Engine
  2796. // resources used by that cluster
  2797. message SetLabelsRequest {
  2798. // Required. Deprecated. The Google Developers Console [project ID or project
  2799. // number](https://developers.google.com/console/help/new/#projectnumber).
  2800. // This field has been deprecated and replaced by the name field.
  2801. string project_id = 1 [
  2802. deprecated = true,
  2803. (google.api.field_behavior) = REQUIRED
  2804. ];
  2805. // Required. Deprecated. The name of the Google Compute Engine
  2806. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2807. // cluster resides. This field has been deprecated and replaced by the name
  2808. // field.
  2809. string zone = 2 [
  2810. deprecated = true,
  2811. (google.api.field_behavior) = REQUIRED
  2812. ];
  2813. // Required. Deprecated. The name of the cluster.
  2814. // This field has been deprecated and replaced by the name field.
  2815. string cluster_id = 3 [
  2816. deprecated = true,
  2817. (google.api.field_behavior) = REQUIRED
  2818. ];
  2819. // Required. The labels to set for that cluster.
  2820. map<string, string> resource_labels = 4 [(google.api.field_behavior) = REQUIRED];
  2821. // Required. The fingerprint of the previous set of labels for this resource,
  2822. // used to detect conflicts. The fingerprint is initially generated by
  2823. // Kubernetes Engine and changes after every request to modify or update
  2824. // labels. You must always provide an up-to-date fingerprint hash when
  2825. // updating or changing labels. Make a `get()` request to the
  2826. // resource to get the latest fingerprint.
  2827. string label_fingerprint = 5 [(google.api.field_behavior) = REQUIRED];
  2828. // The name (project, location, cluster id) of the cluster to set labels.
  2829. // Specified in the format `projects/*/locations/*/clusters/*`.
  2830. string name = 7;
  2831. }
  2832. // SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for
  2833. // a cluster.
  2834. message SetLegacyAbacRequest {
  2835. // Required. Deprecated. The Google Developers Console [project ID or project
  2836. // number](https://support.google.com/cloud/answer/6158840).
  2837. // This field has been deprecated and replaced by the name field.
  2838. string project_id = 1 [
  2839. deprecated = true,
  2840. (google.api.field_behavior) = REQUIRED
  2841. ];
  2842. // Required. Deprecated. The name of the Google Compute Engine
  2843. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2844. // cluster resides. This field has been deprecated and replaced by the name
  2845. // field.
  2846. string zone = 2 [
  2847. deprecated = true,
  2848. (google.api.field_behavior) = REQUIRED
  2849. ];
  2850. // Required. Deprecated. The name of the cluster to update.
  2851. // This field has been deprecated and replaced by the name field.
  2852. string cluster_id = 3 [
  2853. deprecated = true,
  2854. (google.api.field_behavior) = REQUIRED
  2855. ];
  2856. // Required. Whether ABAC authorization will be enabled in the cluster.
  2857. bool enabled = 4 [(google.api.field_behavior) = REQUIRED];
  2858. // The name (project, location, cluster id) of the cluster to set legacy abac.
  2859. // Specified in the format `projects/*/locations/*/clusters/*`.
  2860. string name = 6;
  2861. }
  2862. // StartIPRotationRequest creates a new IP for the cluster and then performs
  2863. // a node upgrade on each node pool to point to the new IP.
  2864. message StartIPRotationRequest {
  2865. // Required. Deprecated. The Google Developers Console [project ID or project
  2866. // number](https://developers.google.com/console/help/new/#projectnumber).
  2867. // This field has been deprecated and replaced by the name field.
  2868. string project_id = 1 [
  2869. deprecated = true,
  2870. (google.api.field_behavior) = REQUIRED
  2871. ];
  2872. // Required. Deprecated. The name of the Google Compute Engine
  2873. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2874. // cluster resides. This field has been deprecated and replaced by the name
  2875. // field.
  2876. string zone = 2 [
  2877. deprecated = true,
  2878. (google.api.field_behavior) = REQUIRED
  2879. ];
  2880. // Required. Deprecated. The name of the cluster.
  2881. // This field has been deprecated and replaced by the name field.
  2882. string cluster_id = 3 [
  2883. deprecated = true,
  2884. (google.api.field_behavior) = REQUIRED
  2885. ];
  2886. // The name (project, location, cluster id) of the cluster to start IP
  2887. // rotation. Specified in the format `projects/*/locations/*/clusters/*`.
  2888. string name = 6;
  2889. // Whether to rotate credentials during IP rotation.
  2890. bool rotate_credentials = 7;
  2891. }
  2892. // CompleteIPRotationRequest moves the cluster master back into single-IP mode.
  2893. message CompleteIPRotationRequest {
  2894. // Required. Deprecated. The Google Developers Console [project ID or project
  2895. // number](https://developers.google.com/console/help/new/#projectnumber).
  2896. // This field has been deprecated and replaced by the name field.
  2897. string project_id = 1 [
  2898. deprecated = true,
  2899. (google.api.field_behavior) = REQUIRED
  2900. ];
  2901. // Required. Deprecated. The name of the Google Compute Engine
  2902. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2903. // cluster resides. This field has been deprecated and replaced by the name
  2904. // field.
  2905. string zone = 2 [
  2906. deprecated = true,
  2907. (google.api.field_behavior) = REQUIRED
  2908. ];
  2909. // Required. Deprecated. The name of the cluster.
  2910. // This field has been deprecated and replaced by the name field.
  2911. string cluster_id = 3 [
  2912. deprecated = true,
  2913. (google.api.field_behavior) = REQUIRED
  2914. ];
  2915. // The name (project, location, cluster id) of the cluster to complete IP
  2916. // rotation. Specified in the format `projects/*/locations/*/clusters/*`.
  2917. string name = 7;
  2918. }
  2919. // AcceleratorConfig represents a Hardware Accelerator request.
  2920. message AcceleratorConfig {
  2921. // The number of the accelerator cards exposed to an instance.
  2922. int64 accelerator_count = 1;
  2923. // The accelerator type resource name. List of supported accelerators
  2924. // [here](https://cloud.google.com/compute/docs/gpus)
  2925. string accelerator_type = 2;
  2926. }
  2927. // WorkloadMetadataConfig defines the metadata configuration to expose to
  2928. // workloads on the node pool.
  2929. message WorkloadMetadataConfig {
  2930. // NodeMetadata is the configuration for if and how to expose the node
  2931. // metadata to the workload running on the node.
  2932. enum NodeMetadata {
  2933. // Not set.
  2934. UNSPECIFIED = 0;
  2935. // Prevent workloads not in hostNetwork from accessing certain VM metadata,
  2936. // specifically kube-env, which contains Kubelet credentials, and the
  2937. // instance identity token.
  2938. //
  2939. // Metadata concealment is a temporary security solution available while the
  2940. // bootstrapping process for cluster nodes is being redesigned with
  2941. // significant security improvements. This feature is scheduled to be
  2942. // deprecated in the future and later removed.
  2943. SECURE = 1;
  2944. // Expose all VM metadata to pods.
  2945. EXPOSE = 2;
  2946. // Run the GKE Metadata Server on this node. The GKE Metadata Server exposes
  2947. // a metadata API to workloads that is compatible with the V1 Compute
  2948. // Metadata APIs exposed by the Compute Engine and App Engine Metadata
  2949. // Servers. This feature can only be enabled if Workload Identity is enabled
  2950. // at the cluster level.
  2951. GKE_METADATA_SERVER = 3;
  2952. }
  2953. // Mode is the configuration for how to expose metadata to workloads running
  2954. // on the node.
  2955. enum Mode {
  2956. // Not set.
  2957. MODE_UNSPECIFIED = 0;
  2958. // Expose all Compute Engine metadata to pods.
  2959. GCE_METADATA = 1;
  2960. // Run the GKE Metadata Server on this node. The GKE Metadata Server exposes
  2961. // a metadata API to workloads that is compatible with the V1 Compute
  2962. // Metadata APIs exposed by the Compute Engine and App Engine Metadata
  2963. // Servers. This feature can only be enabled if Workload Identity is enabled
  2964. // at the cluster level.
  2965. GKE_METADATA = 2;
  2966. }
  2967. // NodeMetadata is the configuration for how to expose metadata to the
  2968. // workloads running on the node.
  2969. NodeMetadata node_metadata = 1 [deprecated = true];
  2970. // Mode is the configuration for how to expose metadata to workloads running
  2971. // on the node pool.
  2972. Mode mode = 2;
  2973. }
  2974. // SetNetworkPolicyRequest enables/disables network policy for a cluster.
  2975. message SetNetworkPolicyRequest {
  2976. // Required. Deprecated. The Google Developers Console [project ID or project
  2977. // number](https://developers.google.com/console/help/new/#projectnumber).
  2978. // This field has been deprecated and replaced by the name field.
  2979. string project_id = 1 [
  2980. deprecated = true,
  2981. (google.api.field_behavior) = REQUIRED
  2982. ];
  2983. // Required. Deprecated. The name of the Google Compute Engine
  2984. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  2985. // cluster resides. This field has been deprecated and replaced by the name
  2986. // field.
  2987. string zone = 2 [
  2988. deprecated = true,
  2989. (google.api.field_behavior) = REQUIRED
  2990. ];
  2991. // Required. Deprecated. The name of the cluster.
  2992. // This field has been deprecated and replaced by the name field.
  2993. string cluster_id = 3 [
  2994. deprecated = true,
  2995. (google.api.field_behavior) = REQUIRED
  2996. ];
  2997. // Required. Configuration options for the NetworkPolicy feature.
  2998. NetworkPolicy network_policy = 4 [(google.api.field_behavior) = REQUIRED];
  2999. // The name (project, location, cluster id) of the cluster to set networking
  3000. // policy. Specified in the format `projects/*/locations/*/clusters/*`.
  3001. string name = 6;
  3002. }
  3003. // SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
  3004. message SetMaintenancePolicyRequest {
  3005. // Required. The Google Developers Console [project ID or project
  3006. // number](https://support.google.com/cloud/answer/6158840).
  3007. string project_id = 1 [(google.api.field_behavior) = REQUIRED];
  3008. // Required. The name of the Google Compute Engine
  3009. // [zone](https://cloud.google.com/compute/docs/zones#available) in which the
  3010. // cluster resides.
  3011. string zone = 2 [(google.api.field_behavior) = REQUIRED];
  3012. // Required. The name of the cluster to update.
  3013. string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
  3014. // Required. The maintenance policy to be set for the cluster. An empty field
  3015. // clears the existing maintenance policy.
  3016. MaintenancePolicy maintenance_policy = 4 [(google.api.field_behavior) = REQUIRED];
  3017. // The name (project, location, cluster id) of the cluster to set maintenance
  3018. // policy.
  3019. // Specified in the format `projects/*/locations/*/clusters/*`.
  3020. string name = 5;
  3021. }
  3022. // ListLocationsRequest is used to request the locations that offer GKE.
  3023. message ListLocationsRequest {
  3024. // Required. Contains the name of the resource requested.
  3025. // Specified in the format `projects/*`.
  3026. string parent = 1 [(google.api.field_behavior) = REQUIRED];
  3027. }
  3028. // ListLocationsResponse returns the list of all GKE locations and their
  3029. // recommendation state.
  3030. message ListLocationsResponse {
  3031. // A full list of GKE locations.
  3032. repeated Location locations = 1;
  3033. // Only return ListLocationsResponse that occur after the page_token. This
  3034. // value should be populated from the ListLocationsResponse.next_page_token if
  3035. // that response token was set (which happens when listing more Locations than
  3036. // fit in a single ListLocationsResponse).
  3037. string next_page_token = 2;
  3038. }
  3039. // Location returns the location name, and if the location is recommended
  3040. // for GKE cluster scheduling.
  3041. message Location {
  3042. // LocationType is the type of GKE location, regional or zonal.
  3043. enum LocationType {
  3044. // LOCATION_TYPE_UNSPECIFIED means the location type was not determined.
  3045. LOCATION_TYPE_UNSPECIFIED = 0;
  3046. // A GKE Location where Zonal clusters can be created.
  3047. ZONE = 1;
  3048. // A GKE Location where Regional clusters can be created.
  3049. REGION = 2;
  3050. }
  3051. // Contains the type of location this Location is for.
  3052. // Regional or Zonal.
  3053. LocationType type = 1;
  3054. // Contains the name of the resource requested.
  3055. // Specified in the format `projects/*/locations/*`.
  3056. string name = 2;
  3057. // Whether the location is recomended for GKE cluster scheduling.
  3058. bool recommended = 3;
  3059. }
  3060. // StatusCondition describes why a cluster or a node pool has a certain status
  3061. // (e.g., ERROR or DEGRADED).
  3062. message StatusCondition {
  3063. // Code for each condition
  3064. enum Code {
  3065. // UNKNOWN indicates a generic condition.
  3066. UNKNOWN = 0;
  3067. // GCE_STOCKOUT indicates that Google Compute Engine resources are
  3068. // temporarily unavailable.
  3069. GCE_STOCKOUT = 1;
  3070. // GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot
  3071. // service account.
  3072. GKE_SERVICE_ACCOUNT_DELETED = 2;
  3073. // Google Compute Engine quota was exceeded.
  3074. GCE_QUOTA_EXCEEDED = 3;
  3075. // Cluster state was manually changed by an SRE due to a system logic error.
  3076. SET_BY_OPERATOR = 4;
  3077. // Unable to perform an encrypt operation against the CloudKMS key used for
  3078. // etcd level encryption.
  3079. // More codes TBA
  3080. CLOUD_KMS_KEY_ERROR = 7;
  3081. }
  3082. // Machine-friendly representation of the condition
  3083. // Deprecated. Use canonical_code instead.
  3084. Code code = 1 [deprecated = true];
  3085. // Human-friendly representation of the condition
  3086. string message = 2;
  3087. // Canonical code of the condition.
  3088. google.rpc.Code canonical_code = 3;
  3089. }
  3090. // NetworkConfig reports the relative names of network & subnetwork.
  3091. message NetworkConfig {
  3092. // Output only. The relative name of the Google Compute Engine
  3093. // [network][google.container.v1beta1.NetworkConfig.network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks)
  3094. // to which the cluster is connected. Example:
  3095. // projects/my-project/global/networks/my-network
  3096. string network = 1;
  3097. // Output only. The relative name of the Google Compute Engine
  3098. // [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the
  3099. // cluster is connected. Example:
  3100. // projects/my-project/regions/us-central1/subnetworks/my-subnet
  3101. string subnetwork = 2;
  3102. // Whether Intra-node visibility is enabled for this cluster.
  3103. // This makes same node pod to pod traffic visible for VPC network.
  3104. bool enable_intra_node_visibility = 5;
  3105. // Whether the cluster disables default in-node sNAT rules. In-node sNAT rules
  3106. // will be disabled when default_snat_status is disabled. When disabled is set
  3107. // to false, default IP masquerade rules will be applied to the nodes to
  3108. // prevent sNAT on cluster internal traffic.
  3109. DefaultSnatStatus default_snat_status = 7;
  3110. // The desired datapath provider for this cluster. By default, uses the
  3111. // IPTables-based kube-proxy implementation.
  3112. DatapathProvider datapath_provider = 11;
  3113. }
  3114. // ListUsableSubnetworksRequest requests the list of usable subnetworks.
  3115. // available to a user for creating clusters.
  3116. message ListUsableSubnetworksRequest {
  3117. // Required. The parent project where subnetworks are usable.
  3118. // Specified in the format `projects/*`.
  3119. string parent = 1 [(google.api.field_behavior) = REQUIRED];
  3120. // Filtering currently only supports equality on the networkProjectId and must
  3121. // be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId`
  3122. // is the project which owns the listed subnetworks. This defaults to the
  3123. // parent project ID.
  3124. string filter = 2;
  3125. // The max number of results per page that should be returned. If the number
  3126. // of available results is larger than `page_size`, a `next_page_token` is
  3127. // returned which can be used to get the next page of results in subsequent
  3128. // requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
  3129. int32 page_size = 3;
  3130. // Specifies a page token to use. Set this to the nextPageToken returned by
  3131. // previous list requests to get the next page of results.
  3132. string page_token = 4;
  3133. }
  3134. // ListUsableSubnetworksResponse is the response of
  3135. // ListUsableSubnetworksRequest.
  3136. message ListUsableSubnetworksResponse {
  3137. // A list of usable subnetworks in the specified network project.
  3138. repeated UsableSubnetwork subnetworks = 1;
  3139. // This token allows you to get the next page of results for list requests.
  3140. // If the number of results is larger than `page_size`, use the
  3141. // `next_page_token` as a value for the query parameter `page_token` in the
  3142. // next request. The value will become empty when there are no more pages.
  3143. string next_page_token = 2;
  3144. }
  3145. // Secondary IP range of a usable subnetwork.
  3146. message UsableSubnetworkSecondaryRange {
  3147. // Status shows the current usage of a secondary IP range.
  3148. enum Status {
  3149. // UNKNOWN is the zero value of the Status enum. It's not a valid status.
  3150. UNKNOWN = 0;
  3151. // UNUSED denotes that this range is unclaimed by any cluster.
  3152. UNUSED = 1;
  3153. // IN_USE_SERVICE denotes that this range is claimed by a cluster for
  3154. // services. It cannot be used for other clusters.
  3155. IN_USE_SERVICE = 2;
  3156. // IN_USE_SHAREABLE_POD denotes this range was created by the network admin
  3157. // and is currently claimed by a cluster for pods. It can only be used by
  3158. // other clusters as a pod range.
  3159. IN_USE_SHAREABLE_POD = 3;
  3160. // IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed
  3161. // for pods. It cannot be used for other clusters.
  3162. IN_USE_MANAGED_POD = 4;
  3163. }
  3164. // The name associated with this subnetwork secondary range, used when adding
  3165. // an alias IP range to a VM instance.
  3166. string range_name = 1;
  3167. // The range of IP addresses belonging to this subnetwork secondary range.
  3168. string ip_cidr_range = 2;
  3169. // This field is to determine the status of the secondary range programmably.
  3170. Status status = 3;
  3171. }
  3172. // UsableSubnetwork resource returns the subnetwork name, its associated network
  3173. // and the primary CIDR range.
  3174. message UsableSubnetwork {
  3175. // Subnetwork Name.
  3176. // Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
  3177. string subnetwork = 1;
  3178. // Network Name.
  3179. // Example: projects/my-project/global/networks/my-network
  3180. string network = 2;
  3181. // The range of internal addresses that are owned by this subnetwork.
  3182. string ip_cidr_range = 3;
  3183. // Secondary IP ranges.
  3184. repeated UsableSubnetworkSecondaryRange secondary_ip_ranges = 4;
  3185. // A human readable status message representing the reasons for cases where
  3186. // the caller cannot use the secondary ranges under the subnet. For example if
  3187. // the secondary_ip_ranges is empty due to a permission issue, an insufficient
  3188. // permission message will be given by status_message.
  3189. string status_message = 5;
  3190. }
  3191. // VerticalPodAutoscaling contains global, per-cluster information
  3192. // required by Vertical Pod Autoscaler to automatically adjust
  3193. // the resources of pods controlled by it.
  3194. message VerticalPodAutoscaling {
  3195. // Enables vertical pod autoscaling.
  3196. bool enabled = 1;
  3197. }
  3198. // DefaultSnatStatus contains the desired state of whether default sNAT should
  3199. // be disabled on the cluster.
  3200. message DefaultSnatStatus {
  3201. // Disables cluster default sNAT rules.
  3202. bool disabled = 1;
  3203. }
  3204. // IntraNodeVisibilityConfig contains the desired config of the intra-node
  3205. // visibility on this cluster.
  3206. message IntraNodeVisibilityConfig {
  3207. // Enables intra node visibility for this cluster.
  3208. bool enabled = 1;
  3209. }
  3210. // Constraints applied to pods.
  3211. message MaxPodsConstraint {
  3212. // Constraint enforced on the max num of pods per node.
  3213. int64 max_pods_per_node = 1;
  3214. }
  3215. // Configuration for the use of Kubernetes Service Accounts in GCP IAM
  3216. // policies.
  3217. message WorkloadIdentityConfig {
  3218. // IAM Identity Namespace to attach all Kubernetes Service Accounts to.
  3219. string identity_namespace = 1 [deprecated = true];
  3220. // The workload pool to attach all Kubernetes service accounts to.
  3221. string workload_pool = 2;
  3222. // identity provider is the third party identity provider.
  3223. string identity_provider = 3;
  3224. }
  3225. // Configuration of etcd encryption.
  3226. message DatabaseEncryption {
  3227. // State of etcd encryption.
  3228. enum State {
  3229. // Should never be set
  3230. UNKNOWN = 0;
  3231. // Secrets in etcd are encrypted.
  3232. ENCRYPTED = 1;
  3233. // Secrets in etcd are stored in plain text (at etcd level) - this is
  3234. // unrelated to Compute Engine level full disk encryption.
  3235. DECRYPTED = 2;
  3236. }
  3237. // Denotes the state of etcd encryption.
  3238. State state = 2;
  3239. // Name of CloudKMS key to use for the encryption of secrets in etcd.
  3240. // Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
  3241. string key_name = 1;
  3242. }
  3243. // Configuration for exporting cluster resource usages.
  3244. message ResourceUsageExportConfig {
  3245. // Parameters for using BigQuery as the destination of resource usage export.
  3246. message BigQueryDestination {
  3247. // The ID of a BigQuery Dataset.
  3248. string dataset_id = 1;
  3249. }
  3250. // Parameters for controlling consumption metering.
  3251. message ConsumptionMeteringConfig {
  3252. // Whether to enable consumption metering for this cluster. If enabled, a
  3253. // second BigQuery table will be created to hold resource consumption
  3254. // records.
  3255. bool enabled = 1;
  3256. }
  3257. // Configuration to use BigQuery as usage export destination.
  3258. BigQueryDestination bigquery_destination = 1;
  3259. // Whether to enable network egress metering for this cluster. If enabled, a
  3260. // daemonset will be created in the cluster to meter network egress traffic.
  3261. bool enable_network_egress_metering = 2;
  3262. // Configuration to enable resource consumption metering.
  3263. ConsumptionMeteringConfig consumption_metering_config = 3;
  3264. }
  3265. // Configuration of Shielded Nodes feature.
  3266. message ShieldedNodes {
  3267. // Whether Shielded Nodes features are enabled on all nodes in this cluster.
  3268. bool enabled = 1;
  3269. }
  3270. // GetOpenIDConfigRequest gets the OIDC discovery document for the
  3271. // cluster. See the OpenID Connect Discovery 1.0 specification for details.
  3272. message GetOpenIDConfigRequest {
  3273. // The cluster (project, location, cluster id) to get the discovery document
  3274. // for. Specified in the format `projects/*/locations/*/clusters/*`.
  3275. string parent = 1;
  3276. }
  3277. // GetOpenIDConfigResponse is an OIDC discovery document for the cluster.
  3278. // See the OpenID Connect Discovery 1.0 specification for details.
  3279. message GetOpenIDConfigResponse {
  3280. // OIDC Issuer.
  3281. string issuer = 1;
  3282. // JSON Web Key uri.
  3283. string jwks_uri = 2;
  3284. // Supported response types.
  3285. repeated string response_types_supported = 3;
  3286. // Supported subject types.
  3287. repeated string subject_types_supported = 4;
  3288. // supported ID Token signing Algorithms.
  3289. repeated string id_token_signing_alg_values_supported = 5;
  3290. // Supported claims.
  3291. repeated string claims_supported = 6;
  3292. // Supported grant types.
  3293. repeated string grant_types = 7;
  3294. }
  3295. // GetJSONWebKeysRequest gets the public component of the keys used by the
  3296. // cluster to sign token requests. This will be the jwks_uri for the discover
  3297. // document returned by getOpenIDConfig. See the OpenID Connect
  3298. // Discovery 1.0 specification for details.
  3299. message GetJSONWebKeysRequest {
  3300. // The cluster (project, location, cluster id) to get keys for. Specified in
  3301. // the format `projects/*/locations/*/clusters/*`.
  3302. string parent = 1;
  3303. }
  3304. // Jwk is a JSON Web Key as specified in RFC 7517
  3305. message Jwk {
  3306. // Key Type.
  3307. string kty = 1;
  3308. // Algorithm.
  3309. string alg = 2;
  3310. // Permitted uses for the public keys.
  3311. string use = 3;
  3312. // Key ID.
  3313. string kid = 4;
  3314. // Used for RSA keys.
  3315. string n = 5;
  3316. // Used for RSA keys.
  3317. string e = 6;
  3318. // Used for ECDSA keys.
  3319. string x = 7;
  3320. // Used for ECDSA keys.
  3321. string y = 8;
  3322. // Used for ECDSA keys.
  3323. string crv = 9;
  3324. }
  3325. // GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
  3326. message GetJSONWebKeysResponse {
  3327. // The public component of the keys used by the cluster to sign token
  3328. // requests.
  3329. repeated Jwk keys = 1;
  3330. }
  3331. // ReleaseChannel indicates which release channel a cluster is
  3332. // subscribed to. Release channels are arranged in order of risk.
  3333. //
  3334. // When a cluster is subscribed to a release channel, Google maintains
  3335. // both the master version and the node version. Node auto-upgrade
  3336. // defaults to true and cannot be disabled.
  3337. message ReleaseChannel {
  3338. // Possible values for 'channel'.
  3339. enum Channel {
  3340. // No channel specified.
  3341. UNSPECIFIED = 0;
  3342. // RAPID channel is offered on an early access basis for customers who want
  3343. // to test new releases.
  3344. //
  3345. // WARNING: Versions available in the RAPID Channel may be subject to
  3346. // unresolved issues with no known workaround and are not subject to any
  3347. // SLAs.
  3348. RAPID = 1;
  3349. // Clusters subscribed to REGULAR receive versions that are considered GA
  3350. // quality. REGULAR is intended for production users who want to take
  3351. // advantage of new features.
  3352. REGULAR = 2;
  3353. // Clusters subscribed to STABLE receive versions that are known to be
  3354. // stable and reliable in production.
  3355. STABLE = 3;
  3356. }
  3357. // channel specifies which release channel the cluster is subscribed to.
  3358. Channel channel = 1;
  3359. }
  3360. // Configuration for Cloud TPU.
  3361. message TpuConfig {
  3362. // Whether Cloud TPU integration is enabled or not.
  3363. bool enabled = 1;
  3364. // Whether to use service networking for Cloud TPU or not.
  3365. bool use_service_networking = 2;
  3366. // IPv4 CIDR block reserved for Cloud TPU in the VPC.
  3367. string ipv4_cidr_block = 3;
  3368. }
  3369. // Master is the configuration for components on master.
  3370. message Master {
  3371. }
  3372. // NotificationConfig is the configuration of notifications.
  3373. message NotificationConfig {
  3374. // Pub/Sub specific notification config.
  3375. message PubSub {
  3376. // Enable notifications for Pub/Sub.
  3377. bool enabled = 1;
  3378. // The desired Pub/Sub topic to which notifications will be
  3379. // sent by GKE. Format is `projects/{project}/topics/{topic}`.
  3380. string topic = 2 [(google.api.resource_reference) = {
  3381. type: "pubsub.googleapis.com/Topic"
  3382. }];
  3383. }
  3384. // Notification config for Pub/Sub.
  3385. PubSub pubsub = 1;
  3386. }
  3387. // ConfidentialNodes is configuration for the confidential nodes feature, which
  3388. // makes nodes run on confidential VMs.
  3389. message ConfidentialNodes {
  3390. // Whether Confidential Nodes feature is enabled for all nodes in this
  3391. // cluster.
  3392. bool enabled = 1;
  3393. }
  3394. // UpgradeEvent is a notification sent to customers by the cluster server when
  3395. // a resource is upgrading.
  3396. message UpgradeEvent {
  3397. // Required. The resource type that is upgrading.
  3398. UpgradeResourceType resource_type = 1 [(google.api.field_behavior) = REQUIRED];
  3399. // Required. The operation associated with this upgrade.
  3400. string operation = 2 [(google.api.field_behavior) = REQUIRED];
  3401. // Required. The time when the operation was started.
  3402. google.protobuf.Timestamp operation_start_time = 3 [(google.api.field_behavior) = REQUIRED];
  3403. // Required. The current version before the upgrade.
  3404. string current_version = 4 [(google.api.field_behavior) = REQUIRED];
  3405. // Required. The target version for the upgrade.
  3406. string target_version = 5 [(google.api.field_behavior) = REQUIRED];
  3407. // Optional. Optional relative path to the resource. For example in node pool upgrades,
  3408. // the relative path of the node pool.
  3409. string resource = 6 [(google.api.field_behavior) = OPTIONAL];
  3410. }
  3411. // The datapath provider selects the implementation of the Kubernetes networking
  3412. // // model for service resolution and network policy enforcement.
  3413. enum DatapathProvider {
  3414. // Default value.
  3415. DATAPATH_PROVIDER_UNSPECIFIED = 0;
  3416. // Use the IPTables implementation based on kube-proxy.
  3417. LEGACY_DATAPATH = 1;
  3418. // Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE
  3419. // Dataplane V2
  3420. // documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2)
  3421. // for more.
  3422. ADVANCED_DATAPATH = 2;
  3423. }
  3424. // UpgradeResourceType is the resource type that is upgrading. It is used
  3425. // in upgrade notifications.
  3426. enum UpgradeResourceType {
  3427. // Default value. This shouldn't be used.
  3428. UPGRADE_RESOURCE_TYPE_UNSPECIFIED = 0;
  3429. // Master / control plane
  3430. MASTER = 1;
  3431. // Node pool
  3432. NODE_POOL = 2;
  3433. }