generated.proto 313 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281
  1. /*
  2. Copyright The Kubernetes Authors.
  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. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = "proto2";
  15. package k8s.io.api.core.v1;
  16. import "k8s.io/apimachinery/pkg/api/resource/generated.proto";
  17. import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  18. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  19. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  20. import "k8s.io/apimachinery/pkg/util/intstr/generated.proto";
  21. // Package-wide variables from generator "generated".
  22. option go_package = "k8s.io/api/core/v1";
  23. // Represents a Persistent Disk resource in AWS.
  24. //
  25. // An AWS EBS disk must exist before mounting to a container. The disk
  26. // must also be in the same AWS zone as the kubelet. An AWS EBS disk
  27. // can only be mounted as read/write once. AWS EBS volumes support
  28. // ownership management and SELinux relabeling.
  29. message AWSElasticBlockStoreVolumeSource {
  30. // volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
  31. // More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  32. optional string volumeID = 1;
  33. // fsType is the filesystem type of the volume that you want to mount.
  34. // Tip: Ensure that the filesystem type is supported by the host operating system.
  35. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  36. // More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  37. // TODO: how do we prevent errors in the filesystem from compromising the machine
  38. // +optional
  39. optional string fsType = 2;
  40. // partition is the partition in the volume that you want to mount.
  41. // If omitted, the default is to mount by volume name.
  42. // Examples: For volume /dev/sda1, you specify the partition as "1".
  43. // Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  44. // +optional
  45. optional int32 partition = 3;
  46. // readOnly value true will force the readOnly setting in VolumeMounts.
  47. // More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  48. // +optional
  49. optional bool readOnly = 4;
  50. }
  51. // Affinity is a group of affinity scheduling rules.
  52. message Affinity {
  53. // Describes node affinity scheduling rules for the pod.
  54. // +optional
  55. optional NodeAffinity nodeAffinity = 1;
  56. // Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
  57. // +optional
  58. optional PodAffinity podAffinity = 2;
  59. // Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
  60. // +optional
  61. optional PodAntiAffinity podAntiAffinity = 3;
  62. }
  63. // AppArmorProfile defines a pod or container's AppArmor settings.
  64. // +union
  65. message AppArmorProfile {
  66. // type indicates which kind of AppArmor profile will be applied.
  67. // Valid options are:
  68. // Localhost - a profile pre-loaded on the node.
  69. // RuntimeDefault - the container runtime's default profile.
  70. // Unconfined - no AppArmor enforcement.
  71. // +unionDiscriminator
  72. optional string type = 1;
  73. // localhostProfile indicates a profile loaded on the node that should be used.
  74. // The profile must be preconfigured on the node to work.
  75. // Must match the loaded name of the profile.
  76. // Must be set if and only if type is "Localhost".
  77. // +optional
  78. optional string localhostProfile = 2;
  79. }
  80. // AttachedVolume describes a volume attached to a node
  81. message AttachedVolume {
  82. // Name of the attached volume
  83. optional string name = 1;
  84. // DevicePath represents the device path where the volume should be available
  85. optional string devicePath = 2;
  86. }
  87. // AvoidPods describes pods that should avoid this node. This is the value for a
  88. // Node annotation with key scheduler.alpha.kubernetes.io/preferAvoidPods and
  89. // will eventually become a field of NodeStatus.
  90. message AvoidPods {
  91. // Bounded-sized list of signatures of pods that should avoid this node, sorted
  92. // in timestamp order from oldest to newest. Size of the slice is unspecified.
  93. // +optional
  94. // +listType=atomic
  95. repeated PreferAvoidPodsEntry preferAvoidPods = 1;
  96. }
  97. // AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  98. message AzureDiskVolumeSource {
  99. // diskName is the Name of the data disk in the blob storage
  100. optional string diskName = 1;
  101. // diskURI is the URI of data disk in the blob storage
  102. optional string diskURI = 2;
  103. // cachingMode is the Host Caching mode: None, Read Only, Read Write.
  104. // +optional
  105. // +default=ref(AzureDataDiskCachingReadWrite)
  106. optional string cachingMode = 3;
  107. // fsType is Filesystem type to mount.
  108. // Must be a filesystem type supported by the host operating system.
  109. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  110. // +optional
  111. // +default="ext4"
  112. optional string fsType = 4;
  113. // readOnly Defaults to false (read/write). ReadOnly here will force
  114. // the ReadOnly setting in VolumeMounts.
  115. // +optional
  116. // +default=false
  117. optional bool readOnly = 5;
  118. // kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
  119. // +default=ref(AzureSharedBlobDisk)
  120. optional string kind = 6;
  121. }
  122. // AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  123. message AzureFilePersistentVolumeSource {
  124. // secretName is the name of secret that contains Azure Storage Account Name and Key
  125. optional string secretName = 1;
  126. // shareName is the azure Share Name
  127. optional string shareName = 2;
  128. // readOnly defaults to false (read/write). ReadOnly here will force
  129. // the ReadOnly setting in VolumeMounts.
  130. // +optional
  131. optional bool readOnly = 3;
  132. // secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key
  133. // default is the same as the Pod
  134. // +optional
  135. optional string secretNamespace = 4;
  136. }
  137. // AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  138. message AzureFileVolumeSource {
  139. // secretName is the name of secret that contains Azure Storage Account Name and Key
  140. optional string secretName = 1;
  141. // shareName is the azure share Name
  142. optional string shareName = 2;
  143. // readOnly defaults to false (read/write). ReadOnly here will force
  144. // the ReadOnly setting in VolumeMounts.
  145. // +optional
  146. optional bool readOnly = 3;
  147. }
  148. // Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
  149. message Binding {
  150. // Standard object's metadata.
  151. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  152. // +optional
  153. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  154. // The target object that you want to bind to the standard object.
  155. optional ObjectReference target = 2;
  156. }
  157. // Represents storage that is managed by an external CSI volume driver
  158. message CSIPersistentVolumeSource {
  159. // driver is the name of the driver to use for this volume.
  160. // Required.
  161. optional string driver = 1;
  162. // volumeHandle is the unique volume name returned by the CSI volume
  163. // plugin’s CreateVolume to refer to the volume on all subsequent calls.
  164. // Required.
  165. optional string volumeHandle = 2;
  166. // readOnly value to pass to ControllerPublishVolumeRequest.
  167. // Defaults to false (read/write).
  168. // +optional
  169. optional bool readOnly = 3;
  170. // fsType to mount. Must be a filesystem type supported by the host operating system.
  171. // Ex. "ext4", "xfs", "ntfs".
  172. // +optional
  173. optional string fsType = 4;
  174. // volumeAttributes of the volume to publish.
  175. // +optional
  176. map<string, string> volumeAttributes = 5;
  177. // controllerPublishSecretRef is a reference to the secret object containing
  178. // sensitive information to pass to the CSI driver to complete the CSI
  179. // ControllerPublishVolume and ControllerUnpublishVolume calls.
  180. // This field is optional, and may be empty if no secret is required. If the
  181. // secret object contains more than one secret, all secrets are passed.
  182. // +optional
  183. optional SecretReference controllerPublishSecretRef = 6;
  184. // nodeStageSecretRef is a reference to the secret object containing sensitive
  185. // information to pass to the CSI driver to complete the CSI NodeStageVolume
  186. // and NodeStageVolume and NodeUnstageVolume calls.
  187. // This field is optional, and may be empty if no secret is required. If the
  188. // secret object contains more than one secret, all secrets are passed.
  189. // +optional
  190. optional SecretReference nodeStageSecretRef = 7;
  191. // nodePublishSecretRef is a reference to the secret object containing
  192. // sensitive information to pass to the CSI driver to complete the CSI
  193. // NodePublishVolume and NodeUnpublishVolume calls.
  194. // This field is optional, and may be empty if no secret is required. If the
  195. // secret object contains more than one secret, all secrets are passed.
  196. // +optional
  197. optional SecretReference nodePublishSecretRef = 8;
  198. // controllerExpandSecretRef is a reference to the secret object containing
  199. // sensitive information to pass to the CSI driver to complete the CSI
  200. // ControllerExpandVolume call.
  201. // This field is optional, and may be empty if no secret is required. If the
  202. // secret object contains more than one secret, all secrets are passed.
  203. // +optional
  204. optional SecretReference controllerExpandSecretRef = 9;
  205. // nodeExpandSecretRef is a reference to the secret object containing
  206. // sensitive information to pass to the CSI driver to complete the CSI
  207. // NodeExpandVolume call.
  208. // This field is optional, may be omitted if no secret is required. If the
  209. // secret object contains more than one secret, all secrets are passed.
  210. // +optional
  211. optional SecretReference nodeExpandSecretRef = 10;
  212. }
  213. // Represents a source location of a volume to mount, managed by an external CSI driver
  214. message CSIVolumeSource {
  215. // driver is the name of the CSI driver that handles this volume.
  216. // Consult with your admin for the correct name as registered in the cluster.
  217. optional string driver = 1;
  218. // readOnly specifies a read-only configuration for the volume.
  219. // Defaults to false (read/write).
  220. // +optional
  221. optional bool readOnly = 2;
  222. // fsType to mount. Ex. "ext4", "xfs", "ntfs".
  223. // If not provided, the empty value is passed to the associated CSI driver
  224. // which will determine the default filesystem to apply.
  225. // +optional
  226. optional string fsType = 3;
  227. // volumeAttributes stores driver-specific properties that are passed to the CSI
  228. // driver. Consult your driver's documentation for supported values.
  229. // +optional
  230. map<string, string> volumeAttributes = 4;
  231. // nodePublishSecretRef is a reference to the secret object containing
  232. // sensitive information to pass to the CSI driver to complete the CSI
  233. // NodePublishVolume and NodeUnpublishVolume calls.
  234. // This field is optional, and may be empty if no secret is required. If the
  235. // secret object contains more than one secret, all secret references are passed.
  236. // +optional
  237. optional LocalObjectReference nodePublishSecretRef = 5;
  238. }
  239. // Adds and removes POSIX capabilities from running containers.
  240. message Capabilities {
  241. // Added capabilities
  242. // +optional
  243. // +listType=atomic
  244. repeated string add = 1;
  245. // Removed capabilities
  246. // +optional
  247. // +listType=atomic
  248. repeated string drop = 2;
  249. }
  250. // Represents a Ceph Filesystem mount that lasts the lifetime of a pod
  251. // Cephfs volumes do not support ownership management or SELinux relabeling.
  252. message CephFSPersistentVolumeSource {
  253. // monitors is Required: Monitors is a collection of Ceph monitors
  254. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  255. // +listType=atomic
  256. repeated string monitors = 1;
  257. // path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
  258. // +optional
  259. optional string path = 2;
  260. // user is Optional: User is the rados user name, default is admin
  261. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  262. // +optional
  263. optional string user = 3;
  264. // secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
  265. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  266. // +optional
  267. optional string secretFile = 4;
  268. // secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
  269. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  270. // +optional
  271. optional SecretReference secretRef = 5;
  272. // readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  273. // the ReadOnly setting in VolumeMounts.
  274. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  275. // +optional
  276. optional bool readOnly = 6;
  277. }
  278. // Represents a Ceph Filesystem mount that lasts the lifetime of a pod
  279. // Cephfs volumes do not support ownership management or SELinux relabeling.
  280. message CephFSVolumeSource {
  281. // monitors is Required: Monitors is a collection of Ceph monitors
  282. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  283. // +listType=atomic
  284. repeated string monitors = 1;
  285. // path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
  286. // +optional
  287. optional string path = 2;
  288. // user is optional: User is the rados user name, default is admin
  289. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  290. // +optional
  291. optional string user = 3;
  292. // secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
  293. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  294. // +optional
  295. optional string secretFile = 4;
  296. // secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
  297. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  298. // +optional
  299. optional LocalObjectReference secretRef = 5;
  300. // readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  301. // the ReadOnly setting in VolumeMounts.
  302. // More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  303. // +optional
  304. optional bool readOnly = 6;
  305. }
  306. // Represents a cinder volume resource in Openstack.
  307. // A Cinder volume must exist before mounting to a container.
  308. // The volume must also be in the same region as the kubelet.
  309. // Cinder volumes support ownership management and SELinux relabeling.
  310. message CinderPersistentVolumeSource {
  311. // volumeID used to identify the volume in cinder.
  312. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  313. optional string volumeID = 1;
  314. // fsType Filesystem type to mount.
  315. // Must be a filesystem type supported by the host operating system.
  316. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  317. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  318. // +optional
  319. optional string fsType = 2;
  320. // readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  321. // the ReadOnly setting in VolumeMounts.
  322. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  323. // +optional
  324. optional bool readOnly = 3;
  325. // secretRef is Optional: points to a secret object containing parameters used to connect
  326. // to OpenStack.
  327. // +optional
  328. optional SecretReference secretRef = 4;
  329. }
  330. // Represents a cinder volume resource in Openstack.
  331. // A Cinder volume must exist before mounting to a container.
  332. // The volume must also be in the same region as the kubelet.
  333. // Cinder volumes support ownership management and SELinux relabeling.
  334. message CinderVolumeSource {
  335. // volumeID used to identify the volume in cinder.
  336. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  337. optional string volumeID = 1;
  338. // fsType is the filesystem type to mount.
  339. // Must be a filesystem type supported by the host operating system.
  340. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  341. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  342. // +optional
  343. optional string fsType = 2;
  344. // readOnly defaults to false (read/write). ReadOnly here will force
  345. // the ReadOnly setting in VolumeMounts.
  346. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  347. // +optional
  348. optional bool readOnly = 3;
  349. // secretRef is optional: points to a secret object containing parameters used to connect
  350. // to OpenStack.
  351. // +optional
  352. optional LocalObjectReference secretRef = 4;
  353. }
  354. // ClientIPConfig represents the configurations of Client IP based session affinity.
  355. message ClientIPConfig {
  356. // timeoutSeconds specifies the seconds of ClientIP type session sticky time.
  357. // The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP".
  358. // Default value is 10800(for 3 hours).
  359. // +optional
  360. optional int32 timeoutSeconds = 1;
  361. }
  362. // ClusterTrustBundleProjection describes how to select a set of
  363. // ClusterTrustBundle objects and project their contents into the pod
  364. // filesystem.
  365. message ClusterTrustBundleProjection {
  366. // Select a single ClusterTrustBundle by object name. Mutually-exclusive
  367. // with signerName and labelSelector.
  368. // +optional
  369. optional string name = 1;
  370. // Select all ClusterTrustBundles that match this signer name.
  371. // Mutually-exclusive with name. The contents of all selected
  372. // ClusterTrustBundles will be unified and deduplicated.
  373. // +optional
  374. optional string signerName = 2;
  375. // Select all ClusterTrustBundles that match this label selector. Only has
  376. // effect if signerName is set. Mutually-exclusive with name. If unset,
  377. // interpreted as "match nothing". If set but empty, interpreted as "match
  378. // everything".
  379. // +optional
  380. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 3;
  381. // If true, don't block pod startup if the referenced ClusterTrustBundle(s)
  382. // aren't available. If using name, then the named ClusterTrustBundle is
  383. // allowed not to exist. If using signerName, then the combination of
  384. // signerName and labelSelector is allowed to match zero
  385. // ClusterTrustBundles.
  386. // +optional
  387. optional bool optional = 5;
  388. // Relative path from the volume root to write the bundle.
  389. optional string path = 4;
  390. }
  391. // Information about the condition of a component.
  392. message ComponentCondition {
  393. // Type of condition for a component.
  394. // Valid value: "Healthy"
  395. optional string type = 1;
  396. // Status of the condition for a component.
  397. // Valid values for "Healthy": "True", "False", or "Unknown".
  398. optional string status = 2;
  399. // Message about the condition for a component.
  400. // For example, information about a health check.
  401. // +optional
  402. optional string message = 3;
  403. // Condition error code for a component.
  404. // For example, a health check error code.
  405. // +optional
  406. optional string error = 4;
  407. }
  408. // ComponentStatus (and ComponentStatusList) holds the cluster validation info.
  409. // Deprecated: This API is deprecated in v1.19+
  410. message ComponentStatus {
  411. // Standard object's metadata.
  412. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  413. // +optional
  414. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  415. // List of component conditions observed
  416. // +optional
  417. // +patchMergeKey=type
  418. // +patchStrategy=merge
  419. // +listType=map
  420. // +listMapKey=type
  421. repeated ComponentCondition conditions = 2;
  422. }
  423. // Status of all the conditions for the component as a list of ComponentStatus objects.
  424. // Deprecated: This API is deprecated in v1.19+
  425. message ComponentStatusList {
  426. // Standard list metadata.
  427. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  428. // +optional
  429. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  430. // List of ComponentStatus objects.
  431. repeated ComponentStatus items = 2;
  432. }
  433. // ConfigMap holds configuration data for pods to consume.
  434. message ConfigMap {
  435. // Standard object's metadata.
  436. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  437. // +optional
  438. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  439. // Immutable, if set to true, ensures that data stored in the ConfigMap cannot
  440. // be updated (only object metadata can be modified).
  441. // If not set to true, the field can be modified at any time.
  442. // Defaulted to nil.
  443. // +optional
  444. optional bool immutable = 4;
  445. // Data contains the configuration data.
  446. // Each key must consist of alphanumeric characters, '-', '_' or '.'.
  447. // Values with non-UTF-8 byte sequences must use the BinaryData field.
  448. // The keys stored in Data must not overlap with the keys in
  449. // the BinaryData field, this is enforced during validation process.
  450. // +optional
  451. map<string, string> data = 2;
  452. // BinaryData contains the binary data.
  453. // Each key must consist of alphanumeric characters, '-', '_' or '.'.
  454. // BinaryData can contain byte sequences that are not in the UTF-8 range.
  455. // The keys stored in BinaryData must not overlap with the ones in
  456. // the Data field, this is enforced during validation process.
  457. // Using this field will require 1.10+ apiserver and
  458. // kubelet.
  459. // +optional
  460. map<string, bytes> binaryData = 3;
  461. }
  462. // ConfigMapEnvSource selects a ConfigMap to populate the environment
  463. // variables with.
  464. //
  465. // The contents of the target ConfigMap's Data field will represent the
  466. // key-value pairs as environment variables.
  467. message ConfigMapEnvSource {
  468. // The ConfigMap to select from.
  469. optional LocalObjectReference localObjectReference = 1;
  470. // Specify whether the ConfigMap must be defined
  471. // +optional
  472. optional bool optional = 2;
  473. }
  474. // Selects a key from a ConfigMap.
  475. // +structType=atomic
  476. message ConfigMapKeySelector {
  477. // The ConfigMap to select from.
  478. optional LocalObjectReference localObjectReference = 1;
  479. // The key to select.
  480. optional string key = 2;
  481. // Specify whether the ConfigMap or its key must be defined
  482. // +optional
  483. optional bool optional = 3;
  484. }
  485. // ConfigMapList is a resource containing a list of ConfigMap objects.
  486. message ConfigMapList {
  487. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  488. // +optional
  489. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  490. // Items is the list of ConfigMaps.
  491. repeated ConfigMap items = 2;
  492. }
  493. // ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.
  494. // This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
  495. message ConfigMapNodeConfigSource {
  496. // Namespace is the metadata.namespace of the referenced ConfigMap.
  497. // This field is required in all cases.
  498. optional string namespace = 1;
  499. // Name is the metadata.name of the referenced ConfigMap.
  500. // This field is required in all cases.
  501. optional string name = 2;
  502. // UID is the metadata.UID of the referenced ConfigMap.
  503. // This field is forbidden in Node.Spec, and required in Node.Status.
  504. // +optional
  505. optional string uid = 3;
  506. // ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap.
  507. // This field is forbidden in Node.Spec, and required in Node.Status.
  508. // +optional
  509. optional string resourceVersion = 4;
  510. // KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure
  511. // This field is required in all cases.
  512. optional string kubeletConfigKey = 5;
  513. }
  514. // Adapts a ConfigMap into a projected volume.
  515. //
  516. // The contents of the target ConfigMap's Data field will be presented in a
  517. // projected volume as files using the keys in the Data field as the file names,
  518. // unless the items element is populated with specific mappings of keys to paths.
  519. // Note that this is identical to a configmap volume source without the default
  520. // mode.
  521. message ConfigMapProjection {
  522. optional LocalObjectReference localObjectReference = 1;
  523. // items if unspecified, each key-value pair in the Data field of the referenced
  524. // ConfigMap will be projected into the volume as a file whose name is the
  525. // key and content is the value. If specified, the listed keys will be
  526. // projected into the specified paths, and unlisted keys will not be
  527. // present. If a key is specified which is not present in the ConfigMap,
  528. // the volume setup will error unless it is marked optional. Paths must be
  529. // relative and may not contain the '..' path or start with '..'.
  530. // +optional
  531. // +listType=atomic
  532. repeated KeyToPath items = 2;
  533. // optional specify whether the ConfigMap or its keys must be defined
  534. // +optional
  535. optional bool optional = 4;
  536. }
  537. // Adapts a ConfigMap into a volume.
  538. //
  539. // The contents of the target ConfigMap's Data field will be presented in a
  540. // volume as files using the keys in the Data field as the file names, unless
  541. // the items element is populated with specific mappings of keys to paths.
  542. // ConfigMap volumes support ownership management and SELinux relabeling.
  543. message ConfigMapVolumeSource {
  544. optional LocalObjectReference localObjectReference = 1;
  545. // items if unspecified, each key-value pair in the Data field of the referenced
  546. // ConfigMap will be projected into the volume as a file whose name is the
  547. // key and content is the value. If specified, the listed keys will be
  548. // projected into the specified paths, and unlisted keys will not be
  549. // present. If a key is specified which is not present in the ConfigMap,
  550. // the volume setup will error unless it is marked optional. Paths must be
  551. // relative and may not contain the '..' path or start with '..'.
  552. // +optional
  553. // +listType=atomic
  554. repeated KeyToPath items = 2;
  555. // defaultMode is optional: mode bits used to set permissions on created files by default.
  556. // Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  557. // YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  558. // Defaults to 0644.
  559. // Directories within the path are not affected by this setting.
  560. // This might be in conflict with other options that affect the file
  561. // mode, like fsGroup, and the result can be other mode bits set.
  562. // +optional
  563. optional int32 defaultMode = 3;
  564. // optional specify whether the ConfigMap or its keys must be defined
  565. // +optional
  566. optional bool optional = 4;
  567. }
  568. // A single application container that you want to run within a pod.
  569. message Container {
  570. // Name of the container specified as a DNS_LABEL.
  571. // Each container in a pod must have a unique name (DNS_LABEL).
  572. // Cannot be updated.
  573. optional string name = 1;
  574. // Container image name.
  575. // More info: https://kubernetes.io/docs/concepts/containers/images
  576. // This field is optional to allow higher level config management to default or override
  577. // container images in workload controllers like Deployments and StatefulSets.
  578. // +optional
  579. optional string image = 2;
  580. // Entrypoint array. Not executed within a shell.
  581. // The container image's ENTRYPOINT is used if this is not provided.
  582. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  583. // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
  584. // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
  585. // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
  586. // of whether the variable exists or not. Cannot be updated.
  587. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
  588. // +optional
  589. // +listType=atomic
  590. repeated string command = 3;
  591. // Arguments to the entrypoint.
  592. // The container image's CMD is used if this is not provided.
  593. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  594. // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
  595. // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
  596. // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
  597. // of whether the variable exists or not. Cannot be updated.
  598. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
  599. // +optional
  600. // +listType=atomic
  601. repeated string args = 4;
  602. // Container's working directory.
  603. // If not specified, the container runtime's default will be used, which
  604. // might be configured in the container image.
  605. // Cannot be updated.
  606. // +optional
  607. optional string workingDir = 5;
  608. // List of ports to expose from the container. Not specifying a port here
  609. // DOES NOT prevent that port from being exposed. Any port which is
  610. // listening on the default "0.0.0.0" address inside a container will be
  611. // accessible from the network.
  612. // Modifying this array with strategic merge patch may corrupt the data.
  613. // For more information See https://github.com/kubernetes/kubernetes/issues/108255.
  614. // Cannot be updated.
  615. // +optional
  616. // +patchMergeKey=containerPort
  617. // +patchStrategy=merge
  618. // +listType=map
  619. // +listMapKey=containerPort
  620. // +listMapKey=protocol
  621. repeated ContainerPort ports = 6;
  622. // List of sources to populate environment variables in the container.
  623. // The keys defined within a source may consist of any printable ASCII characters except '='.
  624. // When a key exists in multiple
  625. // sources, the value associated with the last source will take precedence.
  626. // Values defined by an Env with a duplicate key will take precedence.
  627. // Cannot be updated.
  628. // +optional
  629. // +listType=atomic
  630. repeated EnvFromSource envFrom = 19;
  631. // List of environment variables to set in the container.
  632. // Cannot be updated.
  633. // +optional
  634. // +patchMergeKey=name
  635. // +patchStrategy=merge
  636. // +listType=map
  637. // +listMapKey=name
  638. repeated EnvVar env = 7;
  639. // Compute Resources required by this container.
  640. // Cannot be updated.
  641. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  642. // +optional
  643. optional ResourceRequirements resources = 8;
  644. // Resources resize policy for the container.
  645. // This field cannot be set on ephemeral containers.
  646. // +featureGate=InPlacePodVerticalScaling
  647. // +optional
  648. // +listType=atomic
  649. repeated ContainerResizePolicy resizePolicy = 23;
  650. // RestartPolicy defines the restart behavior of individual containers in a pod.
  651. // This overrides the pod-level restart policy. When this field is not specified,
  652. // the restart behavior is defined by the Pod's restart policy and the container type.
  653. // Additionally, setting the RestartPolicy as "Always" for the init container will
  654. // have the following effect:
  655. // this init container will be continually restarted on
  656. // exit until all regular containers have terminated. Once all regular
  657. // containers have completed, all init containers with restartPolicy "Always"
  658. // will be shut down. This lifecycle differs from normal init containers and
  659. // is often referred to as a "sidecar" container. Although this init
  660. // container still starts in the init container sequence, it does not wait
  661. // for the container to complete before proceeding to the next init
  662. // container. Instead, the next init container starts immediately after this
  663. // init container is started, or after any startupProbe has successfully
  664. // completed.
  665. // +optional
  666. optional string restartPolicy = 24;
  667. // Represents a list of rules to be checked to determine if the
  668. // container should be restarted on exit. The rules are evaluated in
  669. // order. Once a rule matches a container exit condition, the remaining
  670. // rules are ignored. If no rule matches the container exit condition,
  671. // the Container-level restart policy determines the whether the container
  672. // is restarted or not. Constraints on the rules:
  673. // - At most 20 rules are allowed.
  674. // - Rules can have the same action.
  675. // - Identical rules are not forbidden in validations.
  676. // When rules are specified, container MUST set RestartPolicy explicitly
  677. // even it if matches the Pod's RestartPolicy.
  678. // +featureGate=ContainerRestartRules
  679. // +optional
  680. // +listType=atomic
  681. repeated ContainerRestartRule restartPolicyRules = 25;
  682. // Pod volumes to mount into the container's filesystem.
  683. // Cannot be updated.
  684. // +optional
  685. // +patchMergeKey=mountPath
  686. // +patchStrategy=merge
  687. // +listType=map
  688. // +listMapKey=mountPath
  689. repeated VolumeMount volumeMounts = 9;
  690. // volumeDevices is the list of block devices to be used by the container.
  691. // +patchMergeKey=devicePath
  692. // +patchStrategy=merge
  693. // +listType=map
  694. // +listMapKey=devicePath
  695. // +optional
  696. repeated VolumeDevice volumeDevices = 21;
  697. // Periodic probe of container liveness.
  698. // Container will be restarted if the probe fails.
  699. // Cannot be updated.
  700. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
  701. // +optional
  702. optional Probe livenessProbe = 10;
  703. // Periodic probe of container service readiness.
  704. // Container will be removed from service endpoints if the probe fails.
  705. // Cannot be updated.
  706. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
  707. // +optional
  708. optional Probe readinessProbe = 11;
  709. // StartupProbe indicates that the Pod has successfully initialized.
  710. // If specified, no other probes are executed until this completes successfully.
  711. // If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
  712. // This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
  713. // when it might take a long time to load data or warm a cache, than during steady-state operation.
  714. // This cannot be updated.
  715. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
  716. // +optional
  717. optional Probe startupProbe = 22;
  718. // Actions that the management system should take in response to container lifecycle events.
  719. // Cannot be updated.
  720. // +optional
  721. optional Lifecycle lifecycle = 12;
  722. // Optional: Path at which the file to which the container's termination message
  723. // will be written is mounted into the container's filesystem.
  724. // Message written is intended to be brief final status, such as an assertion failure message.
  725. // Will be truncated by the node if greater than 4096 bytes. The total message length across
  726. // all containers will be limited to 12kb.
  727. // Defaults to /dev/termination-log.
  728. // Cannot be updated.
  729. // +optional
  730. optional string terminationMessagePath = 13;
  731. // Indicate how the termination message should be populated. File will use the contents of
  732. // terminationMessagePath to populate the container status message on both success and failure.
  733. // FallbackToLogsOnError will use the last chunk of container log output if the termination
  734. // message file is empty and the container exited with an error.
  735. // The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
  736. // Defaults to File.
  737. // Cannot be updated.
  738. // +optional
  739. optional string terminationMessagePolicy = 20;
  740. // Image pull policy.
  741. // One of Always, Never, IfNotPresent.
  742. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
  743. // Cannot be updated.
  744. // More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
  745. // +optional
  746. optional string imagePullPolicy = 14;
  747. // SecurityContext defines the security options the container should be run with.
  748. // If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
  749. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
  750. // +optional
  751. optional SecurityContext securityContext = 15;
  752. // Whether this container should allocate a buffer for stdin in the container runtime. If this
  753. // is not set, reads from stdin in the container will always result in EOF.
  754. // Default is false.
  755. // +optional
  756. optional bool stdin = 16;
  757. // Whether the container runtime should close the stdin channel after it has been opened by
  758. // a single attach. When stdin is true the stdin stream will remain open across multiple attach
  759. // sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
  760. // first client attaches to stdin, and then remains open and accepts data until the client disconnects,
  761. // at which time stdin is closed and remains closed until the container is restarted. If this
  762. // flag is false, a container processes that reads from stdin will never receive an EOF.
  763. // Default is false
  764. // +optional
  765. optional bool stdinOnce = 17;
  766. // Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
  767. // Default is false.
  768. // +optional
  769. optional bool tty = 18;
  770. }
  771. // ContainerExtendedResourceRequest has the mapping of container name,
  772. // extended resource name to the device request name.
  773. message ContainerExtendedResourceRequest {
  774. // The name of the container requesting resources.
  775. optional string containerName = 1;
  776. // The name of the extended resource in that container which gets backed by DRA.
  777. optional string resourceName = 2;
  778. // The name of the request in the special ResourceClaim which corresponds to the extended resource.
  779. optional string requestName = 3;
  780. }
  781. // Describe a container image
  782. message ContainerImage {
  783. // Names by which this image is known.
  784. // e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
  785. // +optional
  786. // +listType=atomic
  787. repeated string names = 1;
  788. // The size of the image in bytes.
  789. // +optional
  790. optional int64 sizeBytes = 2;
  791. }
  792. // ContainerPort represents a network port in a single container.
  793. message ContainerPort {
  794. // If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
  795. // named port in a pod must have a unique name. Name for the port that can be
  796. // referred to by services.
  797. // +optional
  798. optional string name = 1;
  799. // Number of port to expose on the host.
  800. // If specified, this must be a valid port number, 0 < x < 65536.
  801. // If HostNetwork is specified, this must match ContainerPort.
  802. // Most containers do not need this.
  803. // +optional
  804. optional int32 hostPort = 2;
  805. // Number of port to expose on the pod's IP address.
  806. // This must be a valid port number, 0 < x < 65536.
  807. optional int32 containerPort = 3;
  808. // Protocol for port. Must be UDP, TCP, or SCTP.
  809. // Defaults to "TCP".
  810. // +optional
  811. // +default="TCP"
  812. optional string protocol = 4;
  813. // What host IP to bind the external port to.
  814. // +optional
  815. optional string hostIP = 5;
  816. }
  817. // ContainerResizePolicy represents resource resize policy for the container.
  818. message ContainerResizePolicy {
  819. // Name of the resource to which this resource resize policy applies.
  820. // Supported values: cpu, memory.
  821. optional string resourceName = 1;
  822. // Restart policy to apply when specified resource is resized.
  823. // If not specified, it defaults to NotRequired.
  824. optional string restartPolicy = 2;
  825. }
  826. // ContainerRestartRule describes how a container exit is handled.
  827. message ContainerRestartRule {
  828. // Specifies the action taken on a container exit if the requirements
  829. // are satisfied. The only possible value is "Restart" to restart the
  830. // container.
  831. // +required
  832. optional string action = 1;
  833. // Represents the exit codes to check on container exits.
  834. // +optional
  835. // +oneOf=when
  836. optional ContainerRestartRuleOnExitCodes exitCodes = 2;
  837. }
  838. // ContainerRestartRuleOnExitCodes describes the condition
  839. // for handling an exited container based on its exit codes.
  840. message ContainerRestartRuleOnExitCodes {
  841. // Represents the relationship between the container exit code(s) and the
  842. // specified values. Possible values are:
  843. // - In: the requirement is satisfied if the container exit code is in the
  844. // set of specified values.
  845. // - NotIn: the requirement is satisfied if the container exit code is
  846. // not in the set of specified values.
  847. // +required
  848. optional string operator = 1;
  849. // Specifies the set of values to check for container exit codes.
  850. // At most 255 elements are allowed.
  851. // +optional
  852. // +listType=set
  853. repeated int32 values = 2;
  854. }
  855. // ContainerState holds a possible state of container.
  856. // Only one of its members may be specified.
  857. // If none of them is specified, the default one is ContainerStateWaiting.
  858. message ContainerState {
  859. // Details about a waiting container
  860. // +optional
  861. optional ContainerStateWaiting waiting = 1;
  862. // Details about a running container
  863. // +optional
  864. optional ContainerStateRunning running = 2;
  865. // Details about a terminated container
  866. // +optional
  867. optional ContainerStateTerminated terminated = 3;
  868. }
  869. // ContainerStateRunning is a running state of a container.
  870. message ContainerStateRunning {
  871. // Time at which the container was last (re-)started
  872. // +optional
  873. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startedAt = 1;
  874. }
  875. // ContainerStateTerminated is a terminated state of a container.
  876. message ContainerStateTerminated {
  877. // Exit status from the last termination of the container
  878. optional int32 exitCode = 1;
  879. // Signal from the last termination of the container
  880. // +optional
  881. optional int32 signal = 2;
  882. // (brief) reason from the last termination of the container
  883. // +optional
  884. optional string reason = 3;
  885. // Message regarding the last termination of the container
  886. // +optional
  887. optional string message = 4;
  888. // Time at which previous execution of the container started
  889. // +optional
  890. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startedAt = 5;
  891. // Time at which the container last terminated
  892. // +optional
  893. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time finishedAt = 6;
  894. // Container's ID in the format '<type>://<container_id>'
  895. // +optional
  896. optional string containerID = 7;
  897. }
  898. // ContainerStateWaiting is a waiting state of a container.
  899. message ContainerStateWaiting {
  900. // (brief) reason the container is not yet running.
  901. // +optional
  902. optional string reason = 1;
  903. // Message regarding why the container is not yet running.
  904. // +optional
  905. optional string message = 2;
  906. }
  907. // ContainerStatus contains details for the current status of this container.
  908. message ContainerStatus {
  909. // Name is a DNS_LABEL representing the unique name of the container.
  910. // Each container in a pod must have a unique name across all container types.
  911. // Cannot be updated.
  912. optional string name = 1;
  913. // State holds details about the container's current condition.
  914. // +optional
  915. optional ContainerState state = 2;
  916. // LastTerminationState holds the last termination state of the container to
  917. // help debug container crashes and restarts. This field is not
  918. // populated if the container is still running and RestartCount is 0.
  919. // +optional
  920. optional ContainerState lastState = 3;
  921. // Ready specifies whether the container is currently passing its readiness check.
  922. // The value will change as readiness probes keep executing. If no readiness
  923. // probes are specified, this field defaults to true once the container is
  924. // fully started (see Started field).
  925. //
  926. // The value is typically used to determine whether a container is ready to
  927. // accept traffic.
  928. optional bool ready = 4;
  929. // RestartCount holds the number of times the container has been restarted.
  930. // Kubelet makes an effort to always increment the value, but there
  931. // are cases when the state may be lost due to node restarts and then the value
  932. // may be reset to 0. The value is never negative.
  933. optional int32 restartCount = 5;
  934. // Image is the name of container image that the container is running.
  935. // The container image may not match the image used in the PodSpec,
  936. // as it may have been resolved by the runtime.
  937. // More info: https://kubernetes.io/docs/concepts/containers/images.
  938. optional string image = 6;
  939. // ImageID is the image ID of the container's image. The image ID may not
  940. // match the image ID of the image used in the PodSpec, as it may have been
  941. // resolved by the runtime.
  942. optional string imageID = 7;
  943. // ContainerID is the ID of the container in the format '<type>://<container_id>'.
  944. // Where type is a container runtime identifier, returned from Version call of CRI API
  945. // (for example "containerd").
  946. // +optional
  947. optional string containerID = 8;
  948. // Started indicates whether the container has finished its postStart lifecycle hook
  949. // and passed its startup probe.
  950. // Initialized as false, becomes true after startupProbe is considered
  951. // successful. Resets to false when the container is restarted, or if kubelet
  952. // loses state temporarily. In both cases, startup probes will run again.
  953. // Is always true when no startupProbe is defined and container is running and
  954. // has passed the postStart lifecycle hook. The null value must be treated the
  955. // same as false.
  956. // +optional
  957. optional bool started = 9;
  958. // AllocatedResources represents the compute resources allocated for this container by the
  959. // node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission
  960. // and after successfully admitting desired pod resize.
  961. // +featureGate=InPlacePodVerticalScalingAllocatedStatus
  962. // +optional
  963. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> allocatedResources = 10;
  964. // Resources represents the compute resource requests and limits that have been successfully
  965. // enacted on the running container after it has been started or has been successfully resized.
  966. // +featureGate=InPlacePodVerticalScaling
  967. // +optional
  968. optional ResourceRequirements resources = 11;
  969. // Status of volume mounts.
  970. // +optional
  971. // +patchMergeKey=mountPath
  972. // +patchStrategy=merge
  973. // +listType=map
  974. // +listMapKey=mountPath
  975. repeated VolumeMountStatus volumeMounts = 12;
  976. // User represents user identity information initially attached to the first process of the container
  977. // +featureGate=SupplementalGroupsPolicy
  978. // +optional
  979. optional ContainerUser user = 13;
  980. // AllocatedResourcesStatus represents the status of various resources
  981. // allocated for this Pod.
  982. // +featureGate=ResourceHealthStatus
  983. // +optional
  984. // +patchMergeKey=name
  985. // +patchStrategy=merge
  986. // +listType=map
  987. // +listMapKey=name
  988. repeated ResourceStatus allocatedResourcesStatus = 14;
  989. // StopSignal reports the effective stop signal for this container
  990. // +featureGate=ContainerStopSignals
  991. // +optional
  992. optional string stopSignal = 15;
  993. }
  994. // ContainerUser represents user identity information
  995. message ContainerUser {
  996. // Linux holds user identity information initially attached to the first process of the containers in Linux.
  997. // Note that the actual running identity can be changed if the process has enough privilege to do so.
  998. // +optional
  999. optional LinuxContainerUser linux = 1;
  1000. }
  1001. // DaemonEndpoint contains information about a single Daemon endpoint.
  1002. message DaemonEndpoint {
  1003. // Port number of the given endpoint.
  1004. optional int32 Port = 1;
  1005. }
  1006. // Represents downward API info for projecting into a projected volume.
  1007. // Note that this is identical to a downwardAPI volume source without the default
  1008. // mode.
  1009. message DownwardAPIProjection {
  1010. // Items is a list of DownwardAPIVolume file
  1011. // +optional
  1012. // +listType=atomic
  1013. repeated DownwardAPIVolumeFile items = 1;
  1014. }
  1015. // DownwardAPIVolumeFile represents information to create the file containing the pod field
  1016. message DownwardAPIVolumeFile {
  1017. // Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
  1018. optional string path = 1;
  1019. // Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
  1020. // +optional
  1021. optional ObjectFieldSelector fieldRef = 2;
  1022. // Selects a resource of the container: only resources limits and requests
  1023. // (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
  1024. // +optional
  1025. optional ResourceFieldSelector resourceFieldRef = 3;
  1026. // Optional: mode bits used to set permissions on this file, must be an octal value
  1027. // between 0000 and 0777 or a decimal value between 0 and 511.
  1028. // YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  1029. // If not specified, the volume defaultMode will be used.
  1030. // This might be in conflict with other options that affect the file
  1031. // mode, like fsGroup, and the result can be other mode bits set.
  1032. // +optional
  1033. optional int32 mode = 4;
  1034. }
  1035. // DownwardAPIVolumeSource represents a volume containing downward API info.
  1036. // Downward API volumes support ownership management and SELinux relabeling.
  1037. message DownwardAPIVolumeSource {
  1038. // Items is a list of downward API volume file
  1039. // +optional
  1040. // +listType=atomic
  1041. repeated DownwardAPIVolumeFile items = 1;
  1042. // Optional: mode bits to use on created files by default. Must be a
  1043. // Optional: mode bits used to set permissions on created files by default.
  1044. // Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  1045. // YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  1046. // Defaults to 0644.
  1047. // Directories within the path are not affected by this setting.
  1048. // This might be in conflict with other options that affect the file
  1049. // mode, like fsGroup, and the result can be other mode bits set.
  1050. // +optional
  1051. optional int32 defaultMode = 2;
  1052. }
  1053. // Represents an empty directory for a pod.
  1054. // Empty directory volumes support ownership management and SELinux relabeling.
  1055. message EmptyDirVolumeSource {
  1056. // medium represents what type of storage medium should back this directory.
  1057. // The default is "" which means to use the node's default medium.
  1058. // Must be an empty string (default) or Memory.
  1059. // More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  1060. // +optional
  1061. optional string medium = 1;
  1062. // sizeLimit is the total amount of local storage required for this EmptyDir volume.
  1063. // The size limit is also applicable for memory medium.
  1064. // The maximum usage on memory medium EmptyDir would be the minimum value between
  1065. // the SizeLimit specified here and the sum of memory limits of all containers in a pod.
  1066. // The default is nil which means that the limit is undefined.
  1067. // More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  1068. // +optional
  1069. optional .k8s.io.apimachinery.pkg.api.resource.Quantity sizeLimit = 2;
  1070. }
  1071. // EndpointAddress is a tuple that describes single IP address.
  1072. // Deprecated: This API is deprecated in v1.33+.
  1073. // +structType=atomic
  1074. message EndpointAddress {
  1075. // The IP of this endpoint.
  1076. // May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10),
  1077. // or link-local multicast (224.0.0.0/24 or ff02::/16).
  1078. optional string ip = 1;
  1079. // The Hostname of this endpoint
  1080. // +optional
  1081. optional string hostname = 3;
  1082. // Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
  1083. // +optional
  1084. optional string nodeName = 4;
  1085. // Reference to object providing the endpoint.
  1086. // +optional
  1087. optional ObjectReference targetRef = 2;
  1088. }
  1089. // EndpointPort is a tuple that describes a single port.
  1090. // Deprecated: This API is deprecated in v1.33+.
  1091. // +structType=atomic
  1092. message EndpointPort {
  1093. // The name of this port. This must match the 'name' field in the
  1094. // corresponding ServicePort.
  1095. // Must be a DNS_LABEL.
  1096. // Optional only if one port is defined.
  1097. // +optional
  1098. optional string name = 1;
  1099. // The port number of the endpoint.
  1100. optional int32 port = 2;
  1101. // The IP protocol for this port.
  1102. // Must be UDP, TCP, or SCTP.
  1103. // Default is TCP.
  1104. // +optional
  1105. optional string protocol = 3;
  1106. // The application protocol for this port.
  1107. // This is used as a hint for implementations to offer richer behavior for protocols that they understand.
  1108. // This field follows standard Kubernetes label syntax.
  1109. // Valid values are either:
  1110. //
  1111. // * Un-prefixed protocol names - reserved for IANA standard service names (as per
  1112. // RFC-6335 and https://www.iana.org/assignments/service-names).
  1113. //
  1114. // * Kubernetes-defined prefixed names:
  1115. // * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
  1116. // * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
  1117. // * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
  1118. //
  1119. // * Other protocols should use implementation-defined prefixed names such as
  1120. // mycompany.com/my-custom-protocol.
  1121. // +optional
  1122. optional string appProtocol = 4;
  1123. }
  1124. // EndpointSubset is a group of addresses with a common set of ports. The
  1125. // expanded set of endpoints is the Cartesian product of Addresses x Ports.
  1126. // For example, given:
  1127. //
  1128. // {
  1129. // Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  1130. // Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  1131. // }
  1132. //
  1133. // The resulting set of endpoints can be viewed as:
  1134. //
  1135. // a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
  1136. // b: [ 10.10.1.1:309, 10.10.2.2:309 ]
  1137. //
  1138. // Deprecated: This API is deprecated in v1.33+.
  1139. message EndpointSubset {
  1140. // IP addresses which offer the related ports that are marked as ready. These endpoints
  1141. // should be considered safe for load balancers and clients to utilize.
  1142. // +optional
  1143. // +listType=atomic
  1144. repeated EndpointAddress addresses = 1;
  1145. // IP addresses which offer the related ports but are not currently marked as ready
  1146. // because they have not yet finished starting, have recently failed a readiness check,
  1147. // or have recently failed a liveness check.
  1148. // +optional
  1149. // +listType=atomic
  1150. repeated EndpointAddress notReadyAddresses = 2;
  1151. // Port numbers available on the related IP addresses.
  1152. // +optional
  1153. // +listType=atomic
  1154. repeated EndpointPort ports = 3;
  1155. }
  1156. // Endpoints is a collection of endpoints that implement the actual service. Example:
  1157. //
  1158. // Name: "mysvc",
  1159. // Subsets: [
  1160. // {
  1161. // Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  1162. // Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  1163. // },
  1164. // {
  1165. // Addresses: [{"ip": "10.10.3.3"}],
  1166. // Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
  1167. // },
  1168. // ]
  1169. //
  1170. // Endpoints is a legacy API and does not contain information about all Service features.
  1171. // Use discoveryv1.EndpointSlice for complete information about Service endpoints.
  1172. //
  1173. // Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.
  1174. message Endpoints {
  1175. // Standard object's metadata.
  1176. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  1177. // +optional
  1178. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1179. // The set of all endpoints is the union of all subsets. Addresses are placed into
  1180. // subsets according to the IPs they share. A single address with multiple ports,
  1181. // some of which are ready and some of which are not (because they come from
  1182. // different containers) will result in the address being displayed in different
  1183. // subsets for the different ports. No address will appear in both Addresses and
  1184. // NotReadyAddresses in the same subset.
  1185. // Sets of addresses and ports that comprise a service.
  1186. // +optional
  1187. // +listType=atomic
  1188. repeated EndpointSubset subsets = 2;
  1189. }
  1190. // EndpointsList is a list of endpoints.
  1191. // Deprecated: This API is deprecated in v1.33+.
  1192. message EndpointsList {
  1193. // Standard list metadata.
  1194. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  1195. // +optional
  1196. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1197. // List of endpoints.
  1198. repeated Endpoints items = 2;
  1199. }
  1200. // EnvFromSource represents the source of a set of ConfigMaps or Secrets
  1201. message EnvFromSource {
  1202. // Optional text to prepend to the name of each environment variable.
  1203. // May consist of any printable ASCII characters except '='.
  1204. // +optional
  1205. optional string prefix = 1;
  1206. // The ConfigMap to select from
  1207. // +optional
  1208. optional ConfigMapEnvSource configMapRef = 2;
  1209. // The Secret to select from
  1210. // +optional
  1211. optional SecretEnvSource secretRef = 3;
  1212. }
  1213. // EnvVar represents an environment variable present in a Container.
  1214. message EnvVar {
  1215. // Name of the environment variable.
  1216. // May consist of any printable ASCII characters except '='.
  1217. optional string name = 1;
  1218. // Variable references $(VAR_NAME) are expanded
  1219. // using the previously defined environment variables in the container and
  1220. // any service environment variables. If a variable cannot be resolved,
  1221. // the reference in the input string will be unchanged. Double $$ are reduced
  1222. // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
  1223. // "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
  1224. // Escaped references will never be expanded, regardless of whether the variable
  1225. // exists or not.
  1226. // Defaults to "".
  1227. // +optional
  1228. optional string value = 2;
  1229. // Source for the environment variable's value. Cannot be used if value is not empty.
  1230. // +optional
  1231. optional EnvVarSource valueFrom = 3;
  1232. }
  1233. // EnvVarSource represents a source for the value of an EnvVar.
  1234. message EnvVarSource {
  1235. // Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
  1236. // spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
  1237. // +optional
  1238. optional ObjectFieldSelector fieldRef = 1;
  1239. // Selects a resource of the container: only resources limits and requests
  1240. // (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
  1241. // +optional
  1242. optional ResourceFieldSelector resourceFieldRef = 2;
  1243. // Selects a key of a ConfigMap.
  1244. // +optional
  1245. optional ConfigMapKeySelector configMapKeyRef = 3;
  1246. // Selects a key of a secret in the pod's namespace
  1247. // +optional
  1248. optional SecretKeySelector secretKeyRef = 4;
  1249. // FileKeyRef selects a key of the env file.
  1250. // Requires the EnvFiles feature gate to be enabled.
  1251. //
  1252. // +featureGate=EnvFiles
  1253. // +optional
  1254. optional FileKeySelector fileKeyRef = 5;
  1255. }
  1256. // An EphemeralContainer is a temporary container that you may add to an existing Pod for
  1257. // user-initiated activities such as debugging. Ephemeral containers have no resource or
  1258. // scheduling guarantees, and they will not be restarted when they exit or when a Pod is
  1259. // removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the
  1260. // Pod to exceed its resource allocation.
  1261. //
  1262. // To add an ephemeral container, use the ephemeralcontainers subresource of an existing
  1263. // Pod. Ephemeral containers may not be removed or restarted.
  1264. message EphemeralContainer {
  1265. // Ephemeral containers have all of the fields of Container, plus additional fields
  1266. // specific to ephemeral containers. Fields in common with Container are in the
  1267. // following inlined struct so than an EphemeralContainer may easily be converted
  1268. // to a Container.
  1269. optional EphemeralContainerCommon ephemeralContainerCommon = 1;
  1270. // If set, the name of the container from PodSpec that this ephemeral container targets.
  1271. // The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.
  1272. // If not set then the ephemeral container uses the namespaces configured in the Pod spec.
  1273. //
  1274. // The container runtime must implement support for this feature. If the runtime does not
  1275. // support namespace targeting then the result of setting this field is undefined.
  1276. // +optional
  1277. optional string targetContainerName = 2;
  1278. }
  1279. // EphemeralContainerCommon is a copy of all fields in Container to be inlined in
  1280. // EphemeralContainer. This separate type allows easy conversion from EphemeralContainer
  1281. // to Container and allows separate documentation for the fields of EphemeralContainer.
  1282. // When a new field is added to Container it must be added here as well.
  1283. message EphemeralContainerCommon {
  1284. // Name of the ephemeral container specified as a DNS_LABEL.
  1285. // This name must be unique among all containers, init containers and ephemeral containers.
  1286. optional string name = 1;
  1287. // Container image name.
  1288. // More info: https://kubernetes.io/docs/concepts/containers/images
  1289. optional string image = 2;
  1290. // Entrypoint array. Not executed within a shell.
  1291. // The image's ENTRYPOINT is used if this is not provided.
  1292. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  1293. // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
  1294. // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
  1295. // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
  1296. // of whether the variable exists or not. Cannot be updated.
  1297. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
  1298. // +optional
  1299. // +listType=atomic
  1300. repeated string command = 3;
  1301. // Arguments to the entrypoint.
  1302. // The image's CMD is used if this is not provided.
  1303. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  1304. // cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
  1305. // to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
  1306. // produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
  1307. // of whether the variable exists or not. Cannot be updated.
  1308. // More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
  1309. // +optional
  1310. // +listType=atomic
  1311. repeated string args = 4;
  1312. // Container's working directory.
  1313. // If not specified, the container runtime's default will be used, which
  1314. // might be configured in the container image.
  1315. // Cannot be updated.
  1316. // +optional
  1317. optional string workingDir = 5;
  1318. // Ports are not allowed for ephemeral containers.
  1319. // +optional
  1320. // +patchMergeKey=containerPort
  1321. // +patchStrategy=merge
  1322. // +listType=map
  1323. // +listMapKey=containerPort
  1324. // +listMapKey=protocol
  1325. repeated ContainerPort ports = 6;
  1326. // List of sources to populate environment variables in the container.
  1327. // The keys defined within a source may consist of any printable ASCII characters except '='.
  1328. // When a key exists in multiple
  1329. // sources, the value associated with the last source will take precedence.
  1330. // Values defined by an Env with a duplicate key will take precedence.
  1331. // Cannot be updated.
  1332. // +optional
  1333. // +listType=atomic
  1334. repeated EnvFromSource envFrom = 19;
  1335. // List of environment variables to set in the container.
  1336. // Cannot be updated.
  1337. // +optional
  1338. // +patchMergeKey=name
  1339. // +patchStrategy=merge
  1340. // +listType=map
  1341. // +listMapKey=name
  1342. repeated EnvVar env = 7;
  1343. // Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources
  1344. // already allocated to the pod.
  1345. // +optional
  1346. optional ResourceRequirements resources = 8;
  1347. // Resources resize policy for the container.
  1348. // +featureGate=InPlacePodVerticalScaling
  1349. // +optional
  1350. // +listType=atomic
  1351. repeated ContainerResizePolicy resizePolicy = 23;
  1352. // Restart policy for the container to manage the restart behavior of each
  1353. // container within a pod.
  1354. // You cannot set this field on ephemeral containers.
  1355. // +optional
  1356. optional string restartPolicy = 24;
  1357. // Represents a list of rules to be checked to determine if the
  1358. // container should be restarted on exit. You cannot set this field on
  1359. // ephemeral containers.
  1360. // +featureGate=ContainerRestartRules
  1361. // +optional
  1362. // +listType=atomic
  1363. repeated ContainerRestartRule restartPolicyRules = 25;
  1364. // Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.
  1365. // Cannot be updated.
  1366. // +optional
  1367. // +patchMergeKey=mountPath
  1368. // +patchStrategy=merge
  1369. // +listType=map
  1370. // +listMapKey=mountPath
  1371. repeated VolumeMount volumeMounts = 9;
  1372. // volumeDevices is the list of block devices to be used by the container.
  1373. // +patchMergeKey=devicePath
  1374. // +patchStrategy=merge
  1375. // +listType=map
  1376. // +listMapKey=devicePath
  1377. // +optional
  1378. repeated VolumeDevice volumeDevices = 21;
  1379. // Probes are not allowed for ephemeral containers.
  1380. // +optional
  1381. optional Probe livenessProbe = 10;
  1382. // Probes are not allowed for ephemeral containers.
  1383. // +optional
  1384. optional Probe readinessProbe = 11;
  1385. // Probes are not allowed for ephemeral containers.
  1386. // +optional
  1387. optional Probe startupProbe = 22;
  1388. // Lifecycle is not allowed for ephemeral containers.
  1389. // +optional
  1390. optional Lifecycle lifecycle = 12;
  1391. // Optional: Path at which the file to which the container's termination message
  1392. // will be written is mounted into the container's filesystem.
  1393. // Message written is intended to be brief final status, such as an assertion failure message.
  1394. // Will be truncated by the node if greater than 4096 bytes. The total message length across
  1395. // all containers will be limited to 12kb.
  1396. // Defaults to /dev/termination-log.
  1397. // Cannot be updated.
  1398. // +optional
  1399. optional string terminationMessagePath = 13;
  1400. // Indicate how the termination message should be populated. File will use the contents of
  1401. // terminationMessagePath to populate the container status message on both success and failure.
  1402. // FallbackToLogsOnError will use the last chunk of container log output if the termination
  1403. // message file is empty and the container exited with an error.
  1404. // The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
  1405. // Defaults to File.
  1406. // Cannot be updated.
  1407. // +optional
  1408. optional string terminationMessagePolicy = 20;
  1409. // Image pull policy.
  1410. // One of Always, Never, IfNotPresent.
  1411. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
  1412. // Cannot be updated.
  1413. // More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
  1414. // +optional
  1415. optional string imagePullPolicy = 14;
  1416. // Optional: SecurityContext defines the security options the ephemeral container should be run with.
  1417. // If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
  1418. // +optional
  1419. optional SecurityContext securityContext = 15;
  1420. // Whether this container should allocate a buffer for stdin in the container runtime. If this
  1421. // is not set, reads from stdin in the container will always result in EOF.
  1422. // Default is false.
  1423. // +optional
  1424. optional bool stdin = 16;
  1425. // Whether the container runtime should close the stdin channel after it has been opened by
  1426. // a single attach. When stdin is true the stdin stream will remain open across multiple attach
  1427. // sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
  1428. // first client attaches to stdin, and then remains open and accepts data until the client disconnects,
  1429. // at which time stdin is closed and remains closed until the container is restarted. If this
  1430. // flag is false, a container processes that reads from stdin will never receive an EOF.
  1431. // Default is false
  1432. // +optional
  1433. optional bool stdinOnce = 17;
  1434. // Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
  1435. // Default is false.
  1436. // +optional
  1437. optional bool tty = 18;
  1438. }
  1439. // Represents an ephemeral volume that is handled by a normal storage driver.
  1440. message EphemeralVolumeSource {
  1441. // Will be used to create a stand-alone PVC to provision the volume.
  1442. // The pod in which this EphemeralVolumeSource is embedded will be the
  1443. // owner of the PVC, i.e. the PVC will be deleted together with the
  1444. // pod. The name of the PVC will be `<pod name>-<volume name>` where
  1445. // `<volume name>` is the name from the `PodSpec.Volumes` array
  1446. // entry. Pod validation will reject the pod if the concatenated name
  1447. // is not valid for a PVC (for example, too long).
  1448. //
  1449. // An existing PVC with that name that is not owned by the pod
  1450. // will *not* be used for the pod to avoid using an unrelated
  1451. // volume by mistake. Starting the pod is then blocked until
  1452. // the unrelated PVC is removed. If such a pre-created PVC is
  1453. // meant to be used by the pod, the PVC has to updated with an
  1454. // owner reference to the pod once the pod exists. Normally
  1455. // this should not be necessary, but it may be useful when
  1456. // manually reconstructing a broken cluster.
  1457. //
  1458. // This field is read-only and no changes will be made by Kubernetes
  1459. // to the PVC after it has been created.
  1460. //
  1461. // Required, must not be nil.
  1462. optional PersistentVolumeClaimTemplate volumeClaimTemplate = 1;
  1463. }
  1464. // Event is a report of an event somewhere in the cluster. Events
  1465. // have a limited retention time and triggers and messages may evolve
  1466. // with time. Event consumers should not rely on the timing of an event
  1467. // with a given Reason reflecting a consistent underlying trigger, or the
  1468. // continued existence of events with that Reason. Events should be
  1469. // treated as informative, best-effort, supplemental data.
  1470. message Event {
  1471. // Standard object's metadata.
  1472. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  1473. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1474. // The object that this event is about.
  1475. optional ObjectReference involvedObject = 2;
  1476. // This should be a short, machine understandable string that gives the reason
  1477. // for the transition into the object's current status.
  1478. // TODO: provide exact specification for format.
  1479. // +optional
  1480. optional string reason = 3;
  1481. // A human-readable description of the status of this operation.
  1482. // TODO: decide on maximum length.
  1483. // +optional
  1484. optional string message = 4;
  1485. // The component reporting this event. Should be a short machine understandable string.
  1486. // +optional
  1487. optional EventSource source = 5;
  1488. // The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
  1489. // +optional
  1490. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time firstTimestamp = 6;
  1491. // The time at which the most recent occurrence of this event was recorded.
  1492. // +optional
  1493. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTimestamp = 7;
  1494. // The number of times this event has occurred.
  1495. // +optional
  1496. optional int32 count = 8;
  1497. // Type of this event (Normal, Warning), new types could be added in the future
  1498. // +optional
  1499. optional string type = 9;
  1500. // Time when this Event was first observed.
  1501. // +optional
  1502. optional .k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime eventTime = 10;
  1503. // Data about the Event series this event represents or nil if it's a singleton Event.
  1504. // +optional
  1505. optional EventSeries series = 11;
  1506. // What action was taken/failed regarding to the Regarding object.
  1507. // +optional
  1508. optional string action = 12;
  1509. // Optional secondary object for more complex actions.
  1510. // +optional
  1511. optional ObjectReference related = 13;
  1512. // Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.
  1513. // +optional
  1514. optional string reportingComponent = 14;
  1515. // ID of the controller instance, e.g. `kubelet-xyzf`.
  1516. // +optional
  1517. optional string reportingInstance = 15;
  1518. }
  1519. // EventList is a list of events.
  1520. message EventList {
  1521. // Standard list metadata.
  1522. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  1523. // +optional
  1524. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1525. // List of events
  1526. repeated Event items = 2;
  1527. }
  1528. // EventSeries contain information on series of events, i.e. thing that was/is happening
  1529. // continuously for some time.
  1530. message EventSeries {
  1531. // Number of occurrences in this series up to the last heartbeat time
  1532. optional int32 count = 1;
  1533. // Time of the last occurrence observed
  1534. optional .k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime lastObservedTime = 2;
  1535. }
  1536. // EventSource contains information for an event.
  1537. message EventSource {
  1538. // Component from which the event is generated.
  1539. // +optional
  1540. optional string component = 1;
  1541. // Node name on which the event is generated.
  1542. // +optional
  1543. optional string host = 2;
  1544. }
  1545. // ExecAction describes a "run in container" action.
  1546. message ExecAction {
  1547. // Command is the command line to execute inside the container, the working directory for the
  1548. // command is root ('/') in the container's filesystem. The command is simply exec'd, it is
  1549. // not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
  1550. // a shell, you need to explicitly call out to that shell.
  1551. // Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
  1552. // +optional
  1553. // +listType=atomic
  1554. repeated string command = 1;
  1555. }
  1556. // Represents a Fibre Channel volume.
  1557. // Fibre Channel volumes can only be mounted as read/write once.
  1558. // Fibre Channel volumes support ownership management and SELinux relabeling.
  1559. message FCVolumeSource {
  1560. // targetWWNs is Optional: FC target worldwide names (WWNs)
  1561. // +optional
  1562. // +listType=atomic
  1563. repeated string targetWWNs = 1;
  1564. // lun is Optional: FC target lun number
  1565. // +optional
  1566. optional int32 lun = 2;
  1567. // fsType is the filesystem type to mount.
  1568. // Must be a filesystem type supported by the host operating system.
  1569. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1570. // TODO: how do we prevent errors in the filesystem from compromising the machine
  1571. // +optional
  1572. optional string fsType = 3;
  1573. // readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  1574. // the ReadOnly setting in VolumeMounts.
  1575. // +optional
  1576. optional bool readOnly = 4;
  1577. // wwids Optional: FC volume world wide identifiers (wwids)
  1578. // Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
  1579. // +optional
  1580. // +listType=atomic
  1581. repeated string wwids = 5;
  1582. }
  1583. // FileKeySelector selects a key of the env file.
  1584. // +structType=atomic
  1585. message FileKeySelector {
  1586. // The name of the volume mount containing the env file.
  1587. // +required
  1588. optional string volumeName = 1;
  1589. // The path within the volume from which to select the file.
  1590. // Must be relative and may not contain the '..' path or start with '..'.
  1591. // +required
  1592. optional string path = 2;
  1593. // The key within the env file. An invalid key will prevent the pod from starting.
  1594. // The keys defined within a source may consist of any printable ASCII characters except '='.
  1595. // During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
  1596. // +required
  1597. optional string key = 3;
  1598. // Specify whether the file or its key must be defined. If the file or key
  1599. // does not exist, then the env var is not published.
  1600. // If optional is set to true and the specified key does not exist,
  1601. // the environment variable will not be set in the Pod's containers.
  1602. //
  1603. // If optional is set to false and the specified key does not exist,
  1604. // an error will be returned during Pod creation.
  1605. // +optional
  1606. // +default=false
  1607. optional bool optional = 4;
  1608. }
  1609. // FlexPersistentVolumeSource represents a generic persistent volume resource that is
  1610. // provisioned/attached using an exec based plugin.
  1611. message FlexPersistentVolumeSource {
  1612. // driver is the name of the driver to use for this volume.
  1613. optional string driver = 1;
  1614. // fsType is the Filesystem type to mount.
  1615. // Must be a filesystem type supported by the host operating system.
  1616. // Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  1617. // +optional
  1618. optional string fsType = 2;
  1619. // secretRef is Optional: SecretRef is reference to the secret object containing
  1620. // sensitive information to pass to the plugin scripts. This may be
  1621. // empty if no secret object is specified. If the secret object
  1622. // contains more than one secret, all secrets are passed to the plugin
  1623. // scripts.
  1624. // +optional
  1625. optional SecretReference secretRef = 3;
  1626. // readOnly is Optional: defaults to false (read/write). ReadOnly here will force
  1627. // the ReadOnly setting in VolumeMounts.
  1628. // +optional
  1629. optional bool readOnly = 4;
  1630. // options is Optional: this field holds extra command options if any.
  1631. // +optional
  1632. map<string, string> options = 5;
  1633. }
  1634. // FlexVolume represents a generic volume resource that is
  1635. // provisioned/attached using an exec based plugin.
  1636. message FlexVolumeSource {
  1637. // driver is the name of the driver to use for this volume.
  1638. optional string driver = 1;
  1639. // fsType is the filesystem type to mount.
  1640. // Must be a filesystem type supported by the host operating system.
  1641. // Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  1642. // +optional
  1643. optional string fsType = 2;
  1644. // secretRef is Optional: secretRef is reference to the secret object containing
  1645. // sensitive information to pass to the plugin scripts. This may be
  1646. // empty if no secret object is specified. If the secret object
  1647. // contains more than one secret, all secrets are passed to the plugin
  1648. // scripts.
  1649. // +optional
  1650. optional LocalObjectReference secretRef = 3;
  1651. // readOnly is Optional: defaults to false (read/write). ReadOnly here will force
  1652. // the ReadOnly setting in VolumeMounts.
  1653. // +optional
  1654. optional bool readOnly = 4;
  1655. // options is Optional: this field holds extra command options if any.
  1656. // +optional
  1657. map<string, string> options = 5;
  1658. }
  1659. // Represents a Flocker volume mounted by the Flocker agent.
  1660. // One and only one of datasetName and datasetUUID should be set.
  1661. // Flocker volumes do not support ownership management or SELinux relabeling.
  1662. message FlockerVolumeSource {
  1663. // datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
  1664. // should be considered as deprecated
  1665. // +optional
  1666. optional string datasetName = 1;
  1667. // datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
  1668. // +optional
  1669. optional string datasetUUID = 2;
  1670. }
  1671. // Represents a Persistent Disk resource in Google Compute Engine.
  1672. //
  1673. // A GCE PD must exist before mounting to a container. The disk must
  1674. // also be in the same GCE project and zone as the kubelet. A GCE PD
  1675. // can only be mounted as read/write once or read-only many times. GCE
  1676. // PDs support ownership management and SELinux relabeling.
  1677. message GCEPersistentDiskVolumeSource {
  1678. // pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
  1679. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  1680. optional string pdName = 1;
  1681. // fsType is filesystem type of the volume that you want to mount.
  1682. // Tip: Ensure that the filesystem type is supported by the host operating system.
  1683. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1684. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  1685. // TODO: how do we prevent errors in the filesystem from compromising the machine
  1686. // +optional
  1687. optional string fsType = 2;
  1688. // partition is the partition in the volume that you want to mount.
  1689. // If omitted, the default is to mount by volume name.
  1690. // Examples: For volume /dev/sda1, you specify the partition as "1".
  1691. // Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  1692. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  1693. // +optional
  1694. optional int32 partition = 3;
  1695. // readOnly here will force the ReadOnly setting in VolumeMounts.
  1696. // Defaults to false.
  1697. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  1698. // +optional
  1699. optional bool readOnly = 4;
  1700. }
  1701. // GRPCAction specifies an action involving a GRPC service.
  1702. message GRPCAction {
  1703. // Port number of the gRPC service. Number must be in the range 1 to 65535.
  1704. optional int32 port = 1;
  1705. // Service is the name of the service to place in the gRPC HealthCheckRequest
  1706. // (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  1707. //
  1708. // If this is not specified, the default behavior is defined by gRPC.
  1709. // +optional
  1710. // +default=""
  1711. optional string service = 2;
  1712. }
  1713. // Represents a volume that is populated with the contents of a git repository.
  1714. // Git repo volumes do not support ownership management.
  1715. // Git repo volumes support SELinux relabeling.
  1716. //
  1717. // DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an
  1718. // EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
  1719. // into the Pod's container.
  1720. message GitRepoVolumeSource {
  1721. // repository is the URL
  1722. optional string repository = 1;
  1723. // revision is the commit hash for the specified revision.
  1724. // +optional
  1725. optional string revision = 2;
  1726. // directory is the target directory name.
  1727. // Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
  1728. // git repository. Otherwise, if specified, the volume will contain the git repository in
  1729. // the subdirectory with the given name.
  1730. // +optional
  1731. optional string directory = 3;
  1732. }
  1733. // Represents a Glusterfs mount that lasts the lifetime of a pod.
  1734. // Glusterfs volumes do not support ownership management or SELinux relabeling.
  1735. message GlusterfsPersistentVolumeSource {
  1736. // endpoints is the endpoint name that details Glusterfs topology.
  1737. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1738. optional string endpoints = 1;
  1739. // path is the Glusterfs volume path.
  1740. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1741. optional string path = 2;
  1742. // readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
  1743. // Defaults to false.
  1744. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1745. // +optional
  1746. optional bool readOnly = 3;
  1747. // endpointsNamespace is the namespace that contains Glusterfs endpoint.
  1748. // If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC.
  1749. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1750. // +optional
  1751. optional string endpointsNamespace = 4;
  1752. }
  1753. // Represents a Glusterfs mount that lasts the lifetime of a pod.
  1754. // Glusterfs volumes do not support ownership management or SELinux relabeling.
  1755. message GlusterfsVolumeSource {
  1756. // endpoints is the endpoint name that details Glusterfs topology.
  1757. optional string endpoints = 1;
  1758. // path is the Glusterfs volume path.
  1759. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1760. optional string path = 2;
  1761. // readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
  1762. // Defaults to false.
  1763. // More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  1764. // +optional
  1765. optional bool readOnly = 3;
  1766. }
  1767. // HTTPGetAction describes an action based on HTTP Get requests.
  1768. message HTTPGetAction {
  1769. // Path to access on the HTTP server.
  1770. // +optional
  1771. optional string path = 1;
  1772. // Name or number of the port to access on the container.
  1773. // Number must be in the range 1 to 65535.
  1774. // Name must be an IANA_SVC_NAME.
  1775. optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2;
  1776. // Host name to connect to, defaults to the pod IP. You probably want to set
  1777. // "Host" in httpHeaders instead.
  1778. // +optional
  1779. optional string host = 3;
  1780. // Scheme to use for connecting to the host.
  1781. // Defaults to HTTP.
  1782. // +optional
  1783. optional string scheme = 4;
  1784. // Custom headers to set in the request. HTTP allows repeated headers.
  1785. // +optional
  1786. // +listType=atomic
  1787. repeated HTTPHeader httpHeaders = 5;
  1788. }
  1789. // HTTPHeader describes a custom header to be used in HTTP probes
  1790. message HTTPHeader {
  1791. // The header field name.
  1792. // This will be canonicalized upon output, so case-variant names will be understood as the same header.
  1793. optional string name = 1;
  1794. // The header field value
  1795. optional string value = 2;
  1796. }
  1797. // HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the
  1798. // pod's hosts file.
  1799. message HostAlias {
  1800. // IP address of the host file entry.
  1801. // +required
  1802. optional string ip = 1;
  1803. // Hostnames for the above IP address.
  1804. // +listType=atomic
  1805. repeated string hostnames = 2;
  1806. }
  1807. // HostIP represents a single IP address allocated to the host.
  1808. message HostIP {
  1809. // IP is the IP address assigned to the host
  1810. // +required
  1811. optional string ip = 1;
  1812. }
  1813. // Represents a host path mapped into a pod.
  1814. // Host path volumes do not support ownership management or SELinux relabeling.
  1815. message HostPathVolumeSource {
  1816. // path of the directory on the host.
  1817. // If the path is a symlink, it will follow the link to the real path.
  1818. // More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  1819. optional string path = 1;
  1820. // type for HostPath Volume
  1821. // Defaults to ""
  1822. // More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  1823. // +optional
  1824. optional string type = 2;
  1825. }
  1826. // ISCSIPersistentVolumeSource represents an ISCSI disk.
  1827. // ISCSI volumes can only be mounted as read/write once.
  1828. // ISCSI volumes support ownership management and SELinux relabeling.
  1829. message ISCSIPersistentVolumeSource {
  1830. // targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
  1831. // is other than default (typically TCP ports 860 and 3260).
  1832. optional string targetPortal = 1;
  1833. // iqn is Target iSCSI Qualified Name.
  1834. optional string iqn = 2;
  1835. // lun is iSCSI Target Lun number.
  1836. optional int32 lun = 3;
  1837. // iscsiInterface is the interface Name that uses an iSCSI transport.
  1838. // Defaults to 'default' (tcp).
  1839. // +optional
  1840. // +default="default"
  1841. optional string iscsiInterface = 4;
  1842. // fsType is the filesystem type of the volume that you want to mount.
  1843. // Tip: Ensure that the filesystem type is supported by the host operating system.
  1844. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1845. // More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
  1846. // TODO: how do we prevent errors in the filesystem from compromising the machine
  1847. // +optional
  1848. optional string fsType = 5;
  1849. // readOnly here will force the ReadOnly setting in VolumeMounts.
  1850. // Defaults to false.
  1851. // +optional
  1852. optional bool readOnly = 6;
  1853. // portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port
  1854. // is other than default (typically TCP ports 860 and 3260).
  1855. // +optional
  1856. // +listType=atomic
  1857. repeated string portals = 7;
  1858. // chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
  1859. // +optional
  1860. optional bool chapAuthDiscovery = 8;
  1861. // chapAuthSession defines whether support iSCSI Session CHAP authentication
  1862. // +optional
  1863. optional bool chapAuthSession = 11;
  1864. // secretRef is the CHAP Secret for iSCSI target and initiator authentication
  1865. // +optional
  1866. optional SecretReference secretRef = 10;
  1867. // initiatorName is the custom iSCSI Initiator Name.
  1868. // If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
  1869. // <target portal>:<volume name> will be created for the connection.
  1870. // +optional
  1871. optional string initiatorName = 12;
  1872. }
  1873. // Represents an ISCSI disk.
  1874. // ISCSI volumes can only be mounted as read/write once.
  1875. // ISCSI volumes support ownership management and SELinux relabeling.
  1876. message ISCSIVolumeSource {
  1877. // targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
  1878. // is other than default (typically TCP ports 860 and 3260).
  1879. optional string targetPortal = 1;
  1880. // iqn is the target iSCSI Qualified Name.
  1881. optional string iqn = 2;
  1882. // lun represents iSCSI Target Lun number.
  1883. optional int32 lun = 3;
  1884. // iscsiInterface is the interface Name that uses an iSCSI transport.
  1885. // Defaults to 'default' (tcp).
  1886. // +optional
  1887. // +default="default"
  1888. optional string iscsiInterface = 4;
  1889. // fsType is the filesystem type of the volume that you want to mount.
  1890. // Tip: Ensure that the filesystem type is supported by the host operating system.
  1891. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1892. // More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
  1893. // TODO: how do we prevent errors in the filesystem from compromising the machine
  1894. // +optional
  1895. optional string fsType = 5;
  1896. // readOnly here will force the ReadOnly setting in VolumeMounts.
  1897. // Defaults to false.
  1898. // +optional
  1899. optional bool readOnly = 6;
  1900. // portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
  1901. // is other than default (typically TCP ports 860 and 3260).
  1902. // +optional
  1903. // +listType=atomic
  1904. repeated string portals = 7;
  1905. // chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
  1906. // +optional
  1907. optional bool chapAuthDiscovery = 8;
  1908. // chapAuthSession defines whether support iSCSI Session CHAP authentication
  1909. // +optional
  1910. optional bool chapAuthSession = 11;
  1911. // secretRef is the CHAP Secret for iSCSI target and initiator authentication
  1912. // +optional
  1913. optional LocalObjectReference secretRef = 10;
  1914. // initiatorName is the custom iSCSI Initiator Name.
  1915. // If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
  1916. // <target portal>:<volume name> will be created for the connection.
  1917. // +optional
  1918. optional string initiatorName = 12;
  1919. }
  1920. // ImageVolumeSource represents a image volume resource.
  1921. message ImageVolumeSource {
  1922. // Required: Image or artifact reference to be used.
  1923. // Behaves in the same way as pod.spec.containers[*].image.
  1924. // Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.
  1925. // More info: https://kubernetes.io/docs/concepts/containers/images
  1926. // This field is optional to allow higher level config management to default or override
  1927. // container images in workload controllers like Deployments and StatefulSets.
  1928. // +optional
  1929. optional string reference = 1;
  1930. // Policy for pulling OCI objects. Possible values are:
  1931. // Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
  1932. // Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
  1933. // IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
  1934. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
  1935. // +optional
  1936. optional string pullPolicy = 2;
  1937. }
  1938. // Maps a string key to a path within a volume.
  1939. message KeyToPath {
  1940. // key is the key to project.
  1941. optional string key = 1;
  1942. // path is the relative path of the file to map the key to.
  1943. // May not be an absolute path.
  1944. // May not contain the path element '..'.
  1945. // May not start with the string '..'.
  1946. optional string path = 2;
  1947. // mode is Optional: mode bits used to set permissions on this file.
  1948. // Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  1949. // YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  1950. // If not specified, the volume defaultMode will be used.
  1951. // This might be in conflict with other options that affect the file
  1952. // mode, like fsGroup, and the result can be other mode bits set.
  1953. // +optional
  1954. optional int32 mode = 3;
  1955. }
  1956. // Lifecycle describes actions that the management system should take in response to container lifecycle
  1957. // events. For the PostStart and PreStop lifecycle handlers, management of the container blocks
  1958. // until the action is complete, unless the container process fails, in which case the handler is aborted.
  1959. message Lifecycle {
  1960. // PostStart is called immediately after a container is created. If the handler fails,
  1961. // the container is terminated and restarted according to its restart policy.
  1962. // Other management of the container blocks until the hook completes.
  1963. // More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
  1964. // +optional
  1965. optional LifecycleHandler postStart = 1;
  1966. // PreStop is called immediately before a container is terminated due to an
  1967. // API request or management event such as liveness/startup probe failure,
  1968. // preemption, resource contention, etc. The handler is not called if the
  1969. // container crashes or exits. The Pod's termination grace period countdown begins before the
  1970. // PreStop hook is executed. Regardless of the outcome of the handler, the
  1971. // container will eventually terminate within the Pod's termination grace
  1972. // period (unless delayed by finalizers). Other management of the container blocks until the hook completes
  1973. // or until the termination grace period is reached.
  1974. // More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
  1975. // +optional
  1976. optional LifecycleHandler preStop = 2;
  1977. // StopSignal defines which signal will be sent to a container when it is being stopped.
  1978. // If not specified, the default is defined by the container runtime in use.
  1979. // StopSignal can only be set for Pods with a non-empty .spec.os.name
  1980. // +optional
  1981. optional string stopSignal = 3;
  1982. }
  1983. // LifecycleHandler defines a specific action that should be taken in a lifecycle
  1984. // hook. One and only one of the fields, except TCPSocket must be specified.
  1985. message LifecycleHandler {
  1986. // Exec specifies a command to execute in the container.
  1987. // +optional
  1988. optional ExecAction exec = 1;
  1989. // HTTPGet specifies an HTTP GET request to perform.
  1990. // +optional
  1991. optional HTTPGetAction httpGet = 2;
  1992. // Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
  1993. // for backward compatibility. There is no validation of this field and
  1994. // lifecycle hooks will fail at runtime when it is specified.
  1995. // +optional
  1996. optional TCPSocketAction tcpSocket = 3;
  1997. // Sleep represents a duration that the container should sleep.
  1998. // +optional
  1999. optional SleepAction sleep = 4;
  2000. }
  2001. // LimitRange sets resource usage limits for each kind of resource in a Namespace.
  2002. message LimitRange {
  2003. // Standard object's metadata.
  2004. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  2005. // +optional
  2006. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2007. // Spec defines the limits enforced.
  2008. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  2009. // +optional
  2010. optional LimitRangeSpec spec = 2;
  2011. }
  2012. // LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
  2013. message LimitRangeItem {
  2014. // Type of resource that this limit applies to.
  2015. optional string type = 1;
  2016. // Max usage constraints on this kind by resource name.
  2017. // +optional
  2018. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> max = 2;
  2019. // Min usage constraints on this kind by resource name.
  2020. // +optional
  2021. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> min = 3;
  2022. // Default resource requirement limit value by resource name if resource limit is omitted.
  2023. // +optional
  2024. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> default = 4;
  2025. // DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
  2026. // +optional
  2027. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> defaultRequest = 5;
  2028. // MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
  2029. // +optional
  2030. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> maxLimitRequestRatio = 6;
  2031. }
  2032. // LimitRangeList is a list of LimitRange items.
  2033. message LimitRangeList {
  2034. // Standard list metadata.
  2035. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2036. // +optional
  2037. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2038. // Items is a list of LimitRange objects.
  2039. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  2040. repeated LimitRange items = 2;
  2041. }
  2042. // LimitRangeSpec defines a min/max usage limit for resources that match on kind.
  2043. message LimitRangeSpec {
  2044. // Limits is the list of LimitRangeItem objects that are enforced.
  2045. // +listType=atomic
  2046. repeated LimitRangeItem limits = 1;
  2047. }
  2048. // LinuxContainerUser represents user identity information in Linux containers
  2049. message LinuxContainerUser {
  2050. // UID is the primary uid initially attached to the first process in the container
  2051. optional int64 uid = 1;
  2052. // GID is the primary gid initially attached to the first process in the container
  2053. optional int64 gid = 2;
  2054. // SupplementalGroups are the supplemental groups initially attached to the first process in the container
  2055. // +optional
  2056. // +listType=atomic
  2057. repeated int64 supplementalGroups = 3;
  2058. }
  2059. // List holds a list of objects, which may not be known by the server.
  2060. message List {
  2061. // Standard list metadata.
  2062. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2063. // +optional
  2064. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2065. // List of objects
  2066. repeated .k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
  2067. }
  2068. // LoadBalancerIngress represents the status of a load-balancer ingress point:
  2069. // traffic intended for the service should be sent to an ingress point.
  2070. message LoadBalancerIngress {
  2071. // IP is set for load-balancer ingress points that are IP based
  2072. // (typically GCE or OpenStack load-balancers)
  2073. // +optional
  2074. optional string ip = 1;
  2075. // Hostname is set for load-balancer ingress points that are DNS based
  2076. // (typically AWS load-balancers)
  2077. // +optional
  2078. optional string hostname = 2;
  2079. // IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified.
  2080. // Setting this to "VIP" indicates that traffic is delivered to the node with
  2081. // the destination set to the load-balancer's IP and port.
  2082. // Setting this to "Proxy" indicates that traffic is delivered to the node or pod with
  2083. // the destination set to the node's IP and node port or the pod's IP and port.
  2084. // Service implementations may use this information to adjust traffic routing.
  2085. // +optional
  2086. optional string ipMode = 3;
  2087. // Ports is a list of records of service ports
  2088. // If used, every port defined in the service should have an entry in it
  2089. // +listType=atomic
  2090. // +optional
  2091. repeated PortStatus ports = 4;
  2092. }
  2093. // LoadBalancerStatus represents the status of a load-balancer.
  2094. message LoadBalancerStatus {
  2095. // Ingress is a list containing ingress points for the load-balancer.
  2096. // Traffic intended for the service should be sent to these ingress points.
  2097. // +optional
  2098. // +listType=atomic
  2099. repeated LoadBalancerIngress ingress = 1;
  2100. }
  2101. // LocalObjectReference contains enough information to let you locate the
  2102. // referenced object inside the same namespace.
  2103. // ---
  2104. // New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
  2105. // 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular
  2106. // restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted".
  2107. // Those cannot be well described when embedded.
  2108. // 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
  2109. // 3. We cannot easily change it. Because this type is embedded in many locations, updates to this type
  2110. // will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control.
  2111. //
  2112. // Instead of using this type, create a locally provided and used type that is well-focused on your reference.
  2113. // For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .
  2114. // +structType=atomic
  2115. message LocalObjectReference {
  2116. // Name of the referent.
  2117. // This field is effectively required, but due to backwards compatibility is
  2118. // allowed to be empty. Instances of this type with an empty value here are
  2119. // almost certainly wrong.
  2120. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2121. // +optional
  2122. // +default=""
  2123. // +kubebuilder:default=""
  2124. // TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
  2125. optional string name = 1;
  2126. }
  2127. // Local represents directly-attached storage with node affinity
  2128. message LocalVolumeSource {
  2129. // path of the full path to the volume on the node.
  2130. // It can be either a directory or block device (disk, partition, ...).
  2131. optional string path = 1;
  2132. // fsType is the filesystem type to mount.
  2133. // It applies only when the Path is a block device.
  2134. // Must be a filesystem type supported by the host operating system.
  2135. // Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified.
  2136. // +optional
  2137. optional string fsType = 2;
  2138. }
  2139. // ModifyVolumeStatus represents the status object of ControllerModifyVolume operation
  2140. message ModifyVolumeStatus {
  2141. // targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
  2142. optional string targetVolumeAttributesClassName = 1;
  2143. // status is the status of the ControllerModifyVolume operation. It can be in any of following states:
  2144. // - Pending
  2145. // Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
  2146. // the specified VolumeAttributesClass not existing.
  2147. // - InProgress
  2148. // InProgress indicates that the volume is being modified.
  2149. // - Infeasible
  2150. // Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
  2151. // resolve the error, a valid VolumeAttributesClass needs to be specified.
  2152. // Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
  2153. optional string status = 2;
  2154. }
  2155. // Represents an NFS mount that lasts the lifetime of a pod.
  2156. // NFS volumes do not support ownership management or SELinux relabeling.
  2157. message NFSVolumeSource {
  2158. // server is the hostname or IP address of the NFS server.
  2159. // More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2160. optional string server = 1;
  2161. // path that is exported by the NFS server.
  2162. // More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2163. optional string path = 2;
  2164. // readOnly here will force the NFS export to be mounted with read-only permissions.
  2165. // Defaults to false.
  2166. // More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2167. // +optional
  2168. optional bool readOnly = 3;
  2169. }
  2170. // Namespace provides a scope for Names.
  2171. // Use of multiple namespaces is optional.
  2172. message Namespace {
  2173. // Standard object's metadata.
  2174. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  2175. // +optional
  2176. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2177. // Spec defines the behavior of the Namespace.
  2178. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  2179. // +optional
  2180. optional NamespaceSpec spec = 2;
  2181. // Status describes the current status of a Namespace.
  2182. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  2183. // +optional
  2184. optional NamespaceStatus status = 3;
  2185. }
  2186. // NamespaceCondition contains details about state of namespace.
  2187. message NamespaceCondition {
  2188. // Type of namespace controller condition.
  2189. optional string type = 1;
  2190. // Status of the condition, one of True, False, Unknown.
  2191. optional string status = 2;
  2192. // Last time the condition transitioned from one status to another.
  2193. // +optional
  2194. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  2195. // Unique, one-word, CamelCase reason for the condition's last transition.
  2196. // +optional
  2197. optional string reason = 5;
  2198. // Human-readable message indicating details about last transition.
  2199. // +optional
  2200. optional string message = 6;
  2201. }
  2202. // NamespaceList is a list of Namespaces.
  2203. message NamespaceList {
  2204. // Standard list metadata.
  2205. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2206. // +optional
  2207. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2208. // Items is the list of Namespace objects in the list.
  2209. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  2210. repeated Namespace items = 2;
  2211. }
  2212. // NamespaceSpec describes the attributes on a Namespace.
  2213. message NamespaceSpec {
  2214. // Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
  2215. // More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
  2216. // +optional
  2217. // +listType=atomic
  2218. repeated string finalizers = 1;
  2219. }
  2220. // NamespaceStatus is information about the current status of a Namespace.
  2221. message NamespaceStatus {
  2222. // Phase is the current lifecycle phase of the namespace.
  2223. // More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
  2224. // +optional
  2225. optional string phase = 1;
  2226. // Represents the latest available observations of a namespace's current state.
  2227. // +optional
  2228. // +patchMergeKey=type
  2229. // +patchStrategy=merge
  2230. // +listType=map
  2231. // +listMapKey=type
  2232. repeated NamespaceCondition conditions = 2;
  2233. }
  2234. // Node is a worker node in Kubernetes.
  2235. // Each node will have a unique identifier in the cache (i.e. in etcd).
  2236. message Node {
  2237. // Standard object's metadata.
  2238. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  2239. // +optional
  2240. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2241. // Spec defines the behavior of a node.
  2242. // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  2243. // +optional
  2244. optional NodeSpec spec = 2;
  2245. // Most recently observed status of the node.
  2246. // Populated by the system.
  2247. // Read-only.
  2248. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  2249. // +optional
  2250. optional NodeStatus status = 3;
  2251. }
  2252. // NodeAddress contains information for the node's address.
  2253. message NodeAddress {
  2254. // Node address type, one of Hostname, ExternalIP or InternalIP.
  2255. optional string type = 1;
  2256. // The node address.
  2257. optional string address = 2;
  2258. }
  2259. // Node affinity is a group of node affinity scheduling rules.
  2260. message NodeAffinity {
  2261. // If the affinity requirements specified by this field are not met at
  2262. // scheduling time, the pod will not be scheduled onto the node.
  2263. // If the affinity requirements specified by this field cease to be met
  2264. // at some point during pod execution (e.g. due to an update), the system
  2265. // may or may not try to eventually evict the pod from its node.
  2266. // +optional
  2267. optional NodeSelector requiredDuringSchedulingIgnoredDuringExecution = 1;
  2268. // The scheduler will prefer to schedule pods to nodes that satisfy
  2269. // the affinity expressions specified by this field, but it may choose
  2270. // a node that violates one or more of the expressions. The node that is
  2271. // most preferred is the one with the greatest sum of weights, i.e.
  2272. // for each node that meets all of the scheduling requirements (resource
  2273. // request, requiredDuringScheduling affinity expressions, etc.),
  2274. // compute a sum by iterating through the elements of this field and adding
  2275. // "weight" to the sum if the node matches the corresponding matchExpressions; the
  2276. // node(s) with the highest sum are the most preferred.
  2277. // +optional
  2278. // +listType=atomic
  2279. repeated PreferredSchedulingTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  2280. }
  2281. // NodeCondition contains condition information for a node.
  2282. message NodeCondition {
  2283. // Type of node condition.
  2284. optional string type = 1;
  2285. // Status of the condition, one of True, False, Unknown.
  2286. optional string status = 2;
  2287. // Last time we got an update on a given condition.
  2288. // +optional
  2289. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastHeartbeatTime = 3;
  2290. // Last time the condition transit from one status to another.
  2291. // +optional
  2292. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  2293. // (brief) reason for the condition's last transition.
  2294. // +optional
  2295. optional string reason = 5;
  2296. // Human readable message indicating details about last transition.
  2297. // +optional
  2298. optional string message = 6;
  2299. }
  2300. // NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.
  2301. // This API is deprecated since 1.22
  2302. message NodeConfigSource {
  2303. // ConfigMap is a reference to a Node's ConfigMap
  2304. optional ConfigMapNodeConfigSource configMap = 2;
  2305. }
  2306. // NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
  2307. message NodeConfigStatus {
  2308. // Assigned reports the checkpointed config the node will try to use.
  2309. // When Node.Spec.ConfigSource is updated, the node checkpoints the associated
  2310. // config payload to local disk, along with a record indicating intended
  2311. // config. The node refers to this record to choose its config checkpoint, and
  2312. // reports this record in Assigned. Assigned only updates in the status after
  2313. // the record has been checkpointed to disk. When the Kubelet is restarted,
  2314. // it tries to make the Assigned config the Active config by loading and
  2315. // validating the checkpointed payload identified by Assigned.
  2316. // +optional
  2317. optional NodeConfigSource assigned = 1;
  2318. // Active reports the checkpointed config the node is actively using.
  2319. // Active will represent either the current version of the Assigned config,
  2320. // or the current LastKnownGood config, depending on whether attempting to use the
  2321. // Assigned config results in an error.
  2322. // +optional
  2323. optional NodeConfigSource active = 2;
  2324. // LastKnownGood reports the checkpointed config the node will fall back to
  2325. // when it encounters an error attempting to use the Assigned config.
  2326. // The Assigned config becomes the LastKnownGood config when the node determines
  2327. // that the Assigned config is stable and correct.
  2328. // This is currently implemented as a 10-minute soak period starting when the local
  2329. // record of Assigned config is updated. If the Assigned config is Active at the end
  2330. // of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is
  2331. // reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil,
  2332. // because the local default config is always assumed good.
  2333. // You should not make assumptions about the node's method of determining config stability
  2334. // and correctness, as this may change or become configurable in the future.
  2335. // +optional
  2336. optional NodeConfigSource lastKnownGood = 3;
  2337. // Error describes any problems reconciling the Spec.ConfigSource to the Active config.
  2338. // Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned
  2339. // record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting
  2340. // to load or validate the Assigned config, etc.
  2341. // Errors may occur at different points while syncing config. Earlier errors (e.g. download or
  2342. // checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across
  2343. // Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in
  2344. // a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error
  2345. // by fixing the config assigned in Spec.ConfigSource.
  2346. // You can find additional information for debugging by searching the error message in the Kubelet log.
  2347. // Error is a human-readable description of the error state; machines can check whether or not Error
  2348. // is empty, but should not rely on the stability of the Error text across Kubelet versions.
  2349. // +optional
  2350. optional string error = 4;
  2351. }
  2352. // NodeDaemonEndpoints lists ports opened by daemons running on the Node.
  2353. message NodeDaemonEndpoints {
  2354. // Endpoint on which Kubelet is listening.
  2355. // +optional
  2356. optional DaemonEndpoint kubeletEndpoint = 1;
  2357. }
  2358. // NodeFeatures describes the set of features implemented by the CRI implementation.
  2359. // The features contained in the NodeFeatures should depend only on the cri implementation
  2360. // independent of runtime handlers.
  2361. message NodeFeatures {
  2362. // SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.
  2363. // +optional
  2364. optional bool supplementalGroupsPolicy = 1;
  2365. }
  2366. // NodeList is the whole list of all Nodes which have been registered with master.
  2367. message NodeList {
  2368. // Standard list metadata.
  2369. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2370. // +optional
  2371. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2372. // List of nodes
  2373. repeated Node items = 2;
  2374. }
  2375. // NodeProxyOptions is the query options to a Node's proxy call.
  2376. message NodeProxyOptions {
  2377. // Path is the URL path to use for the current proxy request to node.
  2378. // +optional
  2379. optional string path = 1;
  2380. }
  2381. // NodeRuntimeHandler is a set of runtime handler information.
  2382. message NodeRuntimeHandler {
  2383. // Runtime handler name.
  2384. // Empty for the default runtime handler.
  2385. // +optional
  2386. optional string name = 1;
  2387. // Supported features.
  2388. // +optional
  2389. optional NodeRuntimeHandlerFeatures features = 2;
  2390. }
  2391. // NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
  2392. message NodeRuntimeHandlerFeatures {
  2393. // RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
  2394. // +optional
  2395. optional bool recursiveReadOnlyMounts = 1;
  2396. // UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.
  2397. // +featureGate=UserNamespacesSupport
  2398. // +optional
  2399. optional bool userNamespaces = 2;
  2400. }
  2401. // A node selector represents the union of the results of one or more label queries
  2402. // over a set of nodes; that is, it represents the OR of the selectors represented
  2403. // by the node selector terms.
  2404. // +structType=atomic
  2405. message NodeSelector {
  2406. // Required. A list of node selector terms. The terms are ORed.
  2407. // +listType=atomic
  2408. repeated NodeSelectorTerm nodeSelectorTerms = 1;
  2409. }
  2410. // A node selector requirement is a selector that contains values, a key, and an operator
  2411. // that relates the key and values.
  2412. message NodeSelectorRequirement {
  2413. // The label key that the selector applies to.
  2414. optional string key = 1;
  2415. // Represents a key's relationship to a set of values.
  2416. // Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  2417. optional string operator = 2;
  2418. // An array of string values. If the operator is In or NotIn,
  2419. // the values array must be non-empty. If the operator is Exists or DoesNotExist,
  2420. // the values array must be empty. If the operator is Gt or Lt, the values
  2421. // array must have a single element, which will be interpreted as an integer.
  2422. // This array is replaced during a strategic merge patch.
  2423. // +optional
  2424. // +listType=atomic
  2425. repeated string values = 3;
  2426. }
  2427. // A null or empty node selector term matches no objects. The requirements of
  2428. // them are ANDed.
  2429. // The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
  2430. // +structType=atomic
  2431. message NodeSelectorTerm {
  2432. // A list of node selector requirements by node's labels.
  2433. // +optional
  2434. // +listType=atomic
  2435. repeated NodeSelectorRequirement matchExpressions = 1;
  2436. // A list of node selector requirements by node's fields.
  2437. // +optional
  2438. // +listType=atomic
  2439. repeated NodeSelectorRequirement matchFields = 2;
  2440. }
  2441. // NodeSpec describes the attributes that a node is created with.
  2442. message NodeSpec {
  2443. // PodCIDR represents the pod IP range assigned to the node.
  2444. // +optional
  2445. optional string podCIDR = 1;
  2446. // podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this
  2447. // field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for
  2448. // each of IPv4 and IPv6.
  2449. // +optional
  2450. // +patchStrategy=merge
  2451. // +listType=set
  2452. repeated string podCIDRs = 7;
  2453. // ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
  2454. // +optional
  2455. optional string providerID = 3;
  2456. // Unschedulable controls node schedulability of new pods. By default, node is schedulable.
  2457. // More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
  2458. // +optional
  2459. optional bool unschedulable = 4;
  2460. // If specified, the node's taints.
  2461. // +optional
  2462. // +listType=atomic
  2463. repeated Taint taints = 5;
  2464. // Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed.
  2465. // +optional
  2466. optional NodeConfigSource configSource = 6;
  2467. // Deprecated. Not all kubelets will set this field. Remove field after 1.13.
  2468. // see: https://issues.k8s.io/61966
  2469. // +optional
  2470. optional string externalID = 2;
  2471. }
  2472. // NodeStatus is information about the current status of a node.
  2473. message NodeStatus {
  2474. // Capacity represents the total resources of a node.
  2475. // More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
  2476. // +optional
  2477. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
  2478. // Allocatable represents the resources of a node that are available for scheduling.
  2479. // Defaults to Capacity.
  2480. // +optional
  2481. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> allocatable = 2;
  2482. // NodePhase is the recently observed lifecycle phase of the node.
  2483. // More info: https://kubernetes.io/docs/concepts/nodes/node/#phase
  2484. // The field is never populated, and now is deprecated.
  2485. // +optional
  2486. optional string phase = 3;
  2487. // Conditions is an array of current observed node conditions.
  2488. // More info: https://kubernetes.io/docs/reference/node/node-status/#condition
  2489. // +optional
  2490. // +patchMergeKey=type
  2491. // +patchStrategy=merge
  2492. // +listType=map
  2493. // +listMapKey=type
  2494. repeated NodeCondition conditions = 4;
  2495. // List of addresses reachable to the node.
  2496. // Queried from cloud provider, if available.
  2497. // More info: https://kubernetes.io/docs/reference/node/node-status/#addresses
  2498. // Note: This field is declared as mergeable, but the merge key is not sufficiently
  2499. // unique, which can cause data corruption when it is merged. Callers should instead
  2500. // use a full-replacement patch. See https://pr.k8s.io/79391 for an example.
  2501. // Consumers should assume that addresses can change during the
  2502. // lifetime of a Node. However, there are some exceptions where this may not
  2503. // be possible, such as Pods that inherit a Node's address in its own status or
  2504. // consumers of the downward API (status.hostIP).
  2505. // +optional
  2506. // +patchMergeKey=type
  2507. // +patchStrategy=merge
  2508. // +listType=map
  2509. // +listMapKey=type
  2510. repeated NodeAddress addresses = 5;
  2511. // Endpoints of daemons running on the Node.
  2512. // +optional
  2513. optional NodeDaemonEndpoints daemonEndpoints = 6;
  2514. // Set of ids/uuids to uniquely identify the node.
  2515. // More info: https://kubernetes.io/docs/reference/node/node-status/#info
  2516. // +optional
  2517. optional NodeSystemInfo nodeInfo = 7;
  2518. // List of container images on this node
  2519. // +optional
  2520. // +listType=atomic
  2521. repeated ContainerImage images = 8;
  2522. // List of attachable volumes in use (mounted) by the node.
  2523. // +optional
  2524. // +listType=atomic
  2525. repeated string volumesInUse = 9;
  2526. // List of volumes that are attached to the node.
  2527. // +optional
  2528. // +listType=atomic
  2529. repeated AttachedVolume volumesAttached = 10;
  2530. // Status of the config assigned to the node via the dynamic Kubelet config feature.
  2531. // +optional
  2532. optional NodeConfigStatus config = 11;
  2533. // The available runtime handlers.
  2534. // +featureGate=UserNamespacesSupport
  2535. // +optional
  2536. // +listType=atomic
  2537. repeated NodeRuntimeHandler runtimeHandlers = 12;
  2538. // Features describes the set of features implemented by the CRI implementation.
  2539. // +featureGate=SupplementalGroupsPolicy
  2540. // +optional
  2541. optional NodeFeatures features = 13;
  2542. // DeclaredFeatures represents the features related to feature gates that are declared by the node.
  2543. // +featureGate=NodeDeclaredFeatures
  2544. // +optional
  2545. // +listType=atomic
  2546. repeated string declaredFeatures = 14;
  2547. }
  2548. // NodeSwapStatus represents swap memory information.
  2549. message NodeSwapStatus {
  2550. // Total amount of swap memory in bytes.
  2551. // +optional
  2552. optional int64 capacity = 1;
  2553. }
  2554. // NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
  2555. message NodeSystemInfo {
  2556. // MachineID reported by the node. For unique machine identification
  2557. // in the cluster this field is preferred. Learn more from man(5)
  2558. // machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
  2559. optional string machineID = 1;
  2560. // SystemUUID reported by the node. For unique machine identification
  2561. // MachineID is preferred. This field is specific to Red Hat hosts
  2562. // https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid
  2563. optional string systemUUID = 2;
  2564. // Boot ID reported by the node.
  2565. optional string bootID = 3;
  2566. // Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
  2567. optional string kernelVersion = 4;
  2568. // OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
  2569. optional string osImage = 5;
  2570. // ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
  2571. optional string containerRuntimeVersion = 6;
  2572. // Kubelet Version reported by the node.
  2573. optional string kubeletVersion = 7;
  2574. // Deprecated: KubeProxy Version reported by the node.
  2575. optional string kubeProxyVersion = 8;
  2576. // The Operating System reported by the node
  2577. optional string operatingSystem = 9;
  2578. // The Architecture reported by the node
  2579. optional string architecture = 10;
  2580. // Swap Info reported by the node.
  2581. optional NodeSwapStatus swap = 11;
  2582. }
  2583. // ObjectFieldSelector selects an APIVersioned field of an object.
  2584. // +structType=atomic
  2585. message ObjectFieldSelector {
  2586. // Version of the schema the FieldPath is written in terms of, defaults to "v1".
  2587. // +optional
  2588. optional string apiVersion = 1;
  2589. // Path of the field to select in the specified API version.
  2590. optional string fieldPath = 2;
  2591. }
  2592. // ObjectReference contains enough information to let you inspect or modify the referred object.
  2593. // ---
  2594. // New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
  2595. // 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage.
  2596. // 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular
  2597. // restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted".
  2598. // Those cannot be well described when embedded.
  2599. // 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
  2600. // 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity
  2601. // during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple
  2602. // and the version of the actual struct is irrelevant.
  2603. // 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type
  2604. // will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control.
  2605. //
  2606. // Instead of using this type, create a locally provided and used type that is well-focused on your reference.
  2607. // For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .
  2608. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  2609. // +structType=atomic
  2610. message ObjectReference {
  2611. // Kind of the referent.
  2612. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2613. // +optional
  2614. optional string kind = 1;
  2615. // Namespace of the referent.
  2616. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  2617. // +optional
  2618. optional string namespace = 2;
  2619. // Name of the referent.
  2620. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2621. // +optional
  2622. optional string name = 3;
  2623. // UID of the referent.
  2624. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
  2625. // +optional
  2626. optional string uid = 4;
  2627. // API version of the referent.
  2628. // +optional
  2629. optional string apiVersion = 5;
  2630. // Specific resourceVersion to which this reference is made, if any.
  2631. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  2632. // +optional
  2633. optional string resourceVersion = 6;
  2634. // If referring to a piece of an object instead of an entire object, this string
  2635. // should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
  2636. // For example, if the object reference is to a container within a pod, this would take on a value like:
  2637. // "spec.containers{name}" (where "name" refers to the name of the container that triggered
  2638. // the event) or if no container name is specified "spec.containers[2]" (container with
  2639. // index 2 in this pod). This syntax is chosen only to have some well-defined way of
  2640. // referencing a part of an object.
  2641. // TODO: this design is not final and this field is subject to change in the future.
  2642. // +optional
  2643. optional string fieldPath = 7;
  2644. }
  2645. // PersistentVolume (PV) is a storage resource provisioned by an administrator.
  2646. // It is analogous to a node.
  2647. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
  2648. message PersistentVolume {
  2649. // Standard object's metadata.
  2650. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  2651. // +optional
  2652. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2653. // spec defines a specification of a persistent volume owned by the cluster.
  2654. // Provisioned by an administrator.
  2655. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
  2656. // +optional
  2657. optional PersistentVolumeSpec spec = 2;
  2658. // status represents the current information/status for the persistent volume.
  2659. // Populated by the system.
  2660. // Read-only.
  2661. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes
  2662. // +optional
  2663. optional PersistentVolumeStatus status = 3;
  2664. }
  2665. // PersistentVolumeClaim is a user's request for and claim to a persistent volume
  2666. message PersistentVolumeClaim {
  2667. // Standard object's metadata.
  2668. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  2669. // +optional
  2670. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2671. // spec defines the desired characteristics of a volume requested by a pod author.
  2672. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2673. // +optional
  2674. optional PersistentVolumeClaimSpec spec = 2;
  2675. // status represents the current information/status of a persistent volume claim.
  2676. // Read-only.
  2677. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2678. // +optional
  2679. optional PersistentVolumeClaimStatus status = 3;
  2680. }
  2681. // PersistentVolumeClaimCondition contains details about state of pvc
  2682. message PersistentVolumeClaimCondition {
  2683. // Type is the type of the condition.
  2684. // More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about
  2685. optional string type = 1;
  2686. // Status is the status of the condition.
  2687. // Can be True, False, Unknown.
  2688. // More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required
  2689. optional string status = 2;
  2690. // lastProbeTime is the time we probed the condition.
  2691. // +optional
  2692. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastProbeTime = 3;
  2693. // lastTransitionTime is the time the condition transitioned from one status to another.
  2694. // +optional
  2695. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  2696. // reason is a unique, this should be a short, machine understandable string that gives the reason
  2697. // for condition's last transition. If it reports "Resizing" that means the underlying
  2698. // persistent volume is being resized.
  2699. // +optional
  2700. optional string reason = 5;
  2701. // message is the human-readable message indicating details about last transition.
  2702. // +optional
  2703. optional string message = 6;
  2704. }
  2705. // PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
  2706. message PersistentVolumeClaimList {
  2707. // Standard list metadata.
  2708. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2709. // +optional
  2710. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2711. // items is a list of persistent volume claims.
  2712. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2713. repeated PersistentVolumeClaim items = 2;
  2714. }
  2715. // PersistentVolumeClaimSpec describes the common attributes of storage devices
  2716. // and allows a Source for provider-specific attributes
  2717. message PersistentVolumeClaimSpec {
  2718. // accessModes contains the desired access modes the volume should have.
  2719. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
  2720. // +optional
  2721. // +listType=atomic
  2722. repeated string accessModes = 1;
  2723. // selector is a label query over volumes to consider for binding.
  2724. // +optional
  2725. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
  2726. // resources represents the minimum resources the volume should have.
  2727. // Users are allowed to specify resource requirements
  2728. // that are lower than previous value but must still be higher than capacity recorded in the
  2729. // status field of the claim.
  2730. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
  2731. // +optional
  2732. optional VolumeResourceRequirements resources = 2;
  2733. // volumeName is the binding reference to the PersistentVolume backing this claim.
  2734. // +optional
  2735. optional string volumeName = 3;
  2736. // storageClassName is the name of the StorageClass required by the claim.
  2737. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
  2738. // +optional
  2739. optional string storageClassName = 5;
  2740. // volumeMode defines what type of volume is required by the claim.
  2741. // Value of Filesystem is implied when not included in claim spec.
  2742. // +optional
  2743. optional string volumeMode = 6;
  2744. // dataSource field can be used to specify either:
  2745. // * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
  2746. // * An existing PVC (PersistentVolumeClaim)
  2747. // If the provisioner or an external controller can support the specified data source,
  2748. // it will create a new volume based on the contents of the specified data source.
  2749. // When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
  2750. // and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
  2751. // If the namespace is specified, then dataSourceRef will not be copied to dataSource.
  2752. // +optional
  2753. optional TypedLocalObjectReference dataSource = 7;
  2754. // dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
  2755. // volume is desired. This may be any object from a non-empty API group (non
  2756. // core object) or a PersistentVolumeClaim object.
  2757. // When this field is specified, volume binding will only succeed if the type of
  2758. // the specified object matches some installed volume populator or dynamic
  2759. // provisioner.
  2760. // This field will replace the functionality of the dataSource field and as such
  2761. // if both fields are non-empty, they must have the same value. For backwards
  2762. // compatibility, when namespace isn't specified in dataSourceRef,
  2763. // both fields (dataSource and dataSourceRef) will be set to the same
  2764. // value automatically if one of them is empty and the other is non-empty.
  2765. // When namespace is specified in dataSourceRef,
  2766. // dataSource isn't set to the same value and must be empty.
  2767. // There are three important differences between dataSource and dataSourceRef:
  2768. // * While dataSource only allows two specific types of objects, dataSourceRef
  2769. // allows any non-core object, as well as PersistentVolumeClaim objects.
  2770. // * While dataSource ignores disallowed values (dropping them), dataSourceRef
  2771. // preserves all values, and generates an error if a disallowed value is
  2772. // specified.
  2773. // * While dataSource only allows local objects, dataSourceRef allows objects
  2774. // in any namespaces.
  2775. // (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
  2776. // (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
  2777. // +optional
  2778. optional TypedObjectReference dataSourceRef = 8;
  2779. // volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
  2780. // If specified, the CSI driver will create or update the volume with the attributes defined
  2781. // in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
  2782. // it can be changed after the claim is created. An empty string or nil value indicates that no
  2783. // VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
  2784. // this field can be reset to its previous value (including nil) to cancel the modification.
  2785. // If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
  2786. // set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
  2787. // exists.
  2788. // More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
  2789. // +featureGate=VolumeAttributesClass
  2790. // +optional
  2791. optional string volumeAttributesClassName = 9;
  2792. }
  2793. // PersistentVolumeClaimStatus is the current status of a persistent volume claim.
  2794. message PersistentVolumeClaimStatus {
  2795. // phase represents the current phase of PersistentVolumeClaim.
  2796. // +optional
  2797. optional string phase = 1;
  2798. // accessModes contains the actual access modes the volume backing the PVC has.
  2799. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
  2800. // +optional
  2801. // +listType=atomic
  2802. repeated string accessModes = 2;
  2803. // capacity represents the actual resources of the underlying volume.
  2804. // +optional
  2805. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 3;
  2806. // conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
  2807. // resized then the Condition will be set to 'Resizing'.
  2808. // +optional
  2809. // +patchMergeKey=type
  2810. // +patchStrategy=merge
  2811. // +listType=map
  2812. // +listMapKey=type
  2813. repeated PersistentVolumeClaimCondition conditions = 4;
  2814. // allocatedResources tracks the resources allocated to a PVC including its capacity.
  2815. // Key names follow standard Kubernetes label syntax. Valid values are either:
  2816. // * Un-prefixed keys:
  2817. // - storage - the capacity of the volume.
  2818. // * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
  2819. // Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
  2820. // reserved and hence may not be used.
  2821. //
  2822. // Capacity reported here may be larger than the actual capacity when a volume expansion operation
  2823. // is requested.
  2824. // For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
  2825. // If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
  2826. // If a volume expansion capacity request is lowered, allocatedResources is only
  2827. // lowered if there are no expansion operations in progress and if the actual volume capacity
  2828. // is equal or lower than the requested capacity.
  2829. //
  2830. // A controller that receives PVC update with previously unknown resourceName
  2831. // should ignore the update for the purpose it was designed. For example - a controller that
  2832. // only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
  2833. // resources associated with PVC.
  2834. // +optional
  2835. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> allocatedResources = 5;
  2836. // allocatedResourceStatuses stores status of resource being resized for the given PVC.
  2837. // Key names follow standard Kubernetes label syntax. Valid values are either:
  2838. // * Un-prefixed keys:
  2839. // - storage - the capacity of the volume.
  2840. // * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
  2841. // Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
  2842. // reserved and hence may not be used.
  2843. //
  2844. // ClaimResourceStatus can be in any of following states:
  2845. // - ControllerResizeInProgress:
  2846. // State set when resize controller starts resizing the volume in control-plane.
  2847. // - ControllerResizeFailed:
  2848. // State set when resize has failed in resize controller with a terminal error.
  2849. // - NodeResizePending:
  2850. // State set when resize controller has finished resizing the volume but further resizing of
  2851. // volume is needed on the node.
  2852. // - NodeResizeInProgress:
  2853. // State set when kubelet starts resizing the volume.
  2854. // - NodeResizeFailed:
  2855. // State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
  2856. // NodeResizeFailed.
  2857. // For example: if expanding a PVC for more capacity - this field can be one of the following states:
  2858. // - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
  2859. // - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
  2860. // - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
  2861. // - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
  2862. // - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
  2863. // When this field is not set, it means that no resize operation is in progress for the given PVC.
  2864. //
  2865. // A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus
  2866. // should ignore the update for the purpose it was designed. For example - a controller that
  2867. // only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
  2868. // resources associated with PVC.
  2869. // +mapType=granular
  2870. // +optional
  2871. map<string, string> allocatedResourceStatuses = 7;
  2872. // currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
  2873. // When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
  2874. // +featureGate=VolumeAttributesClass
  2875. // +optional
  2876. optional string currentVolumeAttributesClassName = 8;
  2877. // ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
  2878. // When this is unset, there is no ModifyVolume operation being attempted.
  2879. // +featureGate=VolumeAttributesClass
  2880. // +optional
  2881. optional ModifyVolumeStatus modifyVolumeStatus = 9;
  2882. }
  2883. // PersistentVolumeClaimTemplate is used to produce
  2884. // PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
  2885. message PersistentVolumeClaimTemplate {
  2886. // May contain labels and annotations that will be copied into the PVC
  2887. // when creating it. No other fields are allowed and will be rejected during
  2888. // validation.
  2889. //
  2890. // +optional
  2891. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2892. // The specification for the PersistentVolumeClaim. The entire content is
  2893. // copied unchanged into the PVC that gets created from this
  2894. // template. The same fields as in a PersistentVolumeClaim
  2895. // are also valid here.
  2896. optional PersistentVolumeClaimSpec spec = 2;
  2897. }
  2898. // PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.
  2899. // This volume finds the bound PV and mounts that volume for the pod. A
  2900. // PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another
  2901. // type of volume that is owned by someone else (the system).
  2902. message PersistentVolumeClaimVolumeSource {
  2903. // claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
  2904. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2905. optional string claimName = 1;
  2906. // readOnly Will force the ReadOnly setting in VolumeMounts.
  2907. // Default false.
  2908. // +optional
  2909. optional bool readOnly = 2;
  2910. }
  2911. // PersistentVolumeList is a list of PersistentVolume items.
  2912. message PersistentVolumeList {
  2913. // Standard list metadata.
  2914. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  2915. // +optional
  2916. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2917. // items is a list of persistent volumes.
  2918. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
  2919. repeated PersistentVolume items = 2;
  2920. }
  2921. // PersistentVolumeSource is similar to VolumeSource but meant for the
  2922. // administrator who creates PVs. Exactly one of its members must be set.
  2923. message PersistentVolumeSource {
  2924. // gcePersistentDisk represents a GCE Disk resource that is attached to a
  2925. // kubelet's host machine and then exposed to the pod. Provisioned by an admin.
  2926. // Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
  2927. // gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
  2928. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2929. // +optional
  2930. optional GCEPersistentDiskVolumeSource gcePersistentDisk = 1;
  2931. // awsElasticBlockStore represents an AWS Disk resource that is attached to a
  2932. // kubelet's host machine and then exposed to the pod.
  2933. // Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
  2934. // awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
  2935. // More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  2936. // +optional
  2937. optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 2;
  2938. // hostPath represents a directory on the host.
  2939. // Provisioned by a developer or tester.
  2940. // This is useful for single-node development and testing only!
  2941. // On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster.
  2942. // More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  2943. // +optional
  2944. optional HostPathVolumeSource hostPath = 3;
  2945. // glusterfs represents a Glusterfs volume that is attached to a host and
  2946. // exposed to the pod. Provisioned by an admin.
  2947. // Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
  2948. // More info: https://examples.k8s.io/volumes/glusterfs/README.md
  2949. // +optional
  2950. optional GlusterfsPersistentVolumeSource glusterfs = 4;
  2951. // nfs represents an NFS mount on the host. Provisioned by an admin.
  2952. // More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2953. // +optional
  2954. optional NFSVolumeSource nfs = 5;
  2955. // rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
  2956. // Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
  2957. // More info: https://examples.k8s.io/volumes/rbd/README.md
  2958. // +optional
  2959. optional RBDPersistentVolumeSource rbd = 6;
  2960. // iscsi represents an ISCSI Disk resource that is attached to a
  2961. // kubelet's host machine and then exposed to the pod. Provisioned by an admin.
  2962. // +optional
  2963. optional ISCSIPersistentVolumeSource iscsi = 7;
  2964. // cinder represents a cinder volume attached and mounted on kubelets host machine.
  2965. // Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
  2966. // are redirected to the cinder.csi.openstack.org CSI driver.
  2967. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  2968. // +optional
  2969. optional CinderPersistentVolumeSource cinder = 8;
  2970. // cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
  2971. // Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
  2972. // +optional
  2973. optional CephFSPersistentVolumeSource cephfs = 9;
  2974. // fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  2975. // +optional
  2976. optional FCVolumeSource fc = 10;
  2977. // flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running.
  2978. // Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
  2979. // +optional
  2980. optional FlockerVolumeSource flocker = 11;
  2981. // flexVolume represents a generic volume resource that is
  2982. // provisioned/attached using an exec based plugin.
  2983. // Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
  2984. // +optional
  2985. optional FlexPersistentVolumeSource flexVolume = 12;
  2986. // azureFile represents an Azure File Service mount on the host and bind mount to the pod.
  2987. // Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
  2988. // are redirected to the file.csi.azure.com CSI driver.
  2989. // +optional
  2990. optional AzureFilePersistentVolumeSource azureFile = 13;
  2991. // vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
  2992. // Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
  2993. // are redirected to the csi.vsphere.vmware.com CSI driver.
  2994. // +optional
  2995. optional VsphereVirtualDiskVolumeSource vsphereVolume = 14;
  2996. // quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
  2997. // Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
  2998. // +optional
  2999. optional QuobyteVolumeSource quobyte = 15;
  3000. // azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  3001. // Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
  3002. // are redirected to the disk.csi.azure.com CSI driver.
  3003. // +optional
  3004. optional AzureDiskVolumeSource azureDisk = 16;
  3005. // photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
  3006. // Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
  3007. optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 17;
  3008. // portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
  3009. // Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
  3010. // are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
  3011. // is on.
  3012. // +optional
  3013. optional PortworxVolumeSource portworxVolume = 18;
  3014. // scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  3015. // Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
  3016. // +optional
  3017. optional ScaleIOPersistentVolumeSource scaleIO = 19;
  3018. // local represents directly-attached storage with node affinity
  3019. // +optional
  3020. optional LocalVolumeSource local = 20;
  3021. // storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod.
  3022. // Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
  3023. // More info: https://examples.k8s.io/volumes/storageos/README.md
  3024. // +optional
  3025. optional StorageOSPersistentVolumeSource storageos = 21;
  3026. // csi represents storage that is handled by an external CSI driver.
  3027. // +optional
  3028. optional CSIPersistentVolumeSource csi = 22;
  3029. }
  3030. // PersistentVolumeSpec is the specification of a persistent volume.
  3031. message PersistentVolumeSpec {
  3032. // capacity is the description of the persistent volume's resources and capacity.
  3033. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
  3034. // +optional
  3035. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
  3036. // persistentVolumeSource is the actual volume backing the persistent volume.
  3037. optional PersistentVolumeSource persistentVolumeSource = 2;
  3038. // accessModes contains all ways the volume can be mounted.
  3039. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
  3040. // +optional
  3041. // +listType=atomic
  3042. repeated string accessModes = 3;
  3043. // claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
  3044. // Expected to be non-nil when bound.
  3045. // claim.VolumeName is the authoritative bind between PV and PVC.
  3046. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
  3047. // +optional
  3048. // +structType=granular
  3049. optional ObjectReference claimRef = 4;
  3050. // persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim.
  3051. // Valid options are Retain (default for manually created PersistentVolumes), Delete (default
  3052. // for dynamically provisioned PersistentVolumes), and Recycle (deprecated).
  3053. // Recycle must be supported by the volume plugin underlying this PersistentVolume.
  3054. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
  3055. // +optional
  3056. optional string persistentVolumeReclaimPolicy = 5;
  3057. // storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value
  3058. // means that this volume does not belong to any StorageClass.
  3059. // +optional
  3060. optional string storageClassName = 6;
  3061. // mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will
  3062. // simply fail if one is invalid.
  3063. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
  3064. // +optional
  3065. // +listType=atomic
  3066. repeated string mountOptions = 7;
  3067. // volumeMode defines if a volume is intended to be used with a formatted filesystem
  3068. // or to remain in raw block state. Value of Filesystem is implied when not included in spec.
  3069. // +optional
  3070. optional string volumeMode = 8;
  3071. // nodeAffinity defines constraints that limit what nodes this volume can be accessed from.
  3072. // This field influences the scheduling of pods that use this volume.
  3073. // This field is mutable if MutablePVNodeAffinity feature gate is enabled.
  3074. // +optional
  3075. optional VolumeNodeAffinity nodeAffinity = 9;
  3076. // Name of VolumeAttributesClass to which this persistent volume belongs. Empty value
  3077. // is not allowed. When this field is not set, it indicates that this volume does not belong to any
  3078. // VolumeAttributesClass. This field is mutable and can be changed by the CSI driver
  3079. // after a volume has been updated successfully to a new class.
  3080. // For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound
  3081. // PersistentVolumeClaims during the binding process.
  3082. // +featureGate=VolumeAttributesClass
  3083. // +optional
  3084. optional string volumeAttributesClassName = 10;
  3085. }
  3086. // PersistentVolumeStatus is the current status of a persistent volume.
  3087. message PersistentVolumeStatus {
  3088. // phase indicates if a volume is available, bound to a claim, or released by a claim.
  3089. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
  3090. // +optional
  3091. optional string phase = 1;
  3092. // message is a human-readable message indicating details about why the volume is in this state.
  3093. // +optional
  3094. optional string message = 2;
  3095. // reason is a brief CamelCase string that describes any failure and is meant
  3096. // for machine parsing and tidy display in the CLI.
  3097. // +optional
  3098. optional string reason = 3;
  3099. // lastPhaseTransitionTime is the time the phase transitioned from one to another
  3100. // and automatically resets to current time everytime a volume phase transitions.
  3101. // +optional
  3102. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastPhaseTransitionTime = 4;
  3103. }
  3104. // Represents a Photon Controller persistent disk resource.
  3105. message PhotonPersistentDiskVolumeSource {
  3106. // pdID is the ID that identifies Photon Controller persistent disk
  3107. optional string pdID = 1;
  3108. // fsType is the filesystem type to mount.
  3109. // Must be a filesystem type supported by the host operating system.
  3110. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  3111. optional string fsType = 2;
  3112. }
  3113. // Pod is a collection of containers that can run on a host. This resource is created
  3114. // by clients and scheduled onto hosts.
  3115. message Pod {
  3116. // Standard object's metadata.
  3117. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  3118. // +optional
  3119. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  3120. // Specification of the desired behavior of the pod.
  3121. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  3122. // +optional
  3123. optional PodSpec spec = 2;
  3124. // Most recently observed status of the pod.
  3125. // This data may not be up to date.
  3126. // Populated by the system.
  3127. // Read-only.
  3128. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  3129. // +optional
  3130. optional PodStatus status = 3;
  3131. }
  3132. // Pod affinity is a group of inter pod affinity scheduling rules.
  3133. message PodAffinity {
  3134. // If the affinity requirements specified by this field are not met at
  3135. // scheduling time, the pod will not be scheduled onto the node.
  3136. // If the affinity requirements specified by this field cease to be met
  3137. // at some point during pod execution (e.g. due to a pod label update), the
  3138. // system may or may not try to eventually evict the pod from its node.
  3139. // When there are multiple elements, the lists of nodes corresponding to each
  3140. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  3141. // +optional
  3142. // +listType=atomic
  3143. repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1;
  3144. // The scheduler will prefer to schedule pods to nodes that satisfy
  3145. // the affinity expressions specified by this field, but it may choose
  3146. // a node that violates one or more of the expressions. The node that is
  3147. // most preferred is the one with the greatest sum of weights, i.e.
  3148. // for each node that meets all of the scheduling requirements (resource
  3149. // request, requiredDuringScheduling affinity expressions, etc.),
  3150. // compute a sum by iterating through the elements of this field and adding
  3151. // "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
  3152. // node(s) with the highest sum are the most preferred.
  3153. // +optional
  3154. // +listType=atomic
  3155. repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  3156. }
  3157. // Defines a set of pods (namely those matching the labelSelector
  3158. // relative to the given namespace(s)) that this pod should be
  3159. // co-located (affinity) or not co-located (anti-affinity) with,
  3160. // where co-located is defined as running on a node whose value of
  3161. // the label with key <topologyKey> matches that of any node on which
  3162. // a pod of the set of pods is running
  3163. message PodAffinityTerm {
  3164. // A label query over a set of resources, in this case pods.
  3165. // If it's null, this PodAffinityTerm matches with no Pods.
  3166. // +optional
  3167. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 1;
  3168. // namespaces specifies a static list of namespace names that the term applies to.
  3169. // The term is applied to the union of the namespaces listed in this field
  3170. // and the ones selected by namespaceSelector.
  3171. // null or empty namespaces list and null namespaceSelector means "this pod's namespace".
  3172. // +optional
  3173. // +listType=atomic
  3174. repeated string namespaces = 2;
  3175. // This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  3176. // the labelSelector in the specified namespaces, where co-located is defined as running on a node
  3177. // whose value of the label with key topologyKey matches that of any node on which any of the
  3178. // selected pods is running.
  3179. // Empty topologyKey is not allowed.
  3180. optional string topologyKey = 3;
  3181. // A label query over the set of namespaces that the term applies to.
  3182. // The term is applied to the union of the namespaces selected by this field
  3183. // and the ones listed in the namespaces field.
  3184. // null selector and null or empty namespaces list means "this pod's namespace".
  3185. // An empty selector ({}) matches all namespaces.
  3186. // +optional
  3187. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 4;
  3188. // MatchLabelKeys is a set of pod label keys to select which pods will
  3189. // be taken into consideration. The keys are used to lookup values from the
  3190. // incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
  3191. // to select the group of existing pods which pods will be taken into consideration
  3192. // for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  3193. // pod labels will be ignored. The default value is empty.
  3194. // The same key is forbidden to exist in both matchLabelKeys and labelSelector.
  3195. // Also, matchLabelKeys cannot be set when labelSelector isn't set.
  3196. //
  3197. // +listType=atomic
  3198. // +optional
  3199. repeated string matchLabelKeys = 5;
  3200. // MismatchLabelKeys is a set of pod label keys to select which pods will
  3201. // be taken into consideration. The keys are used to lookup values from the
  3202. // incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
  3203. // to select the group of existing pods which pods will be taken into consideration
  3204. // for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  3205. // pod labels will be ignored. The default value is empty.
  3206. // The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
  3207. // Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
  3208. //
  3209. // +listType=atomic
  3210. // +optional
  3211. repeated string mismatchLabelKeys = 6;
  3212. }
  3213. // Pod anti affinity is a group of inter pod anti affinity scheduling rules.
  3214. message PodAntiAffinity {
  3215. // If the anti-affinity requirements specified by this field are not met at
  3216. // scheduling time, the pod will not be scheduled onto the node.
  3217. // If the anti-affinity requirements specified by this field cease to be met
  3218. // at some point during pod execution (e.g. due to a pod label update), the
  3219. // system may or may not try to eventually evict the pod from its node.
  3220. // When there are multiple elements, the lists of nodes corresponding to each
  3221. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  3222. // +optional
  3223. // +listType=atomic
  3224. repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1;
  3225. // The scheduler will prefer to schedule pods to nodes that satisfy
  3226. // the anti-affinity expressions specified by this field, but it may choose
  3227. // a node that violates one or more of the expressions. The node that is
  3228. // most preferred is the one with the greatest sum of weights, i.e.
  3229. // for each node that meets all of the scheduling requirements (resource
  3230. // request, requiredDuringScheduling anti-affinity expressions, etc.),
  3231. // compute a sum by iterating through the elements of this field and subtracting
  3232. // "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
  3233. // node(s) with the highest sum are the most preferred.
  3234. // +optional
  3235. // +listType=atomic
  3236. repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  3237. }
  3238. // PodAttachOptions is the query options to a Pod's remote attach call.
  3239. // ---
  3240. // TODO: merge w/ PodExecOptions below for stdin, stdout, etc
  3241. // and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY
  3242. message PodAttachOptions {
  3243. // Stdin if true, redirects the standard input stream of the pod for this call.
  3244. // Defaults to false.
  3245. // +optional
  3246. optional bool stdin = 1;
  3247. // Stdout if true indicates that stdout is to be redirected for the attach call.
  3248. // Defaults to true.
  3249. // +optional
  3250. optional bool stdout = 2;
  3251. // Stderr if true indicates that stderr is to be redirected for the attach call.
  3252. // Defaults to true.
  3253. // +optional
  3254. optional bool stderr = 3;
  3255. // TTY if true indicates that a tty will be allocated for the attach call.
  3256. // This is passed through the container runtime so the tty
  3257. // is allocated on the worker node by the container runtime.
  3258. // Defaults to false.
  3259. // +optional
  3260. optional bool tty = 4;
  3261. // The container in which to execute the command.
  3262. // Defaults to only container if there is only one container in the pod.
  3263. // +optional
  3264. optional string container = 5;
  3265. }
  3266. // PodCertificateProjection provides a private key and X.509 certificate in the
  3267. // pod filesystem.
  3268. message PodCertificateProjection {
  3269. // Kubelet's generated CSRs will be addressed to this signer.
  3270. //
  3271. // +required
  3272. optional string signerName = 1;
  3273. // The type of keypair Kubelet will generate for the pod.
  3274. //
  3275. // Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
  3276. // "ECDSAP521", and "ED25519".
  3277. //
  3278. // +required
  3279. optional string keyType = 2;
  3280. // maxExpirationSeconds is the maximum lifetime permitted for the
  3281. // certificate.
  3282. //
  3283. // Kubelet copies this value verbatim into the PodCertificateRequests it
  3284. // generates for this projection.
  3285. //
  3286. // If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
  3287. // will reject values shorter than 3600 (1 hour). The maximum allowable
  3288. // value is 7862400 (91 days).
  3289. //
  3290. // The signer implementation is then free to issue a certificate with any
  3291. // lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
  3292. // seconds (1 hour). This constraint is enforced by kube-apiserver.
  3293. // `kubernetes.io` signers will never issue certificates with a lifetime
  3294. // longer than 24 hours.
  3295. //
  3296. // +optional
  3297. optional int32 maxExpirationSeconds = 3;
  3298. // Write the credential bundle at this path in the projected volume.
  3299. //
  3300. // The credential bundle is a single file that contains multiple PEM blocks.
  3301. // The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
  3302. // key.
  3303. //
  3304. // The remaining blocks are CERTIFICATE blocks, containing the issued
  3305. // certificate chain from the signer (leaf and any intermediates).
  3306. //
  3307. // Using credentialBundlePath lets your Pod's application code make a single
  3308. // atomic read that retrieves a consistent key and certificate chain. If you
  3309. // project them to separate files, your application code will need to
  3310. // additionally check that the leaf certificate was issued to the key.
  3311. //
  3312. // +optional
  3313. optional string credentialBundlePath = 4;
  3314. // Write the key at this path in the projected volume.
  3315. //
  3316. // Most applications should use credentialBundlePath. When using keyPath
  3317. // and certificateChainPath, your application needs to check that the key
  3318. // and leaf certificate are consistent, because it is possible to read the
  3319. // files mid-rotation.
  3320. //
  3321. // +optional
  3322. optional string keyPath = 5;
  3323. // Write the certificate chain at this path in the projected volume.
  3324. //
  3325. // Most applications should use credentialBundlePath. When using keyPath
  3326. // and certificateChainPath, your application needs to check that the key
  3327. // and leaf certificate are consistent, because it is possible to read the
  3328. // files mid-rotation.
  3329. //
  3330. // +optional
  3331. optional string certificateChainPath = 6;
  3332. // userAnnotations allow pod authors to pass additional information to
  3333. // the signer implementation. Kubernetes does not restrict or validate this
  3334. // metadata in any way.
  3335. //
  3336. // These values are copied verbatim into the `spec.unverifiedUserAnnotations` field of
  3337. // the PodCertificateRequest objects that Kubelet creates.
  3338. //
  3339. // Entries are subject to the same validation as object metadata annotations,
  3340. // with the addition that all keys must be domain-prefixed. No restrictions
  3341. // are placed on values, except an overall size limitation on the entire field.
  3342. //
  3343. // Signers should document the keys and values they support. Signers should
  3344. // deny requests that contain keys they do not recognize.
  3345. map<string, string> userAnnotations = 7;
  3346. }
  3347. // PodCondition contains details for the current condition of this pod.
  3348. message PodCondition {
  3349. // Type is the type of the condition.
  3350. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
  3351. optional string type = 1;
  3352. // If set, this represents the .metadata.generation that the pod condition was set based upon.
  3353. // The PodObservedGenerationTracking feature gate must be enabled to use this field.
  3354. // +featureGate=PodObservedGenerationTracking
  3355. // +optional
  3356. optional int64 observedGeneration = 7;
  3357. // Status is the status of the condition.
  3358. // Can be True, False, Unknown.
  3359. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
  3360. optional string status = 2;
  3361. // Last time we probed the condition.
  3362. // +optional
  3363. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastProbeTime = 3;
  3364. // Last time the condition transitioned from one status to another.
  3365. // +optional
  3366. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  3367. // Unique, one-word, CamelCase reason for the condition's last transition.
  3368. // +optional
  3369. optional string reason = 5;
  3370. // Human-readable message indicating details about last transition.
  3371. // +optional
  3372. optional string message = 6;
  3373. }
  3374. // PodDNSConfig defines the DNS parameters of a pod in addition to
  3375. // those generated from DNSPolicy.
  3376. message PodDNSConfig {
  3377. // A list of DNS name server IP addresses.
  3378. // This will be appended to the base nameservers generated from DNSPolicy.
  3379. // Duplicated nameservers will be removed.
  3380. // +optional
  3381. // +listType=atomic
  3382. repeated string nameservers = 1;
  3383. // A list of DNS search domains for host-name lookup.
  3384. // This will be appended to the base search paths generated from DNSPolicy.
  3385. // Duplicated search paths will be removed.
  3386. // +optional
  3387. // +listType=atomic
  3388. repeated string searches = 2;
  3389. // A list of DNS resolver options.
  3390. // This will be merged with the base options generated from DNSPolicy.
  3391. // Duplicated entries will be removed. Resolution options given in Options
  3392. // will override those that appear in the base DNSPolicy.
  3393. // +optional
  3394. // +listType=atomic
  3395. repeated PodDNSConfigOption options = 3;
  3396. }
  3397. // PodDNSConfigOption defines DNS resolver options of a pod.
  3398. message PodDNSConfigOption {
  3399. // Name is this DNS resolver option's name.
  3400. // Required.
  3401. optional string name = 1;
  3402. // Value is this DNS resolver option's value.
  3403. // +optional
  3404. optional string value = 2;
  3405. }
  3406. // PodExecOptions is the query options to a Pod's remote exec call.
  3407. // ---
  3408. // TODO: This is largely identical to PodAttachOptions above, make sure they stay in sync and see about merging
  3409. // and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY
  3410. message PodExecOptions {
  3411. // Redirect the standard input stream of the pod for this call.
  3412. // Defaults to false.
  3413. // +optional
  3414. optional bool stdin = 1;
  3415. // Redirect the standard output stream of the pod for this call.
  3416. // +optional
  3417. optional bool stdout = 2;
  3418. // Redirect the standard error stream of the pod for this call.
  3419. // +optional
  3420. optional bool stderr = 3;
  3421. // TTY if true indicates that a tty will be allocated for the exec call.
  3422. // Defaults to false.
  3423. // +optional
  3424. optional bool tty = 4;
  3425. // Container in which to execute the command.
  3426. // Defaults to only container if there is only one container in the pod.
  3427. // +optional
  3428. optional string container = 5;
  3429. // Command is the remote command to execute. argv array. Not executed within a shell.
  3430. // +listType=atomic
  3431. repeated string command = 6;
  3432. }
  3433. // PodExtendedResourceClaimStatus is stored in the PodStatus for the extended
  3434. // resource requests backed by DRA. It stores the generated name for
  3435. // the corresponding special ResourceClaim created by the scheduler.
  3436. message PodExtendedResourceClaimStatus {
  3437. // RequestMappings identifies the mapping of <container, extended resource backed by DRA> to device request
  3438. // in the generated ResourceClaim.
  3439. // +listType=atomic
  3440. repeated ContainerExtendedResourceRequest requestMappings = 1;
  3441. // ResourceClaimName is the name of the ResourceClaim that was
  3442. // generated for the Pod in the namespace of the Pod.
  3443. optional string resourceClaimName = 2;
  3444. }
  3445. // PodIP represents a single IP address allocated to the pod.
  3446. message PodIP {
  3447. // IP is the IP address assigned to the pod
  3448. // +required
  3449. optional string ip = 1;
  3450. }
  3451. // PodList is a list of Pods.
  3452. message PodList {
  3453. // Standard list metadata.
  3454. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  3455. // +optional
  3456. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  3457. // List of pods.
  3458. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
  3459. repeated Pod items = 2;
  3460. }
  3461. // PodLogOptions is the query options for a Pod's logs REST call.
  3462. message PodLogOptions {
  3463. // The container for which to stream logs. Defaults to only container if there is one container in the pod.
  3464. // +optional
  3465. optional string container = 1;
  3466. // Follow the log stream of the pod. Defaults to false.
  3467. // +optional
  3468. optional bool follow = 2;
  3469. // Return previous terminated container logs. Defaults to false.
  3470. // +optional
  3471. optional bool previous = 3;
  3472. // A relative time in seconds before the current time from which to show logs. If this value
  3473. // precedes the time a pod was started, only logs since the pod start will be returned.
  3474. // If this value is in the future, no logs will be returned.
  3475. // Only one of sinceSeconds or sinceTime may be specified.
  3476. // +optional
  3477. optional int64 sinceSeconds = 4;
  3478. // An RFC3339 timestamp from which to show logs. If this value
  3479. // precedes the time a pod was started, only logs since the pod start will be returned.
  3480. // If this value is in the future, no logs will be returned.
  3481. // Only one of sinceSeconds or sinceTime may be specified.
  3482. // +optional
  3483. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time sinceTime = 5;
  3484. // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line
  3485. // of log output. Defaults to false.
  3486. // +optional
  3487. optional bool timestamps = 6;
  3488. // If set, the number of lines from the end of the logs to show. If not specified,
  3489. // logs are shown from the creation of the container or sinceSeconds or sinceTime.
  3490. // Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".
  3491. // +optional
  3492. optional int64 tailLines = 7;
  3493. // If set, the number of bytes to read from the server before terminating the
  3494. // log output. This may not display a complete final line of logging, and may return
  3495. // slightly more or slightly less than the specified limit.
  3496. // +optional
  3497. optional int64 limitBytes = 8;
  3498. // insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the
  3499. // serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver
  3500. // and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real
  3501. // kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the
  3502. // connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept
  3503. // the actual log data coming from the real kubelet).
  3504. // +optional
  3505. optional bool insecureSkipTLSVerifyBackend = 9;
  3506. // Specify which container log stream to return to the client.
  3507. // Acceptable values are "All", "Stdout" and "Stderr". If not specified, "All" is used, and both stdout and stderr
  3508. // are returned interleaved.
  3509. // Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".
  3510. // +featureGate=PodLogsQuerySplitStreams
  3511. // +optional
  3512. optional string stream = 10;
  3513. }
  3514. // PodOS defines the OS parameters of a pod.
  3515. message PodOS {
  3516. // Name is the name of the operating system. The currently supported values are linux and windows.
  3517. // Additional value may be defined in future and can be one of:
  3518. // https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration
  3519. // Clients should expect to handle additional values and treat unrecognized values in this field as os: null
  3520. optional string name = 1;
  3521. }
  3522. // PodPortForwardOptions is the query options to a Pod's port forward call
  3523. // when using WebSockets.
  3524. // The `port` query parameter must specify the port or
  3525. // ports (comma separated) to forward over.
  3526. // Port forwarding over SPDY does not use these options. It requires the port
  3527. // to be passed in the `port` header as part of request.
  3528. message PodPortForwardOptions {
  3529. // List of ports to forward
  3530. // Required when using WebSockets
  3531. // +optional
  3532. // +listType=atomic
  3533. repeated int32 ports = 1;
  3534. }
  3535. // PodProxyOptions is the query options to a Pod's proxy call.
  3536. message PodProxyOptions {
  3537. // Path is the URL path to use for the current proxy request to pod.
  3538. // +optional
  3539. optional string path = 1;
  3540. }
  3541. // PodReadinessGate contains the reference to a pod condition
  3542. message PodReadinessGate {
  3543. // ConditionType refers to a condition in the pod's condition list with matching type.
  3544. optional string conditionType = 1;
  3545. }
  3546. // PodResourceClaim references exactly one ResourceClaim, either directly
  3547. // or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim
  3548. // for the pod.
  3549. //
  3550. // It adds a name to it that uniquely identifies the ResourceClaim inside the Pod.
  3551. // Containers that need access to the ResourceClaim reference it with this name.
  3552. message PodResourceClaim {
  3553. // Name uniquely identifies this resource claim inside the pod.
  3554. // This must be a DNS_LABEL.
  3555. optional string name = 1;
  3556. // ResourceClaimName is the name of a ResourceClaim object in the same
  3557. // namespace as this pod.
  3558. //
  3559. // Exactly one of ResourceClaimName and ResourceClaimTemplateName must
  3560. // be set.
  3561. optional string resourceClaimName = 3;
  3562. // ResourceClaimTemplateName is the name of a ResourceClaimTemplate
  3563. // object in the same namespace as this pod.
  3564. //
  3565. // The template will be used to create a new ResourceClaim, which will
  3566. // be bound to this pod. When this pod is deleted, the ResourceClaim
  3567. // will also be deleted. The pod name and resource name, along with a
  3568. // generated component, will be used to form a unique name for the
  3569. // ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
  3570. //
  3571. // This field is immutable and no changes will be made to the
  3572. // corresponding ResourceClaim by the control plane after creating the
  3573. // ResourceClaim.
  3574. //
  3575. // Exactly one of ResourceClaimName and ResourceClaimTemplateName must
  3576. // be set.
  3577. optional string resourceClaimTemplateName = 4;
  3578. }
  3579. // PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim
  3580. // which references a ResourceClaimTemplate. It stores the generated name for
  3581. // the corresponding ResourceClaim.
  3582. message PodResourceClaimStatus {
  3583. // Name uniquely identifies this resource claim inside the pod.
  3584. // This must match the name of an entry in pod.spec.resourceClaims,
  3585. // which implies that the string must be a DNS_LABEL.
  3586. optional string name = 1;
  3587. // ResourceClaimName is the name of the ResourceClaim that was
  3588. // generated for the Pod in the namespace of the Pod. If this is
  3589. // unset, then generating a ResourceClaim was not necessary. The
  3590. // pod.spec.resourceClaims entry can be ignored in this case.
  3591. //
  3592. // +optional
  3593. optional string resourceClaimName = 2;
  3594. }
  3595. // PodSchedulingGate is associated to a Pod to guard its scheduling.
  3596. message PodSchedulingGate {
  3597. // Name of the scheduling gate.
  3598. // Each scheduling gate must have a unique name field.
  3599. optional string name = 1;
  3600. }
  3601. // PodSecurityContext holds pod-level security attributes and common container settings.
  3602. // Some fields are also present in container.securityContext. Field values of
  3603. // container.securityContext take precedence over field values of PodSecurityContext.
  3604. message PodSecurityContext {
  3605. // The SELinux context to be applied to all containers.
  3606. // If unspecified, the container runtime will allocate a random SELinux context for each
  3607. // container. May also be set in SecurityContext. If set in
  3608. // both SecurityContext and PodSecurityContext, the value specified in SecurityContext
  3609. // takes precedence for that container.
  3610. // Note that this field cannot be set when spec.os.name is windows.
  3611. // +optional
  3612. optional SELinuxOptions seLinuxOptions = 1;
  3613. // The Windows specific settings applied to all containers.
  3614. // If unspecified, the options within a container's SecurityContext will be used.
  3615. // If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
  3616. // Note that this field cannot be set when spec.os.name is linux.
  3617. // +optional
  3618. optional WindowsSecurityContextOptions windowsOptions = 8;
  3619. // The UID to run the entrypoint of the container process.
  3620. // Defaults to user specified in image metadata if unspecified.
  3621. // May also be set in SecurityContext. If set in both SecurityContext and
  3622. // PodSecurityContext, the value specified in SecurityContext takes precedence
  3623. // for that container.
  3624. // Note that this field cannot be set when spec.os.name is windows.
  3625. // +optional
  3626. optional int64 runAsUser = 2;
  3627. // The GID to run the entrypoint of the container process.
  3628. // Uses runtime default if unset.
  3629. // May also be set in SecurityContext. If set in both SecurityContext and
  3630. // PodSecurityContext, the value specified in SecurityContext takes precedence
  3631. // for that container.
  3632. // Note that this field cannot be set when spec.os.name is windows.
  3633. // +optional
  3634. optional int64 runAsGroup = 6;
  3635. // Indicates that the container must run as a non-root user.
  3636. // If true, the Kubelet will validate the image at runtime to ensure that it
  3637. // does not run as UID 0 (root) and fail to start the container if it does.
  3638. // If unset or false, no such validation will be performed.
  3639. // May also be set in SecurityContext. If set in both SecurityContext and
  3640. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  3641. // +optional
  3642. optional bool runAsNonRoot = 3;
  3643. // A list of groups applied to the first process run in each container, in
  3644. // addition to the container's primary GID and fsGroup (if specified). If
  3645. // the SupplementalGroupsPolicy feature is enabled, the
  3646. // supplementalGroupsPolicy field determines whether these are in addition
  3647. // to or instead of any group memberships defined in the container image.
  3648. // If unspecified, no additional groups are added, though group memberships
  3649. // defined in the container image may still be used, depending on the
  3650. // supplementalGroupsPolicy field.
  3651. // Note that this field cannot be set when spec.os.name is windows.
  3652. // +optional
  3653. // +listType=atomic
  3654. repeated int64 supplementalGroups = 4;
  3655. // Defines how supplemental groups of the first container processes are calculated.
  3656. // Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
  3657. // (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
  3658. // and the container runtime must implement support for this feature.
  3659. // Note that this field cannot be set when spec.os.name is windows.
  3660. // TODO: update the default value to "Merge" when spec.os.name is not windows in v1.34
  3661. // +featureGate=SupplementalGroupsPolicy
  3662. // +optional
  3663. optional string supplementalGroupsPolicy = 12;
  3664. // A special supplemental group that applies to all containers in a pod.
  3665. // Some volume types allow the Kubelet to change the ownership of that volume
  3666. // to be owned by the pod:
  3667. //
  3668. // 1. The owning GID will be the FSGroup
  3669. // 2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
  3670. // 3. The permission bits are OR'd with rw-rw----
  3671. //
  3672. // If unset, the Kubelet will not modify the ownership and permissions of any volume.
  3673. // Note that this field cannot be set when spec.os.name is windows.
  3674. // +optional
  3675. optional int64 fsGroup = 5;
  3676. // Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
  3677. // sysctls (by the container runtime) might fail to launch.
  3678. // Note that this field cannot be set when spec.os.name is windows.
  3679. // +optional
  3680. // +listType=atomic
  3681. repeated Sysctl sysctls = 7;
  3682. // fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
  3683. // before being exposed inside Pod. This field will only apply to
  3684. // volume types which support fsGroup based ownership(and permissions).
  3685. // It will have no effect on ephemeral volume types such as: secret, configmaps
  3686. // and emptydir.
  3687. // Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
  3688. // Note that this field cannot be set when spec.os.name is windows.
  3689. // +optional
  3690. optional string fsGroupChangePolicy = 9;
  3691. // The seccomp options to use by the containers in this pod.
  3692. // Note that this field cannot be set when spec.os.name is windows.
  3693. // +optional
  3694. optional SeccompProfile seccompProfile = 10;
  3695. // appArmorProfile is the AppArmor options to use by the containers in this pod.
  3696. // Note that this field cannot be set when spec.os.name is windows.
  3697. // +optional
  3698. optional AppArmorProfile appArmorProfile = 11;
  3699. // seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
  3700. // It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
  3701. // Valid values are "MountOption" and "Recursive".
  3702. //
  3703. // "Recursive" means relabeling of all files on all Pod volumes by the container runtime.
  3704. // This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
  3705. //
  3706. // "MountOption" mounts all eligible Pod volumes with `-o context` mount option.
  3707. // This requires all Pods that share the same volume to use the same SELinux label.
  3708. // It is not possible to share the same volume among privileged and unprivileged Pods.
  3709. // Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
  3710. // whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
  3711. // CSIDriver instance. Other volumes are always re-labelled recursively.
  3712. // "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
  3713. //
  3714. // If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
  3715. // If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
  3716. // and "Recursive" for all other volumes.
  3717. //
  3718. // This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
  3719. //
  3720. // All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
  3721. // Note that this field cannot be set when spec.os.name is windows.
  3722. // +featureGate=SELinuxChangePolicy
  3723. // +optional
  3724. optional string seLinuxChangePolicy = 13;
  3725. }
  3726. // Describes the class of pods that should avoid this node.
  3727. // Exactly one field should be set.
  3728. message PodSignature {
  3729. // Reference to controller whose pods should avoid this node.
  3730. // +optional
  3731. optional .k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference podController = 1;
  3732. }
  3733. // PodSpec is a description of a pod.
  3734. message PodSpec {
  3735. // List of volumes that can be mounted by containers belonging to the pod.
  3736. // More info: https://kubernetes.io/docs/concepts/storage/volumes
  3737. // +optional
  3738. // +patchMergeKey=name
  3739. // +patchStrategy=merge,retainKeys
  3740. // +listType=map
  3741. // +listMapKey=name
  3742. repeated Volume volumes = 1;
  3743. // List of initialization containers belonging to the pod.
  3744. // Init containers are executed in order prior to containers being started. If any
  3745. // init container fails, the pod is considered to have failed and is handled according
  3746. // to its restartPolicy. The name for an init container or normal container must be
  3747. // unique among all containers.
  3748. // Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.
  3749. // The resourceRequirements of an init container are taken into account during scheduling
  3750. // by finding the highest request/limit for each resource type, and then using the max of
  3751. // that value or the sum of the normal containers. Limits are applied to init containers
  3752. // in a similar fashion.
  3753. // Init containers cannot currently be added or removed.
  3754. // Cannot be updated.
  3755. // More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
  3756. // +patchMergeKey=name
  3757. // +patchStrategy=merge
  3758. // +listType=map
  3759. // +listMapKey=name
  3760. repeated Container initContainers = 20;
  3761. // List of containers belonging to the pod.
  3762. // Containers cannot currently be added or removed.
  3763. // There must be at least one container in a Pod.
  3764. // Cannot be updated.
  3765. // +patchMergeKey=name
  3766. // +patchStrategy=merge
  3767. // +listType=map
  3768. // +listMapKey=name
  3769. repeated Container containers = 2;
  3770. // List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing
  3771. // pod to perform user-initiated actions such as debugging. This list cannot be specified when
  3772. // creating a pod, and it cannot be modified by updating the pod spec. In order to add an
  3773. // ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.
  3774. // +optional
  3775. // +patchMergeKey=name
  3776. // +patchStrategy=merge
  3777. // +listType=map
  3778. // +listMapKey=name
  3779. repeated EphemeralContainer ephemeralContainers = 34;
  3780. // Restart policy for all containers within the pod.
  3781. // One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted.
  3782. // Default to Always.
  3783. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
  3784. // +optional
  3785. optional string restartPolicy = 3;
  3786. // Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
  3787. // Value must be non-negative integer. The value zero indicates stop immediately via
  3788. // the kill signal (no opportunity to shut down).
  3789. // If this value is nil, the default grace period will be used instead.
  3790. // The grace period is the duration in seconds after the processes running in the pod are sent
  3791. // a termination signal and the time when the processes are forcibly halted with a kill signal.
  3792. // Set this value longer than the expected cleanup time for your process.
  3793. // Defaults to 30 seconds.
  3794. // +optional
  3795. optional int64 terminationGracePeriodSeconds = 4;
  3796. // Optional duration in seconds the pod may be active on the node relative to
  3797. // StartTime before the system will actively try to mark it failed and kill associated containers.
  3798. // Value must be a positive integer.
  3799. // +optional
  3800. optional int64 activeDeadlineSeconds = 5;
  3801. // Set DNS policy for the pod.
  3802. // Defaults to "ClusterFirst".
  3803. // Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.
  3804. // DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.
  3805. // To have DNS options set along with hostNetwork, you have to specify DNS policy
  3806. // explicitly to 'ClusterFirstWithHostNet'.
  3807. // +optional
  3808. optional string dnsPolicy = 6;
  3809. // NodeSelector is a selector which must be true for the pod to fit on a node.
  3810. // Selector which must match a node's labels for the pod to be scheduled on that node.
  3811. // More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
  3812. // +optional
  3813. // +mapType=atomic
  3814. map<string, string> nodeSelector = 7;
  3815. // ServiceAccountName is the name of the ServiceAccount to use to run this pod.
  3816. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
  3817. // +optional
  3818. optional string serviceAccountName = 8;
  3819. // DeprecatedServiceAccount is a deprecated alias for ServiceAccountName.
  3820. // Deprecated: Use serviceAccountName instead.
  3821. // +k8s:conversion-gen=false
  3822. // +optional
  3823. optional string serviceAccount = 9;
  3824. // AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
  3825. // +optional
  3826. optional bool automountServiceAccountToken = 21;
  3827. // NodeName indicates in which node this pod is scheduled.
  3828. // If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName.
  3829. // Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod.
  3830. // This field should not be used to express a desire for the pod to be scheduled on a specific node.
  3831. // https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename
  3832. // +optional
  3833. optional string nodeName = 10;
  3834. // Host networking requested for this pod. Use the host's network namespace.
  3835. // When using HostNetwork you should specify ports so the scheduler is aware.
  3836. // When `hostNetwork` is true, specified `hostPort` fields in port definitions must match `containerPort`,
  3837. // and unspecified `hostPort` fields in port definitions are defaulted to match `containerPort`.
  3838. // Default to false.
  3839. // +k8s:conversion-gen=false
  3840. // +optional
  3841. optional bool hostNetwork = 11;
  3842. // Use the host's pid namespace.
  3843. // Optional: Default to false.
  3844. // +k8s:conversion-gen=false
  3845. // +optional
  3846. optional bool hostPID = 12;
  3847. // Use the host's ipc namespace.
  3848. // Optional: Default to false.
  3849. // +k8s:conversion-gen=false
  3850. // +optional
  3851. optional bool hostIPC = 13;
  3852. // Share a single process namespace between all of the containers in a pod.
  3853. // When this is set containers will be able to view and signal processes from other containers
  3854. // in the same pod, and the first process in each container will not be assigned PID 1.
  3855. // HostPID and ShareProcessNamespace cannot both be set.
  3856. // Optional: Default to false.
  3857. // +k8s:conversion-gen=false
  3858. // +optional
  3859. optional bool shareProcessNamespace = 27;
  3860. // SecurityContext holds pod-level security attributes and common container settings.
  3861. // Optional: Defaults to empty. See type description for default values of each field.
  3862. // +optional
  3863. optional PodSecurityContext securityContext = 14;
  3864. // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
  3865. // If specified, these secrets will be passed to individual puller implementations for them to use.
  3866. // More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
  3867. // +optional
  3868. // +patchMergeKey=name
  3869. // +patchStrategy=merge
  3870. // +listType=map
  3871. // +listMapKey=name
  3872. repeated LocalObjectReference imagePullSecrets = 15;
  3873. // Specifies the hostname of the Pod
  3874. // If not specified, the pod's hostname will be set to a system-defined value.
  3875. // +optional
  3876. optional string hostname = 16;
  3877. // If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
  3878. // If not specified, the pod will not have a domainname at all.
  3879. // +optional
  3880. optional string subdomain = 17;
  3881. // If specified, the pod's scheduling constraints
  3882. // +optional
  3883. optional Affinity affinity = 18;
  3884. // If specified, the pod will be dispatched by specified scheduler.
  3885. // If not specified, the pod will be dispatched by default scheduler.
  3886. // +optional
  3887. optional string schedulerName = 19;
  3888. // If specified, the pod's tolerations.
  3889. // +optional
  3890. // +listType=atomic
  3891. repeated Toleration tolerations = 22;
  3892. // HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts
  3893. // file if specified.
  3894. // +optional
  3895. // +patchMergeKey=ip
  3896. // +patchStrategy=merge
  3897. // +listType=map
  3898. // +listMapKey=ip
  3899. repeated HostAlias hostAliases = 23;
  3900. // If specified, indicates the pod's priority. "system-node-critical" and
  3901. // "system-cluster-critical" are two special keywords which indicate the
  3902. // highest priorities with the former being the highest priority. Any other
  3903. // name must be defined by creating a PriorityClass object with that name.
  3904. // If not specified, the pod priority will be default or zero if there is no
  3905. // default.
  3906. // +optional
  3907. optional string priorityClassName = 24;
  3908. // The priority value. Various system components use this field to find the
  3909. // priority of the pod. When Priority Admission Controller is enabled, it
  3910. // prevents users from setting this field. The admission controller populates
  3911. // this field from PriorityClassName.
  3912. // The higher the value, the higher the priority.
  3913. // +optional
  3914. optional int32 priority = 25;
  3915. // Specifies the DNS parameters of a pod.
  3916. // Parameters specified here will be merged to the generated DNS
  3917. // configuration based on DNSPolicy.
  3918. // +optional
  3919. optional PodDNSConfig dnsConfig = 26;
  3920. // If specified, all readiness gates will be evaluated for pod readiness.
  3921. // A pod is ready when all its containers are ready AND
  3922. // all conditions specified in the readiness gates have status equal to "True"
  3923. // More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
  3924. // +optional
  3925. // +listType=atomic
  3926. repeated PodReadinessGate readinessGates = 28;
  3927. // RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used
  3928. // to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.
  3929. // If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an
  3930. // empty definition that uses the default runtime handler.
  3931. // More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
  3932. // +optional
  3933. optional string runtimeClassName = 29;
  3934. // EnableServiceLinks indicates whether information about services should be injected into pod's
  3935. // environment variables, matching the syntax of Docker links.
  3936. // Optional: Defaults to true.
  3937. // +optional
  3938. optional bool enableServiceLinks = 30;
  3939. // PreemptionPolicy is the Policy for preempting pods with lower priority.
  3940. // One of Never, PreemptLowerPriority.
  3941. // Defaults to PreemptLowerPriority if unset.
  3942. // +optional
  3943. optional string preemptionPolicy = 31;
  3944. // Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.
  3945. // This field will be autopopulated at admission time by the RuntimeClass admission controller. If
  3946. // the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.
  3947. // The RuntimeClass admission controller will reject Pod create requests which have the overhead already
  3948. // set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value
  3949. // defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.
  3950. // More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
  3951. // +optional
  3952. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> overhead = 32;
  3953. // TopologySpreadConstraints describes how a group of pods ought to spread across topology
  3954. // domains. Scheduler will schedule pods in a way which abides by the constraints.
  3955. // All topologySpreadConstraints are ANDed.
  3956. // +optional
  3957. // +patchMergeKey=topologyKey
  3958. // +patchStrategy=merge
  3959. // +listType=map
  3960. // +listMapKey=topologyKey
  3961. // +listMapKey=whenUnsatisfiable
  3962. repeated TopologySpreadConstraint topologySpreadConstraints = 33;
  3963. // If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).
  3964. // In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).
  3965. // In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN.
  3966. // If a pod does not have FQDN, this has no effect.
  3967. // Default to false.
  3968. // +optional
  3969. optional bool setHostnameAsFQDN = 35;
  3970. // Specifies the OS of the containers in the pod.
  3971. // Some pod and container fields are restricted if this is set.
  3972. //
  3973. // If the OS field is set to linux, the following fields must be unset:
  3974. // -securityContext.windowsOptions
  3975. //
  3976. // If the OS field is set to windows, following fields must be unset:
  3977. // - spec.hostPID
  3978. // - spec.hostIPC
  3979. // - spec.hostUsers
  3980. // - spec.resources
  3981. // - spec.securityContext.appArmorProfile
  3982. // - spec.securityContext.seLinuxOptions
  3983. // - spec.securityContext.seccompProfile
  3984. // - spec.securityContext.fsGroup
  3985. // - spec.securityContext.fsGroupChangePolicy
  3986. // - spec.securityContext.sysctls
  3987. // - spec.shareProcessNamespace
  3988. // - spec.securityContext.runAsUser
  3989. // - spec.securityContext.runAsGroup
  3990. // - spec.securityContext.supplementalGroups
  3991. // - spec.securityContext.supplementalGroupsPolicy
  3992. // - spec.containers[*].securityContext.appArmorProfile
  3993. // - spec.containers[*].securityContext.seLinuxOptions
  3994. // - spec.containers[*].securityContext.seccompProfile
  3995. // - spec.containers[*].securityContext.capabilities
  3996. // - spec.containers[*].securityContext.readOnlyRootFilesystem
  3997. // - spec.containers[*].securityContext.privileged
  3998. // - spec.containers[*].securityContext.allowPrivilegeEscalation
  3999. // - spec.containers[*].securityContext.procMount
  4000. // - spec.containers[*].securityContext.runAsUser
  4001. // - spec.containers[*].securityContext.runAsGroup
  4002. // +optional
  4003. optional PodOS os = 36;
  4004. // Use the host's user namespace.
  4005. // Optional: Default to true.
  4006. // If set to true or not present, the pod will be run in the host user namespace, useful
  4007. // for when the pod needs a feature only available to the host user namespace, such as
  4008. // loading a kernel module with CAP_SYS_MODULE.
  4009. // When set to false, a new userns is created for the pod. Setting false is useful for
  4010. // mitigating container breakout vulnerabilities even allowing users to run their
  4011. // containers as root without actually having root privileges on the host.
  4012. // This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.
  4013. // +k8s:conversion-gen=false
  4014. // +optional
  4015. optional bool hostUsers = 37;
  4016. // SchedulingGates is an opaque list of values that if specified will block scheduling the pod.
  4017. // If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the
  4018. // scheduler will not attempt to schedule the pod.
  4019. //
  4020. // SchedulingGates can only be set at pod creation time, and be removed only afterwards.
  4021. //
  4022. // +patchMergeKey=name
  4023. // +patchStrategy=merge
  4024. // +listType=map
  4025. // +listMapKey=name
  4026. // +optional
  4027. repeated PodSchedulingGate schedulingGates = 38;
  4028. // ResourceClaims defines which ResourceClaims must be allocated
  4029. // and reserved before the Pod is allowed to start. The resources
  4030. // will be made available to those containers which consume them
  4031. // by name.
  4032. //
  4033. // This is a stable field but requires that the
  4034. // DynamicResourceAllocation feature gate is enabled.
  4035. //
  4036. // This field is immutable.
  4037. //
  4038. // +patchMergeKey=name
  4039. // +patchStrategy=merge,retainKeys
  4040. // +listType=map
  4041. // +listMapKey=name
  4042. // +featureGate=DynamicResourceAllocation
  4043. // +optional
  4044. repeated PodResourceClaim resourceClaims = 39;
  4045. // Resources is the total amount of CPU and Memory resources required by all
  4046. // containers in the pod. It supports specifying Requests and Limits for
  4047. // "cpu", "memory" and "hugepages-" resource names only. ResourceClaims are not supported.
  4048. //
  4049. // This field enables fine-grained control over resource allocation for the
  4050. // entire pod, allowing resource sharing among containers in a pod.
  4051. // TODO: For beta graduation, expand this comment with a detailed explanation.
  4052. //
  4053. // This is an alpha field and requires enabling the PodLevelResources feature
  4054. // gate.
  4055. //
  4056. // +featureGate=PodLevelResources
  4057. // +optional
  4058. optional ResourceRequirements resources = 40;
  4059. // HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod.
  4060. // This field only specifies the pod's hostname and does not affect its DNS records.
  4061. // When this field is set to a non-empty string:
  4062. // - It takes precedence over the values set in `hostname` and `subdomain`.
  4063. // - The Pod's hostname will be set to this value.
  4064. // - `setHostnameAsFQDN` must be nil or set to false.
  4065. // - `hostNetwork` must be set to false.
  4066. //
  4067. // This field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters.
  4068. // Requires the HostnameOverride feature gate to be enabled.
  4069. //
  4070. // +featureGate=HostnameOverride
  4071. // +optional
  4072. optional string hostnameOverride = 41;
  4073. // WorkloadRef provides a reference to the Workload object that this Pod belongs to.
  4074. // This field is used by the scheduler to identify the PodGroup and apply the
  4075. // correct group scheduling policies. The Workload object referenced
  4076. // by this field may not exist at the time the Pod is created.
  4077. // This field is immutable, but a Workload object with the same name
  4078. // may be recreated with different policies. Doing this during pod scheduling
  4079. // may result in the placement not conforming to the expected policies.
  4080. //
  4081. // +featureGate=GenericWorkload
  4082. // +optional
  4083. optional WorkloadReference workloadRef = 42;
  4084. }
  4085. // PodStatus represents information about the status of a pod. Status may trail the actual
  4086. // state of a system, especially if the node that hosts the pod cannot contact the control
  4087. // plane.
  4088. message PodStatus {
  4089. // If set, this represents the .metadata.generation that the pod status was set based upon.
  4090. // The PodObservedGenerationTracking feature gate must be enabled to use this field.
  4091. // +featureGate=PodObservedGenerationTracking
  4092. // +optional
  4093. optional int64 observedGeneration = 17;
  4094. // The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle.
  4095. // The conditions array, the reason and message fields, and the individual container status
  4096. // arrays contain more detail about the pod's status.
  4097. // There are five possible phase values:
  4098. //
  4099. // Pending: The pod has been accepted by the Kubernetes system, but one or more of the
  4100. // container images has not been created. This includes time before being scheduled as
  4101. // well as time spent downloading images over the network, which could take a while.
  4102. // Running: The pod has been bound to a node, and all of the containers have been created.
  4103. // At least one container is still running, or is in the process of starting or restarting.
  4104. // Succeeded: All containers in the pod have terminated in success, and will not be restarted.
  4105. // Failed: All containers in the pod have terminated, and at least one container has
  4106. // terminated in failure. The container either exited with non-zero status or was terminated
  4107. // by the system.
  4108. // Unknown: For some reason the state of the pod could not be obtained, typically due to an
  4109. // error in communicating with the host of the pod.
  4110. //
  4111. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
  4112. // +optional
  4113. optional string phase = 1;
  4114. // Current service state of pod.
  4115. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
  4116. // +optional
  4117. // +patchMergeKey=type
  4118. // +patchStrategy=merge
  4119. // +listType=map
  4120. // +listMapKey=type
  4121. repeated PodCondition conditions = 2;
  4122. // A human readable message indicating details about why the pod is in this condition.
  4123. // +optional
  4124. optional string message = 3;
  4125. // A brief CamelCase message indicating details about why the pod is in this state.
  4126. // e.g. 'Evicted'
  4127. // +optional
  4128. optional string reason = 4;
  4129. // nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be
  4130. // scheduled right away as preemption victims receive their graceful termination periods.
  4131. // This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide
  4132. // to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to
  4133. // give the resources on this node to a higher priority pod that is created after preemption.
  4134. // As a result, this field may be different than PodSpec.nodeName when the pod is
  4135. // scheduled.
  4136. // +optional
  4137. optional string nominatedNodeName = 11;
  4138. // hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet.
  4139. // A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will
  4140. // not be updated even if there is a node is assigned to pod
  4141. // +optional
  4142. optional string hostIP = 5;
  4143. // hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must
  4144. // match the hostIP field. This list is empty if the pod has not started yet.
  4145. // A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will
  4146. // not be updated even if there is a node is assigned to this pod.
  4147. // +optional
  4148. // +patchStrategy=merge
  4149. // +patchMergeKey=ip
  4150. // +listType=atomic
  4151. repeated HostIP hostIPs = 16;
  4152. // podIP address allocated to the pod. Routable at least within the cluster.
  4153. // Empty if not yet allocated.
  4154. // +optional
  4155. optional string podIP = 6;
  4156. // podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must
  4157. // match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list
  4158. // is empty if no IPs have been allocated yet.
  4159. // +optional
  4160. // +patchStrategy=merge
  4161. // +patchMergeKey=ip
  4162. // +listType=map
  4163. // +listMapKey=ip
  4164. repeated PodIP podIPs = 12;
  4165. // RFC 3339 date and time at which the object was acknowledged by the Kubelet.
  4166. // This is before the Kubelet pulled the container image(s) for the pod.
  4167. // +optional
  4168. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 7;
  4169. // Statuses of init containers in this pod. The most recent successful non-restartable
  4170. // init container will have ready = true, the most recently started container will have
  4171. // startTime set.
  4172. // Each init container in the pod should have at most one status in this list,
  4173. // and all statuses should be for containers in the pod.
  4174. // However this is not enforced.
  4175. // If a status for a non-existent container is present in the list, or the list has duplicate names,
  4176. // the behavior of various Kubernetes components is not defined and those statuses might be
  4177. // ignored.
  4178. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status
  4179. // +listType=atomic
  4180. repeated ContainerStatus initContainerStatuses = 10;
  4181. // Statuses of containers in this pod.
  4182. // Each container in the pod should have at most one status in this list,
  4183. // and all statuses should be for containers in the pod.
  4184. // However this is not enforced.
  4185. // If a status for a non-existent container is present in the list, or the list has duplicate names,
  4186. // the behavior of various Kubernetes components is not defined and those statuses might be
  4187. // ignored.
  4188. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
  4189. // +optional
  4190. // +listType=atomic
  4191. repeated ContainerStatus containerStatuses = 8;
  4192. // The Quality of Service (QOS) classification assigned to the pod based on resource requirements
  4193. // See PodQOSClass type for available QOS classes
  4194. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes
  4195. // +optional
  4196. optional string qosClass = 9;
  4197. // Statuses for any ephemeral containers that have run in this pod.
  4198. // Each ephemeral container in the pod should have at most one status in this list,
  4199. // and all statuses should be for containers in the pod.
  4200. // However this is not enforced.
  4201. // If a status for a non-existent container is present in the list, or the list has duplicate names,
  4202. // the behavior of various Kubernetes components is not defined and those statuses might be
  4203. // ignored.
  4204. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
  4205. // +optional
  4206. // +listType=atomic
  4207. repeated ContainerStatus ephemeralContainerStatuses = 13;
  4208. // Status of resources resize desired for pod's containers.
  4209. // It is empty if no resources resize is pending.
  4210. // Any changes to container resources will automatically set this to "Proposed"
  4211. // Deprecated: Resize status is moved to two pod conditions PodResizePending and PodResizeInProgress.
  4212. // PodResizePending will track states where the spec has been resized, but the Kubelet has not yet allocated the resources.
  4213. // PodResizeInProgress will track in-progress resizes, and should be present whenever allocated resources != acknowledged resources.
  4214. // +featureGate=InPlacePodVerticalScaling
  4215. // +optional
  4216. optional string resize = 14;
  4217. // Status of resource claims.
  4218. // +patchMergeKey=name
  4219. // +patchStrategy=merge,retainKeys
  4220. // +listType=map
  4221. // +listMapKey=name
  4222. // +featureGate=DynamicResourceAllocation
  4223. // +optional
  4224. repeated PodResourceClaimStatus resourceClaimStatuses = 15;
  4225. // Status of extended resource claim backed by DRA.
  4226. // +featureGate=DRAExtendedResource
  4227. // +optional
  4228. optional PodExtendedResourceClaimStatus extendedResourceClaimStatus = 18;
  4229. // AllocatedResources is the total requests allocated for this pod by the node.
  4230. // If pod-level requests are not set, this will be the total requests aggregated
  4231. // across containers in the pod.
  4232. // +featureGate=InPlacePodLevelResourcesVerticalScaling
  4233. // +optional
  4234. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> allocatedResources = 19;
  4235. // Resources represents the compute resource requests and limits that have been
  4236. // applied at the pod level if pod-level requests or limits are set in
  4237. // PodSpec.Resources
  4238. // +featureGate=InPlacePodLevelResourcesVerticalScaling
  4239. // +optional
  4240. optional ResourceRequirements resources = 20;
  4241. }
  4242. // PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded
  4243. message PodStatusResult {
  4244. // Standard object's metadata.
  4245. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4246. // +optional
  4247. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4248. // Most recently observed status of the pod.
  4249. // This data may not be up to date.
  4250. // Populated by the system.
  4251. // Read-only.
  4252. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4253. // +optional
  4254. optional PodStatus status = 2;
  4255. }
  4256. // PodTemplate describes a template for creating copies of a predefined pod.
  4257. message PodTemplate {
  4258. // Standard object's metadata.
  4259. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4260. // +optional
  4261. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4262. // Template defines the pods that will be created from this pod template.
  4263. // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4264. // +optional
  4265. optional PodTemplateSpec template = 2;
  4266. }
  4267. // PodTemplateList is a list of PodTemplates.
  4268. message PodTemplateList {
  4269. // Standard list metadata.
  4270. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  4271. // +optional
  4272. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  4273. // List of pod templates
  4274. repeated PodTemplate items = 2;
  4275. }
  4276. // PodTemplateSpec describes the data a pod should have when created from a template
  4277. message PodTemplateSpec {
  4278. // Standard object's metadata.
  4279. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4280. // +optional
  4281. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4282. // Specification of the desired behavior of the pod.
  4283. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4284. // +optional
  4285. optional PodSpec spec = 2;
  4286. }
  4287. // PortStatus represents the error condition of a service port
  4288. message PortStatus {
  4289. // Port is the port number of the service port of which status is recorded here
  4290. optional int32 port = 1;
  4291. // Protocol is the protocol of the service port of which status is recorded here
  4292. // The supported values are: "TCP", "UDP", "SCTP"
  4293. optional string protocol = 2;
  4294. // Error is to record the problem with the service port
  4295. // The format of the error shall comply with the following rules:
  4296. // - built-in error values shall be specified in this file and those shall use
  4297. // CamelCase names
  4298. // - cloud provider specific error values must have names that comply with the
  4299. // format foo.example.com/CamelCase.
  4300. // ---
  4301. // The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
  4302. // +optional
  4303. // +kubebuilder:validation:Required
  4304. // +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
  4305. // +kubebuilder:validation:MaxLength=316
  4306. optional string error = 3;
  4307. }
  4308. // PortworxVolumeSource represents a Portworx volume resource.
  4309. message PortworxVolumeSource {
  4310. // volumeID uniquely identifies a Portworx volume
  4311. optional string volumeID = 1;
  4312. // fSType represents the filesystem type to mount
  4313. // Must be a filesystem type supported by the host operating system.
  4314. // Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
  4315. optional string fsType = 2;
  4316. // readOnly defaults to false (read/write). ReadOnly here will force
  4317. // the ReadOnly setting in VolumeMounts.
  4318. // +optional
  4319. optional bool readOnly = 3;
  4320. }
  4321. // Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
  4322. // +k8s:openapi-gen=false
  4323. message Preconditions {
  4324. // Specifies the target UID.
  4325. // +optional
  4326. optional string uid = 1;
  4327. }
  4328. // Describes a class of pods that should avoid this node.
  4329. message PreferAvoidPodsEntry {
  4330. // The class of pods.
  4331. optional PodSignature podSignature = 1;
  4332. // Time at which this entry was added to the list.
  4333. // +optional
  4334. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time evictionTime = 2;
  4335. // (brief) reason why this entry was added to the list.
  4336. // +optional
  4337. optional string reason = 3;
  4338. // Human readable message indicating why this entry was added to the list.
  4339. // +optional
  4340. optional string message = 4;
  4341. }
  4342. // An empty preferred scheduling term matches all objects with implicit weight 0
  4343. // (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
  4344. message PreferredSchedulingTerm {
  4345. // Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
  4346. optional int32 weight = 1;
  4347. // A node selector term, associated with the corresponding weight.
  4348. optional NodeSelectorTerm preference = 2;
  4349. }
  4350. // Probe describes a health check to be performed against a container to determine whether it is
  4351. // alive or ready to receive traffic.
  4352. message Probe {
  4353. // The action taken to determine the health of a container
  4354. optional ProbeHandler handler = 1;
  4355. // Number of seconds after the container has started before liveness probes are initiated.
  4356. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
  4357. // +optional
  4358. optional int32 initialDelaySeconds = 2;
  4359. // Number of seconds after which the probe times out.
  4360. // Defaults to 1 second. Minimum value is 1.
  4361. // More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
  4362. // +optional
  4363. optional int32 timeoutSeconds = 3;
  4364. // How often (in seconds) to perform the probe.
  4365. // Default to 10 seconds. Minimum value is 1.
  4366. // +optional
  4367. optional int32 periodSeconds = 4;
  4368. // Minimum consecutive successes for the probe to be considered successful after having failed.
  4369. // Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
  4370. // +optional
  4371. optional int32 successThreshold = 5;
  4372. // Minimum consecutive failures for the probe to be considered failed after having succeeded.
  4373. // Defaults to 3. Minimum value is 1.
  4374. // +optional
  4375. optional int32 failureThreshold = 6;
  4376. // Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
  4377. // The grace period is the duration in seconds after the processes running in the pod are sent
  4378. // a termination signal and the time when the processes are forcibly halted with a kill signal.
  4379. // Set this value longer than the expected cleanup time for your process.
  4380. // If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
  4381. // value overrides the value provided by the pod spec.
  4382. // Value must be non-negative integer. The value zero indicates stop immediately via
  4383. // the kill signal (no opportunity to shut down).
  4384. // This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
  4385. // Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
  4386. // +optional
  4387. optional int64 terminationGracePeriodSeconds = 7;
  4388. }
  4389. // ProbeHandler defines a specific action that should be taken in a probe.
  4390. // One and only one of the fields must be specified.
  4391. message ProbeHandler {
  4392. // Exec specifies a command to execute in the container.
  4393. // +optional
  4394. optional ExecAction exec = 1;
  4395. // HTTPGet specifies an HTTP GET request to perform.
  4396. // +optional
  4397. optional HTTPGetAction httpGet = 2;
  4398. // TCPSocket specifies a connection to a TCP port.
  4399. // +optional
  4400. optional TCPSocketAction tcpSocket = 3;
  4401. // GRPC specifies a GRPC HealthCheckRequest.
  4402. // +optional
  4403. optional GRPCAction grpc = 4;
  4404. }
  4405. // Represents a projected volume source
  4406. message ProjectedVolumeSource {
  4407. // sources is the list of volume projections. Each entry in this list
  4408. // handles one source.
  4409. // +optional
  4410. // +listType=atomic
  4411. repeated VolumeProjection sources = 1;
  4412. // defaultMode are the mode bits used to set permissions on created files by default.
  4413. // Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  4414. // YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  4415. // Directories within the path are not affected by this setting.
  4416. // This might be in conflict with other options that affect the file
  4417. // mode, like fsGroup, and the result can be other mode bits set.
  4418. // +optional
  4419. optional int32 defaultMode = 2;
  4420. }
  4421. // Represents a Quobyte mount that lasts the lifetime of a pod.
  4422. // Quobyte volumes do not support ownership management or SELinux relabeling.
  4423. message QuobyteVolumeSource {
  4424. // registry represents a single or multiple Quobyte Registry services
  4425. // specified as a string as host:port pair (multiple entries are separated with commas)
  4426. // which acts as the central registry for volumes
  4427. optional string registry = 1;
  4428. // volume is a string that references an already created Quobyte volume by name.
  4429. optional string volume = 2;
  4430. // readOnly here will force the Quobyte volume to be mounted with read-only permissions.
  4431. // Defaults to false.
  4432. // +optional
  4433. optional bool readOnly = 3;
  4434. // user to map volume access to
  4435. // Defaults to serivceaccount user
  4436. // +optional
  4437. optional string user = 4;
  4438. // group to map volume access to
  4439. // Default is no group
  4440. // +optional
  4441. optional string group = 5;
  4442. // tenant owning the given Quobyte volume in the Backend
  4443. // Used with dynamically provisioned Quobyte volumes, value is set by the plugin
  4444. // +optional
  4445. optional string tenant = 6;
  4446. }
  4447. // Represents a Rados Block Device mount that lasts the lifetime of a pod.
  4448. // RBD volumes support ownership management and SELinux relabeling.
  4449. message RBDPersistentVolumeSource {
  4450. // monitors is a collection of Ceph monitors.
  4451. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4452. // +listType=atomic
  4453. repeated string monitors = 1;
  4454. // image is the rados image name.
  4455. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4456. optional string image = 2;
  4457. // fsType is the filesystem type of the volume that you want to mount.
  4458. // Tip: Ensure that the filesystem type is supported by the host operating system.
  4459. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  4460. // More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
  4461. // TODO: how do we prevent errors in the filesystem from compromising the machine
  4462. // +optional
  4463. optional string fsType = 3;
  4464. // pool is the rados pool name.
  4465. // Default is rbd.
  4466. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4467. // +optional
  4468. // +default="rbd"
  4469. optional string pool = 4;
  4470. // user is the rados user name.
  4471. // Default is admin.
  4472. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4473. // +optional
  4474. // +default="admin"
  4475. optional string user = 5;
  4476. // keyring is the path to key ring for RBDUser.
  4477. // Default is /etc/ceph/keyring.
  4478. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4479. // +optional
  4480. // +default="/etc/ceph/keyring"
  4481. optional string keyring = 6;
  4482. // secretRef is name of the authentication secret for RBDUser. If provided
  4483. // overrides keyring.
  4484. // Default is nil.
  4485. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4486. // +optional
  4487. optional SecretReference secretRef = 7;
  4488. // readOnly here will force the ReadOnly setting in VolumeMounts.
  4489. // Defaults to false.
  4490. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4491. // +optional
  4492. optional bool readOnly = 8;
  4493. }
  4494. // Represents a Rados Block Device mount that lasts the lifetime of a pod.
  4495. // RBD volumes support ownership management and SELinux relabeling.
  4496. message RBDVolumeSource {
  4497. // monitors is a collection of Ceph monitors.
  4498. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4499. // +listType=atomic
  4500. repeated string monitors = 1;
  4501. // image is the rados image name.
  4502. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4503. optional string image = 2;
  4504. // fsType is the filesystem type of the volume that you want to mount.
  4505. // Tip: Ensure that the filesystem type is supported by the host operating system.
  4506. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  4507. // More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
  4508. // TODO: how do we prevent errors in the filesystem from compromising the machine
  4509. // +optional
  4510. optional string fsType = 3;
  4511. // pool is the rados pool name.
  4512. // Default is rbd.
  4513. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4514. // +optional
  4515. // +default="rbd"
  4516. optional string pool = 4;
  4517. // user is the rados user name.
  4518. // Default is admin.
  4519. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4520. // +optional
  4521. // +default="admin"
  4522. optional string user = 5;
  4523. // keyring is the path to key ring for RBDUser.
  4524. // Default is /etc/ceph/keyring.
  4525. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4526. // +optional
  4527. // +default="/etc/ceph/keyring"
  4528. optional string keyring = 6;
  4529. // secretRef is name of the authentication secret for RBDUser. If provided
  4530. // overrides keyring.
  4531. // Default is nil.
  4532. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4533. // +optional
  4534. optional LocalObjectReference secretRef = 7;
  4535. // readOnly here will force the ReadOnly setting in VolumeMounts.
  4536. // Defaults to false.
  4537. // More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  4538. // +optional
  4539. optional bool readOnly = 8;
  4540. }
  4541. // RangeAllocation is not a public type.
  4542. message RangeAllocation {
  4543. // Standard object's metadata.
  4544. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4545. // +optional
  4546. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4547. // Range is string that identifies the range represented by 'data'.
  4548. optional string range = 2;
  4549. // Data is a bit array containing all allocated addresses in the previous segment.
  4550. optional bytes data = 3;
  4551. }
  4552. // ReplicationController represents the configuration of a replication controller.
  4553. message ReplicationController {
  4554. // If the Labels of a ReplicationController are empty, they are defaulted to
  4555. // be the same as the Pod(s) that the replication controller manages.
  4556. // Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4557. // +optional
  4558. // +k8s:subfield(name)=+k8s:optional
  4559. // +k8s:subfield(name)=+k8s:format=k8s-long-name
  4560. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4561. // Spec defines the specification of the desired behavior of the replication controller.
  4562. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4563. // +optional
  4564. optional ReplicationControllerSpec spec = 2;
  4565. // Status is the most recently observed status of the replication controller.
  4566. // This data may be out of date by some window of time.
  4567. // Populated by the system.
  4568. // Read-only.
  4569. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4570. // +optional
  4571. optional ReplicationControllerStatus status = 3;
  4572. }
  4573. // ReplicationControllerCondition describes the state of a replication controller at a certain point.
  4574. message ReplicationControllerCondition {
  4575. // Type of replication controller condition.
  4576. optional string type = 1;
  4577. // Status of the condition, one of True, False, Unknown.
  4578. optional string status = 2;
  4579. // The last time the condition transitioned from one status to another.
  4580. // +optional
  4581. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
  4582. // The reason for the condition's last transition.
  4583. // +optional
  4584. optional string reason = 4;
  4585. // A human readable message indicating details about the transition.
  4586. // +optional
  4587. optional string message = 5;
  4588. }
  4589. // ReplicationControllerList is a collection of replication controllers.
  4590. message ReplicationControllerList {
  4591. // Standard list metadata.
  4592. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  4593. // +optional
  4594. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  4595. // List of replication controllers.
  4596. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
  4597. repeated ReplicationController items = 2;
  4598. }
  4599. // ReplicationControllerSpec is the specification of a replication controller.
  4600. message ReplicationControllerSpec {
  4601. // Replicas is the number of desired replicas.
  4602. // This is a pointer to distinguish between explicit zero and unspecified.
  4603. // Defaults to 1.
  4604. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
  4605. // +optional
  4606. // +k8s:optional
  4607. // +default=1
  4608. // +k8s:minimum=0
  4609. optional int32 replicas = 1;
  4610. // Minimum number of seconds for which a newly created pod should be ready
  4611. // without any of its container crashing, for it to be considered available.
  4612. // Defaults to 0 (pod will be considered available as soon as it is ready)
  4613. // +optional
  4614. // +k8s:optional
  4615. // +default=0
  4616. // +k8s:minimum=0
  4617. optional int32 minReadySeconds = 4;
  4618. // Selector is a label query over pods that should match the Replicas count.
  4619. // If Selector is empty, it is defaulted to the labels present on the Pod template.
  4620. // Label keys and values that must match in order to be controlled by this replication
  4621. // controller, if empty defaulted to labels on Pod template.
  4622. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  4623. // +optional
  4624. // +mapType=atomic
  4625. map<string, string> selector = 2;
  4626. // Template is the object that describes the pod that will be created if
  4627. // insufficient replicas are detected. This takes precedence over a TemplateRef.
  4628. // The only allowed template.spec.restartPolicy value is "Always".
  4629. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
  4630. // +optional
  4631. optional PodTemplateSpec template = 3;
  4632. }
  4633. // ReplicationControllerStatus represents the current status of a replication
  4634. // controller.
  4635. message ReplicationControllerStatus {
  4636. // Replicas is the most recently observed number of replicas.
  4637. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
  4638. optional int32 replicas = 1;
  4639. // The number of pods that have labels matching the labels of the pod template of the replication controller.
  4640. // +optional
  4641. optional int32 fullyLabeledReplicas = 2;
  4642. // The number of ready replicas for this replication controller.
  4643. // +optional
  4644. optional int32 readyReplicas = 4;
  4645. // The number of available replicas (ready for at least minReadySeconds) for this replication controller.
  4646. // +optional
  4647. optional int32 availableReplicas = 5;
  4648. // ObservedGeneration reflects the generation of the most recently observed replication controller.
  4649. // +optional
  4650. optional int64 observedGeneration = 3;
  4651. // Represents the latest available observations of a replication controller's current state.
  4652. // +optional
  4653. // +patchMergeKey=type
  4654. // +patchStrategy=merge
  4655. // +listType=map
  4656. // +listMapKey=type
  4657. repeated ReplicationControllerCondition conditions = 6;
  4658. }
  4659. // ResourceClaim references one entry in PodSpec.ResourceClaims.
  4660. message ResourceClaim {
  4661. // Name must match the name of one entry in pod.spec.resourceClaims of
  4662. // the Pod where this field is used. It makes that resource available
  4663. // inside a container.
  4664. optional string name = 1;
  4665. // Request is the name chosen for a request in the referenced claim.
  4666. // If empty, everything from the claim is made available, otherwise
  4667. // only the result of this request.
  4668. //
  4669. // +optional
  4670. optional string request = 2;
  4671. }
  4672. // ResourceFieldSelector represents container resources (cpu, memory) and their output format
  4673. // +structType=atomic
  4674. message ResourceFieldSelector {
  4675. // Container name: required for volumes, optional for env vars
  4676. // +optional
  4677. optional string containerName = 1;
  4678. // Required: resource to select
  4679. optional string resource = 2;
  4680. // Specifies the output format of the exposed resources, defaults to "1"
  4681. // +optional
  4682. optional .k8s.io.apimachinery.pkg.api.resource.Quantity divisor = 3;
  4683. }
  4684. // ResourceHealth represents the health of a resource. It has the latest device health information.
  4685. // This is a part of KEP https://kep.k8s.io/4680.
  4686. message ResourceHealth {
  4687. // ResourceID is the unique identifier of the resource. See the ResourceID type for more information.
  4688. optional string resourceID = 1;
  4689. // Health of the resource.
  4690. // can be one of:
  4691. // - Healthy: operates as normal
  4692. // - Unhealthy: reported unhealthy. We consider this a temporary health issue
  4693. // since we do not have a mechanism today to distinguish
  4694. // temporary and permanent issues.
  4695. // - Unknown: The status cannot be determined.
  4696. // For example, Device Plugin got unregistered and hasn't been re-registered since.
  4697. //
  4698. // In future we may want to introduce the PermanentlyUnhealthy Status.
  4699. optional string health = 2;
  4700. }
  4701. // ResourceQuota sets aggregate quota restrictions enforced per namespace
  4702. message ResourceQuota {
  4703. // Standard object's metadata.
  4704. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4705. // +optional
  4706. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4707. // Spec defines the desired quota.
  4708. // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4709. // +optional
  4710. optional ResourceQuotaSpec spec = 2;
  4711. // Status defines the actual enforced quota and its current usage.
  4712. // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  4713. // +optional
  4714. optional ResourceQuotaStatus status = 3;
  4715. }
  4716. // ResourceQuotaList is a list of ResourceQuota items.
  4717. message ResourceQuotaList {
  4718. // Standard list metadata.
  4719. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  4720. // +optional
  4721. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  4722. // Items is a list of ResourceQuota objects.
  4723. // More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
  4724. repeated ResourceQuota items = 2;
  4725. }
  4726. // ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
  4727. message ResourceQuotaSpec {
  4728. // hard is the set of desired hard limits for each named resource.
  4729. // More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
  4730. // +optional
  4731. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> hard = 1;
  4732. // A collection of filters that must match each object tracked by a quota.
  4733. // If not specified, the quota matches all objects.
  4734. // +optional
  4735. // +listType=atomic
  4736. repeated string scopes = 2;
  4737. // scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota
  4738. // but expressed using ScopeSelectorOperator in combination with possible values.
  4739. // For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
  4740. // +optional
  4741. optional ScopeSelector scopeSelector = 3;
  4742. }
  4743. // ResourceQuotaStatus defines the enforced hard limits and observed use.
  4744. message ResourceQuotaStatus {
  4745. // Hard is the set of enforced hard limits for each named resource.
  4746. // More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
  4747. // +optional
  4748. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> hard = 1;
  4749. // Used is the current observed total usage of the resource in the namespace.
  4750. // +optional
  4751. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> used = 2;
  4752. }
  4753. // ResourceRequirements describes the compute resource requirements.
  4754. message ResourceRequirements {
  4755. // Limits describes the maximum amount of compute resources allowed.
  4756. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  4757. // +optional
  4758. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> limits = 1;
  4759. // Requests describes the minimum amount of compute resources required.
  4760. // If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
  4761. // otherwise to an implementation-defined value. Requests cannot exceed Limits.
  4762. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  4763. // +optional
  4764. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> requests = 2;
  4765. // Claims lists the names of resources, defined in spec.resourceClaims,
  4766. // that are used by this container.
  4767. //
  4768. // This field depends on the
  4769. // DynamicResourceAllocation feature gate.
  4770. //
  4771. // This field is immutable. It can only be set for containers.
  4772. //
  4773. // +listType=map
  4774. // +listMapKey=name
  4775. // +featureGate=DynamicResourceAllocation
  4776. // +optional
  4777. repeated ResourceClaim claims = 3;
  4778. }
  4779. // ResourceStatus represents the status of a single resource allocated to a Pod.
  4780. message ResourceStatus {
  4781. // Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec.
  4782. // For DRA resources, the value must be "claim:<claim_name>/<request>".
  4783. // When this status is reported about a container, the "claim_name" and "request" must match one of the claims of this container.
  4784. // +required
  4785. optional string name = 1;
  4786. // List of unique resources health. Each element in the list contains an unique resource ID and its health.
  4787. // At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource allocated to the Pod on the Node.
  4788. // If other Pod on the same Node reports the status with the same resource ID, it must be the same resource they share.
  4789. // See ResourceID type definition for a specific format it has in various use cases.
  4790. // +listType=map
  4791. // +listMapKey=resourceID
  4792. repeated ResourceHealth resources = 2;
  4793. }
  4794. // SELinuxOptions are the labels to be applied to the container
  4795. message SELinuxOptions {
  4796. // User is a SELinux user label that applies to the container.
  4797. // +optional
  4798. optional string user = 1;
  4799. // Role is a SELinux role label that applies to the container.
  4800. // +optional
  4801. optional string role = 2;
  4802. // Type is a SELinux type label that applies to the container.
  4803. // +optional
  4804. optional string type = 3;
  4805. // Level is SELinux level label that applies to the container.
  4806. // +optional
  4807. optional string level = 4;
  4808. }
  4809. // ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
  4810. message ScaleIOPersistentVolumeSource {
  4811. // gateway is the host address of the ScaleIO API Gateway.
  4812. optional string gateway = 1;
  4813. // system is the name of the storage system as configured in ScaleIO.
  4814. optional string system = 2;
  4815. // secretRef references to the secret for ScaleIO user and other
  4816. // sensitive information. If this is not provided, Login operation will fail.
  4817. optional SecretReference secretRef = 3;
  4818. // sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
  4819. // +optional
  4820. optional bool sslEnabled = 4;
  4821. // protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
  4822. // +optional
  4823. optional string protectionDomain = 5;
  4824. // storagePool is the ScaleIO Storage Pool associated with the protection domain.
  4825. // +optional
  4826. optional string storagePool = 6;
  4827. // storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
  4828. // Default is ThinProvisioned.
  4829. // +optional
  4830. // +default="ThinProvisioned"
  4831. optional string storageMode = 7;
  4832. // volumeName is the name of a volume already created in the ScaleIO system
  4833. // that is associated with this volume source.
  4834. optional string volumeName = 8;
  4835. // fsType is the filesystem type to mount.
  4836. // Must be a filesystem type supported by the host operating system.
  4837. // Ex. "ext4", "xfs", "ntfs".
  4838. // Default is "xfs"
  4839. // +optional
  4840. // +default="xfs"
  4841. optional string fsType = 9;
  4842. // readOnly defaults to false (read/write). ReadOnly here will force
  4843. // the ReadOnly setting in VolumeMounts.
  4844. // +optional
  4845. optional bool readOnly = 10;
  4846. }
  4847. // ScaleIOVolumeSource represents a persistent ScaleIO volume
  4848. message ScaleIOVolumeSource {
  4849. // gateway is the host address of the ScaleIO API Gateway.
  4850. optional string gateway = 1;
  4851. // system is the name of the storage system as configured in ScaleIO.
  4852. optional string system = 2;
  4853. // secretRef references to the secret for ScaleIO user and other
  4854. // sensitive information. If this is not provided, Login operation will fail.
  4855. optional LocalObjectReference secretRef = 3;
  4856. // sslEnabled Flag enable/disable SSL communication with Gateway, default false
  4857. // +optional
  4858. optional bool sslEnabled = 4;
  4859. // protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
  4860. // +optional
  4861. optional string protectionDomain = 5;
  4862. // storagePool is the ScaleIO Storage Pool associated with the protection domain.
  4863. // +optional
  4864. optional string storagePool = 6;
  4865. // storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
  4866. // Default is ThinProvisioned.
  4867. // +optional
  4868. // +default="ThinProvisioned"
  4869. optional string storageMode = 7;
  4870. // volumeName is the name of a volume already created in the ScaleIO system
  4871. // that is associated with this volume source.
  4872. optional string volumeName = 8;
  4873. // fsType is the filesystem type to mount.
  4874. // Must be a filesystem type supported by the host operating system.
  4875. // Ex. "ext4", "xfs", "ntfs".
  4876. // Default is "xfs".
  4877. // +optional
  4878. // +default="xfs"
  4879. optional string fsType = 9;
  4880. // readOnly Defaults to false (read/write). ReadOnly here will force
  4881. // the ReadOnly setting in VolumeMounts.
  4882. // +optional
  4883. optional bool readOnly = 10;
  4884. }
  4885. // A scope selector represents the AND of the selectors represented
  4886. // by the scoped-resource selector requirements.
  4887. // +structType=atomic
  4888. message ScopeSelector {
  4889. // A list of scope selector requirements by scope of the resources.
  4890. // +optional
  4891. // +listType=atomic
  4892. repeated ScopedResourceSelectorRequirement matchExpressions = 1;
  4893. }
  4894. // A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator
  4895. // that relates the scope name and values.
  4896. message ScopedResourceSelectorRequirement {
  4897. // The name of the scope that the selector applies to.
  4898. optional string scopeName = 1;
  4899. // Represents a scope's relationship to a set of values.
  4900. // Valid operators are In, NotIn, Exists, DoesNotExist.
  4901. optional string operator = 2;
  4902. // An array of string values. If the operator is In or NotIn,
  4903. // the values array must be non-empty. If the operator is Exists or DoesNotExist,
  4904. // the values array must be empty.
  4905. // This array is replaced during a strategic merge patch.
  4906. // +optional
  4907. // +listType=atomic
  4908. repeated string values = 3;
  4909. }
  4910. // SeccompProfile defines a pod/container's seccomp profile settings.
  4911. // Only one profile source may be set.
  4912. // +union
  4913. message SeccompProfile {
  4914. // type indicates which kind of seccomp profile will be applied.
  4915. // Valid options are:
  4916. //
  4917. // Localhost - a profile defined in a file on the node should be used.
  4918. // RuntimeDefault - the container runtime default profile should be used.
  4919. // Unconfined - no profile should be applied.
  4920. // +unionDiscriminator
  4921. optional string type = 1;
  4922. // localhostProfile indicates a profile defined in a file on the node should be used.
  4923. // The profile must be preconfigured on the node to work.
  4924. // Must be a descending path, relative to the kubelet's configured seccomp profile location.
  4925. // Must be set if type is "Localhost". Must NOT be set for any other type.
  4926. // +optional
  4927. optional string localhostProfile = 2;
  4928. }
  4929. // Secret holds secret data of a certain type. The total bytes of the values in
  4930. // the Data field must be less than MaxSecretSize bytes.
  4931. message Secret {
  4932. // Standard object's metadata.
  4933. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  4934. // +optional
  4935. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  4936. // Immutable, if set to true, ensures that data stored in the Secret cannot
  4937. // be updated (only object metadata can be modified).
  4938. // If not set to true, the field can be modified at any time.
  4939. // Defaulted to nil.
  4940. // +optional
  4941. optional bool immutable = 5;
  4942. // Data contains the secret data. Each key must consist of alphanumeric
  4943. // characters, '-', '_' or '.'. The serialized form of the secret data is a
  4944. // base64 encoded string, representing the arbitrary (possibly non-string)
  4945. // data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
  4946. // +optional
  4947. map<string, bytes> data = 2;
  4948. // stringData allows specifying non-binary secret data in string form.
  4949. // It is provided as a write-only input field for convenience.
  4950. // All keys and values are merged into the data field on write, overwriting any existing values.
  4951. // The stringData field is never output when reading from the API.
  4952. // +k8s:conversion-gen=false
  4953. // +optional
  4954. map<string, string> stringData = 4;
  4955. // Used to facilitate programmatic handling of secret data.
  4956. // More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types
  4957. // +optional
  4958. optional string type = 3;
  4959. }
  4960. // SecretEnvSource selects a Secret to populate the environment
  4961. // variables with.
  4962. //
  4963. // The contents of the target Secret's Data field will represent the
  4964. // key-value pairs as environment variables.
  4965. message SecretEnvSource {
  4966. // The Secret to select from.
  4967. optional LocalObjectReference localObjectReference = 1;
  4968. // Specify whether the Secret must be defined
  4969. // +optional
  4970. optional bool optional = 2;
  4971. }
  4972. // SecretKeySelector selects a key of a Secret.
  4973. // +structType=atomic
  4974. message SecretKeySelector {
  4975. // The name of the secret in the pod's namespace to select from.
  4976. optional LocalObjectReference localObjectReference = 1;
  4977. // The key of the secret to select from. Must be a valid secret key.
  4978. optional string key = 2;
  4979. // Specify whether the Secret or its key must be defined
  4980. // +optional
  4981. optional bool optional = 3;
  4982. }
  4983. // SecretList is a list of Secret.
  4984. message SecretList {
  4985. // Standard list metadata.
  4986. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  4987. // +optional
  4988. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  4989. // Items is a list of secret objects.
  4990. // More info: https://kubernetes.io/docs/concepts/configuration/secret
  4991. repeated Secret items = 2;
  4992. }
  4993. // Adapts a secret into a projected volume.
  4994. //
  4995. // The contents of the target Secret's Data field will be presented in a
  4996. // projected volume as files using the keys in the Data field as the file names.
  4997. // Note that this is identical to a secret volume source without the default
  4998. // mode.
  4999. message SecretProjection {
  5000. optional LocalObjectReference localObjectReference = 1;
  5001. // items if unspecified, each key-value pair in the Data field of the referenced
  5002. // Secret will be projected into the volume as a file whose name is the
  5003. // key and content is the value. If specified, the listed keys will be
  5004. // projected into the specified paths, and unlisted keys will not be
  5005. // present. If a key is specified which is not present in the Secret,
  5006. // the volume setup will error unless it is marked optional. Paths must be
  5007. // relative and may not contain the '..' path or start with '..'.
  5008. // +optional
  5009. // +listType=atomic
  5010. repeated KeyToPath items = 2;
  5011. // optional field specify whether the Secret or its key must be defined
  5012. // +optional
  5013. optional bool optional = 4;
  5014. }
  5015. // SecretReference represents a Secret Reference. It has enough information to retrieve secret
  5016. // in any namespace
  5017. // +structType=atomic
  5018. message SecretReference {
  5019. // name is unique within a namespace to reference a secret resource.
  5020. // +optional
  5021. optional string name = 1;
  5022. // namespace defines the space within which the secret name must be unique.
  5023. // +optional
  5024. optional string namespace = 2;
  5025. }
  5026. // Adapts a Secret into a volume.
  5027. //
  5028. // The contents of the target Secret's Data field will be presented in a volume
  5029. // as files using the keys in the Data field as the file names.
  5030. // Secret volumes support ownership management and SELinux relabeling.
  5031. message SecretVolumeSource {
  5032. // secretName is the name of the secret in the pod's namespace to use.
  5033. // More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
  5034. // +optional
  5035. optional string secretName = 1;
  5036. // items If unspecified, each key-value pair in the Data field of the referenced
  5037. // Secret will be projected into the volume as a file whose name is the
  5038. // key and content is the value. If specified, the listed keys will be
  5039. // projected into the specified paths, and unlisted keys will not be
  5040. // present. If a key is specified which is not present in the Secret,
  5041. // the volume setup will error unless it is marked optional. Paths must be
  5042. // relative and may not contain the '..' path or start with '..'.
  5043. // +optional
  5044. // +listType=atomic
  5045. repeated KeyToPath items = 2;
  5046. // defaultMode is Optional: mode bits used to set permissions on created files by default.
  5047. // Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  5048. // YAML accepts both octal and decimal values, JSON requires decimal values
  5049. // for mode bits. Defaults to 0644.
  5050. // Directories within the path are not affected by this setting.
  5051. // This might be in conflict with other options that affect the file
  5052. // mode, like fsGroup, and the result can be other mode bits set.
  5053. // +optional
  5054. optional int32 defaultMode = 3;
  5055. // optional field specify whether the Secret or its keys must be defined
  5056. // +optional
  5057. optional bool optional = 4;
  5058. }
  5059. // SecurityContext holds security configuration that will be applied to a container.
  5060. // Some fields are present in both SecurityContext and PodSecurityContext. When both
  5061. // are set, the values in SecurityContext take precedence.
  5062. message SecurityContext {
  5063. // The capabilities to add/drop when running containers.
  5064. // Defaults to the default set of capabilities granted by the container runtime.
  5065. // Note that this field cannot be set when spec.os.name is windows.
  5066. // +optional
  5067. optional Capabilities capabilities = 1;
  5068. // Run container in privileged mode.
  5069. // Processes in privileged containers are essentially equivalent to root on the host.
  5070. // Defaults to false.
  5071. // Note that this field cannot be set when spec.os.name is windows.
  5072. // +optional
  5073. optional bool privileged = 2;
  5074. // The SELinux context to be applied to the container.
  5075. // If unspecified, the container runtime will allocate a random SELinux context for each
  5076. // container. May also be set in PodSecurityContext. If set in both SecurityContext and
  5077. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  5078. // Note that this field cannot be set when spec.os.name is windows.
  5079. // +optional
  5080. optional SELinuxOptions seLinuxOptions = 3;
  5081. // The Windows specific settings applied to all containers.
  5082. // If unspecified, the options from the PodSecurityContext will be used.
  5083. // If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
  5084. // Note that this field cannot be set when spec.os.name is linux.
  5085. // +optional
  5086. optional WindowsSecurityContextOptions windowsOptions = 10;
  5087. // The UID to run the entrypoint of the container process.
  5088. // Defaults to user specified in image metadata if unspecified.
  5089. // May also be set in PodSecurityContext. If set in both SecurityContext and
  5090. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  5091. // Note that this field cannot be set when spec.os.name is windows.
  5092. // +optional
  5093. optional int64 runAsUser = 4;
  5094. // The GID to run the entrypoint of the container process.
  5095. // Uses runtime default if unset.
  5096. // May also be set in PodSecurityContext. If set in both SecurityContext and
  5097. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  5098. // Note that this field cannot be set when spec.os.name is windows.
  5099. // +optional
  5100. optional int64 runAsGroup = 8;
  5101. // Indicates that the container must run as a non-root user.
  5102. // If true, the Kubelet will validate the image at runtime to ensure that it
  5103. // does not run as UID 0 (root) and fail to start the container if it does.
  5104. // If unset or false, no such validation will be performed.
  5105. // May also be set in PodSecurityContext. If set in both SecurityContext and
  5106. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  5107. // +optional
  5108. optional bool runAsNonRoot = 5;
  5109. // Whether this container has a read-only root filesystem.
  5110. // Default is false.
  5111. // Note that this field cannot be set when spec.os.name is windows.
  5112. // +optional
  5113. optional bool readOnlyRootFilesystem = 6;
  5114. // AllowPrivilegeEscalation controls whether a process can gain more
  5115. // privileges than its parent process. This bool directly controls if
  5116. // the no_new_privs flag will be set on the container process.
  5117. // AllowPrivilegeEscalation is true always when the container is:
  5118. // 1) run as Privileged
  5119. // 2) has CAP_SYS_ADMIN
  5120. // Note that this field cannot be set when spec.os.name is windows.
  5121. // +optional
  5122. optional bool allowPrivilegeEscalation = 7;
  5123. // procMount denotes the type of proc mount to use for the containers.
  5124. // The default value is Default which uses the container runtime defaults for
  5125. // readonly paths and masked paths.
  5126. // This requires the ProcMountType feature flag to be enabled.
  5127. // Note that this field cannot be set when spec.os.name is windows.
  5128. // +optional
  5129. optional string procMount = 9;
  5130. // The seccomp options to use by this container. If seccomp options are
  5131. // provided at both the pod & container level, the container options
  5132. // override the pod options.
  5133. // Note that this field cannot be set when spec.os.name is windows.
  5134. // +optional
  5135. optional SeccompProfile seccompProfile = 11;
  5136. // appArmorProfile is the AppArmor options to use by this container. If set, this profile
  5137. // overrides the pod's appArmorProfile.
  5138. // Note that this field cannot be set when spec.os.name is windows.
  5139. // +optional
  5140. optional AppArmorProfile appArmorProfile = 12;
  5141. }
  5142. // SerializedReference is a reference to serialized object.
  5143. message SerializedReference {
  5144. // The reference to an object in the system.
  5145. // +optional
  5146. optional ObjectReference reference = 1;
  5147. }
  5148. // Service is a named abstraction of software service (for example, mysql) consisting of local port
  5149. // (for example 3306) that the proxy listens on, and the selector that determines which pods
  5150. // will answer requests sent through the proxy.
  5151. message Service {
  5152. // Standard object's metadata.
  5153. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  5154. // +optional
  5155. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  5156. // Spec defines the behavior of a service.
  5157. // https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  5158. // +optional
  5159. optional ServiceSpec spec = 2;
  5160. // Most recently observed status of the service.
  5161. // Populated by the system.
  5162. // Read-only.
  5163. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  5164. // +optional
  5165. optional ServiceStatus status = 3;
  5166. }
  5167. // ServiceAccount binds together:
  5168. // * a name, understood by users, and perhaps by peripheral systems, for an identity
  5169. // * a principal that can be authenticated and authorized
  5170. // * a set of secrets
  5171. message ServiceAccount {
  5172. // Standard object's metadata.
  5173. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  5174. // +optional
  5175. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  5176. // Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use.
  5177. // Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true".
  5178. // The "kubernetes.io/enforce-mountable-secrets" annotation is deprecated since v1.32.
  5179. // Prefer separate namespaces to isolate access to mounted secrets.
  5180. // This field should not be used to find auto-generated service account token secrets for use outside of pods.
  5181. // Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created.
  5182. // More info: https://kubernetes.io/docs/concepts/configuration/secret
  5183. // +optional
  5184. // +patchMergeKey=name
  5185. // +patchStrategy=merge
  5186. // +listType=map
  5187. // +listMapKey=name
  5188. repeated ObjectReference secrets = 2;
  5189. // ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
  5190. // in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets
  5191. // can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet.
  5192. // More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
  5193. // +optional
  5194. // +listType=atomic
  5195. repeated LocalObjectReference imagePullSecrets = 3;
  5196. // AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.
  5197. // Can be overridden at the pod level.
  5198. // +optional
  5199. optional bool automountServiceAccountToken = 4;
  5200. }
  5201. // ServiceAccountList is a list of ServiceAccount objects
  5202. message ServiceAccountList {
  5203. // Standard list metadata.
  5204. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  5205. // +optional
  5206. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  5207. // List of ServiceAccounts.
  5208. // More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
  5209. repeated ServiceAccount items = 2;
  5210. }
  5211. // ServiceAccountTokenProjection represents a projected service account token
  5212. // volume. This projection can be used to insert a service account token into
  5213. // the pods runtime filesystem for use against APIs (Kubernetes API Server or
  5214. // otherwise).
  5215. message ServiceAccountTokenProjection {
  5216. // audience is the intended audience of the token. A recipient of a token
  5217. // must identify itself with an identifier specified in the audience of the
  5218. // token, and otherwise should reject the token. The audience defaults to the
  5219. // identifier of the apiserver.
  5220. // +optional
  5221. optional string audience = 1;
  5222. // expirationSeconds is the requested duration of validity of the service
  5223. // account token. As the token approaches expiration, the kubelet volume
  5224. // plugin will proactively rotate the service account token. The kubelet will
  5225. // start trying to rotate the token if the token is older than 80 percent of
  5226. // its time to live or if the token is older than 24 hours.Defaults to 1 hour
  5227. // and must be at least 10 minutes.
  5228. // +optional
  5229. optional int64 expirationSeconds = 2;
  5230. // path is the path relative to the mount point of the file to project the
  5231. // token into.
  5232. optional string path = 3;
  5233. }
  5234. // ServiceList holds a list of services.
  5235. message ServiceList {
  5236. // Standard list metadata.
  5237. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  5238. // +optional
  5239. optional .k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  5240. // List of services
  5241. repeated Service items = 2;
  5242. }
  5243. // ServicePort contains information on service's port.
  5244. message ServicePort {
  5245. // The name of this port within the service. This must be a DNS_LABEL.
  5246. // All ports within a ServiceSpec must have unique names. When considering
  5247. // the endpoints for a Service, this must match the 'name' field in the
  5248. // EndpointPort.
  5249. // Optional if only one ServicePort is defined on this service.
  5250. // +optional
  5251. optional string name = 1;
  5252. // The IP protocol for this port. Supports "TCP", "UDP", and "SCTP".
  5253. // Default is TCP.
  5254. // +default="TCP"
  5255. // +optional
  5256. optional string protocol = 2;
  5257. // The application protocol for this port.
  5258. // This is used as a hint for implementations to offer richer behavior for protocols that they understand.
  5259. // This field follows standard Kubernetes label syntax.
  5260. // Valid values are either:
  5261. //
  5262. // * Un-prefixed protocol names - reserved for IANA standard service names (as per
  5263. // RFC-6335 and https://www.iana.org/assignments/service-names).
  5264. //
  5265. // * Kubernetes-defined prefixed names:
  5266. // * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
  5267. // * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
  5268. // * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
  5269. //
  5270. // * Other protocols should use implementation-defined prefixed names such as
  5271. // mycompany.com/my-custom-protocol.
  5272. // +optional
  5273. optional string appProtocol = 6;
  5274. // The port that will be exposed by this service.
  5275. optional int32 port = 3;
  5276. // Number or name of the port to access on the pods targeted by the service.
  5277. // Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
  5278. // If this is a string, it will be looked up as a named port in the
  5279. // target Pod's container ports. If this is not specified, the value
  5280. // of the 'port' field is used (an identity map).
  5281. // This field is ignored for services with clusterIP=None, and should be
  5282. // omitted or set equal to the 'port' field.
  5283. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
  5284. // +optional
  5285. optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString targetPort = 4;
  5286. // The port on each node on which this service is exposed when type is
  5287. // NodePort or LoadBalancer. Usually assigned by the system. If a value is
  5288. // specified, in-range, and not in use it will be used, otherwise the
  5289. // operation will fail. If not specified, a port will be allocated if this
  5290. // Service requires one. If this field is specified when creating a
  5291. // Service which does not need it, creation will fail. This field will be
  5292. // wiped when updating a Service to no longer need it (e.g. changing type
  5293. // from NodePort to ClusterIP).
  5294. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
  5295. // +optional
  5296. optional int32 nodePort = 5;
  5297. }
  5298. // ServiceProxyOptions is the query options to a Service's proxy call.
  5299. message ServiceProxyOptions {
  5300. // Path is the part of URLs that include service endpoints, suffixes,
  5301. // and parameters to use for the current proxy request to service.
  5302. // For example, the whole request URL is
  5303. // http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy.
  5304. // Path is _search?q=user:kimchy.
  5305. // +optional
  5306. optional string path = 1;
  5307. }
  5308. // ServiceSpec describes the attributes that a user creates on a service.
  5309. message ServiceSpec {
  5310. // The list of ports that are exposed by this service.
  5311. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  5312. // +patchMergeKey=port
  5313. // +patchStrategy=merge
  5314. // +listType=map
  5315. // +listMapKey=port
  5316. // +listMapKey=protocol
  5317. repeated ServicePort ports = 1;
  5318. // Route service traffic to pods with label keys and values matching this
  5319. // selector. If empty or not present, the service is assumed to have an
  5320. // external process managing its endpoints, which Kubernetes will not
  5321. // modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
  5322. // Ignored if type is ExternalName.
  5323. // More info: https://kubernetes.io/docs/concepts/services-networking/service/
  5324. // +optional
  5325. // +mapType=atomic
  5326. map<string, string> selector = 2;
  5327. // clusterIP is the IP address of the service and is usually assigned
  5328. // randomly. If an address is specified manually, is in-range (as per
  5329. // system configuration), and is not in use, it will be allocated to the
  5330. // service; otherwise creation of the service will fail. This field may not
  5331. // be changed through updates unless the type field is also being changed
  5332. // to ExternalName (which requires this field to be blank) or the type
  5333. // field is being changed from ExternalName (in which case this field may
  5334. // optionally be specified, as describe above). Valid values are "None",
  5335. // empty string (""), or a valid IP address. Setting this to "None" makes a
  5336. // "headless service" (no virtual IP), which is useful when direct endpoint
  5337. // connections are preferred and proxying is not required. Only applies to
  5338. // types ClusterIP, NodePort, and LoadBalancer. If this field is specified
  5339. // when creating a Service of type ExternalName, creation will fail. This
  5340. // field will be wiped when updating a Service to type ExternalName.
  5341. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  5342. // +optional
  5343. optional string clusterIP = 3;
  5344. // ClusterIPs is a list of IP addresses assigned to this service, and are
  5345. // usually assigned randomly. If an address is specified manually, is
  5346. // in-range (as per system configuration), and is not in use, it will be
  5347. // allocated to the service; otherwise creation of the service will fail.
  5348. // This field may not be changed through updates unless the type field is
  5349. // also being changed to ExternalName (which requires this field to be
  5350. // empty) or the type field is being changed from ExternalName (in which
  5351. // case this field may optionally be specified, as describe above). Valid
  5352. // values are "None", empty string (""), or a valid IP address. Setting
  5353. // this to "None" makes a "headless service" (no virtual IP), which is
  5354. // useful when direct endpoint connections are preferred and proxying is
  5355. // not required. Only applies to types ClusterIP, NodePort, and
  5356. // LoadBalancer. If this field is specified when creating a Service of type
  5357. // ExternalName, creation will fail. This field will be wiped when updating
  5358. // a Service to type ExternalName. If this field is not specified, it will
  5359. // be initialized from the clusterIP field. If this field is specified,
  5360. // clients must ensure that clusterIPs[0] and clusterIP have the same
  5361. // value.
  5362. //
  5363. // This field may hold a maximum of two entries (dual-stack IPs, in either order).
  5364. // These IPs must correspond to the values of the ipFamilies field. Both
  5365. // clusterIPs and ipFamilies are governed by the ipFamilyPolicy field.
  5366. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  5367. // +listType=atomic
  5368. // +optional
  5369. repeated string clusterIPs = 18;
  5370. // type determines how the Service is exposed. Defaults to ClusterIP. Valid
  5371. // options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
  5372. // "ClusterIP" allocates a cluster-internal IP address for load-balancing
  5373. // to endpoints. Endpoints are determined by the selector or if that is not
  5374. // specified, by manual construction of an Endpoints object or
  5375. // EndpointSlice objects. If clusterIP is "None", no virtual IP is
  5376. // allocated and the endpoints are published as a set of endpoints rather
  5377. // than a virtual IP.
  5378. // "NodePort" builds on ClusterIP and allocates a port on every node which
  5379. // routes to the same endpoints as the clusterIP.
  5380. // "LoadBalancer" builds on NodePort and creates an external load-balancer
  5381. // (if supported in the current cloud) which routes to the same endpoints
  5382. // as the clusterIP.
  5383. // "ExternalName" aliases this service to the specified externalName.
  5384. // Several other fields do not apply to ExternalName services.
  5385. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
  5386. // +optional
  5387. optional string type = 4;
  5388. // externalIPs is a list of IP addresses for which nodes in the cluster
  5389. // will also accept traffic for this service. These IPs are not managed by
  5390. // Kubernetes. The user is responsible for ensuring that traffic arrives
  5391. // at a node with this IP. A common example is external load-balancers
  5392. // that are not part of the Kubernetes system.
  5393. // +optional
  5394. // +listType=atomic
  5395. repeated string externalIPs = 5;
  5396. // Supports "ClientIP" and "None". Used to maintain session affinity.
  5397. // Enable client IP based session affinity.
  5398. // Must be ClientIP or None.
  5399. // Defaults to None.
  5400. // More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  5401. // +optional
  5402. optional string sessionAffinity = 7;
  5403. // Only applies to Service Type: LoadBalancer.
  5404. // This feature depends on whether the underlying cloud-provider supports specifying
  5405. // the loadBalancerIP when a load balancer is created.
  5406. // This field will be ignored if the cloud-provider does not support the feature.
  5407. // Deprecated: This field was under-specified and its meaning varies across implementations.
  5408. // Using it is non-portable and it may not support dual-stack.
  5409. // Users are encouraged to use implementation-specific annotations when available.
  5410. // +optional
  5411. optional string loadBalancerIP = 8;
  5412. // If specified and supported by the platform, this will restrict traffic through the cloud-provider
  5413. // load-balancer will be restricted to the specified client IPs. This field will be ignored if the
  5414. // cloud-provider does not support the feature."
  5415. // More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/
  5416. // +optional
  5417. // +listType=atomic
  5418. repeated string loadBalancerSourceRanges = 9;
  5419. // externalName is the external reference that discovery mechanisms will
  5420. // return as an alias for this service (e.g. a DNS CNAME record). No
  5421. // proxying will be involved. Must be a lowercase RFC-1123 hostname
  5422. // (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
  5423. // +optional
  5424. optional string externalName = 10;
  5425. // externalTrafficPolicy describes how nodes distribute service traffic they
  5426. // receive on one of the Service's "externally-facing" addresses (NodePorts,
  5427. // ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure
  5428. // the service in a way that assumes that external load balancers will take care
  5429. // of balancing the service traffic between nodes, and so each node will deliver
  5430. // traffic only to the node-local endpoints of the service, without masquerading
  5431. // the client source IP. (Traffic mistakenly sent to a node with no endpoints will
  5432. // be dropped.) The default value, "Cluster", uses the standard behavior of
  5433. // routing to all endpoints evenly (possibly modified by topology and other
  5434. // features). Note that traffic sent to an External IP or LoadBalancer IP from
  5435. // within the cluster will always get "Cluster" semantics, but clients sending to
  5436. // a NodePort from within the cluster may need to take traffic policy into account
  5437. // when picking a node.
  5438. // +optional
  5439. optional string externalTrafficPolicy = 11;
  5440. // healthCheckNodePort specifies the healthcheck nodePort for the service.
  5441. // This only applies when type is set to LoadBalancer and
  5442. // externalTrafficPolicy is set to Local. If a value is specified, is
  5443. // in-range, and is not in use, it will be used. If not specified, a value
  5444. // will be automatically allocated. External systems (e.g. load-balancers)
  5445. // can use this port to determine if a given node holds endpoints for this
  5446. // service or not. If this field is specified when creating a Service
  5447. // which does not need it, creation will fail. This field will be wiped
  5448. // when updating a Service to no longer need it (e.g. changing type).
  5449. // This field cannot be updated once set.
  5450. // +optional
  5451. optional int32 healthCheckNodePort = 12;
  5452. // publishNotReadyAddresses indicates that any agent which deals with endpoints for this
  5453. // Service should disregard any indications of ready/not-ready.
  5454. // The primary use case for setting this field is for a StatefulSet's Headless Service to
  5455. // propagate SRV DNS records for its Pods for the purpose of peer discovery.
  5456. // The Kubernetes controllers that generate Endpoints and EndpointSlice resources for
  5457. // Services interpret this to mean that all endpoints are considered "ready" even if the
  5458. // Pods themselves are not. Agents which consume only Kubernetes generated endpoints
  5459. // through the Endpoints or EndpointSlice resources can safely assume this behavior.
  5460. // +optional
  5461. optional bool publishNotReadyAddresses = 13;
  5462. // sessionAffinityConfig contains the configurations of session affinity.
  5463. // +optional
  5464. optional SessionAffinityConfig sessionAffinityConfig = 14;
  5465. // IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this
  5466. // service. This field is usually assigned automatically based on cluster
  5467. // configuration and the ipFamilyPolicy field. If this field is specified
  5468. // manually, the requested family is available in the cluster,
  5469. // and ipFamilyPolicy allows it, it will be used; otherwise creation of
  5470. // the service will fail. This field is conditionally mutable: it allows
  5471. // for adding or removing a secondary IP family, but it does not allow
  5472. // changing the primary IP family of the Service. Valid values are "IPv4"
  5473. // and "IPv6". This field only applies to Services of types ClusterIP,
  5474. // NodePort, and LoadBalancer, and does apply to "headless" services.
  5475. // This field will be wiped when updating a Service to type ExternalName.
  5476. //
  5477. // This field may hold a maximum of two entries (dual-stack families, in
  5478. // either order). These families must correspond to the values of the
  5479. // clusterIPs field, if specified. Both clusterIPs and ipFamilies are
  5480. // governed by the ipFamilyPolicy field.
  5481. // +listType=atomic
  5482. // +optional
  5483. repeated string ipFamilies = 19;
  5484. // IPFamilyPolicy represents the dual-stack-ness requested or required by
  5485. // this Service. If there is no value provided, then this field will be set
  5486. // to SingleStack. Services can be "SingleStack" (a single IP family),
  5487. // "PreferDualStack" (two IP families on dual-stack configured clusters or
  5488. // a single IP family on single-stack clusters), or "RequireDualStack"
  5489. // (two IP families on dual-stack configured clusters, otherwise fail). The
  5490. // ipFamilies and clusterIPs fields depend on the value of this field. This
  5491. // field will be wiped when updating a service to type ExternalName.
  5492. // +optional
  5493. optional string ipFamilyPolicy = 17;
  5494. // allocateLoadBalancerNodePorts defines if NodePorts will be automatically
  5495. // allocated for services with type LoadBalancer. Default is "true". It
  5496. // may be set to "false" if the cluster load-balancer does not rely on
  5497. // NodePorts. If the caller requests specific NodePorts (by specifying a
  5498. // value), those requests will be respected, regardless of this field.
  5499. // This field may only be set for services with type LoadBalancer and will
  5500. // be cleared if the type is changed to any other type.
  5501. // +optional
  5502. optional bool allocateLoadBalancerNodePorts = 20;
  5503. // loadBalancerClass is the class of the load balancer implementation this Service belongs to.
  5504. // If specified, the value of this field must be a label-style identifier, with an optional prefix,
  5505. // e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users.
  5506. // This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load
  5507. // balancer implementation is used, today this is typically done through the cloud provider integration,
  5508. // but should apply for any default implementation. If set, it is assumed that a load balancer
  5509. // implementation is watching for Services with a matching class. Any default load balancer
  5510. // implementation (e.g. cloud providers) should ignore Services that set this field.
  5511. // This field can only be set when creating or updating a Service to type 'LoadBalancer'.
  5512. // Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
  5513. // +optional
  5514. optional string loadBalancerClass = 21;
  5515. // InternalTrafficPolicy describes how nodes distribute service traffic they
  5516. // receive on the ClusterIP. If set to "Local", the proxy will assume that pods
  5517. // only want to talk to endpoints of the service on the same node as the pod,
  5518. // dropping the traffic if there are no local endpoints. The default value,
  5519. // "Cluster", uses the standard behavior of routing to all endpoints evenly
  5520. // (possibly modified by topology and other features).
  5521. // +optional
  5522. optional string internalTrafficPolicy = 22;
  5523. // TrafficDistribution offers a way to express preferences for how traffic
  5524. // is distributed to Service endpoints. Implementations can use this field
  5525. // as a hint, but are not required to guarantee strict adherence. If the
  5526. // field is not set, the implementation will apply its default routing
  5527. // strategy. If set to "PreferClose", implementations should prioritize
  5528. // endpoints that are in the same zone.
  5529. // +optional
  5530. optional string trafficDistribution = 23;
  5531. }
  5532. // ServiceStatus represents the current status of a service.
  5533. message ServiceStatus {
  5534. // LoadBalancer contains the current status of the load-balancer,
  5535. // if one is present.
  5536. // +optional
  5537. optional LoadBalancerStatus loadBalancer = 1;
  5538. // Current service state
  5539. // +optional
  5540. // +patchMergeKey=type
  5541. // +patchStrategy=merge
  5542. // +listType=map
  5543. // +listMapKey=type
  5544. repeated .k8s.io.apimachinery.pkg.apis.meta.v1.Condition conditions = 2;
  5545. }
  5546. // SessionAffinityConfig represents the configurations of session affinity.
  5547. message SessionAffinityConfig {
  5548. // clientIP contains the configurations of Client IP based session affinity.
  5549. // +optional
  5550. optional ClientIPConfig clientIP = 1;
  5551. }
  5552. // SleepAction describes a "sleep" action.
  5553. message SleepAction {
  5554. // Seconds is the number of seconds to sleep.
  5555. optional int64 seconds = 1;
  5556. }
  5557. // Represents a StorageOS persistent volume resource.
  5558. message StorageOSPersistentVolumeSource {
  5559. // volumeName is the human-readable name of the StorageOS volume. Volume
  5560. // names are only unique within a namespace.
  5561. optional string volumeName = 1;
  5562. // volumeNamespace specifies the scope of the volume within StorageOS. If no
  5563. // namespace is specified then the Pod's namespace will be used. This allows the
  5564. // Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
  5565. // Set VolumeName to any name to override the default behaviour.
  5566. // Set to "default" if you are not using namespaces within StorageOS.
  5567. // Namespaces that do not pre-exist within StorageOS will be created.
  5568. // +optional
  5569. optional string volumeNamespace = 2;
  5570. // fsType is the filesystem type to mount.
  5571. // Must be a filesystem type supported by the host operating system.
  5572. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  5573. // +optional
  5574. optional string fsType = 3;
  5575. // readOnly defaults to false (read/write). ReadOnly here will force
  5576. // the ReadOnly setting in VolumeMounts.
  5577. // +optional
  5578. optional bool readOnly = 4;
  5579. // secretRef specifies the secret to use for obtaining the StorageOS API
  5580. // credentials. If not specified, default values will be attempted.
  5581. // +optional
  5582. optional ObjectReference secretRef = 5;
  5583. }
  5584. // Represents a StorageOS persistent volume resource.
  5585. message StorageOSVolumeSource {
  5586. // volumeName is the human-readable name of the StorageOS volume. Volume
  5587. // names are only unique within a namespace.
  5588. optional string volumeName = 1;
  5589. // volumeNamespace specifies the scope of the volume within StorageOS. If no
  5590. // namespace is specified then the Pod's namespace will be used. This allows the
  5591. // Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
  5592. // Set VolumeName to any name to override the default behaviour.
  5593. // Set to "default" if you are not using namespaces within StorageOS.
  5594. // Namespaces that do not pre-exist within StorageOS will be created.
  5595. // +optional
  5596. optional string volumeNamespace = 2;
  5597. // fsType is the filesystem type to mount.
  5598. // Must be a filesystem type supported by the host operating system.
  5599. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  5600. // +optional
  5601. optional string fsType = 3;
  5602. // readOnly defaults to false (read/write). ReadOnly here will force
  5603. // the ReadOnly setting in VolumeMounts.
  5604. // +optional
  5605. optional bool readOnly = 4;
  5606. // secretRef specifies the secret to use for obtaining the StorageOS API
  5607. // credentials. If not specified, default values will be attempted.
  5608. // +optional
  5609. optional LocalObjectReference secretRef = 5;
  5610. }
  5611. // Sysctl defines a kernel parameter to be set
  5612. message Sysctl {
  5613. // Name of a property to set
  5614. optional string name = 1;
  5615. // Value of a property to set
  5616. optional string value = 2;
  5617. }
  5618. // TCPSocketAction describes an action based on opening a socket
  5619. message TCPSocketAction {
  5620. // Number or name of the port to access on the container.
  5621. // Number must be in the range 1 to 65535.
  5622. // Name must be an IANA_SVC_NAME.
  5623. optional .k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 1;
  5624. // Optional: Host name to connect to, defaults to the pod IP.
  5625. // +optional
  5626. optional string host = 2;
  5627. }
  5628. // The node this Taint is attached to has the "effect" on
  5629. // any pod that does not tolerate the Taint.
  5630. message Taint {
  5631. // Required. The taint key to be applied to a node.
  5632. optional string key = 1;
  5633. // The taint value corresponding to the taint key.
  5634. // +optional
  5635. optional string value = 2;
  5636. // Required. The effect of the taint on pods
  5637. // that do not tolerate the taint.
  5638. // Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
  5639. optional string effect = 3;
  5640. // TimeAdded represents the time at which the taint was added.
  5641. // +optional
  5642. optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time timeAdded = 4;
  5643. }
  5644. // The pod this Toleration is attached to tolerates any taint that matches
  5645. // the triple <key,value,effect> using the matching operator <operator>.
  5646. message Toleration {
  5647. // Key is the taint key that the toleration applies to. Empty means match all taint keys.
  5648. // If the key is empty, operator must be Exists; this combination means to match all values and all keys.
  5649. // +optional
  5650. optional string key = 1;
  5651. // Operator represents a key's relationship to the value.
  5652. // Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.
  5653. // Exists is equivalent to wildcard for value, so that a pod can
  5654. // tolerate all taints of a particular category.
  5655. // Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
  5656. // +optional
  5657. optional string operator = 2;
  5658. // Value is the taint value the toleration matches to.
  5659. // If the operator is Exists, the value should be empty, otherwise just a regular string.
  5660. // +optional
  5661. optional string value = 3;
  5662. // Effect indicates the taint effect to match. Empty means match all taint effects.
  5663. // When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
  5664. // +optional
  5665. optional string effect = 4;
  5666. // TolerationSeconds represents the period of time the toleration (which must be
  5667. // of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
  5668. // it is not set, which means tolerate the taint forever (do not evict). Zero and
  5669. // negative values will be treated as 0 (evict immediately) by the system.
  5670. // +optional
  5671. optional int64 tolerationSeconds = 5;
  5672. }
  5673. // A topology selector requirement is a selector that matches given label.
  5674. // This is an alpha feature and may change in the future.
  5675. message TopologySelectorLabelRequirement {
  5676. // The label key that the selector applies to.
  5677. optional string key = 1;
  5678. // An array of string values. One value must match the label to be selected.
  5679. // Each entry in Values is ORed.
  5680. // +listType=atomic
  5681. repeated string values = 2;
  5682. }
  5683. // A topology selector term represents the result of label queries.
  5684. // A null or empty topology selector term matches no objects.
  5685. // The requirements of them are ANDed.
  5686. // It provides a subset of functionality as NodeSelectorTerm.
  5687. // This is an alpha feature and may change in the future.
  5688. // +structType=atomic
  5689. message TopologySelectorTerm {
  5690. // A list of topology selector requirements by labels.
  5691. // +optional
  5692. // +listType=atomic
  5693. repeated TopologySelectorLabelRequirement matchLabelExpressions = 1;
  5694. }
  5695. // TopologySpreadConstraint specifies how to spread matching pods among the given topology.
  5696. message TopologySpreadConstraint {
  5697. // MaxSkew describes the degree to which pods may be unevenly distributed.
  5698. // When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
  5699. // between the number of matching pods in the target topology and the global minimum.
  5700. // The global minimum is the minimum number of matching pods in an eligible domain
  5701. // or zero if the number of eligible domains is less than MinDomains.
  5702. // For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
  5703. // labelSelector spread as 2/2/1:
  5704. // In this case, the global minimum is 1.
  5705. // +-------+-------+-------+
  5706. // | zone1 | zone2 | zone3 |
  5707. // +-------+-------+-------+
  5708. // | P P | P P | P |
  5709. // +-------+-------+-------+
  5710. // - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
  5711. // scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
  5712. // violate MaxSkew(1).
  5713. // - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
  5714. // When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
  5715. // to topologies that satisfy it.
  5716. // It's a required field. Default value is 1 and 0 is not allowed.
  5717. optional int32 maxSkew = 1;
  5718. // TopologyKey is the key of node labels. Nodes that have a label with this key
  5719. // and identical values are considered to be in the same topology.
  5720. // We consider each <key, value> as a "bucket", and try to put balanced number
  5721. // of pods into each bucket.
  5722. // We define a domain as a particular instance of a topology.
  5723. // Also, we define an eligible domain as a domain whose nodes meet the requirements of
  5724. // nodeAffinityPolicy and nodeTaintsPolicy.
  5725. // e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
  5726. // And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
  5727. // It's a required field.
  5728. optional string topologyKey = 2;
  5729. // WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
  5730. // the spread constraint.
  5731. // - DoNotSchedule (default) tells the scheduler not to schedule it.
  5732. // - ScheduleAnyway tells the scheduler to schedule the pod in any location,
  5733. // but giving higher precedence to topologies that would help reduce the
  5734. // skew.
  5735. // A constraint is considered "Unsatisfiable" for an incoming pod
  5736. // if and only if every possible node assignment for that pod would violate
  5737. // "MaxSkew" on some topology.
  5738. // For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
  5739. // labelSelector spread as 3/1/1:
  5740. // +-------+-------+-------+
  5741. // | zone1 | zone2 | zone3 |
  5742. // +-------+-------+-------+
  5743. // | P P P | P | P |
  5744. // +-------+-------+-------+
  5745. // If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
  5746. // to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
  5747. // MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
  5748. // won't make it *more* imbalanced.
  5749. // It's a required field.
  5750. optional string whenUnsatisfiable = 3;
  5751. // LabelSelector is used to find matching pods.
  5752. // Pods that match this label selector are counted to determine the number of pods
  5753. // in their corresponding topology domain.
  5754. // +optional
  5755. optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 4;
  5756. // MinDomains indicates a minimum number of eligible domains.
  5757. // When the number of eligible domains with matching topology keys is less than minDomains,
  5758. // Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
  5759. // And when the number of eligible domains with matching topology keys equals or greater than minDomains,
  5760. // this value has no effect on scheduling.
  5761. // As a result, when the number of eligible domains is less than minDomains,
  5762. // scheduler won't schedule more than maxSkew Pods to those domains.
  5763. // If value is nil, the constraint behaves as if MinDomains is equal to 1.
  5764. // Valid values are integers greater than 0.
  5765. // When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
  5766. //
  5767. // For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
  5768. // labelSelector spread as 2/2/2:
  5769. // +-------+-------+-------+
  5770. // | zone1 | zone2 | zone3 |
  5771. // +-------+-------+-------+
  5772. // | P P | P P | P P |
  5773. // +-------+-------+-------+
  5774. // The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
  5775. // In this situation, new pod with the same labelSelector cannot be scheduled,
  5776. // because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
  5777. // it will violate MaxSkew.
  5778. // +optional
  5779. optional int32 minDomains = 5;
  5780. // NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
  5781. // when calculating pod topology spread skew. Options are:
  5782. // - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
  5783. // - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
  5784. //
  5785. // If this value is nil, the behavior is equivalent to the Honor policy.
  5786. // +optional
  5787. optional string nodeAffinityPolicy = 6;
  5788. // NodeTaintsPolicy indicates how we will treat node taints when calculating
  5789. // pod topology spread skew. Options are:
  5790. // - Honor: nodes without taints, along with tainted nodes for which the incoming pod
  5791. // has a toleration, are included.
  5792. // - Ignore: node taints are ignored. All nodes are included.
  5793. //
  5794. // If this value is nil, the behavior is equivalent to the Ignore policy.
  5795. // +optional
  5796. optional string nodeTaintsPolicy = 7;
  5797. // MatchLabelKeys is a set of pod label keys to select the pods over which
  5798. // spreading will be calculated. The keys are used to lookup values from the
  5799. // incoming pod labels, those key-value labels are ANDed with labelSelector
  5800. // to select the group of existing pods over which spreading will be calculated
  5801. // for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
  5802. // MatchLabelKeys cannot be set when LabelSelector isn't set.
  5803. // Keys that don't exist in the incoming pod labels will
  5804. // be ignored. A null or empty list means only match against labelSelector.
  5805. //
  5806. // This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
  5807. // +listType=atomic
  5808. // +optional
  5809. repeated string matchLabelKeys = 8;
  5810. }
  5811. // TypedLocalObjectReference contains enough information to let you locate the
  5812. // typed referenced object inside the same namespace.
  5813. // ---
  5814. // New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs.
  5815. // 1. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular
  5816. // restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted".
  5817. // Those cannot be well described when embedded.
  5818. // 2. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen.
  5819. // 3. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity
  5820. // during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple
  5821. // and the version of the actual struct is irrelevant.
  5822. // 4. We cannot easily change it. Because this type is embedded in many locations, updates to this type
  5823. // will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control.
  5824. //
  5825. // Instead of using this type, create a locally provided and used type that is well-focused on your reference.
  5826. // For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .
  5827. // +structType=atomic
  5828. message TypedLocalObjectReference {
  5829. // APIGroup is the group for the resource being referenced.
  5830. // If APIGroup is not specified, the specified Kind must be in the core API group.
  5831. // For any other third-party types, APIGroup is required.
  5832. // +optional
  5833. optional string apiGroup = 1;
  5834. // Kind is the type of resource being referenced
  5835. optional string kind = 2;
  5836. // Name is the name of resource being referenced
  5837. optional string name = 3;
  5838. }
  5839. // TypedObjectReference contains enough information to let you locate the typed referenced object
  5840. message TypedObjectReference {
  5841. // APIGroup is the group for the resource being referenced.
  5842. // If APIGroup is not specified, the specified Kind must be in the core API group.
  5843. // For any other third-party types, APIGroup is required.
  5844. // +optional
  5845. optional string apiGroup = 1;
  5846. // Kind is the type of resource being referenced
  5847. optional string kind = 2;
  5848. // Name is the name of resource being referenced
  5849. optional string name = 3;
  5850. // Namespace is the namespace of resource being referenced
  5851. // Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
  5852. // (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
  5853. // +featureGate=CrossNamespaceVolumeDataSource
  5854. // +optional
  5855. optional string namespace = 4;
  5856. }
  5857. // Volume represents a named volume in a pod that may be accessed by any container in the pod.
  5858. message Volume {
  5859. // name of the volume.
  5860. // Must be a DNS_LABEL and unique within the pod.
  5861. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  5862. optional string name = 1;
  5863. // volumeSource represents the location and type of the mounted volume.
  5864. // If not specified, the Volume is implied to be an EmptyDir.
  5865. // This implied behavior is deprecated and will be removed in a future version.
  5866. optional VolumeSource volumeSource = 2;
  5867. }
  5868. // volumeDevice describes a mapping of a raw block device within a container.
  5869. message VolumeDevice {
  5870. // name must match the name of a persistentVolumeClaim in the pod
  5871. optional string name = 1;
  5872. // devicePath is the path inside of the container that the device will be mapped to.
  5873. optional string devicePath = 2;
  5874. }
  5875. // VolumeMount describes a mounting of a Volume within a container.
  5876. message VolumeMount {
  5877. // This must match the Name of a Volume.
  5878. optional string name = 1;
  5879. // Mounted read-only if true, read-write otherwise (false or unspecified).
  5880. // Defaults to false.
  5881. // +optional
  5882. optional bool readOnly = 2;
  5883. // RecursiveReadOnly specifies whether read-only mounts should be handled
  5884. // recursively.
  5885. //
  5886. // If ReadOnly is false, this field has no meaning and must be unspecified.
  5887. //
  5888. // If ReadOnly is true, and this field is set to Disabled, the mount is not made
  5889. // recursively read-only. If this field is set to IfPossible, the mount is made
  5890. // recursively read-only, if it is supported by the container runtime. If this
  5891. // field is set to Enabled, the mount is made recursively read-only if it is
  5892. // supported by the container runtime, otherwise the pod will not be started and
  5893. // an error will be generated to indicate the reason.
  5894. //
  5895. // If this field is set to IfPossible or Enabled, MountPropagation must be set to
  5896. // None (or be unspecified, which defaults to None).
  5897. //
  5898. // If this field is not specified, it is treated as an equivalent of Disabled.
  5899. // +optional
  5900. optional string recursiveReadOnly = 7;
  5901. // Path within the container at which the volume should be mounted. Must
  5902. // not contain ':'.
  5903. optional string mountPath = 3;
  5904. // Path within the volume from which the container's volume should be mounted.
  5905. // Defaults to "" (volume's root).
  5906. // +optional
  5907. optional string subPath = 4;
  5908. // mountPropagation determines how mounts are propagated from the host
  5909. // to container and the other way around.
  5910. // When not set, MountPropagationNone is used.
  5911. // This field is beta in 1.10.
  5912. // When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
  5913. // (which defaults to None).
  5914. // +optional
  5915. optional string mountPropagation = 5;
  5916. // Expanded path within the volume from which the container's volume should be mounted.
  5917. // Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
  5918. // Defaults to "" (volume's root).
  5919. // SubPathExpr and SubPath are mutually exclusive.
  5920. // +optional
  5921. optional string subPathExpr = 6;
  5922. }
  5923. // VolumeMountStatus shows status of volume mounts.
  5924. message VolumeMountStatus {
  5925. // Name corresponds to the name of the original VolumeMount.
  5926. optional string name = 1;
  5927. // MountPath corresponds to the original VolumeMount.
  5928. optional string mountPath = 2;
  5929. // ReadOnly corresponds to the original VolumeMount.
  5930. // +optional
  5931. optional bool readOnly = 3;
  5932. // RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts).
  5933. // An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled,
  5934. // depending on the mount result.
  5935. // +optional
  5936. optional string recursiveReadOnly = 4;
  5937. }
  5938. // VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
  5939. message VolumeNodeAffinity {
  5940. // required specifies hard node constraints that must be met.
  5941. optional NodeSelector required = 1;
  5942. }
  5943. // Projection that may be projected along with other supported volume types.
  5944. // Exactly one of these fields must be set.
  5945. message VolumeProjection {
  5946. // secret information about the secret data to project
  5947. // +optional
  5948. optional SecretProjection secret = 1;
  5949. // downwardAPI information about the downwardAPI data to project
  5950. // +optional
  5951. optional DownwardAPIProjection downwardAPI = 2;
  5952. // configMap information about the configMap data to project
  5953. // +optional
  5954. optional ConfigMapProjection configMap = 3;
  5955. // serviceAccountToken is information about the serviceAccountToken data to project
  5956. // +optional
  5957. optional ServiceAccountTokenProjection serviceAccountToken = 4;
  5958. // ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
  5959. // of ClusterTrustBundle objects in an auto-updating file.
  5960. //
  5961. // Alpha, gated by the ClusterTrustBundleProjection feature gate.
  5962. //
  5963. // ClusterTrustBundle objects can either be selected by name, or by the
  5964. // combination of signer name and a label selector.
  5965. //
  5966. // Kubelet performs aggressive normalization of the PEM contents written
  5967. // into the pod filesystem. Esoteric PEM features such as inter-block
  5968. // comments and block headers are stripped. Certificates are deduplicated.
  5969. // The ordering of certificates within the file is arbitrary, and Kubelet
  5970. // may change the order over time.
  5971. //
  5972. // +featureGate=ClusterTrustBundleProjection
  5973. // +optional
  5974. optional ClusterTrustBundleProjection clusterTrustBundle = 5;
  5975. // Projects an auto-rotating credential bundle (private key and certificate
  5976. // chain) that the pod can use either as a TLS client or server.
  5977. //
  5978. // Kubelet generates a private key and uses it to send a
  5979. // PodCertificateRequest to the named signer. Once the signer approves the
  5980. // request and issues a certificate chain, Kubelet writes the key and
  5981. // certificate chain to the pod filesystem. The pod does not start until
  5982. // certificates have been issued for each podCertificate projected volume
  5983. // source in its spec.
  5984. //
  5985. // Kubelet will begin trying to rotate the certificate at the time indicated
  5986. // by the signer using the PodCertificateRequest.Status.BeginRefreshAt
  5987. // timestamp.
  5988. //
  5989. // Kubelet can write a single file, indicated by the credentialBundlePath
  5990. // field, or separate files, indicated by the keyPath and
  5991. // certificateChainPath fields.
  5992. //
  5993. // The credential bundle is a single file in PEM format. The first PEM
  5994. // entry is the private key (in PKCS#8 format), and the remaining PEM
  5995. // entries are the certificate chain issued by the signer (typically,
  5996. // signers will return their certificate chain in leaf-to-root order).
  5997. //
  5998. // Prefer using the credential bundle format, since your application code
  5999. // can read it atomically. If you use keyPath and certificateChainPath,
  6000. // your application must make two separate file reads. If these coincide
  6001. // with a certificate rotation, it is possible that the private key and leaf
  6002. // certificate you read may not correspond to each other. Your application
  6003. // will need to check for this condition, and re-read until they are
  6004. // consistent.
  6005. //
  6006. // The named signer controls chooses the format of the certificate it
  6007. // issues; consult the signer implementation's documentation to learn how to
  6008. // use the certificates it issues.
  6009. //
  6010. // +featureGate=PodCertificateProjection
  6011. // +optional
  6012. optional PodCertificateProjection podCertificate = 6;
  6013. }
  6014. // VolumeResourceRequirements describes the storage resource requirements for a volume.
  6015. message VolumeResourceRequirements {
  6016. // Limits describes the maximum amount of compute resources allowed.
  6017. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  6018. // +optional
  6019. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> limits = 1;
  6020. // Requests describes the minimum amount of compute resources required.
  6021. // If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
  6022. // otherwise to an implementation-defined value. Requests cannot exceed Limits.
  6023. // More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  6024. // +optional
  6025. map<string, .k8s.io.apimachinery.pkg.api.resource.Quantity> requests = 2;
  6026. }
  6027. // Represents the source of a volume to mount.
  6028. // Only one of its members may be specified.
  6029. message VolumeSource {
  6030. // hostPath represents a pre-existing file or directory on the host
  6031. // machine that is directly exposed to the container. This is generally
  6032. // used for system agents or other privileged things that are allowed
  6033. // to see the host machine. Most containers will NOT need this.
  6034. // More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  6035. // ---
  6036. // TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
  6037. // mount host directories as read/write.
  6038. // +optional
  6039. optional HostPathVolumeSource hostPath = 1;
  6040. // emptyDir represents a temporary directory that shares a pod's lifetime.
  6041. // More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  6042. // +optional
  6043. optional EmptyDirVolumeSource emptyDir = 2;
  6044. // gcePersistentDisk represents a GCE Disk resource that is attached to a
  6045. // kubelet's host machine and then exposed to the pod.
  6046. // Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
  6047. // gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
  6048. // More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  6049. // +optional
  6050. optional GCEPersistentDiskVolumeSource gcePersistentDisk = 3;
  6051. // awsElasticBlockStore represents an AWS Disk resource that is attached to a
  6052. // kubelet's host machine and then exposed to the pod.
  6053. // Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
  6054. // awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
  6055. // More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  6056. // +optional
  6057. optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 4;
  6058. // gitRepo represents a git repository at a particular revision.
  6059. // Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
  6060. // EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
  6061. // into the Pod's container.
  6062. // +optional
  6063. optional GitRepoVolumeSource gitRepo = 5;
  6064. // secret represents a secret that should populate this volume.
  6065. // More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
  6066. // +optional
  6067. optional SecretVolumeSource secret = 6;
  6068. // nfs represents an NFS mount on the host that shares a pod's lifetime
  6069. // More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  6070. // +optional
  6071. optional NFSVolumeSource nfs = 7;
  6072. // iscsi represents an ISCSI Disk resource that is attached to a
  6073. // kubelet's host machine and then exposed to the pod.
  6074. // More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
  6075. // +optional
  6076. optional ISCSIVolumeSource iscsi = 8;
  6077. // glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
  6078. // Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
  6079. // +optional
  6080. optional GlusterfsVolumeSource glusterfs = 9;
  6081. // persistentVolumeClaimVolumeSource represents a reference to a
  6082. // PersistentVolumeClaim in the same namespace.
  6083. // More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  6084. // +optional
  6085. optional PersistentVolumeClaimVolumeSource persistentVolumeClaim = 10;
  6086. // rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
  6087. // Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
  6088. // +optional
  6089. optional RBDVolumeSource rbd = 11;
  6090. // flexVolume represents a generic volume resource that is
  6091. // provisioned/attached using an exec based plugin.
  6092. // Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
  6093. // +optional
  6094. optional FlexVolumeSource flexVolume = 12;
  6095. // cinder represents a cinder volume attached and mounted on kubelets host machine.
  6096. // Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
  6097. // are redirected to the cinder.csi.openstack.org CSI driver.
  6098. // More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  6099. // +optional
  6100. optional CinderVolumeSource cinder = 13;
  6101. // cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
  6102. // Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
  6103. // +optional
  6104. optional CephFSVolumeSource cephfs = 14;
  6105. // flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
  6106. // Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
  6107. // +optional
  6108. optional FlockerVolumeSource flocker = 15;
  6109. // downwardAPI represents downward API about the pod that should populate this volume
  6110. // +optional
  6111. optional DownwardAPIVolumeSource downwardAPI = 16;
  6112. // fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  6113. // +optional
  6114. optional FCVolumeSource fc = 17;
  6115. // azureFile represents an Azure File Service mount on the host and bind mount to the pod.
  6116. // Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
  6117. // are redirected to the file.csi.azure.com CSI driver.
  6118. // +optional
  6119. optional AzureFileVolumeSource azureFile = 18;
  6120. // configMap represents a configMap that should populate this volume
  6121. // +optional
  6122. optional ConfigMapVolumeSource configMap = 19;
  6123. // vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
  6124. // Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
  6125. // are redirected to the csi.vsphere.vmware.com CSI driver.
  6126. // +optional
  6127. optional VsphereVirtualDiskVolumeSource vsphereVolume = 20;
  6128. // quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
  6129. // Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
  6130. // +optional
  6131. optional QuobyteVolumeSource quobyte = 21;
  6132. // azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  6133. // Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
  6134. // are redirected to the disk.csi.azure.com CSI driver.
  6135. // +optional
  6136. optional AzureDiskVolumeSource azureDisk = 22;
  6137. // photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
  6138. // Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
  6139. optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 23;
  6140. // projected items for all in one resources secrets, configmaps, and downward API
  6141. optional ProjectedVolumeSource projected = 26;
  6142. // portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
  6143. // Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
  6144. // are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
  6145. // is on.
  6146. // +optional
  6147. optional PortworxVolumeSource portworxVolume = 24;
  6148. // scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  6149. // Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
  6150. // +optional
  6151. optional ScaleIOVolumeSource scaleIO = 25;
  6152. // storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
  6153. // Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
  6154. // +optional
  6155. optional StorageOSVolumeSource storageos = 27;
  6156. // csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
  6157. // +optional
  6158. optional CSIVolumeSource csi = 28;
  6159. // ephemeral represents a volume that is handled by a cluster storage driver.
  6160. // The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
  6161. // and deleted when the pod is removed.
  6162. //
  6163. // Use this if:
  6164. // a) the volume is only needed while the pod runs,
  6165. // b) features of normal volumes like restoring from snapshot or capacity
  6166. // tracking are needed,
  6167. // c) the storage driver is specified through a storage class, and
  6168. // d) the storage driver supports dynamic volume provisioning through
  6169. // a PersistentVolumeClaim (see EphemeralVolumeSource for more
  6170. // information on the connection between this volume type
  6171. // and PersistentVolumeClaim).
  6172. //
  6173. // Use PersistentVolumeClaim or one of the vendor-specific
  6174. // APIs for volumes that persist for longer than the lifecycle
  6175. // of an individual pod.
  6176. //
  6177. // Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
  6178. // be used that way - see the documentation of the driver for
  6179. // more information.
  6180. //
  6181. // A pod can use both types of ephemeral volumes and
  6182. // persistent volumes at the same time.
  6183. //
  6184. // +optional
  6185. optional EphemeralVolumeSource ephemeral = 29;
  6186. // image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
  6187. // The volume is resolved at pod startup depending on which PullPolicy value is provided:
  6188. //
  6189. // - Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
  6190. // - Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
  6191. // - IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
  6192. //
  6193. // The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
  6194. // A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
  6195. // The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
  6196. // The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
  6197. // The volume will be mounted read-only (ro) and non-executable files (noexec).
  6198. // Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
  6199. // The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
  6200. // +featureGate=ImageVolume
  6201. // +optional
  6202. optional ImageVolumeSource image = 30;
  6203. }
  6204. // Represents a vSphere volume resource.
  6205. message VsphereVirtualDiskVolumeSource {
  6206. // volumePath is the path that identifies vSphere volume vmdk
  6207. optional string volumePath = 1;
  6208. // fsType is filesystem type to mount.
  6209. // Must be a filesystem type supported by the host operating system.
  6210. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  6211. // +optional
  6212. optional string fsType = 2;
  6213. // storagePolicyName is the storage Policy Based Management (SPBM) profile name.
  6214. // +optional
  6215. optional string storagePolicyName = 3;
  6216. // storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
  6217. // +optional
  6218. optional string storagePolicyID = 4;
  6219. }
  6220. // The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
  6221. message WeightedPodAffinityTerm {
  6222. // weight associated with matching the corresponding podAffinityTerm,
  6223. // in the range 1-100.
  6224. optional int32 weight = 1;
  6225. // Required. A pod affinity term, associated with the corresponding weight.
  6226. optional PodAffinityTerm podAffinityTerm = 2;
  6227. }
  6228. // WindowsSecurityContextOptions contain Windows-specific options and credentials.
  6229. message WindowsSecurityContextOptions {
  6230. // GMSACredentialSpecName is the name of the GMSA credential spec to use.
  6231. // +optional
  6232. optional string gmsaCredentialSpecName = 1;
  6233. // GMSACredentialSpec is where the GMSA admission webhook
  6234. // (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
  6235. // GMSA credential spec named by the GMSACredentialSpecName field.
  6236. // +optional
  6237. optional string gmsaCredentialSpec = 2;
  6238. // The UserName in Windows to run the entrypoint of the container process.
  6239. // Defaults to the user specified in image metadata if unspecified.
  6240. // May also be set in PodSecurityContext. If set in both SecurityContext and
  6241. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  6242. // +optional
  6243. optional string runAsUserName = 3;
  6244. // HostProcess determines if a container should be run as a 'Host Process' container.
  6245. // All of a Pod's containers must have the same effective HostProcess value
  6246. // (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
  6247. // In addition, if HostProcess is true then HostNetwork must also be set to true.
  6248. // +optional
  6249. optional bool hostProcess = 4;
  6250. }
  6251. // WorkloadReference identifies the Workload object and PodGroup membership
  6252. // that a Pod belongs to. The scheduler uses this information to apply
  6253. // workload-aware scheduling semantics.
  6254. message WorkloadReference {
  6255. // Name defines the name of the Workload object this Pod belongs to.
  6256. // Workload must be in the same namespace as the Pod.
  6257. // If it doesn't match any existing Workload, the Pod will remain unschedulable
  6258. // until a Workload object is created and observed by the kube-scheduler.
  6259. // It must be a DNS subdomain.
  6260. //
  6261. // +required
  6262. optional string name = 1;
  6263. // PodGroup is the name of the PodGroup within the Workload that this Pod
  6264. // belongs to. If it doesn't match any existing PodGroup within the Workload,
  6265. // the Pod will remain unschedulable until the Workload object is recreated
  6266. // and observed by the kube-scheduler. It must be a DNS label.
  6267. //
  6268. // +required
  6269. optional string podGroup = 2;
  6270. // PodGroupReplicaKey specifies the replica key of the PodGroup to which this
  6271. // Pod belongs. It is used to distinguish pods belonging to different replicas
  6272. // of the same pod group. The pod group policy is applied separately to each replica.
  6273. // When set, it must be a DNS label.
  6274. //
  6275. // +optional
  6276. optional string podGroupReplicaKey = 3;
  6277. }