locostack.com_managedmodels.yaml 278 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026
  1. ---
  2. apiVersion: apiextensions.k8s.io/v1
  3. kind: CustomResourceDefinition
  4. metadata:
  5. annotations:
  6. controller-gen.kubebuilder.io/version: v0.20.1
  7. name: managedmodels.locostack.com
  8. spec:
  9. group: locostack.com
  10. names:
  11. kind: ManagedModel
  12. listKind: ManagedModelList
  13. plural: managedmodels
  14. shortNames:
  15. - mm
  16. singular: managedmodel
  17. scope: Namespaced
  18. versions:
  19. - additionalPrinterColumns:
  20. - jsonPath: .spec.category
  21. name: Category
  22. type: string
  23. - jsonPath: .spec.modelName
  24. name: Model
  25. type: string
  26. - jsonPath: .spec.template.name
  27. name: Runtime
  28. type: string
  29. - jsonPath: .status.conditions[?(@.type=='Ready')].status
  30. name: Ready
  31. type: string
  32. name: v1alpha1
  33. schema:
  34. openAPIV3Schema:
  35. description: ManagedModel is the Schema for the managedmodels API
  36. properties:
  37. apiVersion:
  38. description: |-
  39. APIVersion defines the versioned schema of this representation of an object.
  40. Servers should convert recognized schemas to the latest internal value, and
  41. may reject unrecognized values.
  42. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  43. type: string
  44. kind:
  45. description: |-
  46. Kind is a string value representing the REST resource this object represents.
  47. Servers may infer this from the endpoint the client submits requests to.
  48. Cannot be updated.
  49. In CamelCase.
  50. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  51. type: string
  52. metadata:
  53. type: object
  54. spec:
  55. description: spec defines the desired state of ManagedModel
  56. properties:
  57. category:
  58. description: |-
  59. category is the model category: language, embedding, or reranker.
  60. Determines which gateway endpoint clients use and the routing mode in the proxy config.
  61. enum:
  62. - language
  63. - embedding
  64. - reranker
  65. type: string
  66. modelName:
  67. description: |-
  68. modelName is the identifier exposed to clients and used as the model identifier
  69. in the gateway's proxy configuration.
  70. type: string
  71. runtimeInferenceParameters:
  72. properties:
  73. chatTemplate:
  74. description: chatTemplate is the template used for chat-based
  75. models, if supported by the runtime.
  76. type: string
  77. contextWindow:
  78. description: contextWindow is the context window size for the
  79. model, if supported by the runtime.
  80. format: int32
  81. type: integer
  82. extra:
  83. additionalProperties:
  84. type: string
  85. description: |-
  86. extra are pass-through key-value pairs forwarded as provider-specific parameters
  87. to the gateway when the model is gateway-bound.
  88. type: object
  89. temperature:
  90. description: temperature is the sampling temperature.
  91. type: string
  92. topK:
  93. description: topK is the top-k sampling parameter.
  94. format: int32
  95. type: integer
  96. topP:
  97. description: topP is the nucleus sampling parameter.
  98. type: string
  99. type: object
  100. stackRef:
  101. description: stackRef associates this model with a stack.
  102. properties:
  103. name:
  104. default: ""
  105. description: |-
  106. Name of the referent.
  107. This field is effectively required, but due to backwards compatibility is
  108. allowed to be empty. Instances of this type with an empty value here are
  109. almost certainly wrong.
  110. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  111. type: string
  112. type: object
  113. x-kubernetes-map-type: atomic
  114. template:
  115. description: template holds the configuration overrides for the component.
  116. properties:
  117. metadata:
  118. description: metadata is a standard object metadata.
  119. type: object
  120. name:
  121. description: name selects a built-in preset.
  122. type: string
  123. spec:
  124. description: spec holds the pod-level configuration for the workload.
  125. properties:
  126. affinity:
  127. description: affinity provides fine-grained node and pod (anti-)affinity
  128. rules.
  129. properties:
  130. nodeAffinity:
  131. description: Describes node affinity scheduling rules
  132. for the pod.
  133. properties:
  134. preferredDuringSchedulingIgnoredDuringExecution:
  135. description: |-
  136. The scheduler will prefer to schedule pods to nodes that satisfy
  137. the affinity expressions specified by this field, but it may choose
  138. a node that violates one or more of the expressions. The node that is
  139. most preferred is the one with the greatest sum of weights, i.e.
  140. for each node that meets all of the scheduling requirements (resource
  141. request, requiredDuringScheduling affinity expressions, etc.),
  142. compute a sum by iterating through the elements of this field and adding
  143. "weight" to the sum if the node matches the corresponding matchExpressions; the
  144. node(s) with the highest sum are the most preferred.
  145. items:
  146. description: |-
  147. An empty preferred scheduling term matches all objects with implicit weight 0
  148. (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
  149. properties:
  150. preference:
  151. description: A node selector term, associated
  152. with the corresponding weight.
  153. properties:
  154. matchExpressions:
  155. description: A list of node selector requirements
  156. by node's labels.
  157. items:
  158. description: |-
  159. A node selector requirement is a selector that contains values, a key, and an operator
  160. that relates the key and values.
  161. properties:
  162. key:
  163. description: The label key that the
  164. selector applies to.
  165. type: string
  166. operator:
  167. description: |-
  168. Represents a key's relationship to a set of values.
  169. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  170. type: string
  171. values:
  172. description: |-
  173. An array of string values. If the operator is In or NotIn,
  174. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  175. the values array must be empty. If the operator is Gt or Lt, the values
  176. array must have a single element, which will be interpreted as an integer.
  177. This array is replaced during a strategic merge patch.
  178. items:
  179. type: string
  180. type: array
  181. x-kubernetes-list-type: atomic
  182. required:
  183. - key
  184. - operator
  185. type: object
  186. type: array
  187. x-kubernetes-list-type: atomic
  188. matchFields:
  189. description: A list of node selector requirements
  190. by node's fields.
  191. items:
  192. description: |-
  193. A node selector requirement is a selector that contains values, a key, and an operator
  194. that relates the key and values.
  195. properties:
  196. key:
  197. description: The label key that the
  198. selector applies to.
  199. type: string
  200. operator:
  201. description: |-
  202. Represents a key's relationship to a set of values.
  203. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  204. type: string
  205. values:
  206. description: |-
  207. An array of string values. If the operator is In or NotIn,
  208. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  209. the values array must be empty. If the operator is Gt or Lt, the values
  210. array must have a single element, which will be interpreted as an integer.
  211. This array is replaced during a strategic merge patch.
  212. items:
  213. type: string
  214. type: array
  215. x-kubernetes-list-type: atomic
  216. required:
  217. - key
  218. - operator
  219. type: object
  220. type: array
  221. x-kubernetes-list-type: atomic
  222. type: object
  223. x-kubernetes-map-type: atomic
  224. weight:
  225. description: Weight associated with matching
  226. the corresponding nodeSelectorTerm, in the
  227. range 1-100.
  228. format: int32
  229. type: integer
  230. required:
  231. - preference
  232. - weight
  233. type: object
  234. type: array
  235. x-kubernetes-list-type: atomic
  236. requiredDuringSchedulingIgnoredDuringExecution:
  237. description: |-
  238. If the affinity requirements specified by this field are not met at
  239. scheduling time, the pod will not be scheduled onto the node.
  240. If the affinity requirements specified by this field cease to be met
  241. at some point during pod execution (e.g. due to an update), the system
  242. may or may not try to eventually evict the pod from its node.
  243. properties:
  244. nodeSelectorTerms:
  245. description: Required. A list of node selector
  246. terms. The terms are ORed.
  247. items:
  248. description: |-
  249. A null or empty node selector term matches no objects. The requirements of
  250. them are ANDed.
  251. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
  252. properties:
  253. matchExpressions:
  254. description: A list of node selector requirements
  255. by node's labels.
  256. items:
  257. description: |-
  258. A node selector requirement is a selector that contains values, a key, and an operator
  259. that relates the key and values.
  260. properties:
  261. key:
  262. description: The label key that the
  263. selector applies to.
  264. type: string
  265. operator:
  266. description: |-
  267. Represents a key's relationship to a set of values.
  268. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  269. type: string
  270. values:
  271. description: |-
  272. An array of string values. If the operator is In or NotIn,
  273. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  274. the values array must be empty. If the operator is Gt or Lt, the values
  275. array must have a single element, which will be interpreted as an integer.
  276. This array is replaced during a strategic merge patch.
  277. items:
  278. type: string
  279. type: array
  280. x-kubernetes-list-type: atomic
  281. required:
  282. - key
  283. - operator
  284. type: object
  285. type: array
  286. x-kubernetes-list-type: atomic
  287. matchFields:
  288. description: A list of node selector requirements
  289. by node's fields.
  290. items:
  291. description: |-
  292. A node selector requirement is a selector that contains values, a key, and an operator
  293. that relates the key and values.
  294. properties:
  295. key:
  296. description: The label key that the
  297. selector applies to.
  298. type: string
  299. operator:
  300. description: |-
  301. Represents a key's relationship to a set of values.
  302. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  303. type: string
  304. values:
  305. description: |-
  306. An array of string values. If the operator is In or NotIn,
  307. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  308. the values array must be empty. If the operator is Gt or Lt, the values
  309. array must have a single element, which will be interpreted as an integer.
  310. This array is replaced during a strategic merge patch.
  311. items:
  312. type: string
  313. type: array
  314. x-kubernetes-list-type: atomic
  315. required:
  316. - key
  317. - operator
  318. type: object
  319. type: array
  320. x-kubernetes-list-type: atomic
  321. type: object
  322. x-kubernetes-map-type: atomic
  323. type: array
  324. x-kubernetes-list-type: atomic
  325. required:
  326. - nodeSelectorTerms
  327. type: object
  328. x-kubernetes-map-type: atomic
  329. type: object
  330. podAffinity:
  331. description: Describes pod affinity scheduling rules (e.g.
  332. co-locate this pod in the same node, zone, etc. as some
  333. other pod(s)).
  334. properties:
  335. preferredDuringSchedulingIgnoredDuringExecution:
  336. description: |-
  337. The scheduler will prefer to schedule pods to nodes that satisfy
  338. the affinity expressions specified by this field, but it may choose
  339. a node that violates one or more of the expressions. The node that is
  340. most preferred is the one with the greatest sum of weights, i.e.
  341. for each node that meets all of the scheduling requirements (resource
  342. request, requiredDuringScheduling affinity expressions, etc.),
  343. compute a sum by iterating through the elements of this field and adding
  344. "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
  345. node(s) with the highest sum are the most preferred.
  346. items:
  347. description: The weights of all of the matched WeightedPodAffinityTerm
  348. fields are added per-node to find the most preferred
  349. node(s)
  350. properties:
  351. podAffinityTerm:
  352. description: Required. A pod affinity term,
  353. associated with the corresponding weight.
  354. properties:
  355. labelSelector:
  356. description: |-
  357. A label query over a set of resources, in this case pods.
  358. If it's null, this PodAffinityTerm matches with no Pods.
  359. properties:
  360. matchExpressions:
  361. description: matchExpressions is a list
  362. of label selector requirements. The
  363. requirements are ANDed.
  364. items:
  365. description: |-
  366. A label selector requirement is a selector that contains values, a key, and an operator that
  367. relates the key and values.
  368. properties:
  369. key:
  370. description: key is the label
  371. key that the selector applies
  372. to.
  373. type: string
  374. operator:
  375. description: |-
  376. operator represents a key's relationship to a set of values.
  377. Valid operators are In, NotIn, Exists and DoesNotExist.
  378. type: string
  379. values:
  380. description: |-
  381. values is an array of string values. If the operator is In or NotIn,
  382. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  383. the values array must be empty. This array is replaced during a strategic
  384. merge patch.
  385. items:
  386. type: string
  387. type: array
  388. x-kubernetes-list-type: atomic
  389. required:
  390. - key
  391. - operator
  392. type: object
  393. type: array
  394. x-kubernetes-list-type: atomic
  395. matchLabels:
  396. additionalProperties:
  397. type: string
  398. description: |-
  399. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  400. map is equivalent to an element of matchExpressions, whose key field is "key", the
  401. operator is "In", and the values array contains only "value". The requirements are ANDed.
  402. type: object
  403. type: object
  404. x-kubernetes-map-type: atomic
  405. matchLabelKeys:
  406. description: |-
  407. MatchLabelKeys is a set of pod label keys to select which pods will
  408. be taken into consideration. The keys are used to lookup values from the
  409. incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
  410. to select the group of existing pods which pods will be taken into consideration
  411. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  412. pod labels will be ignored. The default value is empty.
  413. The same key is forbidden to exist in both matchLabelKeys and labelSelector.
  414. Also, matchLabelKeys cannot be set when labelSelector isn't set.
  415. items:
  416. type: string
  417. type: array
  418. x-kubernetes-list-type: atomic
  419. mismatchLabelKeys:
  420. description: |-
  421. MismatchLabelKeys is a set of pod label keys to select which pods will
  422. be taken into consideration. The keys are used to lookup values from the
  423. incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
  424. to select the group of existing pods which pods will be taken into consideration
  425. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  426. pod labels will be ignored. The default value is empty.
  427. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
  428. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
  429. items:
  430. type: string
  431. type: array
  432. x-kubernetes-list-type: atomic
  433. namespaceSelector:
  434. description: |-
  435. A label query over the set of namespaces that the term applies to.
  436. The term is applied to the union of the namespaces selected by this field
  437. and the ones listed in the namespaces field.
  438. null selector and null or empty namespaces list means "this pod's namespace".
  439. An empty selector ({}) matches all namespaces.
  440. properties:
  441. matchExpressions:
  442. description: matchExpressions is a list
  443. of label selector requirements. The
  444. requirements are ANDed.
  445. items:
  446. description: |-
  447. A label selector requirement is a selector that contains values, a key, and an operator that
  448. relates the key and values.
  449. properties:
  450. key:
  451. description: key is the label
  452. key that the selector applies
  453. to.
  454. type: string
  455. operator:
  456. description: |-
  457. operator represents a key's relationship to a set of values.
  458. Valid operators are In, NotIn, Exists and DoesNotExist.
  459. type: string
  460. values:
  461. description: |-
  462. values is an array of string values. If the operator is In or NotIn,
  463. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  464. the values array must be empty. This array is replaced during a strategic
  465. merge patch.
  466. items:
  467. type: string
  468. type: array
  469. x-kubernetes-list-type: atomic
  470. required:
  471. - key
  472. - operator
  473. type: object
  474. type: array
  475. x-kubernetes-list-type: atomic
  476. matchLabels:
  477. additionalProperties:
  478. type: string
  479. description: |-
  480. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  481. map is equivalent to an element of matchExpressions, whose key field is "key", the
  482. operator is "In", and the values array contains only "value". The requirements are ANDed.
  483. type: object
  484. type: object
  485. x-kubernetes-map-type: atomic
  486. namespaces:
  487. description: |-
  488. namespaces specifies a static list of namespace names that the term applies to.
  489. The term is applied to the union of the namespaces listed in this field
  490. and the ones selected by namespaceSelector.
  491. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
  492. items:
  493. type: string
  494. type: array
  495. x-kubernetes-list-type: atomic
  496. topologyKey:
  497. description: |-
  498. This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  499. the labelSelector in the specified namespaces, where co-located is defined as running on a node
  500. whose value of the label with key topologyKey matches that of any node on which any of the
  501. selected pods is running.
  502. Empty topologyKey is not allowed.
  503. type: string
  504. required:
  505. - topologyKey
  506. type: object
  507. weight:
  508. description: |-
  509. weight associated with matching the corresponding podAffinityTerm,
  510. in the range 1-100.
  511. format: int32
  512. type: integer
  513. required:
  514. - podAffinityTerm
  515. - weight
  516. type: object
  517. type: array
  518. x-kubernetes-list-type: atomic
  519. requiredDuringSchedulingIgnoredDuringExecution:
  520. description: |-
  521. If the affinity requirements specified by this field are not met at
  522. scheduling time, the pod will not be scheduled onto the node.
  523. If the affinity requirements specified by this field cease to be met
  524. at some point during pod execution (e.g. due to a pod label update), the
  525. system may or may not try to eventually evict the pod from its node.
  526. When there are multiple elements, the lists of nodes corresponding to each
  527. podAffinityTerm are intersected, i.e. all terms must be satisfied.
  528. items:
  529. description: |-
  530. Defines a set of pods (namely those matching the labelSelector
  531. relative to the given namespace(s)) that this pod should be
  532. co-located (affinity) or not co-located (anti-affinity) with,
  533. where co-located is defined as running on a node whose value of
  534. the label with key <topologyKey> matches that of any node on which
  535. a pod of the set of pods is running
  536. properties:
  537. labelSelector:
  538. description: |-
  539. A label query over a set of resources, in this case pods.
  540. If it's null, this PodAffinityTerm matches with no Pods.
  541. properties:
  542. matchExpressions:
  543. description: matchExpressions is a list
  544. of label selector requirements. The requirements
  545. are ANDed.
  546. items:
  547. description: |-
  548. A label selector requirement is a selector that contains values, a key, and an operator that
  549. relates the key and values.
  550. properties:
  551. key:
  552. description: key is the label key
  553. that the selector applies to.
  554. type: string
  555. operator:
  556. description: |-
  557. operator represents a key's relationship to a set of values.
  558. Valid operators are In, NotIn, Exists and DoesNotExist.
  559. type: string
  560. values:
  561. description: |-
  562. values is an array of string values. If the operator is In or NotIn,
  563. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  564. the values array must be empty. This array is replaced during a strategic
  565. merge patch.
  566. items:
  567. type: string
  568. type: array
  569. x-kubernetes-list-type: atomic
  570. required:
  571. - key
  572. - operator
  573. type: object
  574. type: array
  575. x-kubernetes-list-type: atomic
  576. matchLabels:
  577. additionalProperties:
  578. type: string
  579. description: |-
  580. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  581. map is equivalent to an element of matchExpressions, whose key field is "key", the
  582. operator is "In", and the values array contains only "value". The requirements are ANDed.
  583. type: object
  584. type: object
  585. x-kubernetes-map-type: atomic
  586. matchLabelKeys:
  587. description: |-
  588. MatchLabelKeys is a set of pod label keys to select which pods will
  589. be taken into consideration. The keys are used to lookup values from the
  590. incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
  591. to select the group of existing pods which pods will be taken into consideration
  592. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  593. pod labels will be ignored. The default value is empty.
  594. The same key is forbidden to exist in both matchLabelKeys and labelSelector.
  595. Also, matchLabelKeys cannot be set when labelSelector isn't set.
  596. items:
  597. type: string
  598. type: array
  599. x-kubernetes-list-type: atomic
  600. mismatchLabelKeys:
  601. description: |-
  602. MismatchLabelKeys is a set of pod label keys to select which pods will
  603. be taken into consideration. The keys are used to lookup values from the
  604. incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
  605. to select the group of existing pods which pods will be taken into consideration
  606. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  607. pod labels will be ignored. The default value is empty.
  608. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
  609. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
  610. items:
  611. type: string
  612. type: array
  613. x-kubernetes-list-type: atomic
  614. namespaceSelector:
  615. description: |-
  616. A label query over the set of namespaces that the term applies to.
  617. The term is applied to the union of the namespaces selected by this field
  618. and the ones listed in the namespaces field.
  619. null selector and null or empty namespaces list means "this pod's namespace".
  620. An empty selector ({}) matches all namespaces.
  621. properties:
  622. matchExpressions:
  623. description: matchExpressions is a list
  624. of label selector requirements. The requirements
  625. are ANDed.
  626. items:
  627. description: |-
  628. A label selector requirement is a selector that contains values, a key, and an operator that
  629. relates the key and values.
  630. properties:
  631. key:
  632. description: key is the label key
  633. that the selector applies to.
  634. type: string
  635. operator:
  636. description: |-
  637. operator represents a key's relationship to a set of values.
  638. Valid operators are In, NotIn, Exists and DoesNotExist.
  639. type: string
  640. values:
  641. description: |-
  642. values is an array of string values. If the operator is In or NotIn,
  643. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  644. the values array must be empty. This array is replaced during a strategic
  645. merge patch.
  646. items:
  647. type: string
  648. type: array
  649. x-kubernetes-list-type: atomic
  650. required:
  651. - key
  652. - operator
  653. type: object
  654. type: array
  655. x-kubernetes-list-type: atomic
  656. matchLabels:
  657. additionalProperties:
  658. type: string
  659. description: |-
  660. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  661. map is equivalent to an element of matchExpressions, whose key field is "key", the
  662. operator is "In", and the values array contains only "value". The requirements are ANDed.
  663. type: object
  664. type: object
  665. x-kubernetes-map-type: atomic
  666. namespaces:
  667. description: |-
  668. namespaces specifies a static list of namespace names that the term applies to.
  669. The term is applied to the union of the namespaces listed in this field
  670. and the ones selected by namespaceSelector.
  671. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
  672. items:
  673. type: string
  674. type: array
  675. x-kubernetes-list-type: atomic
  676. topologyKey:
  677. description: |-
  678. This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  679. the labelSelector in the specified namespaces, where co-located is defined as running on a node
  680. whose value of the label with key topologyKey matches that of any node on which any of the
  681. selected pods is running.
  682. Empty topologyKey is not allowed.
  683. type: string
  684. required:
  685. - topologyKey
  686. type: object
  687. type: array
  688. x-kubernetes-list-type: atomic
  689. type: object
  690. podAntiAffinity:
  691. description: Describes pod anti-affinity scheduling rules
  692. (e.g. avoid putting this pod in the same node, zone,
  693. etc. as some other pod(s)).
  694. properties:
  695. preferredDuringSchedulingIgnoredDuringExecution:
  696. description: |-
  697. The scheduler will prefer to schedule pods to nodes that satisfy
  698. the anti-affinity expressions specified by this field, but it may choose
  699. a node that violates one or more of the expressions. The node that is
  700. most preferred is the one with the greatest sum of weights, i.e.
  701. for each node that meets all of the scheduling requirements (resource
  702. request, requiredDuringScheduling anti-affinity expressions, etc.),
  703. compute a sum by iterating through the elements of this field and subtracting
  704. "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
  705. node(s) with the highest sum are the most preferred.
  706. items:
  707. description: The weights of all of the matched WeightedPodAffinityTerm
  708. fields are added per-node to find the most preferred
  709. node(s)
  710. properties:
  711. podAffinityTerm:
  712. description: Required. A pod affinity term,
  713. associated with the corresponding weight.
  714. properties:
  715. labelSelector:
  716. description: |-
  717. A label query over a set of resources, in this case pods.
  718. If it's null, this PodAffinityTerm matches with no Pods.
  719. properties:
  720. matchExpressions:
  721. description: matchExpressions is a list
  722. of label selector requirements. The
  723. requirements are ANDed.
  724. items:
  725. description: |-
  726. A label selector requirement is a selector that contains values, a key, and an operator that
  727. relates the key and values.
  728. properties:
  729. key:
  730. description: key is the label
  731. key that the selector applies
  732. to.
  733. type: string
  734. operator:
  735. description: |-
  736. operator represents a key's relationship to a set of values.
  737. Valid operators are In, NotIn, Exists and DoesNotExist.
  738. type: string
  739. values:
  740. description: |-
  741. values is an array of string values. If the operator is In or NotIn,
  742. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  743. the values array must be empty. This array is replaced during a strategic
  744. merge patch.
  745. items:
  746. type: string
  747. type: array
  748. x-kubernetes-list-type: atomic
  749. required:
  750. - key
  751. - operator
  752. type: object
  753. type: array
  754. x-kubernetes-list-type: atomic
  755. matchLabels:
  756. additionalProperties:
  757. type: string
  758. description: |-
  759. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  760. map is equivalent to an element of matchExpressions, whose key field is "key", the
  761. operator is "In", and the values array contains only "value". The requirements are ANDed.
  762. type: object
  763. type: object
  764. x-kubernetes-map-type: atomic
  765. matchLabelKeys:
  766. description: |-
  767. MatchLabelKeys is a set of pod label keys to select which pods will
  768. be taken into consideration. The keys are used to lookup values from the
  769. incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
  770. to select the group of existing pods which pods will be taken into consideration
  771. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  772. pod labels will be ignored. The default value is empty.
  773. The same key is forbidden to exist in both matchLabelKeys and labelSelector.
  774. Also, matchLabelKeys cannot be set when labelSelector isn't set.
  775. items:
  776. type: string
  777. type: array
  778. x-kubernetes-list-type: atomic
  779. mismatchLabelKeys:
  780. description: |-
  781. MismatchLabelKeys is a set of pod label keys to select which pods will
  782. be taken into consideration. The keys are used to lookup values from the
  783. incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
  784. to select the group of existing pods which pods will be taken into consideration
  785. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  786. pod labels will be ignored. The default value is empty.
  787. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
  788. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
  789. items:
  790. type: string
  791. type: array
  792. x-kubernetes-list-type: atomic
  793. namespaceSelector:
  794. description: |-
  795. A label query over the set of namespaces that the term applies to.
  796. The term is applied to the union of the namespaces selected by this field
  797. and the ones listed in the namespaces field.
  798. null selector and null or empty namespaces list means "this pod's namespace".
  799. An empty selector ({}) matches all namespaces.
  800. properties:
  801. matchExpressions:
  802. description: matchExpressions is a list
  803. of label selector requirements. The
  804. requirements are ANDed.
  805. items:
  806. description: |-
  807. A label selector requirement is a selector that contains values, a key, and an operator that
  808. relates the key and values.
  809. properties:
  810. key:
  811. description: key is the label
  812. key that the selector applies
  813. to.
  814. type: string
  815. operator:
  816. description: |-
  817. operator represents a key's relationship to a set of values.
  818. Valid operators are In, NotIn, Exists and DoesNotExist.
  819. type: string
  820. values:
  821. description: |-
  822. values is an array of string values. If the operator is In or NotIn,
  823. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  824. the values array must be empty. This array is replaced during a strategic
  825. merge patch.
  826. items:
  827. type: string
  828. type: array
  829. x-kubernetes-list-type: atomic
  830. required:
  831. - key
  832. - operator
  833. type: object
  834. type: array
  835. x-kubernetes-list-type: atomic
  836. matchLabels:
  837. additionalProperties:
  838. type: string
  839. description: |-
  840. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  841. map is equivalent to an element of matchExpressions, whose key field is "key", the
  842. operator is "In", and the values array contains only "value". The requirements are ANDed.
  843. type: object
  844. type: object
  845. x-kubernetes-map-type: atomic
  846. namespaces:
  847. description: |-
  848. namespaces specifies a static list of namespace names that the term applies to.
  849. The term is applied to the union of the namespaces listed in this field
  850. and the ones selected by namespaceSelector.
  851. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
  852. items:
  853. type: string
  854. type: array
  855. x-kubernetes-list-type: atomic
  856. topologyKey:
  857. description: |-
  858. This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  859. the labelSelector in the specified namespaces, where co-located is defined as running on a node
  860. whose value of the label with key topologyKey matches that of any node on which any of the
  861. selected pods is running.
  862. Empty topologyKey is not allowed.
  863. type: string
  864. required:
  865. - topologyKey
  866. type: object
  867. weight:
  868. description: |-
  869. weight associated with matching the corresponding podAffinityTerm,
  870. in the range 1-100.
  871. format: int32
  872. type: integer
  873. required:
  874. - podAffinityTerm
  875. - weight
  876. type: object
  877. type: array
  878. x-kubernetes-list-type: atomic
  879. requiredDuringSchedulingIgnoredDuringExecution:
  880. description: |-
  881. If the anti-affinity requirements specified by this field are not met at
  882. scheduling time, the pod will not be scheduled onto the node.
  883. If the anti-affinity requirements specified by this field cease to be met
  884. at some point during pod execution (e.g. due to a pod label update), the
  885. system may or may not try to eventually evict the pod from its node.
  886. When there are multiple elements, the lists of nodes corresponding to each
  887. podAffinityTerm are intersected, i.e. all terms must be satisfied.
  888. items:
  889. description: |-
  890. Defines a set of pods (namely those matching the labelSelector
  891. relative to the given namespace(s)) that this pod should be
  892. co-located (affinity) or not co-located (anti-affinity) with,
  893. where co-located is defined as running on a node whose value of
  894. the label with key <topologyKey> matches that of any node on which
  895. a pod of the set of pods is running
  896. properties:
  897. labelSelector:
  898. description: |-
  899. A label query over a set of resources, in this case pods.
  900. If it's null, this PodAffinityTerm matches with no Pods.
  901. properties:
  902. matchExpressions:
  903. description: matchExpressions is a list
  904. of label selector requirements. The requirements
  905. are ANDed.
  906. items:
  907. description: |-
  908. A label selector requirement is a selector that contains values, a key, and an operator that
  909. relates the key and values.
  910. properties:
  911. key:
  912. description: key is the label key
  913. that the selector applies to.
  914. type: string
  915. operator:
  916. description: |-
  917. operator represents a key's relationship to a set of values.
  918. Valid operators are In, NotIn, Exists and DoesNotExist.
  919. type: string
  920. values:
  921. description: |-
  922. values is an array of string values. If the operator is In or NotIn,
  923. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  924. the values array must be empty. This array is replaced during a strategic
  925. merge patch.
  926. items:
  927. type: string
  928. type: array
  929. x-kubernetes-list-type: atomic
  930. required:
  931. - key
  932. - operator
  933. type: object
  934. type: array
  935. x-kubernetes-list-type: atomic
  936. matchLabels:
  937. additionalProperties:
  938. type: string
  939. description: |-
  940. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  941. map is equivalent to an element of matchExpressions, whose key field is "key", the
  942. operator is "In", and the values array contains only "value". The requirements are ANDed.
  943. type: object
  944. type: object
  945. x-kubernetes-map-type: atomic
  946. matchLabelKeys:
  947. description: |-
  948. MatchLabelKeys is a set of pod label keys to select which pods will
  949. be taken into consideration. The keys are used to lookup values from the
  950. incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
  951. to select the group of existing pods which pods will be taken into consideration
  952. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  953. pod labels will be ignored. The default value is empty.
  954. The same key is forbidden to exist in both matchLabelKeys and labelSelector.
  955. Also, matchLabelKeys cannot be set when labelSelector isn't set.
  956. items:
  957. type: string
  958. type: array
  959. x-kubernetes-list-type: atomic
  960. mismatchLabelKeys:
  961. description: |-
  962. MismatchLabelKeys is a set of pod label keys to select which pods will
  963. be taken into consideration. The keys are used to lookup values from the
  964. incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
  965. to select the group of existing pods which pods will be taken into consideration
  966. for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
  967. pod labels will be ignored. The default value is empty.
  968. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
  969. Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
  970. items:
  971. type: string
  972. type: array
  973. x-kubernetes-list-type: atomic
  974. namespaceSelector:
  975. description: |-
  976. A label query over the set of namespaces that the term applies to.
  977. The term is applied to the union of the namespaces selected by this field
  978. and the ones listed in the namespaces field.
  979. null selector and null or empty namespaces list means "this pod's namespace".
  980. An empty selector ({}) matches all namespaces.
  981. properties:
  982. matchExpressions:
  983. description: matchExpressions is a list
  984. of label selector requirements. The requirements
  985. are ANDed.
  986. items:
  987. description: |-
  988. A label selector requirement is a selector that contains values, a key, and an operator that
  989. relates the key and values.
  990. properties:
  991. key:
  992. description: key is the label key
  993. that the selector applies to.
  994. type: string
  995. operator:
  996. description: |-
  997. operator represents a key's relationship to a set of values.
  998. Valid operators are In, NotIn, Exists and DoesNotExist.
  999. type: string
  1000. values:
  1001. description: |-
  1002. values is an array of string values. If the operator is In or NotIn,
  1003. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  1004. the values array must be empty. This array is replaced during a strategic
  1005. merge patch.
  1006. items:
  1007. type: string
  1008. type: array
  1009. x-kubernetes-list-type: atomic
  1010. required:
  1011. - key
  1012. - operator
  1013. type: object
  1014. type: array
  1015. x-kubernetes-list-type: atomic
  1016. matchLabels:
  1017. additionalProperties:
  1018. type: string
  1019. description: |-
  1020. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  1021. map is equivalent to an element of matchExpressions, whose key field is "key", the
  1022. operator is "In", and the values array contains only "value". The requirements are ANDed.
  1023. type: object
  1024. type: object
  1025. x-kubernetes-map-type: atomic
  1026. namespaces:
  1027. description: |-
  1028. namespaces specifies a static list of namespace names that the term applies to.
  1029. The term is applied to the union of the namespaces listed in this field
  1030. and the ones selected by namespaceSelector.
  1031. null or empty namespaces list and null namespaceSelector means "this pod's namespace".
  1032. items:
  1033. type: string
  1034. type: array
  1035. x-kubernetes-list-type: atomic
  1036. topologyKey:
  1037. description: |-
  1038. This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  1039. the labelSelector in the specified namespaces, where co-located is defined as running on a node
  1040. whose value of the label with key topologyKey matches that of any node on which any of the
  1041. selected pods is running.
  1042. Empty topologyKey is not allowed.
  1043. type: string
  1044. required:
  1045. - topologyKey
  1046. type: object
  1047. type: array
  1048. x-kubernetes-list-type: atomic
  1049. type: object
  1050. type: object
  1051. nodeSelector:
  1052. additionalProperties:
  1053. type: string
  1054. description: nodeSelector pins pods to nodes that match all
  1055. the specified labels.
  1056. type: object
  1057. resources:
  1058. description: resources sets per-container resource requests
  1059. and limits.
  1060. properties:
  1061. claims:
  1062. description: |-
  1063. Claims lists the names of resources, defined in spec.resourceClaims,
  1064. that are used by this container.
  1065. This field depends on the
  1066. DynamicResourceAllocation feature gate.
  1067. This field is immutable. It can only be set for containers.
  1068. items:
  1069. description: ResourceClaim references one entry in PodSpec.ResourceClaims.
  1070. properties:
  1071. name:
  1072. description: |-
  1073. Name must match the name of one entry in pod.spec.resourceClaims of
  1074. the Pod where this field is used. It makes that resource available
  1075. inside a container.
  1076. type: string
  1077. request:
  1078. description: |-
  1079. Request is the name chosen for a request in the referenced claim.
  1080. If empty, everything from the claim is made available, otherwise
  1081. only the result of this request.
  1082. type: string
  1083. required:
  1084. - name
  1085. type: object
  1086. type: array
  1087. x-kubernetes-list-map-keys:
  1088. - name
  1089. x-kubernetes-list-type: map
  1090. limits:
  1091. additionalProperties:
  1092. anyOf:
  1093. - type: integer
  1094. - type: string
  1095. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  1096. x-kubernetes-int-or-string: true
  1097. description: |-
  1098. Limits describes the maximum amount of compute resources allowed.
  1099. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  1100. type: object
  1101. requests:
  1102. additionalProperties:
  1103. anyOf:
  1104. - type: integer
  1105. - type: string
  1106. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  1107. x-kubernetes-int-or-string: true
  1108. description: |-
  1109. Requests describes the minimum amount of compute resources required.
  1110. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
  1111. otherwise to an implementation-defined value. Requests cannot exceed Limits.
  1112. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  1113. type: object
  1114. type: object
  1115. runtime:
  1116. description: runtime describes the container runtime to use
  1117. for the workload.
  1118. properties:
  1119. args:
  1120. description: args specifies or overrides the preset's
  1121. container command.
  1122. items:
  1123. type: string
  1124. type: array
  1125. command:
  1126. description: command specifies or overrides the preset's
  1127. container entrypoint.
  1128. items:
  1129. type: string
  1130. type: array
  1131. conditionalArgs:
  1132. description: conditionalArgs are appended to the preset
  1133. command conditionally.
  1134. items:
  1135. properties:
  1136. args:
  1137. description: args are appended to the preset args.
  1138. items:
  1139. type: string
  1140. type: array
  1141. when:
  1142. description: when the value is not empty after variable
  1143. substitution, the args are appended to the preset
  1144. args.
  1145. type: string
  1146. required:
  1147. - args
  1148. - when
  1149. type: object
  1150. type: array
  1151. env:
  1152. description: env holds environment variables injected
  1153. into the container.
  1154. items:
  1155. description: EnvVar represents an environment variable
  1156. present in a Container.
  1157. properties:
  1158. name:
  1159. description: |-
  1160. Name of the environment variable.
  1161. May consist of any printable ASCII characters except '='.
  1162. type: string
  1163. value:
  1164. description: |-
  1165. Variable references $(VAR_NAME) are expanded
  1166. using the previously defined environment variables in the container and
  1167. any service environment variables. If a variable cannot be resolved,
  1168. the reference in the input string will be unchanged. Double $$ are reduced
  1169. to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
  1170. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
  1171. Escaped references will never be expanded, regardless of whether the variable
  1172. exists or not.
  1173. Defaults to "".
  1174. type: string
  1175. valueFrom:
  1176. description: Source for the environment variable's
  1177. value. Cannot be used if value is not empty.
  1178. properties:
  1179. configMapKeyRef:
  1180. description: Selects a key of a ConfigMap.
  1181. properties:
  1182. key:
  1183. description: The key to select.
  1184. type: string
  1185. name:
  1186. default: ""
  1187. description: |-
  1188. Name of the referent.
  1189. This field is effectively required, but due to backwards compatibility is
  1190. allowed to be empty. Instances of this type with an empty value here are
  1191. almost certainly wrong.
  1192. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  1193. type: string
  1194. optional:
  1195. description: Specify whether the ConfigMap
  1196. or its key must be defined
  1197. type: boolean
  1198. required:
  1199. - key
  1200. type: object
  1201. x-kubernetes-map-type: atomic
  1202. fieldRef:
  1203. description: |-
  1204. Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
  1205. spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
  1206. properties:
  1207. apiVersion:
  1208. description: Version of the schema the FieldPath
  1209. is written in terms of, defaults to "v1".
  1210. type: string
  1211. fieldPath:
  1212. description: Path of the field to select
  1213. in the specified API version.
  1214. type: string
  1215. required:
  1216. - fieldPath
  1217. type: object
  1218. x-kubernetes-map-type: atomic
  1219. fileKeyRef:
  1220. description: |-
  1221. FileKeyRef selects a key of the env file.
  1222. Requires the EnvFiles feature gate to be enabled.
  1223. properties:
  1224. key:
  1225. description: |-
  1226. The key within the env file. An invalid key will prevent the pod from starting.
  1227. The keys defined within a source may consist of any printable ASCII characters except '='.
  1228. During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.
  1229. type: string
  1230. optional:
  1231. default: false
  1232. description: |-
  1233. Specify whether the file or its key must be defined. If the file or key
  1234. does not exist, then the env var is not published.
  1235. If optional is set to true and the specified key does not exist,
  1236. the environment variable will not be set in the Pod's containers.
  1237. If optional is set to false and the specified key does not exist,
  1238. an error will be returned during Pod creation.
  1239. type: boolean
  1240. path:
  1241. description: |-
  1242. The path within the volume from which to select the file.
  1243. Must be relative and may not contain the '..' path or start with '..'.
  1244. type: string
  1245. volumeName:
  1246. description: The name of the volume mount
  1247. containing the env file.
  1248. type: string
  1249. required:
  1250. - key
  1251. - path
  1252. - volumeName
  1253. type: object
  1254. x-kubernetes-map-type: atomic
  1255. resourceFieldRef:
  1256. description: |-
  1257. Selects a resource of the container: only resources limits and requests
  1258. (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
  1259. properties:
  1260. containerName:
  1261. description: 'Container name: required for
  1262. volumes, optional for env vars'
  1263. type: string
  1264. divisor:
  1265. anyOf:
  1266. - type: integer
  1267. - type: string
  1268. description: Specifies the output format
  1269. of the exposed resources, defaults to
  1270. "1"
  1271. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  1272. x-kubernetes-int-or-string: true
  1273. resource:
  1274. description: 'Required: resource to select'
  1275. type: string
  1276. required:
  1277. - resource
  1278. type: object
  1279. x-kubernetes-map-type: atomic
  1280. secretKeyRef:
  1281. description: Selects a key of a secret in the
  1282. pod's namespace
  1283. properties:
  1284. key:
  1285. description: The key of the secret to select
  1286. from. Must be a valid secret key.
  1287. type: string
  1288. name:
  1289. default: ""
  1290. description: |-
  1291. Name of the referent.
  1292. This field is effectively required, but due to backwards compatibility is
  1293. allowed to be empty. Instances of this type with an empty value here are
  1294. almost certainly wrong.
  1295. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  1296. type: string
  1297. optional:
  1298. description: Specify whether the Secret
  1299. or its key must be defined
  1300. type: boolean
  1301. required:
  1302. - key
  1303. type: object
  1304. x-kubernetes-map-type: atomic
  1305. type: object
  1306. required:
  1307. - name
  1308. type: object
  1309. type: array
  1310. envFrom:
  1311. description: envFrom references ConfigMaps or Secrets
  1312. whose key-value pairs are injected as environment variables.
  1313. items:
  1314. description: EnvFromSource represents the source of
  1315. a set of ConfigMaps or Secrets
  1316. properties:
  1317. configMapRef:
  1318. description: The ConfigMap to select from
  1319. properties:
  1320. name:
  1321. default: ""
  1322. description: |-
  1323. Name of the referent.
  1324. This field is effectively required, but due to backwards compatibility is
  1325. allowed to be empty. Instances of this type with an empty value here are
  1326. almost certainly wrong.
  1327. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  1328. type: string
  1329. optional:
  1330. description: Specify whether the ConfigMap must
  1331. be defined
  1332. type: boolean
  1333. type: object
  1334. x-kubernetes-map-type: atomic
  1335. prefix:
  1336. description: |-
  1337. Optional text to prepend to the name of each environment variable.
  1338. May consist of any printable ASCII characters except '='.
  1339. type: string
  1340. secretRef:
  1341. description: The Secret to select from
  1342. properties:
  1343. name:
  1344. default: ""
  1345. description: |-
  1346. Name of the referent.
  1347. This field is effectively required, but due to backwards compatibility is
  1348. allowed to be empty. Instances of this type with an empty value here are
  1349. almost certainly wrong.
  1350. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  1351. type: string
  1352. optional:
  1353. description: Specify whether the Secret must
  1354. be defined
  1355. type: boolean
  1356. type: object
  1357. x-kubernetes-map-type: atomic
  1358. type: object
  1359. type: array
  1360. extraArgs:
  1361. description: extraArgs are appended to the preset command.
  1362. items:
  1363. type: string
  1364. type: array
  1365. image:
  1366. description: |-
  1367. image specifies or overrides the preset's container image, e.g. to pin a specific tag
  1368. or pull from a private registry mirror.
  1369. type: string
  1370. name:
  1371. description: name selects a built-in runtime preset.
  1372. type: string
  1373. port:
  1374. description: port specifies or overrides the container
  1375. port the runtime listens on.
  1376. format: int32
  1377. type: integer
  1378. volumeMounts:
  1379. description: volumeMounts defines where pod volumes are
  1380. mounted inside the container.
  1381. items:
  1382. description: VolumeMount describes a mounting of a Volume
  1383. within a container.
  1384. properties:
  1385. mountPath:
  1386. description: |-
  1387. Path within the container at which the volume should be mounted. Must
  1388. not contain ':'.
  1389. type: string
  1390. mountPropagation:
  1391. description: |-
  1392. mountPropagation determines how mounts are propagated from the host
  1393. to container and the other way around.
  1394. When not set, MountPropagationNone is used.
  1395. This field is beta in 1.10.
  1396. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
  1397. (which defaults to None).
  1398. type: string
  1399. name:
  1400. description: This must match the Name of a Volume.
  1401. type: string
  1402. readOnly:
  1403. description: |-
  1404. Mounted read-only if true, read-write otherwise (false or unspecified).
  1405. Defaults to false.
  1406. type: boolean
  1407. recursiveReadOnly:
  1408. description: |-
  1409. RecursiveReadOnly specifies whether read-only mounts should be handled
  1410. recursively.
  1411. If ReadOnly is false, this field has no meaning and must be unspecified.
  1412. If ReadOnly is true, and this field is set to Disabled, the mount is not made
  1413. recursively read-only. If this field is set to IfPossible, the mount is made
  1414. recursively read-only, if it is supported by the container runtime. If this
  1415. field is set to Enabled, the mount is made recursively read-only if it is
  1416. supported by the container runtime, otherwise the pod will not be started and
  1417. an error will be generated to indicate the reason.
  1418. If this field is set to IfPossible or Enabled, MountPropagation must be set to
  1419. None (or be unspecified, which defaults to None).
  1420. If this field is not specified, it is treated as an equivalent of Disabled.
  1421. type: string
  1422. subPath:
  1423. description: |-
  1424. Path within the volume from which the container's volume should be mounted.
  1425. Defaults to "" (volume's root).
  1426. type: string
  1427. subPathExpr:
  1428. description: |-
  1429. Expanded path within the volume from which the container's volume should be mounted.
  1430. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
  1431. Defaults to "" (volume's root).
  1432. SubPathExpr and SubPath are mutually exclusive.
  1433. type: string
  1434. required:
  1435. - mountPath
  1436. - name
  1437. type: object
  1438. type: array
  1439. type: object
  1440. securityContext:
  1441. description: |-
  1442. securityContext sets pod-level security attributes such as runAsUser,
  1443. runAsGroup, fsGroup, and sysctls.
  1444. properties:
  1445. appArmorProfile:
  1446. description: |-
  1447. appArmorProfile is the AppArmor options to use by the containers in this pod.
  1448. Note that this field cannot be set when spec.os.name is windows.
  1449. properties:
  1450. localhostProfile:
  1451. description: |-
  1452. localhostProfile indicates a profile loaded on the node that should be used.
  1453. The profile must be preconfigured on the node to work.
  1454. Must match the loaded name of the profile.
  1455. Must be set if and only if type is "Localhost".
  1456. type: string
  1457. type:
  1458. description: |-
  1459. type indicates which kind of AppArmor profile will be applied.
  1460. Valid options are:
  1461. Localhost - a profile pre-loaded on the node.
  1462. RuntimeDefault - the container runtime's default profile.
  1463. Unconfined - no AppArmor enforcement.
  1464. type: string
  1465. required:
  1466. - type
  1467. type: object
  1468. fsGroup:
  1469. description: |-
  1470. A special supplemental group that applies to all containers in a pod.
  1471. Some volume types allow the Kubelet to change the ownership of that volume
  1472. to be owned by the pod:
  1473. 1. The owning GID will be the FSGroup
  1474. 2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
  1475. 3. The permission bits are OR'd with rw-rw----
  1476. If unset, the Kubelet will not modify the ownership and permissions of any volume.
  1477. Note that this field cannot be set when spec.os.name is windows.
  1478. format: int64
  1479. type: integer
  1480. fsGroupChangePolicy:
  1481. description: |-
  1482. fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
  1483. before being exposed inside Pod. This field will only apply to
  1484. volume types which support fsGroup based ownership(and permissions).
  1485. It will have no effect on ephemeral volume types such as: secret, configmaps
  1486. and emptydir.
  1487. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
  1488. Note that this field cannot be set when spec.os.name is windows.
  1489. type: string
  1490. runAsGroup:
  1491. description: |-
  1492. The GID to run the entrypoint of the container process.
  1493. Uses runtime default if unset.
  1494. May also be set in SecurityContext. If set in both SecurityContext and
  1495. PodSecurityContext, the value specified in SecurityContext takes precedence
  1496. for that container.
  1497. Note that this field cannot be set when spec.os.name is windows.
  1498. format: int64
  1499. type: integer
  1500. runAsNonRoot:
  1501. description: |-
  1502. Indicates that the container must run as a non-root user.
  1503. If true, the Kubelet will validate the image at runtime to ensure that it
  1504. does not run as UID 0 (root) and fail to start the container if it does.
  1505. If unset or false, no such validation will be performed.
  1506. May also be set in SecurityContext. If set in both SecurityContext and
  1507. PodSecurityContext, the value specified in SecurityContext takes precedence.
  1508. type: boolean
  1509. runAsUser:
  1510. description: |-
  1511. The UID to run the entrypoint of the container process.
  1512. Defaults to user specified in image metadata if unspecified.
  1513. May also be set in SecurityContext. If set in both SecurityContext and
  1514. PodSecurityContext, the value specified in SecurityContext takes precedence
  1515. for that container.
  1516. Note that this field cannot be set when spec.os.name is windows.
  1517. format: int64
  1518. type: integer
  1519. seLinuxChangePolicy:
  1520. description: |-
  1521. seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
  1522. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
  1523. Valid values are "MountOption" and "Recursive".
  1524. "Recursive" means relabeling of all files on all Pod volumes by the container runtime.
  1525. This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.
  1526. "MountOption" mounts all eligible Pod volumes with `-o context` mount option.
  1527. This requires all Pods that share the same volume to use the same SELinux label.
  1528. It is not possible to share the same volume among privileged and unprivileged Pods.
  1529. Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
  1530. whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
  1531. CSIDriver instance. Other volumes are always re-labelled recursively.
  1532. "MountOption" value is allowed only when SELinuxMount feature gate is enabled.
  1533. If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
  1534. If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
  1535. and "Recursive" for all other volumes.
  1536. This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.
  1537. All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
  1538. Note that this field cannot be set when spec.os.name is windows.
  1539. type: string
  1540. seLinuxOptions:
  1541. description: |-
  1542. The SELinux context to be applied to all containers.
  1543. If unspecified, the container runtime will allocate a random SELinux context for each
  1544. container. May also be set in SecurityContext. If set in
  1545. both SecurityContext and PodSecurityContext, the value specified in SecurityContext
  1546. takes precedence for that container.
  1547. Note that this field cannot be set when spec.os.name is windows.
  1548. properties:
  1549. level:
  1550. description: Level is SELinux level label that applies
  1551. to the container.
  1552. type: string
  1553. role:
  1554. description: Role is a SELinux role label that applies
  1555. to the container.
  1556. type: string
  1557. type:
  1558. description: Type is a SELinux type label that applies
  1559. to the container.
  1560. type: string
  1561. user:
  1562. description: User is a SELinux user label that applies
  1563. to the container.
  1564. type: string
  1565. type: object
  1566. seccompProfile:
  1567. description: |-
  1568. The seccomp options to use by the containers in this pod.
  1569. Note that this field cannot be set when spec.os.name is windows.
  1570. properties:
  1571. localhostProfile:
  1572. description: |-
  1573. localhostProfile indicates a profile defined in a file on the node should be used.
  1574. The profile must be preconfigured on the node to work.
  1575. Must be a descending path, relative to the kubelet's configured seccomp profile location.
  1576. Must be set if type is "Localhost". Must NOT be set for any other type.
  1577. type: string
  1578. type:
  1579. description: |-
  1580. type indicates which kind of seccomp profile will be applied.
  1581. Valid options are:
  1582. Localhost - a profile defined in a file on the node should be used.
  1583. RuntimeDefault - the container runtime default profile should be used.
  1584. Unconfined - no profile should be applied.
  1585. type: string
  1586. required:
  1587. - type
  1588. type: object
  1589. supplementalGroups:
  1590. description: |-
  1591. A list of groups applied to the first process run in each container, in
  1592. addition to the container's primary GID and fsGroup (if specified). If
  1593. the SupplementalGroupsPolicy feature is enabled, the
  1594. supplementalGroupsPolicy field determines whether these are in addition
  1595. to or instead of any group memberships defined in the container image.
  1596. If unspecified, no additional groups are added, though group memberships
  1597. defined in the container image may still be used, depending on the
  1598. supplementalGroupsPolicy field.
  1599. Note that this field cannot be set when spec.os.name is windows.
  1600. items:
  1601. format: int64
  1602. type: integer
  1603. type: array
  1604. x-kubernetes-list-type: atomic
  1605. supplementalGroupsPolicy:
  1606. description: |-
  1607. Defines how supplemental groups of the first container processes are calculated.
  1608. Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
  1609. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
  1610. and the container runtime must implement support for this feature.
  1611. Note that this field cannot be set when spec.os.name is windows.
  1612. type: string
  1613. sysctls:
  1614. description: |-
  1615. Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
  1616. sysctls (by the container runtime) might fail to launch.
  1617. Note that this field cannot be set when spec.os.name is windows.
  1618. items:
  1619. description: Sysctl defines a kernel parameter to be
  1620. set
  1621. properties:
  1622. name:
  1623. description: Name of a property to set
  1624. type: string
  1625. value:
  1626. description: Value of a property to set
  1627. type: string
  1628. required:
  1629. - name
  1630. - value
  1631. type: object
  1632. type: array
  1633. x-kubernetes-list-type: atomic
  1634. windowsOptions:
  1635. description: |-
  1636. The Windows specific settings applied to all containers.
  1637. If unspecified, the options within a container's SecurityContext will be used.
  1638. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
  1639. Note that this field cannot be set when spec.os.name is linux.
  1640. properties:
  1641. gmsaCredentialSpec:
  1642. description: |-
  1643. GMSACredentialSpec is where the GMSA admission webhook
  1644. (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
  1645. GMSA credential spec named by the GMSACredentialSpecName field.
  1646. type: string
  1647. gmsaCredentialSpecName:
  1648. description: GMSACredentialSpecName is the name of
  1649. the GMSA credential spec to use.
  1650. type: string
  1651. hostProcess:
  1652. description: |-
  1653. HostProcess determines if a container should be run as a 'Host Process' container.
  1654. All of a Pod's containers must have the same effective HostProcess value
  1655. (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
  1656. In addition, if HostProcess is true then HostNetwork must also be set to true.
  1657. type: boolean
  1658. runAsUserName:
  1659. description: |-
  1660. The UserName in Windows to run the entrypoint of the container process.
  1661. Defaults to the user specified in image metadata if unspecified.
  1662. May also be set in PodSecurityContext. If set in both SecurityContext and
  1663. PodSecurityContext, the value specified in SecurityContext takes precedence.
  1664. type: string
  1665. type: object
  1666. type: object
  1667. tolerations:
  1668. description: tolerations allow pods to be scheduled onto nodes
  1669. with matching taints.
  1670. items:
  1671. description: |-
  1672. The pod this Toleration is attached to tolerates any taint that matches
  1673. the triple <key,value,effect> using the matching operator <operator>.
  1674. properties:
  1675. effect:
  1676. description: |-
  1677. Effect indicates the taint effect to match. Empty means match all taint effects.
  1678. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
  1679. type: string
  1680. key:
  1681. description: |-
  1682. Key is the taint key that the toleration applies to. Empty means match all taint keys.
  1683. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
  1684. type: string
  1685. operator:
  1686. description: |-
  1687. Operator represents a key's relationship to the value.
  1688. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.
  1689. Exists is equivalent to wildcard for value, so that a pod can
  1690. tolerate all taints of a particular category.
  1691. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
  1692. type: string
  1693. tolerationSeconds:
  1694. description: |-
  1695. TolerationSeconds represents the period of time the toleration (which must be
  1696. of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
  1697. it is not set, which means tolerate the taint forever (do not evict). Zero and
  1698. negative values will be treated as 0 (evict immediately) by the system.
  1699. format: int64
  1700. type: integer
  1701. value:
  1702. description: |-
  1703. Value is the taint value the toleration matches to.
  1704. If the operator is Exists, the value should be empty, otherwise just a regular string.
  1705. type: string
  1706. type: object
  1707. type: array
  1708. topologySpreadConstraints:
  1709. description: |-
  1710. topologySpreadConstraints controls how pods are spread across failure
  1711. domains (zones, nodes). Prefer this over pod anti-affinity for HA spread.
  1712. items:
  1713. description: TopologySpreadConstraint specifies how to spread
  1714. matching pods among the given topology.
  1715. properties:
  1716. labelSelector:
  1717. description: |-
  1718. LabelSelector is used to find matching pods.
  1719. Pods that match this label selector are counted to determine the number of pods
  1720. in their corresponding topology domain.
  1721. properties:
  1722. matchExpressions:
  1723. description: matchExpressions is a list of label
  1724. selector requirements. The requirements are ANDed.
  1725. items:
  1726. description: |-
  1727. A label selector requirement is a selector that contains values, a key, and an operator that
  1728. relates the key and values.
  1729. properties:
  1730. key:
  1731. description: key is the label key that the
  1732. selector applies to.
  1733. type: string
  1734. operator:
  1735. description: |-
  1736. operator represents a key's relationship to a set of values.
  1737. Valid operators are In, NotIn, Exists and DoesNotExist.
  1738. type: string
  1739. values:
  1740. description: |-
  1741. values is an array of string values. If the operator is In or NotIn,
  1742. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  1743. the values array must be empty. This array is replaced during a strategic
  1744. merge patch.
  1745. items:
  1746. type: string
  1747. type: array
  1748. x-kubernetes-list-type: atomic
  1749. required:
  1750. - key
  1751. - operator
  1752. type: object
  1753. type: array
  1754. x-kubernetes-list-type: atomic
  1755. matchLabels:
  1756. additionalProperties:
  1757. type: string
  1758. description: |-
  1759. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  1760. map is equivalent to an element of matchExpressions, whose key field is "key", the
  1761. operator is "In", and the values array contains only "value". The requirements are ANDed.
  1762. type: object
  1763. type: object
  1764. x-kubernetes-map-type: atomic
  1765. matchLabelKeys:
  1766. description: |-
  1767. MatchLabelKeys is a set of pod label keys to select the pods over which
  1768. spreading will be calculated. The keys are used to lookup values from the
  1769. incoming pod labels, those key-value labels are ANDed with labelSelector
  1770. to select the group of existing pods over which spreading will be calculated
  1771. for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
  1772. MatchLabelKeys cannot be set when LabelSelector isn't set.
  1773. Keys that don't exist in the incoming pod labels will
  1774. be ignored. A null or empty list means only match against labelSelector.
  1775. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
  1776. items:
  1777. type: string
  1778. type: array
  1779. x-kubernetes-list-type: atomic
  1780. maxSkew:
  1781. description: |-
  1782. MaxSkew describes the degree to which pods may be unevenly distributed.
  1783. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
  1784. between the number of matching pods in the target topology and the global minimum.
  1785. The global minimum is the minimum number of matching pods in an eligible domain
  1786. or zero if the number of eligible domains is less than MinDomains.
  1787. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
  1788. labelSelector spread as 2/2/1:
  1789. In this case, the global minimum is 1.
  1790. | zone1 | zone2 | zone3 |
  1791. | P P | P P | P |
  1792. - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
  1793. scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
  1794. violate MaxSkew(1).
  1795. - if MaxSkew is 2, incoming pod can be scheduled onto any zone.
  1796. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
  1797. to topologies that satisfy it.
  1798. It's a required field. Default value is 1 and 0 is not allowed.
  1799. format: int32
  1800. type: integer
  1801. minDomains:
  1802. description: |-
  1803. MinDomains indicates a minimum number of eligible domains.
  1804. When the number of eligible domains with matching topology keys is less than minDomains,
  1805. Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
  1806. And when the number of eligible domains with matching topology keys equals or greater than minDomains,
  1807. this value has no effect on scheduling.
  1808. As a result, when the number of eligible domains is less than minDomains,
  1809. scheduler won't schedule more than maxSkew Pods to those domains.
  1810. If value is nil, the constraint behaves as if MinDomains is equal to 1.
  1811. Valid values are integers greater than 0.
  1812. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.
  1813. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
  1814. labelSelector spread as 2/2/2:
  1815. | zone1 | zone2 | zone3 |
  1816. | P P | P P | P P |
  1817. The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
  1818. In this situation, new pod with the same labelSelector cannot be scheduled,
  1819. because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
  1820. it will violate MaxSkew.
  1821. format: int32
  1822. type: integer
  1823. nodeAffinityPolicy:
  1824. description: |-
  1825. NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
  1826. when calculating pod topology spread skew. Options are:
  1827. - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
  1828. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.
  1829. If this value is nil, the behavior is equivalent to the Honor policy.
  1830. type: string
  1831. nodeTaintsPolicy:
  1832. description: |-
  1833. NodeTaintsPolicy indicates how we will treat node taints when calculating
  1834. pod topology spread skew. Options are:
  1835. - Honor: nodes without taints, along with tainted nodes for which the incoming pod
  1836. has a toleration, are included.
  1837. - Ignore: node taints are ignored. All nodes are included.
  1838. If this value is nil, the behavior is equivalent to the Ignore policy.
  1839. type: string
  1840. topologyKey:
  1841. description: |-
  1842. TopologyKey is the key of node labels. Nodes that have a label with this key
  1843. and identical values are considered to be in the same topology.
  1844. We consider each <key, value> as a "bucket", and try to put balanced number
  1845. of pods into each bucket.
  1846. We define a domain as a particular instance of a topology.
  1847. Also, we define an eligible domain as a domain whose nodes meet the requirements of
  1848. nodeAffinityPolicy and nodeTaintsPolicy.
  1849. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
  1850. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
  1851. It's a required field.
  1852. type: string
  1853. whenUnsatisfiable:
  1854. description: |-
  1855. WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
  1856. the spread constraint.
  1857. - DoNotSchedule (default) tells the scheduler not to schedule it.
  1858. - ScheduleAnyway tells the scheduler to schedule the pod in any location,
  1859. but giving higher precedence to topologies that would help reduce the
  1860. skew.
  1861. A constraint is considered "Unsatisfiable" for an incoming pod
  1862. if and only if every possible node assignment for that pod would violate
  1863. "MaxSkew" on some topology.
  1864. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
  1865. labelSelector spread as 3/1/1:
  1866. | zone1 | zone2 | zone3 |
  1867. | P P P | P | P |
  1868. If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
  1869. to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
  1870. MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
  1871. won't make it *more* imbalanced.
  1872. It's a required field.
  1873. type: string
  1874. required:
  1875. - maxSkew
  1876. - topologyKey
  1877. - whenUnsatisfiable
  1878. type: object
  1879. type: array
  1880. volumes:
  1881. description: volumes defines additional pod volumes available
  1882. to the runtime container.
  1883. items:
  1884. description: Volume represents a named volume in a pod that
  1885. may be accessed by any container in the pod.
  1886. properties:
  1887. awsElasticBlockStore:
  1888. description: |-
  1889. awsElasticBlockStore represents an AWS Disk resource that is attached to a
  1890. kubelet's host machine and then exposed to the pod.
  1891. Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
  1892. awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
  1893. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  1894. properties:
  1895. fsType:
  1896. description: |-
  1897. fsType is the filesystem type of the volume that you want to mount.
  1898. Tip: Ensure that the filesystem type is supported by the host operating system.
  1899. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1900. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  1901. type: string
  1902. partition:
  1903. description: |-
  1904. partition is the partition in the volume that you want to mount.
  1905. If omitted, the default is to mount by volume name.
  1906. Examples: For volume /dev/sda1, you specify the partition as "1".
  1907. Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  1908. format: int32
  1909. type: integer
  1910. readOnly:
  1911. description: |-
  1912. readOnly value true will force the readOnly setting in VolumeMounts.
  1913. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  1914. type: boolean
  1915. volumeID:
  1916. description: |-
  1917. volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
  1918. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
  1919. type: string
  1920. required:
  1921. - volumeID
  1922. type: object
  1923. azureDisk:
  1924. description: |-
  1925. azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  1926. Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
  1927. are redirected to the disk.csi.azure.com CSI driver.
  1928. properties:
  1929. cachingMode:
  1930. description: 'cachingMode is the Host Caching mode:
  1931. None, Read Only, Read Write.'
  1932. type: string
  1933. diskName:
  1934. description: diskName is the Name of the data disk
  1935. in the blob storage
  1936. type: string
  1937. diskURI:
  1938. description: diskURI is the URI of data disk in
  1939. the blob storage
  1940. type: string
  1941. fsType:
  1942. default: ext4
  1943. description: |-
  1944. fsType is Filesystem type to mount.
  1945. Must be a filesystem type supported by the host operating system.
  1946. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1947. type: string
  1948. kind:
  1949. description: 'kind expected values are Shared: multiple
  1950. blob disks per storage account Dedicated: single
  1951. blob disk per storage account Managed: azure
  1952. managed data disk (only in managed availability
  1953. set). defaults to shared'
  1954. type: string
  1955. readOnly:
  1956. default: false
  1957. description: |-
  1958. readOnly Defaults to false (read/write). ReadOnly here will force
  1959. the ReadOnly setting in VolumeMounts.
  1960. type: boolean
  1961. required:
  1962. - diskName
  1963. - diskURI
  1964. type: object
  1965. azureFile:
  1966. description: |-
  1967. azureFile represents an Azure File Service mount on the host and bind mount to the pod.
  1968. Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
  1969. are redirected to the file.csi.azure.com CSI driver.
  1970. properties:
  1971. readOnly:
  1972. description: |-
  1973. readOnly defaults to false (read/write). ReadOnly here will force
  1974. the ReadOnly setting in VolumeMounts.
  1975. type: boolean
  1976. secretName:
  1977. description: secretName is the name of secret that
  1978. contains Azure Storage Account Name and Key
  1979. type: string
  1980. shareName:
  1981. description: shareName is the azure share Name
  1982. type: string
  1983. required:
  1984. - secretName
  1985. - shareName
  1986. type: object
  1987. cephfs:
  1988. description: |-
  1989. cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
  1990. Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
  1991. properties:
  1992. monitors:
  1993. description: |-
  1994. monitors is Required: Monitors is a collection of Ceph monitors
  1995. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  1996. items:
  1997. type: string
  1998. type: array
  1999. x-kubernetes-list-type: atomic
  2000. path:
  2001. description: 'path is Optional: Used as the mounted
  2002. root, rather than the full Ceph tree, default
  2003. is /'
  2004. type: string
  2005. readOnly:
  2006. description: |-
  2007. readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  2008. the ReadOnly setting in VolumeMounts.
  2009. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  2010. type: boolean
  2011. secretFile:
  2012. description: |-
  2013. secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
  2014. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  2015. type: string
  2016. secretRef:
  2017. description: |-
  2018. secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
  2019. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  2020. properties:
  2021. name:
  2022. default: ""
  2023. description: |-
  2024. Name of the referent.
  2025. This field is effectively required, but due to backwards compatibility is
  2026. allowed to be empty. Instances of this type with an empty value here are
  2027. almost certainly wrong.
  2028. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2029. type: string
  2030. type: object
  2031. x-kubernetes-map-type: atomic
  2032. user:
  2033. description: |-
  2034. user is optional: User is the rados user name, default is admin
  2035. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
  2036. type: string
  2037. required:
  2038. - monitors
  2039. type: object
  2040. cinder:
  2041. description: |-
  2042. cinder represents a cinder volume attached and mounted on kubelets host machine.
  2043. Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
  2044. are redirected to the cinder.csi.openstack.org CSI driver.
  2045. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  2046. properties:
  2047. fsType:
  2048. description: |-
  2049. fsType is the filesystem type to mount.
  2050. Must be a filesystem type supported by the host operating system.
  2051. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2052. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  2053. type: string
  2054. readOnly:
  2055. description: |-
  2056. readOnly defaults to false (read/write). ReadOnly here will force
  2057. the ReadOnly setting in VolumeMounts.
  2058. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  2059. type: boolean
  2060. secretRef:
  2061. description: |-
  2062. secretRef is optional: points to a secret object containing parameters used to connect
  2063. to OpenStack.
  2064. properties:
  2065. name:
  2066. default: ""
  2067. description: |-
  2068. Name of the referent.
  2069. This field is effectively required, but due to backwards compatibility is
  2070. allowed to be empty. Instances of this type with an empty value here are
  2071. almost certainly wrong.
  2072. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2073. type: string
  2074. type: object
  2075. x-kubernetes-map-type: atomic
  2076. volumeID:
  2077. description: |-
  2078. volumeID used to identify the volume in cinder.
  2079. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
  2080. type: string
  2081. required:
  2082. - volumeID
  2083. type: object
  2084. configMap:
  2085. description: configMap represents a configMap that should
  2086. populate this volume
  2087. properties:
  2088. defaultMode:
  2089. description: |-
  2090. defaultMode is optional: mode bits used to set permissions on created files by default.
  2091. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  2092. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  2093. Defaults to 0644.
  2094. Directories within the path are not affected by this setting.
  2095. This might be in conflict with other options that affect the file
  2096. mode, like fsGroup, and the result can be other mode bits set.
  2097. format: int32
  2098. type: integer
  2099. items:
  2100. description: |-
  2101. items if unspecified, each key-value pair in the Data field of the referenced
  2102. ConfigMap will be projected into the volume as a file whose name is the
  2103. key and content is the value. If specified, the listed keys will be
  2104. projected into the specified paths, and unlisted keys will not be
  2105. present. If a key is specified which is not present in the ConfigMap,
  2106. the volume setup will error unless it is marked optional. Paths must be
  2107. relative and may not contain the '..' path or start with '..'.
  2108. items:
  2109. description: Maps a string key to a path within
  2110. a volume.
  2111. properties:
  2112. key:
  2113. description: key is the key to project.
  2114. type: string
  2115. mode:
  2116. description: |-
  2117. mode is Optional: mode bits used to set permissions on this file.
  2118. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  2119. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  2120. If not specified, the volume defaultMode will be used.
  2121. This might be in conflict with other options that affect the file
  2122. mode, like fsGroup, and the result can be other mode bits set.
  2123. format: int32
  2124. type: integer
  2125. path:
  2126. description: |-
  2127. path is the relative path of the file to map the key to.
  2128. May not be an absolute path.
  2129. May not contain the path element '..'.
  2130. May not start with the string '..'.
  2131. type: string
  2132. required:
  2133. - key
  2134. - path
  2135. type: object
  2136. type: array
  2137. x-kubernetes-list-type: atomic
  2138. name:
  2139. default: ""
  2140. description: |-
  2141. Name of the referent.
  2142. This field is effectively required, but due to backwards compatibility is
  2143. allowed to be empty. Instances of this type with an empty value here are
  2144. almost certainly wrong.
  2145. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2146. type: string
  2147. optional:
  2148. description: optional specify whether the ConfigMap
  2149. or its keys must be defined
  2150. type: boolean
  2151. type: object
  2152. x-kubernetes-map-type: atomic
  2153. csi:
  2154. description: csi (Container Storage Interface) represents
  2155. ephemeral storage that is handled by certain external
  2156. CSI drivers.
  2157. properties:
  2158. driver:
  2159. description: |-
  2160. driver is the name of the CSI driver that handles this volume.
  2161. Consult with your admin for the correct name as registered in the cluster.
  2162. type: string
  2163. fsType:
  2164. description: |-
  2165. fsType to mount. Ex. "ext4", "xfs", "ntfs".
  2166. If not provided, the empty value is passed to the associated CSI driver
  2167. which will determine the default filesystem to apply.
  2168. type: string
  2169. nodePublishSecretRef:
  2170. description: |-
  2171. nodePublishSecretRef is a reference to the secret object containing
  2172. sensitive information to pass to the CSI driver to complete the CSI
  2173. NodePublishVolume and NodeUnpublishVolume calls.
  2174. This field is optional, and may be empty if no secret is required. If the
  2175. secret object contains more than one secret, all secret references are passed.
  2176. properties:
  2177. name:
  2178. default: ""
  2179. description: |-
  2180. Name of the referent.
  2181. This field is effectively required, but due to backwards compatibility is
  2182. allowed to be empty. Instances of this type with an empty value here are
  2183. almost certainly wrong.
  2184. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2185. type: string
  2186. type: object
  2187. x-kubernetes-map-type: atomic
  2188. readOnly:
  2189. description: |-
  2190. readOnly specifies a read-only configuration for the volume.
  2191. Defaults to false (read/write).
  2192. type: boolean
  2193. volumeAttributes:
  2194. additionalProperties:
  2195. type: string
  2196. description: |-
  2197. volumeAttributes stores driver-specific properties that are passed to the CSI
  2198. driver. Consult your driver's documentation for supported values.
  2199. type: object
  2200. required:
  2201. - driver
  2202. type: object
  2203. downwardAPI:
  2204. description: downwardAPI represents downward API about
  2205. the pod that should populate this volume
  2206. properties:
  2207. defaultMode:
  2208. description: |-
  2209. Optional: mode bits to use on created files by default. Must be a
  2210. Optional: mode bits used to set permissions on created files by default.
  2211. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  2212. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  2213. Defaults to 0644.
  2214. Directories within the path are not affected by this setting.
  2215. This might be in conflict with other options that affect the file
  2216. mode, like fsGroup, and the result can be other mode bits set.
  2217. format: int32
  2218. type: integer
  2219. items:
  2220. description: Items is a list of downward API volume
  2221. file
  2222. items:
  2223. description: DownwardAPIVolumeFile represents
  2224. information to create the file containing the
  2225. pod field
  2226. properties:
  2227. fieldRef:
  2228. description: 'Required: Selects a field of
  2229. the pod: only annotations, labels, name,
  2230. namespace and uid are supported.'
  2231. properties:
  2232. apiVersion:
  2233. description: Version of the schema the
  2234. FieldPath is written in terms of, defaults
  2235. to "v1".
  2236. type: string
  2237. fieldPath:
  2238. description: Path of the field to select
  2239. in the specified API version.
  2240. type: string
  2241. required:
  2242. - fieldPath
  2243. type: object
  2244. x-kubernetes-map-type: atomic
  2245. mode:
  2246. description: |-
  2247. Optional: mode bits used to set permissions on this file, must be an octal value
  2248. between 0000 and 0777 or a decimal value between 0 and 511.
  2249. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  2250. If not specified, the volume defaultMode will be used.
  2251. This might be in conflict with other options that affect the file
  2252. mode, like fsGroup, and the result can be other mode bits set.
  2253. format: int32
  2254. type: integer
  2255. path:
  2256. description: 'Required: Path is the relative
  2257. path name of the file to be created. Must
  2258. not be absolute or contain the ''..'' path.
  2259. Must be utf-8 encoded. The first item of
  2260. the relative path must not start with ''..'''
  2261. type: string
  2262. resourceFieldRef:
  2263. description: |-
  2264. Selects a resource of the container: only resources limits and requests
  2265. (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
  2266. properties:
  2267. containerName:
  2268. description: 'Container name: required
  2269. for volumes, optional for env vars'
  2270. type: string
  2271. divisor:
  2272. anyOf:
  2273. - type: integer
  2274. - type: string
  2275. description: Specifies the output format
  2276. of the exposed resources, defaults to
  2277. "1"
  2278. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  2279. x-kubernetes-int-or-string: true
  2280. resource:
  2281. description: 'Required: resource to select'
  2282. type: string
  2283. required:
  2284. - resource
  2285. type: object
  2286. x-kubernetes-map-type: atomic
  2287. required:
  2288. - path
  2289. type: object
  2290. type: array
  2291. x-kubernetes-list-type: atomic
  2292. type: object
  2293. emptyDir:
  2294. description: |-
  2295. emptyDir represents a temporary directory that shares a pod's lifetime.
  2296. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  2297. properties:
  2298. medium:
  2299. description: |-
  2300. medium represents what type of storage medium should back this directory.
  2301. The default is "" which means to use the node's default medium.
  2302. Must be an empty string (default) or Memory.
  2303. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  2304. type: string
  2305. sizeLimit:
  2306. anyOf:
  2307. - type: integer
  2308. - type: string
  2309. description: |-
  2310. sizeLimit is the total amount of local storage required for this EmptyDir volume.
  2311. The size limit is also applicable for memory medium.
  2312. The maximum usage on memory medium EmptyDir would be the minimum value between
  2313. the SizeLimit specified here and the sum of memory limits of all containers in a pod.
  2314. The default is nil which means that the limit is undefined.
  2315. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
  2316. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  2317. x-kubernetes-int-or-string: true
  2318. type: object
  2319. ephemeral:
  2320. description: |-
  2321. ephemeral represents a volume that is handled by a cluster storage driver.
  2322. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
  2323. and deleted when the pod is removed.
  2324. Use this if:
  2325. a) the volume is only needed while the pod runs,
  2326. b) features of normal volumes like restoring from snapshot or capacity
  2327. tracking are needed,
  2328. c) the storage driver is specified through a storage class, and
  2329. d) the storage driver supports dynamic volume provisioning through
  2330. a PersistentVolumeClaim (see EphemeralVolumeSource for more
  2331. information on the connection between this volume type
  2332. and PersistentVolumeClaim).
  2333. Use PersistentVolumeClaim or one of the vendor-specific
  2334. APIs for volumes that persist for longer than the lifecycle
  2335. of an individual pod.
  2336. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
  2337. be used that way - see the documentation of the driver for
  2338. more information.
  2339. A pod can use both types of ephemeral volumes and
  2340. persistent volumes at the same time.
  2341. properties:
  2342. volumeClaimTemplate:
  2343. description: |-
  2344. Will be used to create a stand-alone PVC to provision the volume.
  2345. The pod in which this EphemeralVolumeSource is embedded will be the
  2346. owner of the PVC, i.e. the PVC will be deleted together with the
  2347. pod. The name of the PVC will be `<pod name>-<volume name>` where
  2348. `<volume name>` is the name from the `PodSpec.Volumes` array
  2349. entry. Pod validation will reject the pod if the concatenated name
  2350. is not valid for a PVC (for example, too long).
  2351. An existing PVC with that name that is not owned by the pod
  2352. will *not* be used for the pod to avoid using an unrelated
  2353. volume by mistake. Starting the pod is then blocked until
  2354. the unrelated PVC is removed. If such a pre-created PVC is
  2355. meant to be used by the pod, the PVC has to updated with an
  2356. owner reference to the pod once the pod exists. Normally
  2357. this should not be necessary, but it may be useful when
  2358. manually reconstructing a broken cluster.
  2359. This field is read-only and no changes will be made by Kubernetes
  2360. to the PVC after it has been created.
  2361. Required, must not be nil.
  2362. properties:
  2363. metadata:
  2364. description: |-
  2365. May contain labels and annotations that will be copied into the PVC
  2366. when creating it. No other fields are allowed and will be rejected during
  2367. validation.
  2368. type: object
  2369. spec:
  2370. description: |-
  2371. The specification for the PersistentVolumeClaim. The entire content is
  2372. copied unchanged into the PVC that gets created from this
  2373. template. The same fields as in a PersistentVolumeClaim
  2374. are also valid here.
  2375. properties:
  2376. accessModes:
  2377. description: |-
  2378. accessModes contains the desired access modes the volume should have.
  2379. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
  2380. items:
  2381. type: string
  2382. type: array
  2383. x-kubernetes-list-type: atomic
  2384. dataSource:
  2385. description: |-
  2386. dataSource field can be used to specify either:
  2387. * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
  2388. * An existing PVC (PersistentVolumeClaim)
  2389. If the provisioner or an external controller can support the specified data source,
  2390. it will create a new volume based on the contents of the specified data source.
  2391. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
  2392. and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
  2393. If the namespace is specified, then dataSourceRef will not be copied to dataSource.
  2394. properties:
  2395. apiGroup:
  2396. description: |-
  2397. APIGroup is the group for the resource being referenced.
  2398. If APIGroup is not specified, the specified Kind must be in the core API group.
  2399. For any other third-party types, APIGroup is required.
  2400. type: string
  2401. kind:
  2402. description: Kind is the type of resource
  2403. being referenced
  2404. type: string
  2405. name:
  2406. description: Name is the name of resource
  2407. being referenced
  2408. type: string
  2409. required:
  2410. - kind
  2411. - name
  2412. type: object
  2413. x-kubernetes-map-type: atomic
  2414. dataSourceRef:
  2415. description: |-
  2416. dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
  2417. volume is desired. This may be any object from a non-empty API group (non
  2418. core object) or a PersistentVolumeClaim object.
  2419. When this field is specified, volume binding will only succeed if the type of
  2420. the specified object matches some installed volume populator or dynamic
  2421. provisioner.
  2422. This field will replace the functionality of the dataSource field and as such
  2423. if both fields are non-empty, they must have the same value. For backwards
  2424. compatibility, when namespace isn't specified in dataSourceRef,
  2425. both fields (dataSource and dataSourceRef) will be set to the same
  2426. value automatically if one of them is empty and the other is non-empty.
  2427. When namespace is specified in dataSourceRef,
  2428. dataSource isn't set to the same value and must be empty.
  2429. There are three important differences between dataSource and dataSourceRef:
  2430. * While dataSource only allows two specific types of objects, dataSourceRef
  2431. allows any non-core object, as well as PersistentVolumeClaim objects.
  2432. * While dataSource ignores disallowed values (dropping them), dataSourceRef
  2433. preserves all values, and generates an error if a disallowed value is
  2434. specified.
  2435. * While dataSource only allows local objects, dataSourceRef allows objects
  2436. in any namespaces.
  2437. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
  2438. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
  2439. properties:
  2440. apiGroup:
  2441. description: |-
  2442. APIGroup is the group for the resource being referenced.
  2443. If APIGroup is not specified, the specified Kind must be in the core API group.
  2444. For any other third-party types, APIGroup is required.
  2445. type: string
  2446. kind:
  2447. description: Kind is the type of resource
  2448. being referenced
  2449. type: string
  2450. name:
  2451. description: Name is the name of resource
  2452. being referenced
  2453. type: string
  2454. namespace:
  2455. description: |-
  2456. Namespace is the namespace of resource being referenced
  2457. 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.
  2458. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
  2459. type: string
  2460. required:
  2461. - kind
  2462. - name
  2463. type: object
  2464. resources:
  2465. description: |-
  2466. resources represents the minimum resources the volume should have.
  2467. Users are allowed to specify resource requirements
  2468. that are lower than previous value but must still be higher than capacity recorded in the
  2469. status field of the claim.
  2470. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
  2471. properties:
  2472. limits:
  2473. additionalProperties:
  2474. anyOf:
  2475. - type: integer
  2476. - type: string
  2477. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  2478. x-kubernetes-int-or-string: true
  2479. description: |-
  2480. Limits describes the maximum amount of compute resources allowed.
  2481. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  2482. type: object
  2483. requests:
  2484. additionalProperties:
  2485. anyOf:
  2486. - type: integer
  2487. - type: string
  2488. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  2489. x-kubernetes-int-or-string: true
  2490. description: |-
  2491. Requests describes the minimum amount of compute resources required.
  2492. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
  2493. otherwise to an implementation-defined value. Requests cannot exceed Limits.
  2494. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
  2495. type: object
  2496. type: object
  2497. selector:
  2498. description: selector is a label query over
  2499. volumes to consider for binding.
  2500. properties:
  2501. matchExpressions:
  2502. description: matchExpressions is a list
  2503. of label selector requirements. The
  2504. requirements are ANDed.
  2505. items:
  2506. description: |-
  2507. A label selector requirement is a selector that contains values, a key, and an operator that
  2508. relates the key and values.
  2509. properties:
  2510. key:
  2511. description: key is the label
  2512. key that the selector applies
  2513. to.
  2514. type: string
  2515. operator:
  2516. description: |-
  2517. operator represents a key's relationship to a set of values.
  2518. Valid operators are In, NotIn, Exists and DoesNotExist.
  2519. type: string
  2520. values:
  2521. description: |-
  2522. values is an array of string values. If the operator is In or NotIn,
  2523. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  2524. the values array must be empty. This array is replaced during a strategic
  2525. merge patch.
  2526. items:
  2527. type: string
  2528. type: array
  2529. x-kubernetes-list-type: atomic
  2530. required:
  2531. - key
  2532. - operator
  2533. type: object
  2534. type: array
  2535. x-kubernetes-list-type: atomic
  2536. matchLabels:
  2537. additionalProperties:
  2538. type: string
  2539. description: |-
  2540. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  2541. map is equivalent to an element of matchExpressions, whose key field is "key", the
  2542. operator is "In", and the values array contains only "value". The requirements are ANDed.
  2543. type: object
  2544. type: object
  2545. x-kubernetes-map-type: atomic
  2546. storageClassName:
  2547. description: |-
  2548. storageClassName is the name of the StorageClass required by the claim.
  2549. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
  2550. type: string
  2551. volumeAttributesClassName:
  2552. description: |-
  2553. volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
  2554. If specified, the CSI driver will create or update the volume with the attributes defined
  2555. in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
  2556. it can be changed after the claim is created. An empty string or nil value indicates that no
  2557. VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
  2558. this field can be reset to its previous value (including nil) to cancel the modification.
  2559. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
  2560. set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
  2561. exists.
  2562. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
  2563. type: string
  2564. volumeMode:
  2565. description: |-
  2566. volumeMode defines what type of volume is required by the claim.
  2567. Value of Filesystem is implied when not included in claim spec.
  2568. type: string
  2569. volumeName:
  2570. description: volumeName is the binding reference
  2571. to the PersistentVolume backing this claim.
  2572. type: string
  2573. type: object
  2574. required:
  2575. - spec
  2576. type: object
  2577. type: object
  2578. fc:
  2579. description: fc represents a Fibre Channel resource
  2580. that is attached to a kubelet's host machine and then
  2581. exposed to the pod.
  2582. properties:
  2583. fsType:
  2584. description: |-
  2585. fsType is the filesystem type to mount.
  2586. Must be a filesystem type supported by the host operating system.
  2587. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2588. type: string
  2589. lun:
  2590. description: 'lun is Optional: FC target lun number'
  2591. format: int32
  2592. type: integer
  2593. readOnly:
  2594. description: |-
  2595. readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
  2596. the ReadOnly setting in VolumeMounts.
  2597. type: boolean
  2598. targetWWNs:
  2599. description: 'targetWWNs is Optional: FC target
  2600. worldwide names (WWNs)'
  2601. items:
  2602. type: string
  2603. type: array
  2604. x-kubernetes-list-type: atomic
  2605. wwids:
  2606. description: |-
  2607. wwids Optional: FC volume world wide identifiers (wwids)
  2608. Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
  2609. items:
  2610. type: string
  2611. type: array
  2612. x-kubernetes-list-type: atomic
  2613. type: object
  2614. flexVolume:
  2615. description: |-
  2616. flexVolume represents a generic volume resource that is
  2617. provisioned/attached using an exec based plugin.
  2618. Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
  2619. properties:
  2620. driver:
  2621. description: driver is the name of the driver to
  2622. use for this volume.
  2623. type: string
  2624. fsType:
  2625. description: |-
  2626. fsType is the filesystem type to mount.
  2627. Must be a filesystem type supported by the host operating system.
  2628. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  2629. type: string
  2630. options:
  2631. additionalProperties:
  2632. type: string
  2633. description: 'options is Optional: this field holds
  2634. extra command options if any.'
  2635. type: object
  2636. readOnly:
  2637. description: |-
  2638. readOnly is Optional: defaults to false (read/write). ReadOnly here will force
  2639. the ReadOnly setting in VolumeMounts.
  2640. type: boolean
  2641. secretRef:
  2642. description: |-
  2643. secretRef is Optional: secretRef is reference to the secret object containing
  2644. sensitive information to pass to the plugin scripts. This may be
  2645. empty if no secret object is specified. If the secret object
  2646. contains more than one secret, all secrets are passed to the plugin
  2647. scripts.
  2648. properties:
  2649. name:
  2650. default: ""
  2651. description: |-
  2652. Name of the referent.
  2653. This field is effectively required, but due to backwards compatibility is
  2654. allowed to be empty. Instances of this type with an empty value here are
  2655. almost certainly wrong.
  2656. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2657. type: string
  2658. type: object
  2659. x-kubernetes-map-type: atomic
  2660. required:
  2661. - driver
  2662. type: object
  2663. flocker:
  2664. description: |-
  2665. flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
  2666. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
  2667. properties:
  2668. datasetName:
  2669. description: |-
  2670. datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
  2671. should be considered as deprecated
  2672. type: string
  2673. datasetUUID:
  2674. description: datasetUUID is the UUID of the dataset.
  2675. This is unique identifier of a Flocker dataset
  2676. type: string
  2677. type: object
  2678. gcePersistentDisk:
  2679. description: |-
  2680. gcePersistentDisk represents a GCE Disk resource that is attached to a
  2681. kubelet's host machine and then exposed to the pod.
  2682. Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
  2683. gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
  2684. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2685. properties:
  2686. fsType:
  2687. description: |-
  2688. fsType is filesystem type of the volume that you want to mount.
  2689. Tip: Ensure that the filesystem type is supported by the host operating system.
  2690. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2691. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2692. type: string
  2693. partition:
  2694. description: |-
  2695. partition is the partition in the volume that you want to mount.
  2696. If omitted, the default is to mount by volume name.
  2697. Examples: For volume /dev/sda1, you specify the partition as "1".
  2698. Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  2699. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2700. format: int32
  2701. type: integer
  2702. pdName:
  2703. description: |-
  2704. pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
  2705. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2706. type: string
  2707. readOnly:
  2708. description: |-
  2709. readOnly here will force the ReadOnly setting in VolumeMounts.
  2710. Defaults to false.
  2711. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
  2712. type: boolean
  2713. required:
  2714. - pdName
  2715. type: object
  2716. gitRepo:
  2717. description: |-
  2718. gitRepo represents a git repository at a particular revision.
  2719. Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
  2720. EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
  2721. into the Pod's container.
  2722. properties:
  2723. directory:
  2724. description: |-
  2725. directory is the target directory name.
  2726. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
  2727. git repository. Otherwise, if specified, the volume will contain the git repository in
  2728. the subdirectory with the given name.
  2729. type: string
  2730. repository:
  2731. description: repository is the URL
  2732. type: string
  2733. revision:
  2734. description: revision is the commit hash for the
  2735. specified revision.
  2736. type: string
  2737. required:
  2738. - repository
  2739. type: object
  2740. glusterfs:
  2741. description: |-
  2742. glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
  2743. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
  2744. properties:
  2745. endpoints:
  2746. description: endpoints is the endpoint name that
  2747. details Glusterfs topology.
  2748. type: string
  2749. path:
  2750. description: |-
  2751. path is the Glusterfs volume path.
  2752. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  2753. type: string
  2754. readOnly:
  2755. description: |-
  2756. readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
  2757. Defaults to false.
  2758. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
  2759. type: boolean
  2760. required:
  2761. - endpoints
  2762. - path
  2763. type: object
  2764. hostPath:
  2765. description: |-
  2766. hostPath represents a pre-existing file or directory on the host
  2767. machine that is directly exposed to the container. This is generally
  2768. used for system agents or other privileged things that are allowed
  2769. to see the host machine. Most containers will NOT need this.
  2770. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  2771. properties:
  2772. path:
  2773. description: |-
  2774. path of the directory on the host.
  2775. If the path is a symlink, it will follow the link to the real path.
  2776. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  2777. type: string
  2778. type:
  2779. description: |-
  2780. type for HostPath Volume
  2781. Defaults to ""
  2782. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
  2783. type: string
  2784. required:
  2785. - path
  2786. type: object
  2787. image:
  2788. description: |-
  2789. image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
  2790. The volume is resolved at pod startup depending on which PullPolicy value is provided:
  2791. - Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
  2792. - 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.
  2793. - 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.
  2794. The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
  2795. 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.
  2796. 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.
  2797. 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.
  2798. The volume will be mounted read-only (ro) and non-executable files (noexec).
  2799. Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
  2800. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
  2801. properties:
  2802. pullPolicy:
  2803. description: |-
  2804. Policy for pulling OCI objects. Possible values are:
  2805. Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
  2806. 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.
  2807. 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.
  2808. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
  2809. type: string
  2810. reference:
  2811. description: |-
  2812. Required: Image or artifact reference to be used.
  2813. Behaves in the same way as pod.spec.containers[*].image.
  2814. 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.
  2815. More info: https://kubernetes.io/docs/concepts/containers/images
  2816. This field is optional to allow higher level config management to default or override
  2817. container images in workload controllers like Deployments and StatefulSets.
  2818. type: string
  2819. type: object
  2820. iscsi:
  2821. description: |-
  2822. iscsi represents an ISCSI Disk resource that is attached to a
  2823. kubelet's host machine and then exposed to the pod.
  2824. More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
  2825. properties:
  2826. chapAuthDiscovery:
  2827. description: chapAuthDiscovery defines whether support
  2828. iSCSI Discovery CHAP authentication
  2829. type: boolean
  2830. chapAuthSession:
  2831. description: chapAuthSession defines whether support
  2832. iSCSI Session CHAP authentication
  2833. type: boolean
  2834. fsType:
  2835. description: |-
  2836. fsType is the filesystem type of the volume that you want to mount.
  2837. Tip: Ensure that the filesystem type is supported by the host operating system.
  2838. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2839. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
  2840. type: string
  2841. initiatorName:
  2842. description: |-
  2843. initiatorName is the custom iSCSI Initiator Name.
  2844. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
  2845. <target portal>:<volume name> will be created for the connection.
  2846. type: string
  2847. iqn:
  2848. description: iqn is the target iSCSI Qualified Name.
  2849. type: string
  2850. iscsiInterface:
  2851. default: default
  2852. description: |-
  2853. iscsiInterface is the interface Name that uses an iSCSI transport.
  2854. Defaults to 'default' (tcp).
  2855. type: string
  2856. lun:
  2857. description: lun represents iSCSI Target Lun number.
  2858. format: int32
  2859. type: integer
  2860. portals:
  2861. description: |-
  2862. portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
  2863. is other than default (typically TCP ports 860 and 3260).
  2864. items:
  2865. type: string
  2866. type: array
  2867. x-kubernetes-list-type: atomic
  2868. readOnly:
  2869. description: |-
  2870. readOnly here will force the ReadOnly setting in VolumeMounts.
  2871. Defaults to false.
  2872. type: boolean
  2873. secretRef:
  2874. description: secretRef is the CHAP Secret for iSCSI
  2875. target and initiator authentication
  2876. properties:
  2877. name:
  2878. default: ""
  2879. description: |-
  2880. Name of the referent.
  2881. This field is effectively required, but due to backwards compatibility is
  2882. allowed to be empty. Instances of this type with an empty value here are
  2883. almost certainly wrong.
  2884. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2885. type: string
  2886. type: object
  2887. x-kubernetes-map-type: atomic
  2888. targetPortal:
  2889. description: |-
  2890. targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
  2891. is other than default (typically TCP ports 860 and 3260).
  2892. type: string
  2893. required:
  2894. - iqn
  2895. - lun
  2896. - targetPortal
  2897. type: object
  2898. name:
  2899. description: |-
  2900. name of the volume.
  2901. Must be a DNS_LABEL and unique within the pod.
  2902. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  2903. type: string
  2904. nfs:
  2905. description: |-
  2906. nfs represents an NFS mount on the host that shares a pod's lifetime
  2907. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2908. properties:
  2909. path:
  2910. description: |-
  2911. path that is exported by the NFS server.
  2912. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2913. type: string
  2914. readOnly:
  2915. description: |-
  2916. readOnly here will force the NFS export to be mounted with read-only permissions.
  2917. Defaults to false.
  2918. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2919. type: boolean
  2920. server:
  2921. description: |-
  2922. server is the hostname or IP address of the NFS server.
  2923. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  2924. type: string
  2925. required:
  2926. - path
  2927. - server
  2928. type: object
  2929. persistentVolumeClaim:
  2930. description: |-
  2931. persistentVolumeClaimVolumeSource represents a reference to a
  2932. PersistentVolumeClaim in the same namespace.
  2933. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2934. properties:
  2935. claimName:
  2936. description: |-
  2937. claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
  2938. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
  2939. type: string
  2940. readOnly:
  2941. description: |-
  2942. readOnly Will force the ReadOnly setting in VolumeMounts.
  2943. Default false.
  2944. type: boolean
  2945. required:
  2946. - claimName
  2947. type: object
  2948. photonPersistentDisk:
  2949. description: |-
  2950. photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
  2951. Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
  2952. properties:
  2953. fsType:
  2954. description: |-
  2955. fsType is the filesystem type to mount.
  2956. Must be a filesystem type supported by the host operating system.
  2957. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2958. type: string
  2959. pdID:
  2960. description: pdID is the ID that identifies Photon
  2961. Controller persistent disk
  2962. type: string
  2963. required:
  2964. - pdID
  2965. type: object
  2966. portworxVolume:
  2967. description: |-
  2968. portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
  2969. Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
  2970. are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
  2971. is on.
  2972. properties:
  2973. fsType:
  2974. description: |-
  2975. fSType represents the filesystem type to mount
  2976. Must be a filesystem type supported by the host operating system.
  2977. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
  2978. type: string
  2979. readOnly:
  2980. description: |-
  2981. readOnly defaults to false (read/write). ReadOnly here will force
  2982. the ReadOnly setting in VolumeMounts.
  2983. type: boolean
  2984. volumeID:
  2985. description: volumeID uniquely identifies a Portworx
  2986. volume
  2987. type: string
  2988. required:
  2989. - volumeID
  2990. type: object
  2991. projected:
  2992. description: projected items for all in one resources
  2993. secrets, configmaps, and downward API
  2994. properties:
  2995. defaultMode:
  2996. description: |-
  2997. defaultMode are the mode bits used to set permissions on created files by default.
  2998. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  2999. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  3000. Directories within the path are not affected by this setting.
  3001. This might be in conflict with other options that affect the file
  3002. mode, like fsGroup, and the result can be other mode bits set.
  3003. format: int32
  3004. type: integer
  3005. sources:
  3006. description: |-
  3007. sources is the list of volume projections. Each entry in this list
  3008. handles one source.
  3009. items:
  3010. description: |-
  3011. Projection that may be projected along with other supported volume types.
  3012. Exactly one of these fields must be set.
  3013. properties:
  3014. clusterTrustBundle:
  3015. description: |-
  3016. ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
  3017. of ClusterTrustBundle objects in an auto-updating file.
  3018. Alpha, gated by the ClusterTrustBundleProjection feature gate.
  3019. ClusterTrustBundle objects can either be selected by name, or by the
  3020. combination of signer name and a label selector.
  3021. Kubelet performs aggressive normalization of the PEM contents written
  3022. into the pod filesystem. Esoteric PEM features such as inter-block
  3023. comments and block headers are stripped. Certificates are deduplicated.
  3024. The ordering of certificates within the file is arbitrary, and Kubelet
  3025. may change the order over time.
  3026. properties:
  3027. labelSelector:
  3028. description: |-
  3029. Select all ClusterTrustBundles that match this label selector. Only has
  3030. effect if signerName is set. Mutually-exclusive with name. If unset,
  3031. interpreted as "match nothing". If set but empty, interpreted as "match
  3032. everything".
  3033. properties:
  3034. matchExpressions:
  3035. description: matchExpressions is a
  3036. list of label selector requirements.
  3037. The requirements are ANDed.
  3038. items:
  3039. description: |-
  3040. A label selector requirement is a selector that contains values, a key, and an operator that
  3041. relates the key and values.
  3042. properties:
  3043. key:
  3044. description: key is the label
  3045. key that the selector applies
  3046. to.
  3047. type: string
  3048. operator:
  3049. description: |-
  3050. operator represents a key's relationship to a set of values.
  3051. Valid operators are In, NotIn, Exists and DoesNotExist.
  3052. type: string
  3053. values:
  3054. description: |-
  3055. values is an array of string values. If the operator is In or NotIn,
  3056. the values array must be non-empty. If the operator is Exists or DoesNotExist,
  3057. the values array must be empty. This array is replaced during a strategic
  3058. merge patch.
  3059. items:
  3060. type: string
  3061. type: array
  3062. x-kubernetes-list-type: atomic
  3063. required:
  3064. - key
  3065. - operator
  3066. type: object
  3067. type: array
  3068. x-kubernetes-list-type: atomic
  3069. matchLabels:
  3070. additionalProperties:
  3071. type: string
  3072. description: |-
  3073. matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  3074. map is equivalent to an element of matchExpressions, whose key field is "key", the
  3075. operator is "In", and the values array contains only "value". The requirements are ANDed.
  3076. type: object
  3077. type: object
  3078. x-kubernetes-map-type: atomic
  3079. name:
  3080. description: |-
  3081. Select a single ClusterTrustBundle by object name. Mutually-exclusive
  3082. with signerName and labelSelector.
  3083. type: string
  3084. optional:
  3085. description: |-
  3086. If true, don't block pod startup if the referenced ClusterTrustBundle(s)
  3087. aren't available. If using name, then the named ClusterTrustBundle is
  3088. allowed not to exist. If using signerName, then the combination of
  3089. signerName and labelSelector is allowed to match zero
  3090. ClusterTrustBundles.
  3091. type: boolean
  3092. path:
  3093. description: Relative path from the volume
  3094. root to write the bundle.
  3095. type: string
  3096. signerName:
  3097. description: |-
  3098. Select all ClusterTrustBundles that match this signer name.
  3099. Mutually-exclusive with name. The contents of all selected
  3100. ClusterTrustBundles will be unified and deduplicated.
  3101. type: string
  3102. required:
  3103. - path
  3104. type: object
  3105. configMap:
  3106. description: configMap information about the
  3107. configMap data to project
  3108. properties:
  3109. items:
  3110. description: |-
  3111. items if unspecified, each key-value pair in the Data field of the referenced
  3112. ConfigMap will be projected into the volume as a file whose name is the
  3113. key and content is the value. If specified, the listed keys will be
  3114. projected into the specified paths, and unlisted keys will not be
  3115. present. If a key is specified which is not present in the ConfigMap,
  3116. the volume setup will error unless it is marked optional. Paths must be
  3117. relative and may not contain the '..' path or start with '..'.
  3118. items:
  3119. description: Maps a string key to a
  3120. path within a volume.
  3121. properties:
  3122. key:
  3123. description: key is the key to project.
  3124. type: string
  3125. mode:
  3126. description: |-
  3127. mode is Optional: mode bits used to set permissions on this file.
  3128. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  3129. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  3130. If not specified, the volume defaultMode will be used.
  3131. This might be in conflict with other options that affect the file
  3132. mode, like fsGroup, and the result can be other mode bits set.
  3133. format: int32
  3134. type: integer
  3135. path:
  3136. description: |-
  3137. path is the relative path of the file to map the key to.
  3138. May not be an absolute path.
  3139. May not contain the path element '..'.
  3140. May not start with the string '..'.
  3141. type: string
  3142. required:
  3143. - key
  3144. - path
  3145. type: object
  3146. type: array
  3147. x-kubernetes-list-type: atomic
  3148. name:
  3149. default: ""
  3150. description: |-
  3151. Name of the referent.
  3152. This field is effectively required, but due to backwards compatibility is
  3153. allowed to be empty. Instances of this type with an empty value here are
  3154. almost certainly wrong.
  3155. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3156. type: string
  3157. optional:
  3158. description: optional specify whether
  3159. the ConfigMap or its keys must be defined
  3160. type: boolean
  3161. type: object
  3162. x-kubernetes-map-type: atomic
  3163. downwardAPI:
  3164. description: downwardAPI information about
  3165. the downwardAPI data to project
  3166. properties:
  3167. items:
  3168. description: Items is a list of DownwardAPIVolume
  3169. file
  3170. items:
  3171. description: DownwardAPIVolumeFile represents
  3172. information to create the file containing
  3173. the pod field
  3174. properties:
  3175. fieldRef:
  3176. description: 'Required: Selects
  3177. a field of the pod: only annotations,
  3178. labels, name, namespace and uid
  3179. are supported.'
  3180. properties:
  3181. apiVersion:
  3182. description: Version of the
  3183. schema the FieldPath is written
  3184. in terms of, defaults to "v1".
  3185. type: string
  3186. fieldPath:
  3187. description: Path of the field
  3188. to select in the specified
  3189. API version.
  3190. type: string
  3191. required:
  3192. - fieldPath
  3193. type: object
  3194. x-kubernetes-map-type: atomic
  3195. mode:
  3196. description: |-
  3197. Optional: mode bits used to set permissions on this file, must be an octal value
  3198. between 0000 and 0777 or a decimal value between 0 and 511.
  3199. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  3200. If not specified, the volume defaultMode will be used.
  3201. This might be in conflict with other options that affect the file
  3202. mode, like fsGroup, and the result can be other mode bits set.
  3203. format: int32
  3204. type: integer
  3205. path:
  3206. description: 'Required: Path is the
  3207. relative path name of the file
  3208. to be created. Must not be absolute
  3209. or contain the ''..'' path. Must
  3210. be utf-8 encoded. The first item
  3211. of the relative path must not
  3212. start with ''..'''
  3213. type: string
  3214. resourceFieldRef:
  3215. description: |-
  3216. Selects a resource of the container: only resources limits and requests
  3217. (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
  3218. properties:
  3219. containerName:
  3220. description: 'Container name:
  3221. required for volumes, optional
  3222. for env vars'
  3223. type: string
  3224. divisor:
  3225. anyOf:
  3226. - type: integer
  3227. - type: string
  3228. description: Specifies the output
  3229. format of the exposed resources,
  3230. defaults to "1"
  3231. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
  3232. x-kubernetes-int-or-string: true
  3233. resource:
  3234. description: 'Required: resource
  3235. to select'
  3236. type: string
  3237. required:
  3238. - resource
  3239. type: object
  3240. x-kubernetes-map-type: atomic
  3241. required:
  3242. - path
  3243. type: object
  3244. type: array
  3245. x-kubernetes-list-type: atomic
  3246. type: object
  3247. podCertificate:
  3248. description: |-
  3249. Projects an auto-rotating credential bundle (private key and certificate
  3250. chain) that the pod can use either as a TLS client or server.
  3251. Kubelet generates a private key and uses it to send a
  3252. PodCertificateRequest to the named signer. Once the signer approves the
  3253. request and issues a certificate chain, Kubelet writes the key and
  3254. certificate chain to the pod filesystem. The pod does not start until
  3255. certificates have been issued for each podCertificate projected volume
  3256. source in its spec.
  3257. Kubelet will begin trying to rotate the certificate at the time indicated
  3258. by the signer using the PodCertificateRequest.Status.BeginRefreshAt
  3259. timestamp.
  3260. Kubelet can write a single file, indicated by the credentialBundlePath
  3261. field, or separate files, indicated by the keyPath and
  3262. certificateChainPath fields.
  3263. The credential bundle is a single file in PEM format. The first PEM
  3264. entry is the private key (in PKCS#8 format), and the remaining PEM
  3265. entries are the certificate chain issued by the signer (typically,
  3266. signers will return their certificate chain in leaf-to-root order).
  3267. Prefer using the credential bundle format, since your application code
  3268. can read it atomically. If you use keyPath and certificateChainPath,
  3269. your application must make two separate file reads. If these coincide
  3270. with a certificate rotation, it is possible that the private key and leaf
  3271. certificate you read may not correspond to each other. Your application
  3272. will need to check for this condition, and re-read until they are
  3273. consistent.
  3274. The named signer controls chooses the format of the certificate it
  3275. issues; consult the signer implementation's documentation to learn how to
  3276. use the certificates it issues.
  3277. properties:
  3278. certificateChainPath:
  3279. description: |-
  3280. Write the certificate chain at this path in the projected volume.
  3281. Most applications should use credentialBundlePath. When using keyPath
  3282. and certificateChainPath, your application needs to check that the key
  3283. and leaf certificate are consistent, because it is possible to read the
  3284. files mid-rotation.
  3285. type: string
  3286. credentialBundlePath:
  3287. description: |-
  3288. Write the credential bundle at this path in the projected volume.
  3289. The credential bundle is a single file that contains multiple PEM blocks.
  3290. The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
  3291. key.
  3292. The remaining blocks are CERTIFICATE blocks, containing the issued
  3293. certificate chain from the signer (leaf and any intermediates).
  3294. Using credentialBundlePath lets your Pod's application code make a single
  3295. atomic read that retrieves a consistent key and certificate chain. If you
  3296. project them to separate files, your application code will need to
  3297. additionally check that the leaf certificate was issued to the key.
  3298. type: string
  3299. keyPath:
  3300. description: |-
  3301. Write the key at this path in the projected volume.
  3302. Most applications should use credentialBundlePath. When using keyPath
  3303. and certificateChainPath, your application needs to check that the key
  3304. and leaf certificate are consistent, because it is possible to read the
  3305. files mid-rotation.
  3306. type: string
  3307. keyType:
  3308. description: |-
  3309. The type of keypair Kubelet will generate for the pod.
  3310. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
  3311. "ECDSAP521", and "ED25519".
  3312. type: string
  3313. maxExpirationSeconds:
  3314. description: |-
  3315. maxExpirationSeconds is the maximum lifetime permitted for the
  3316. certificate.
  3317. Kubelet copies this value verbatim into the PodCertificateRequests it
  3318. generates for this projection.
  3319. If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
  3320. will reject values shorter than 3600 (1 hour). The maximum allowable
  3321. value is 7862400 (91 days).
  3322. The signer implementation is then free to issue a certificate with any
  3323. lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
  3324. seconds (1 hour). This constraint is enforced by kube-apiserver.
  3325. `kubernetes.io` signers will never issue certificates with a lifetime
  3326. longer than 24 hours.
  3327. format: int32
  3328. type: integer
  3329. signerName:
  3330. description: Kubelet's generated CSRs
  3331. will be addressed to this signer.
  3332. type: string
  3333. userAnnotations:
  3334. additionalProperties:
  3335. type: string
  3336. description: |-
  3337. userAnnotations allow pod authors to pass additional information to
  3338. the signer implementation. Kubernetes does not restrict or validate this
  3339. metadata in any way.
  3340. These values are copied verbatim into the `spec.unverifiedUserAnnotations` field of
  3341. the PodCertificateRequest objects that Kubelet creates.
  3342. Entries are subject to the same validation as object metadata annotations,
  3343. with the addition that all keys must be domain-prefixed. No restrictions
  3344. are placed on values, except an overall size limitation on the entire field.
  3345. Signers should document the keys and values they support. Signers should
  3346. deny requests that contain keys they do not recognize.
  3347. type: object
  3348. required:
  3349. - keyType
  3350. - signerName
  3351. type: object
  3352. secret:
  3353. description: secret information about the
  3354. secret data to project
  3355. properties:
  3356. items:
  3357. description: |-
  3358. items if unspecified, each key-value pair in the Data field of the referenced
  3359. Secret will be projected into the volume as a file whose name is the
  3360. key and content is the value. If specified, the listed keys will be
  3361. projected into the specified paths, and unlisted keys will not be
  3362. present. If a key is specified which is not present in the Secret,
  3363. the volume setup will error unless it is marked optional. Paths must be
  3364. relative and may not contain the '..' path or start with '..'.
  3365. items:
  3366. description: Maps a string key to a
  3367. path within a volume.
  3368. properties:
  3369. key:
  3370. description: key is the key to project.
  3371. type: string
  3372. mode:
  3373. description: |-
  3374. mode is Optional: mode bits used to set permissions on this file.
  3375. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  3376. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  3377. If not specified, the volume defaultMode will be used.
  3378. This might be in conflict with other options that affect the file
  3379. mode, like fsGroup, and the result can be other mode bits set.
  3380. format: int32
  3381. type: integer
  3382. path:
  3383. description: |-
  3384. path is the relative path of the file to map the key to.
  3385. May not be an absolute path.
  3386. May not contain the path element '..'.
  3387. May not start with the string '..'.
  3388. type: string
  3389. required:
  3390. - key
  3391. - path
  3392. type: object
  3393. type: array
  3394. x-kubernetes-list-type: atomic
  3395. name:
  3396. default: ""
  3397. description: |-
  3398. Name of the referent.
  3399. This field is effectively required, but due to backwards compatibility is
  3400. allowed to be empty. Instances of this type with an empty value here are
  3401. almost certainly wrong.
  3402. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3403. type: string
  3404. optional:
  3405. description: optional field specify whether
  3406. the Secret or its key must be defined
  3407. type: boolean
  3408. type: object
  3409. x-kubernetes-map-type: atomic
  3410. serviceAccountToken:
  3411. description: serviceAccountToken is information
  3412. about the serviceAccountToken data to project
  3413. properties:
  3414. audience:
  3415. description: |-
  3416. audience is the intended audience of the token. A recipient of a token
  3417. must identify itself with an identifier specified in the audience of the
  3418. token, and otherwise should reject the token. The audience defaults to the
  3419. identifier of the apiserver.
  3420. type: string
  3421. expirationSeconds:
  3422. description: |-
  3423. expirationSeconds is the requested duration of validity of the service
  3424. account token. As the token approaches expiration, the kubelet volume
  3425. plugin will proactively rotate the service account token. The kubelet will
  3426. start trying to rotate the token if the token is older than 80 percent of
  3427. its time to live or if the token is older than 24 hours.Defaults to 1 hour
  3428. and must be at least 10 minutes.
  3429. format: int64
  3430. type: integer
  3431. path:
  3432. description: |-
  3433. path is the path relative to the mount point of the file to project the
  3434. token into.
  3435. type: string
  3436. required:
  3437. - path
  3438. type: object
  3439. type: object
  3440. type: array
  3441. x-kubernetes-list-type: atomic
  3442. type: object
  3443. quobyte:
  3444. description: |-
  3445. quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
  3446. Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
  3447. properties:
  3448. group:
  3449. description: |-
  3450. group to map volume access to
  3451. Default is no group
  3452. type: string
  3453. readOnly:
  3454. description: |-
  3455. readOnly here will force the Quobyte volume to be mounted with read-only permissions.
  3456. Defaults to false.
  3457. type: boolean
  3458. registry:
  3459. description: |-
  3460. registry represents a single or multiple Quobyte Registry services
  3461. specified as a string as host:port pair (multiple entries are separated with commas)
  3462. which acts as the central registry for volumes
  3463. type: string
  3464. tenant:
  3465. description: |-
  3466. tenant owning the given Quobyte volume in the Backend
  3467. Used with dynamically provisioned Quobyte volumes, value is set by the plugin
  3468. type: string
  3469. user:
  3470. description: |-
  3471. user to map volume access to
  3472. Defaults to serivceaccount user
  3473. type: string
  3474. volume:
  3475. description: volume is a string that references
  3476. an already created Quobyte volume by name.
  3477. type: string
  3478. required:
  3479. - registry
  3480. - volume
  3481. type: object
  3482. rbd:
  3483. description: |-
  3484. rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
  3485. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
  3486. properties:
  3487. fsType:
  3488. description: |-
  3489. fsType is the filesystem type of the volume that you want to mount.
  3490. Tip: Ensure that the filesystem type is supported by the host operating system.
  3491. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  3492. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
  3493. type: string
  3494. image:
  3495. description: |-
  3496. image is the rados image name.
  3497. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3498. type: string
  3499. keyring:
  3500. default: /etc/ceph/keyring
  3501. description: |-
  3502. keyring is the path to key ring for RBDUser.
  3503. Default is /etc/ceph/keyring.
  3504. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3505. type: string
  3506. monitors:
  3507. description: |-
  3508. monitors is a collection of Ceph monitors.
  3509. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3510. items:
  3511. type: string
  3512. type: array
  3513. x-kubernetes-list-type: atomic
  3514. pool:
  3515. default: rbd
  3516. description: |-
  3517. pool is the rados pool name.
  3518. Default is rbd.
  3519. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3520. type: string
  3521. readOnly:
  3522. description: |-
  3523. readOnly here will force the ReadOnly setting in VolumeMounts.
  3524. Defaults to false.
  3525. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3526. type: boolean
  3527. secretRef:
  3528. description: |-
  3529. secretRef is name of the authentication secret for RBDUser. If provided
  3530. overrides keyring.
  3531. Default is nil.
  3532. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3533. properties:
  3534. name:
  3535. default: ""
  3536. description: |-
  3537. Name of the referent.
  3538. This field is effectively required, but due to backwards compatibility is
  3539. allowed to be empty. Instances of this type with an empty value here are
  3540. almost certainly wrong.
  3541. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3542. type: string
  3543. type: object
  3544. x-kubernetes-map-type: atomic
  3545. user:
  3546. default: admin
  3547. description: |-
  3548. user is the rados user name.
  3549. Default is admin.
  3550. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
  3551. type: string
  3552. required:
  3553. - image
  3554. - monitors
  3555. type: object
  3556. scaleIO:
  3557. description: |-
  3558. scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  3559. Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
  3560. properties:
  3561. fsType:
  3562. default: xfs
  3563. description: |-
  3564. fsType is the filesystem type to mount.
  3565. Must be a filesystem type supported by the host operating system.
  3566. Ex. "ext4", "xfs", "ntfs".
  3567. Default is "xfs".
  3568. type: string
  3569. gateway:
  3570. description: gateway is the host address of the
  3571. ScaleIO API Gateway.
  3572. type: string
  3573. protectionDomain:
  3574. description: protectionDomain is the name of the
  3575. ScaleIO Protection Domain for the configured storage.
  3576. type: string
  3577. readOnly:
  3578. description: |-
  3579. readOnly Defaults to false (read/write). ReadOnly here will force
  3580. the ReadOnly setting in VolumeMounts.
  3581. type: boolean
  3582. secretRef:
  3583. description: |-
  3584. secretRef references to the secret for ScaleIO user and other
  3585. sensitive information. If this is not provided, Login operation will fail.
  3586. properties:
  3587. name:
  3588. default: ""
  3589. description: |-
  3590. Name of the referent.
  3591. This field is effectively required, but due to backwards compatibility is
  3592. allowed to be empty. Instances of this type with an empty value here are
  3593. almost certainly wrong.
  3594. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3595. type: string
  3596. type: object
  3597. x-kubernetes-map-type: atomic
  3598. sslEnabled:
  3599. description: sslEnabled Flag enable/disable SSL
  3600. communication with Gateway, default false
  3601. type: boolean
  3602. storageMode:
  3603. default: ThinProvisioned
  3604. description: |-
  3605. storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
  3606. Default is ThinProvisioned.
  3607. type: string
  3608. storagePool:
  3609. description: storagePool is the ScaleIO Storage
  3610. Pool associated with the protection domain.
  3611. type: string
  3612. system:
  3613. description: system is the name of the storage system
  3614. as configured in ScaleIO.
  3615. type: string
  3616. volumeName:
  3617. description: |-
  3618. volumeName is the name of a volume already created in the ScaleIO system
  3619. that is associated with this volume source.
  3620. type: string
  3621. required:
  3622. - gateway
  3623. - secretRef
  3624. - system
  3625. type: object
  3626. secret:
  3627. description: |-
  3628. secret represents a secret that should populate this volume.
  3629. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
  3630. properties:
  3631. defaultMode:
  3632. description: |-
  3633. defaultMode is Optional: mode bits used to set permissions on created files by default.
  3634. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  3635. YAML accepts both octal and decimal values, JSON requires decimal values
  3636. for mode bits. Defaults to 0644.
  3637. Directories within the path are not affected by this setting.
  3638. This might be in conflict with other options that affect the file
  3639. mode, like fsGroup, and the result can be other mode bits set.
  3640. format: int32
  3641. type: integer
  3642. items:
  3643. description: |-
  3644. items If unspecified, each key-value pair in the Data field of the referenced
  3645. Secret will be projected into the volume as a file whose name is the
  3646. key and content is the value. If specified, the listed keys will be
  3647. projected into the specified paths, and unlisted keys will not be
  3648. present. If a key is specified which is not present in the Secret,
  3649. the volume setup will error unless it is marked optional. Paths must be
  3650. relative and may not contain the '..' path or start with '..'.
  3651. items:
  3652. description: Maps a string key to a path within
  3653. a volume.
  3654. properties:
  3655. key:
  3656. description: key is the key to project.
  3657. type: string
  3658. mode:
  3659. description: |-
  3660. mode is Optional: mode bits used to set permissions on this file.
  3661. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
  3662. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
  3663. If not specified, the volume defaultMode will be used.
  3664. This might be in conflict with other options that affect the file
  3665. mode, like fsGroup, and the result can be other mode bits set.
  3666. format: int32
  3667. type: integer
  3668. path:
  3669. description: |-
  3670. path is the relative path of the file to map the key to.
  3671. May not be an absolute path.
  3672. May not contain the path element '..'.
  3673. May not start with the string '..'.
  3674. type: string
  3675. required:
  3676. - key
  3677. - path
  3678. type: object
  3679. type: array
  3680. x-kubernetes-list-type: atomic
  3681. optional:
  3682. description: optional field specify whether the
  3683. Secret or its keys must be defined
  3684. type: boolean
  3685. secretName:
  3686. description: |-
  3687. secretName is the name of the secret in the pod's namespace to use.
  3688. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
  3689. type: string
  3690. type: object
  3691. storageos:
  3692. description: |-
  3693. storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
  3694. Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
  3695. properties:
  3696. fsType:
  3697. description: |-
  3698. fsType is the filesystem type to mount.
  3699. Must be a filesystem type supported by the host operating system.
  3700. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  3701. type: string
  3702. readOnly:
  3703. description: |-
  3704. readOnly defaults to false (read/write). ReadOnly here will force
  3705. the ReadOnly setting in VolumeMounts.
  3706. type: boolean
  3707. secretRef:
  3708. description: |-
  3709. secretRef specifies the secret to use for obtaining the StorageOS API
  3710. credentials. If not specified, default values will be attempted.
  3711. properties:
  3712. name:
  3713. default: ""
  3714. description: |-
  3715. Name of the referent.
  3716. This field is effectively required, but due to backwards compatibility is
  3717. allowed to be empty. Instances of this type with an empty value here are
  3718. almost certainly wrong.
  3719. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3720. type: string
  3721. type: object
  3722. x-kubernetes-map-type: atomic
  3723. volumeName:
  3724. description: |-
  3725. volumeName is the human-readable name of the StorageOS volume. Volume
  3726. names are only unique within a namespace.
  3727. type: string
  3728. volumeNamespace:
  3729. description: |-
  3730. volumeNamespace specifies the scope of the volume within StorageOS. If no
  3731. namespace is specified then the Pod's namespace will be used. This allows the
  3732. Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
  3733. Set VolumeName to any name to override the default behaviour.
  3734. Set to "default" if you are not using namespaces within StorageOS.
  3735. Namespaces that do not pre-exist within StorageOS will be created.
  3736. type: string
  3737. type: object
  3738. vsphereVolume:
  3739. description: |-
  3740. vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
  3741. Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
  3742. are redirected to the csi.vsphere.vmware.com CSI driver.
  3743. properties:
  3744. fsType:
  3745. description: |-
  3746. fsType is filesystem type to mount.
  3747. Must be a filesystem type supported by the host operating system.
  3748. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  3749. type: string
  3750. storagePolicyID:
  3751. description: storagePolicyID is the storage Policy
  3752. Based Management (SPBM) profile ID associated
  3753. with the StoragePolicyName.
  3754. type: string
  3755. storagePolicyName:
  3756. description: storagePolicyName is the storage Policy
  3757. Based Management (SPBM) profile name.
  3758. type: string
  3759. volumePath:
  3760. description: volumePath is the path that identifies
  3761. vSphere volume vmdk
  3762. type: string
  3763. required:
  3764. - volumePath
  3765. type: object
  3766. required:
  3767. - name
  3768. type: object
  3769. type: array
  3770. type: object
  3771. required:
  3772. - name
  3773. type: object
  3774. weights:
  3775. description: |-
  3776. weights specifies where to fetch the model weights from.
  3777. Exactly one source (huggingFace, url, pvc) must be set.
  3778. properties:
  3779. huggingFace:
  3780. description: |-
  3781. huggingFace pulls artifacts from HuggingFace Hub.
  3782. The operator creates a managed PVC and a one-off download Job.
  3783. properties:
  3784. endpoint:
  3785. description: |-
  3786. endpoint is the base URL for HuggingFace API requests.
  3787. Defaults to "https://huggingface.co" if not specified.
  3788. type: string
  3789. fileName:
  3790. description: fileName is the specific file to pull from the
  3791. repo (e.g. a single GGUF for llama.cpp).
  3792. type: string
  3793. repo:
  3794. description: |-
  3795. repo is the HuggingFace repository id (e.g. meta-llama/Llama-3.1-8B-Instruct).
  3796. Defaults from modelClassRef.baseModelId when omitted.
  3797. type: string
  3798. revision:
  3799. description: revision is the branch, tag, or commit to pull.
  3800. Defaults to "main".
  3801. type: string
  3802. tokenSecretRef:
  3803. description: |-
  3804. tokenSecretRef references a Secret key holding an HF token for gated or private repos.
  3805. Injected into the download Job only; inference pods do not receive the token.
  3806. properties:
  3807. key:
  3808. description: The key of the secret to select from. Must
  3809. be a valid secret key.
  3810. type: string
  3811. name:
  3812. default: ""
  3813. description: |-
  3814. Name of the referent.
  3815. This field is effectively required, but due to backwards compatibility is
  3816. allowed to be empty. Instances of this type with an empty value here are
  3817. almost certainly wrong.
  3818. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3819. type: string
  3820. optional:
  3821. description: Specify whether the Secret or its key must
  3822. be defined
  3823. type: boolean
  3824. required:
  3825. - key
  3826. type: object
  3827. x-kubernetes-map-type: atomic
  3828. required:
  3829. - repo
  3830. type: object
  3831. pvc:
  3832. description: |-
  3833. pvc mounts artifacts from a PersistentVolumeClaim.
  3834. The user is responsible for populating the volume before referencing it.
  3835. properties:
  3836. claimName:
  3837. description: claimName is the name of an existing PVC in the
  3838. same namespace.
  3839. type: string
  3840. filePath:
  3841. description: filePath is the path inside the PVC where the
  3842. artifact is located.
  3843. type: string
  3844. required:
  3845. - claimName
  3846. type: object
  3847. url:
  3848. description: |-
  3849. url downloads artifacts from an arbitrary HTTP/HTTPS URL.
  3850. The operator creates a managed PVC and a one-off download Job.
  3851. properties:
  3852. authSecretRef:
  3853. description: |-
  3854. authSecretRef references a Secret whose key-value pairs are injected as HTTP
  3855. request headers into the download Job. Not mounted in inference pods.
  3856. properties:
  3857. name:
  3858. default: ""
  3859. description: |-
  3860. Name of the referent.
  3861. This field is effectively required, but due to backwards compatibility is
  3862. allowed to be empty. Instances of this type with an empty value here are
  3863. almost certainly wrong.
  3864. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  3865. type: string
  3866. type: object
  3867. x-kubernetes-map-type: atomic
  3868. checksum:
  3869. description: 'checksum is the expected checksum of the downloaded
  3870. file (format: sha256:<hex>).'
  3871. type: string
  3872. fileName:
  3873. description: |-
  3874. fileName is the filename to write inside the PVC.
  3875. Defaults to the last path segment of the URL.
  3876. type: string
  3877. url:
  3878. description: url is the HTTP or HTTPS URL to download the
  3879. artifacts from.
  3880. type: string
  3881. required:
  3882. - url
  3883. type: object
  3884. type: object
  3885. required:
  3886. - category
  3887. - modelName
  3888. - weights
  3889. type: object
  3890. status:
  3891. description: status defines the observed state of ManagedModel
  3892. properties:
  3893. conditions:
  3894. description: |-
  3895. conditions represent the current state of the ManagedModel resource.
  3896. Each condition has a unique type and reflects the status of a specific aspect of the resource.
  3897. Standard condition types include:
  3898. - "Available": the resource is fully functional
  3899. - "Progressing": the resource is being created or updated
  3900. - "Degraded": the resource failed to reach or maintain its desired state
  3901. The status of each condition is one of True, False, or Unknown.
  3902. items:
  3903. description: Condition contains details for one aspect of the current
  3904. state of this API Resource.
  3905. properties:
  3906. lastTransitionTime:
  3907. description: |-
  3908. lastTransitionTime is the last time the condition transitioned from one status to another.
  3909. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
  3910. format: date-time
  3911. type: string
  3912. message:
  3913. description: |-
  3914. message is a human readable message indicating details about the transition.
  3915. This may be an empty string.
  3916. maxLength: 32768
  3917. type: string
  3918. observedGeneration:
  3919. description: |-
  3920. observedGeneration represents the .metadata.generation that the condition was set based upon.
  3921. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
  3922. with respect to the current state of the instance.
  3923. format: int64
  3924. minimum: 0
  3925. type: integer
  3926. reason:
  3927. description: |-
  3928. reason contains a programmatic identifier indicating the reason for the condition's last transition.
  3929. Producers of specific condition types may define expected values and meanings for this field,
  3930. and whether the values are considered a guaranteed API.
  3931. The value should be a CamelCase string.
  3932. This field may not be empty.
  3933. maxLength: 1024
  3934. minLength: 1
  3935. pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
  3936. type: string
  3937. status:
  3938. description: status of the condition, one of True, False, Unknown.
  3939. enum:
  3940. - "True"
  3941. - "False"
  3942. - Unknown
  3943. type: string
  3944. type:
  3945. description: type of condition in CamelCase or in foo.example.com/CamelCase.
  3946. maxLength: 316
  3947. 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])$
  3948. type: string
  3949. required:
  3950. - lastTransitionTime
  3951. - message
  3952. - reason
  3953. - status
  3954. - type
  3955. type: object
  3956. type: array
  3957. x-kubernetes-list-map-keys:
  3958. - type
  3959. x-kubernetes-list-type: map
  3960. endpoint:
  3961. description: endpoint is the URL where the model can be accessed for
  3962. inference requests.
  3963. type: string
  3964. observedGeneration:
  3965. description: observedGeneration is the .metadata.generation last reconciled.
  3966. format: int64
  3967. type: integer
  3968. type: object
  3969. required:
  3970. - spec
  3971. type: object
  3972. served: true
  3973. storage: true
  3974. subresources:
  3975. status: {}