locostack.com_agents.yaml 279 KB

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