generated.proto 155 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922
  1. /*
  2. Copyright 2017 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = 'proto2';
  15. package k8s.io.kubernetes.pkg.api.v1;
  16. import "k8s.io/apimachinery/pkg/api/resource/generated.proto";
  17. import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  18. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  19. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  20. import "k8s.io/apimachinery/pkg/util/intstr/generated.proto";
  21. import "k8s.io/apiserver/pkg/apis/example/v1/generated.proto";
  22. // Package-wide variables from generator "generated".
  23. option go_package = "v1";
  24. // Represents a Persistent Disk resource in AWS.
  25. //
  26. // An AWS EBS disk must exist before mounting to a container. The disk
  27. // must also be in the same AWS zone as the kubelet. An AWS EBS disk
  28. // can only be mounted as read/write once. AWS EBS volumes support
  29. // ownership management and SELinux relabeling.
  30. message AWSElasticBlockStoreVolumeSource {
  31. // Unique ID of the persistent disk resource in AWS (Amazon EBS volume).
  32. // More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
  33. optional string volumeID = 1;
  34. // Filesystem type of the volume that you want to mount.
  35. // Tip: Ensure that the filesystem type is supported by the host operating system.
  36. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  37. // More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
  38. // TODO: how do we prevent errors in the filesystem from compromising the machine
  39. // +optional
  40. optional string fsType = 2;
  41. // The partition in the volume that you want to mount.
  42. // If omitted, the default is to mount by volume name.
  43. // Examples: For volume /dev/sda1, you specify the partition as "1".
  44. // Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  45. // +optional
  46. optional int32 partition = 3;
  47. // Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
  48. // If omitted, the default is "false".
  49. // More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
  50. // +optional
  51. optional bool readOnly = 4;
  52. }
  53. // Affinity is a group of affinity scheduling rules.
  54. message Affinity {
  55. // Describes node affinity scheduling rules for the pod.
  56. // +optional
  57. optional NodeAffinity nodeAffinity = 1;
  58. // Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
  59. // +optional
  60. optional PodAffinity podAffinity = 2;
  61. // Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
  62. // +optional
  63. optional PodAntiAffinity podAntiAffinity = 3;
  64. }
  65. // AttachedVolume describes a volume attached to a node
  66. message AttachedVolume {
  67. // Name of the attached volume
  68. optional string name = 1;
  69. // DevicePath represents the device path where the volume should be available
  70. optional string devicePath = 2;
  71. }
  72. // AvoidPods describes pods that should avoid this node. This is the value for a
  73. // Node annotation with key scheduler.alpha.kubernetes.io/preferAvoidPods and
  74. // will eventually become a field of NodeStatus.
  75. message AvoidPods {
  76. // Bounded-sized list of signatures of pods that should avoid this node, sorted
  77. // in timestamp order from oldest to newest. Size of the slice is unspecified.
  78. // +optional
  79. repeated PreferAvoidPodsEntry preferAvoidPods = 1;
  80. }
  81. // AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  82. message AzureDiskVolumeSource {
  83. // The Name of the data disk in the blob storage
  84. optional string diskName = 1;
  85. // The URI the data disk in the blob storage
  86. optional string diskURI = 2;
  87. // Host Caching mode: None, Read Only, Read Write.
  88. // +optional
  89. optional string cachingMode = 3;
  90. // Filesystem type to mount.
  91. // Must be a filesystem type supported by the host operating system.
  92. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  93. // +optional
  94. optional string fsType = 4;
  95. // Defaults to false (read/write). ReadOnly here will force
  96. // the ReadOnly setting in VolumeMounts.
  97. // +optional
  98. optional bool readOnly = 5;
  99. }
  100. // AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  101. message AzureFileVolumeSource {
  102. // the name of secret that contains Azure Storage Account Name and Key
  103. optional string secretName = 1;
  104. // Share Name
  105. optional string shareName = 2;
  106. // Defaults to false (read/write). ReadOnly here will force
  107. // the ReadOnly setting in VolumeMounts.
  108. // +optional
  109. optional bool readOnly = 3;
  110. }
  111. // Binding ties one object to another.
  112. // For example, a pod is bound to a node by a scheduler.
  113. message Binding {
  114. // Standard object's metadata.
  115. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  116. // +optional
  117. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  118. // The target object that you want to bind to the standard object.
  119. optional ObjectReference target = 2;
  120. }
  121. // Adds and removes POSIX capabilities from running containers.
  122. message Capabilities {
  123. // Added capabilities
  124. // +optional
  125. repeated string add = 1;
  126. // Removed capabilities
  127. // +optional
  128. repeated string drop = 2;
  129. }
  130. // Represents a Ceph Filesystem mount that lasts the lifetime of a pod
  131. // Cephfs volumes do not support ownership management or SELinux relabeling.
  132. message CephFSVolumeSource {
  133. // Required: Monitors is a collection of Ceph monitors
  134. // More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
  135. repeated string monitors = 1;
  136. // Optional: Used as the mounted root, rather than the full Ceph tree, default is /
  137. // +optional
  138. optional string path = 2;
  139. // Optional: User is the rados user name, default is admin
  140. // More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
  141. // +optional
  142. optional string user = 3;
  143. // Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
  144. // More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
  145. // +optional
  146. optional string secretFile = 4;
  147. // Optional: SecretRef is reference to the authentication secret for User, default is empty.
  148. // More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
  149. // +optional
  150. optional LocalObjectReference secretRef = 5;
  151. // Optional: Defaults to false (read/write). ReadOnly here will force
  152. // the ReadOnly setting in VolumeMounts.
  153. // More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
  154. // +optional
  155. optional bool readOnly = 6;
  156. }
  157. // Represents a cinder volume resource in Openstack.
  158. // A Cinder volume must exist before mounting to a container.
  159. // The volume must also be in the same region as the kubelet.
  160. // Cinder volumes support ownership management and SELinux relabeling.
  161. message CinderVolumeSource {
  162. // volume id used to identify the volume in cinder
  163. // More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  164. optional string volumeID = 1;
  165. // Filesystem type to mount.
  166. // Must be a filesystem type supported by the host operating system.
  167. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  168. // More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  169. // +optional
  170. optional string fsType = 2;
  171. // Optional: Defaults to false (read/write). ReadOnly here will force
  172. // the ReadOnly setting in VolumeMounts.
  173. // More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  174. // +optional
  175. optional bool readOnly = 3;
  176. }
  177. // Information about the condition of a component.
  178. message ComponentCondition {
  179. // Type of condition for a component.
  180. // Valid value: "Healthy"
  181. optional string type = 1;
  182. // Status of the condition for a component.
  183. // Valid values for "Healthy": "True", "False", or "Unknown".
  184. optional string status = 2;
  185. // Message about the condition for a component.
  186. // For example, information about a health check.
  187. // +optional
  188. optional string message = 3;
  189. // Condition error code for a component.
  190. // For example, a health check error code.
  191. // +optional
  192. optional string error = 4;
  193. }
  194. // ComponentStatus (and ComponentStatusList) holds the cluster validation info.
  195. message ComponentStatus {
  196. // Standard object's metadata.
  197. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  198. // +optional
  199. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  200. // List of component conditions observed
  201. // +optional
  202. repeated ComponentCondition conditions = 2;
  203. }
  204. // Status of all the conditions for the component as a list of ComponentStatus objects.
  205. message ComponentStatusList {
  206. // Standard list metadata.
  207. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  208. // +optional
  209. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  210. // List of ComponentStatus objects.
  211. repeated ComponentStatus items = 2;
  212. }
  213. // ConfigMap holds configuration data for pods to consume.
  214. message ConfigMap {
  215. // Standard object's metadata.
  216. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  217. // +optional
  218. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  219. // Data contains the configuration data.
  220. // Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
  221. // +optional
  222. map<string, string> data = 2;
  223. }
  224. // ConfigMapEnvSource selects a ConfigMap to populate the environment
  225. // variables with.
  226. //
  227. // The contents of the target ConfigMap's Data field will represent the
  228. // key-value pairs as environment variables.
  229. message ConfigMapEnvSource {
  230. // The ConfigMap to select from.
  231. optional LocalObjectReference localObjectReference = 1;
  232. // Specify whether the ConfigMap must be defined
  233. // +optional
  234. optional bool optional = 2;
  235. }
  236. // Selects a key from a ConfigMap.
  237. message ConfigMapKeySelector {
  238. // The ConfigMap to select from.
  239. optional LocalObjectReference localObjectReference = 1;
  240. // The key to select.
  241. optional string key = 2;
  242. // Specify whether the ConfigMap or it's key must be defined
  243. // +optional
  244. optional bool optional = 3;
  245. }
  246. // ConfigMapList is a resource containing a list of ConfigMap objects.
  247. message ConfigMapList {
  248. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  249. // +optional
  250. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  251. // Items is the list of ConfigMaps.
  252. repeated ConfigMap items = 2;
  253. }
  254. // Adapts a ConfigMap into a projected volume.
  255. //
  256. // The contents of the target ConfigMap's Data field will be presented in a
  257. // projected volume as files using the keys in the Data field as the file names,
  258. // unless the items element is populated with specific mappings of keys to paths.
  259. // Note that this is identical to a configmap volume source without the default
  260. // mode.
  261. message ConfigMapProjection {
  262. optional LocalObjectReference localObjectReference = 1;
  263. // If unspecified, each key-value pair in the Data field of the referenced
  264. // ConfigMap will be projected into the volume as a file whose name is the
  265. // key and content is the value. If specified, the listed keys will be
  266. // projected into the specified paths, and unlisted keys will not be
  267. // present. If a key is specified which is not present in the ConfigMap,
  268. // the volume setup will error unless it is marked optional. Paths must be
  269. // relative and may not contain the '..' path or start with '..'.
  270. // +optional
  271. repeated KeyToPath items = 2;
  272. // Specify whether the ConfigMap or it's keys must be defined
  273. // +optional
  274. optional bool optional = 4;
  275. }
  276. // Adapts a ConfigMap into a volume.
  277. //
  278. // The contents of the target ConfigMap's Data field will be presented in a
  279. // volume as files using the keys in the Data field as the file names, unless
  280. // the items element is populated with specific mappings of keys to paths.
  281. // ConfigMap volumes support ownership management and SELinux relabeling.
  282. message ConfigMapVolumeSource {
  283. optional LocalObjectReference localObjectReference = 1;
  284. // If unspecified, each key-value pair in the Data field of the referenced
  285. // ConfigMap will be projected into the volume as a file whose name is the
  286. // key and content is the value. If specified, the listed keys will be
  287. // projected into the specified paths, and unlisted keys will not be
  288. // present. If a key is specified which is not present in the ConfigMap,
  289. // the volume setup will error unless it is marked optional. Paths must be
  290. // relative and may not contain the '..' path or start with '..'.
  291. // +optional
  292. repeated KeyToPath items = 2;
  293. // Optional: mode bits to use on created files by default. Must be a
  294. // value between 0 and 0777. Defaults to 0644.
  295. // Directories within the path are not affected by this setting.
  296. // This might be in conflict with other options that affect the file
  297. // mode, like fsGroup, and the result can be other mode bits set.
  298. // +optional
  299. optional int32 defaultMode = 3;
  300. // Specify whether the ConfigMap or it's keys must be defined
  301. // +optional
  302. optional bool optional = 4;
  303. }
  304. // A single application container that you want to run within a pod.
  305. message Container {
  306. // Name of the container specified as a DNS_LABEL.
  307. // Each container in a pod must have a unique name (DNS_LABEL).
  308. // Cannot be updated.
  309. optional string name = 1;
  310. // Docker image name.
  311. // More info: http://kubernetes.io/docs/user-guide/images
  312. // +optional
  313. optional string image = 2;
  314. // Entrypoint array. Not executed within a shell.
  315. // The docker image's ENTRYPOINT is used if this is not provided.
  316. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  317. // cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
  318. // can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
  319. // regardless of whether the variable exists or not.
  320. // Cannot be updated.
  321. // More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
  322. // +optional
  323. repeated string command = 3;
  324. // Arguments to the entrypoint.
  325. // The docker image's CMD is used if this is not provided.
  326. // Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
  327. // cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
  328. // can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
  329. // regardless of whether the variable exists or not.
  330. // Cannot be updated.
  331. // More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
  332. // +optional
  333. repeated string args = 4;
  334. // Container's working directory.
  335. // If not specified, the container runtime's default will be used, which
  336. // might be configured in the container image.
  337. // Cannot be updated.
  338. // +optional
  339. optional string workingDir = 5;
  340. // List of ports to expose from the container. Exposing a port here gives
  341. // the system additional information about the network connections a
  342. // container uses, but is primarily informational. Not specifying a port here
  343. // DOES NOT prevent that port from being exposed. Any port which is
  344. // listening on the default "0.0.0.0" address inside a container will be
  345. // accessible from the network.
  346. // Cannot be updated.
  347. // +optional
  348. repeated ContainerPort ports = 6;
  349. // List of sources to populate environment variables in the container.
  350. // The keys defined within a source must be a C_IDENTIFIER. All invalid keys
  351. // will be reported as an event when the container is starting. When a key exists in multiple
  352. // sources, the value associated with the last source will take precedence.
  353. // Values defined by an Env with a duplicate key will take precedence.
  354. // Cannot be updated.
  355. // +optional
  356. repeated EnvFromSource envFrom = 19;
  357. // List of environment variables to set in the container.
  358. // Cannot be updated.
  359. // +optional
  360. repeated EnvVar env = 7;
  361. // Compute Resources required by this container.
  362. // Cannot be updated.
  363. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
  364. // +optional
  365. optional ResourceRequirements resources = 8;
  366. // Pod volumes to mount into the container's filesystem.
  367. // Cannot be updated.
  368. // +optional
  369. repeated VolumeMount volumeMounts = 9;
  370. // Periodic probe of container liveness.
  371. // Container will be restarted if the probe fails.
  372. // Cannot be updated.
  373. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  374. // +optional
  375. optional Probe livenessProbe = 10;
  376. // Periodic probe of container service readiness.
  377. // Container will be removed from service endpoints if the probe fails.
  378. // Cannot be updated.
  379. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  380. // +optional
  381. optional Probe readinessProbe = 11;
  382. // Actions that the management system should take in response to container lifecycle events.
  383. // Cannot be updated.
  384. // +optional
  385. optional Lifecycle lifecycle = 12;
  386. // Optional: Path at which the file to which the container's termination message
  387. // will be written is mounted into the container's filesystem.
  388. // Message written is intended to be brief final status, such as an assertion failure message.
  389. // Will be truncated by the node if greater than 4096 bytes. The total message length across
  390. // all containers will be limited to 12kb.
  391. // Defaults to /dev/termination-log.
  392. // Cannot be updated.
  393. // +optional
  394. optional string terminationMessagePath = 13;
  395. // Indicate how the termination message should be populated. File will use the contents of
  396. // terminationMessagePath to populate the container status message on both success and failure.
  397. // FallbackToLogsOnError will use the last chunk of container log output if the termination
  398. // message file is empty and the container exited with an error.
  399. // The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
  400. // Defaults to File.
  401. // Cannot be updated.
  402. // +optional
  403. optional string terminationMessagePolicy = 20;
  404. // Image pull policy.
  405. // One of Always, Never, IfNotPresent.
  406. // Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
  407. // Cannot be updated.
  408. // More info: http://kubernetes.io/docs/user-guide/images#updating-images
  409. // +optional
  410. optional string imagePullPolicy = 14;
  411. // Security options the pod should run with.
  412. // More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
  413. // +optional
  414. optional SecurityContext securityContext = 15;
  415. // Whether this container should allocate a buffer for stdin in the container runtime. If this
  416. // is not set, reads from stdin in the container will always result in EOF.
  417. // Default is false.
  418. // +optional
  419. optional bool stdin = 16;
  420. // Whether the container runtime should close the stdin channel after it has been opened by
  421. // a single attach. When stdin is true the stdin stream will remain open across multiple attach
  422. // sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
  423. // first client attaches to stdin, and then remains open and accepts data until the client disconnects,
  424. // at which time stdin is closed and remains closed until the container is restarted. If this
  425. // flag is false, a container processes that reads from stdin will never receive an EOF.
  426. // Default is false
  427. // +optional
  428. optional bool stdinOnce = 17;
  429. // Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
  430. // Default is false.
  431. // +optional
  432. optional bool tty = 18;
  433. }
  434. // Describe a container image
  435. message ContainerImage {
  436. // Names by which this image is known.
  437. // e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
  438. repeated string names = 1;
  439. // The size of the image in bytes.
  440. // +optional
  441. optional int64 sizeBytes = 2;
  442. }
  443. // ContainerPort represents a network port in a single container.
  444. message ContainerPort {
  445. // If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
  446. // named port in a pod must have a unique name. Name for the port that can be
  447. // referred to by services.
  448. // +optional
  449. optional string name = 1;
  450. // Number of port to expose on the host.
  451. // If specified, this must be a valid port number, 0 < x < 65536.
  452. // If HostNetwork is specified, this must match ContainerPort.
  453. // Most containers do not need this.
  454. // +optional
  455. optional int32 hostPort = 2;
  456. // Number of port to expose on the pod's IP address.
  457. // This must be a valid port number, 0 < x < 65536.
  458. optional int32 containerPort = 3;
  459. // Protocol for port. Must be UDP or TCP.
  460. // Defaults to "TCP".
  461. // +optional
  462. optional string protocol = 4;
  463. // What host IP to bind the external port to.
  464. // +optional
  465. optional string hostIP = 5;
  466. }
  467. // ContainerState holds a possible state of container.
  468. // Only one of its members may be specified.
  469. // If none of them is specified, the default one is ContainerStateWaiting.
  470. message ContainerState {
  471. // Details about a waiting container
  472. // +optional
  473. optional ContainerStateWaiting waiting = 1;
  474. // Details about a running container
  475. // +optional
  476. optional ContainerStateRunning running = 2;
  477. // Details about a terminated container
  478. // +optional
  479. optional ContainerStateTerminated terminated = 3;
  480. }
  481. // ContainerStateRunning is a running state of a container.
  482. message ContainerStateRunning {
  483. // Time at which the container was last (re-)started
  484. // +optional
  485. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startedAt = 1;
  486. }
  487. // ContainerStateTerminated is a terminated state of a container.
  488. message ContainerStateTerminated {
  489. // Exit status from the last termination of the container
  490. optional int32 exitCode = 1;
  491. // Signal from the last termination of the container
  492. // +optional
  493. optional int32 signal = 2;
  494. // (brief) reason from the last termination of the container
  495. // +optional
  496. optional string reason = 3;
  497. // Message regarding the last termination of the container
  498. // +optional
  499. optional string message = 4;
  500. // Time at which previous execution of the container started
  501. // +optional
  502. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startedAt = 5;
  503. // Time at which the container last terminated
  504. // +optional
  505. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time finishedAt = 6;
  506. // Container's ID in the format 'docker://<container_id>'
  507. // +optional
  508. optional string containerID = 7;
  509. }
  510. // ContainerStateWaiting is a waiting state of a container.
  511. message ContainerStateWaiting {
  512. // (brief) reason the container is not yet running.
  513. // +optional
  514. optional string reason = 1;
  515. // Message regarding why the container is not yet running.
  516. // +optional
  517. optional string message = 2;
  518. }
  519. // ContainerStatus contains details for the current status of this container.
  520. message ContainerStatus {
  521. // This must be a DNS_LABEL. Each container in a pod must have a unique name.
  522. // Cannot be updated.
  523. optional string name = 1;
  524. // Details about the container's current condition.
  525. // +optional
  526. optional ContainerState state = 2;
  527. // Details about the container's last termination condition.
  528. // +optional
  529. optional ContainerState lastState = 3;
  530. // Specifies whether the container has passed its readiness probe.
  531. optional bool ready = 4;
  532. // The number of times the container has been restarted, currently based on
  533. // the number of dead containers that have not yet been removed.
  534. // Note that this is calculated from dead containers. But those containers are subject to
  535. // garbage collection. This value will get capped at 5 by GC.
  536. optional int32 restartCount = 5;
  537. // The image the container is running.
  538. // More info: http://kubernetes.io/docs/user-guide/images
  539. // TODO(dchen1107): Which image the container is running with?
  540. optional string image = 6;
  541. // ImageID of the container's image.
  542. optional string imageID = 7;
  543. // Container's ID in the format 'docker://<container_id>'.
  544. // More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
  545. // +optional
  546. optional string containerID = 8;
  547. }
  548. // DaemonEndpoint contains information about a single Daemon endpoint.
  549. message DaemonEndpoint {
  550. // Port number of the given endpoint.
  551. optional int32 Port = 1;
  552. }
  553. // DeleteOptions may be provided when deleting an API object
  554. // DEPRECATED: This type has been moved to meta/v1 and will be removed soon.
  555. // +k8s:openapi-gen=false
  556. message DeleteOptions {
  557. // The duration in seconds before the object should be deleted. Value must be non-negative integer.
  558. // The value zero indicates delete immediately. If this value is nil, the default grace period for the
  559. // specified type will be used.
  560. // Defaults to a per object value if not specified. zero means delete immediately.
  561. // +optional
  562. optional int64 gracePeriodSeconds = 1;
  563. // Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
  564. // returned.
  565. // +optional
  566. optional Preconditions preconditions = 2;
  567. // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
  568. // Should the dependent objects be orphaned. If true/false, the "orphan"
  569. // finalizer will be added to/removed from the object's finalizers list.
  570. // Either this field or PropagationPolicy may be set, but not both.
  571. // +optional
  572. optional bool orphanDependents = 3;
  573. // Whether and how garbage collection will be performed.
  574. // Either this field or OrphanDependents may be set, but not both.
  575. // The default policy is decided by the existing finalizer set in the
  576. // metadata.finalizers and the resource-specific default policy.
  577. // +optional
  578. optional string propagationPolicy = 4;
  579. }
  580. // Represents downward API info for projecting into a projected volume.
  581. // Note that this is identical to a downwardAPI volume source without the default
  582. // mode.
  583. message DownwardAPIProjection {
  584. // Items is a list of DownwardAPIVolume file
  585. // +optional
  586. repeated DownwardAPIVolumeFile items = 1;
  587. }
  588. // DownwardAPIVolumeFile represents information to create the file containing the pod field
  589. message DownwardAPIVolumeFile {
  590. // Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
  591. optional string path = 1;
  592. // Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
  593. // +optional
  594. optional ObjectFieldSelector fieldRef = 2;
  595. // Selects a resource of the container: only resources limits and requests
  596. // (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
  597. // +optional
  598. optional ResourceFieldSelector resourceFieldRef = 3;
  599. // Optional: mode bits to use on this file, must be a value between 0
  600. // and 0777. If not specified, the volume defaultMode will be used.
  601. // This might be in conflict with other options that affect the file
  602. // mode, like fsGroup, and the result can be other mode bits set.
  603. // +optional
  604. optional int32 mode = 4;
  605. }
  606. // DownwardAPIVolumeSource represents a volume containing downward API info.
  607. // Downward API volumes support ownership management and SELinux relabeling.
  608. message DownwardAPIVolumeSource {
  609. // Items is a list of downward API volume file
  610. // +optional
  611. repeated DownwardAPIVolumeFile items = 1;
  612. // Optional: mode bits to use on created files by default. Must be a
  613. // value between 0 and 0777. Defaults to 0644.
  614. // Directories within the path are not affected by this setting.
  615. // This might be in conflict with other options that affect the file
  616. // mode, like fsGroup, and the result can be other mode bits set.
  617. // +optional
  618. optional int32 defaultMode = 2;
  619. }
  620. // Represents an empty directory for a pod.
  621. // Empty directory volumes support ownership management and SELinux relabeling.
  622. message EmptyDirVolumeSource {
  623. // What type of storage medium should back this directory.
  624. // The default is "" which means to use the node's default medium.
  625. // Must be an empty string (default) or Memory.
  626. // More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
  627. // +optional
  628. optional string medium = 1;
  629. }
  630. // EndpointAddress is a tuple that describes single IP address.
  631. message EndpointAddress {
  632. // The IP of this endpoint.
  633. // May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16),
  634. // or link-local multicast ((224.0.0.0/24).
  635. // IPv6 is also accepted but not fully supported on all platforms. Also, certain
  636. // kubernetes components, like kube-proxy, are not IPv6 ready.
  637. // TODO: This should allow hostname or IP, See #4447.
  638. optional string ip = 1;
  639. // The Hostname of this endpoint
  640. // +optional
  641. optional string hostname = 3;
  642. // Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
  643. // +optional
  644. optional string nodeName = 4;
  645. // Reference to object providing the endpoint.
  646. // +optional
  647. optional ObjectReference targetRef = 2;
  648. }
  649. // EndpointPort is a tuple that describes a single port.
  650. message EndpointPort {
  651. // The name of this port (corresponds to ServicePort.Name).
  652. // Must be a DNS_LABEL.
  653. // Optional only if one port is defined.
  654. // +optional
  655. optional string name = 1;
  656. // The port number of the endpoint.
  657. optional int32 port = 2;
  658. // The IP protocol for this port.
  659. // Must be UDP or TCP.
  660. // Default is TCP.
  661. // +optional
  662. optional string protocol = 3;
  663. }
  664. // EndpointSubset is a group of addresses with a common set of ports. The
  665. // expanded set of endpoints is the Cartesian product of Addresses x Ports.
  666. // For example, given:
  667. // {
  668. // Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  669. // Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  670. // }
  671. // The resulting set of endpoints can be viewed as:
  672. // a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
  673. // b: [ 10.10.1.1:309, 10.10.2.2:309 ]
  674. message EndpointSubset {
  675. // IP addresses which offer the related ports that are marked as ready. These endpoints
  676. // should be considered safe for load balancers and clients to utilize.
  677. // +optional
  678. repeated EndpointAddress addresses = 1;
  679. // IP addresses which offer the related ports but are not currently marked as ready
  680. // because they have not yet finished starting, have recently failed a readiness check,
  681. // or have recently failed a liveness check.
  682. // +optional
  683. repeated EndpointAddress notReadyAddresses = 2;
  684. // Port numbers available on the related IP addresses.
  685. // +optional
  686. repeated EndpointPort ports = 3;
  687. }
  688. // Endpoints is a collection of endpoints that implement the actual service. Example:
  689. // Name: "mysvc",
  690. // Subsets: [
  691. // {
  692. // Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  693. // Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
  694. // },
  695. // {
  696. // Addresses: [{"ip": "10.10.3.3"}],
  697. // Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
  698. // },
  699. // ]
  700. message Endpoints {
  701. // Standard object's metadata.
  702. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  703. // +optional
  704. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  705. // The set of all endpoints is the union of all subsets. Addresses are placed into
  706. // subsets according to the IPs they share. A single address with multiple ports,
  707. // some of which are ready and some of which are not (because they come from
  708. // different containers) will result in the address being displayed in different
  709. // subsets for the different ports. No address will appear in both Addresses and
  710. // NotReadyAddresses in the same subset.
  711. // Sets of addresses and ports that comprise a service.
  712. repeated EndpointSubset subsets = 2;
  713. }
  714. // EndpointsList is a list of endpoints.
  715. message EndpointsList {
  716. // Standard list metadata.
  717. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  718. // +optional
  719. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  720. // List of endpoints.
  721. repeated Endpoints items = 2;
  722. }
  723. // EnvFromSource represents the source of a set of ConfigMaps
  724. message EnvFromSource {
  725. // An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
  726. // +optional
  727. optional string prefix = 1;
  728. // The ConfigMap to select from
  729. // +optional
  730. optional ConfigMapEnvSource configMapRef = 2;
  731. // The Secret to select from
  732. // +optional
  733. optional SecretEnvSource secretRef = 3;
  734. }
  735. // EnvVar represents an environment variable present in a Container.
  736. message EnvVar {
  737. // Name of the environment variable. Must be a C_IDENTIFIER.
  738. optional string name = 1;
  739. // Variable references $(VAR_NAME) are expanded
  740. // using the previous defined environment variables in the container and
  741. // any service environment variables. If a variable cannot be resolved,
  742. // the reference in the input string will be unchanged. The $(VAR_NAME)
  743. // syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped
  744. // references will never be expanded, regardless of whether the variable
  745. // exists or not.
  746. // Defaults to "".
  747. // +optional
  748. optional string value = 2;
  749. // Source for the environment variable's value. Cannot be used if value is not empty.
  750. // +optional
  751. optional EnvVarSource valueFrom = 3;
  752. }
  753. // EnvVarSource represents a source for the value of an EnvVar.
  754. message EnvVarSource {
  755. // Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations,
  756. // spec.nodeName, spec.serviceAccountName, status.podIP.
  757. // +optional
  758. optional ObjectFieldSelector fieldRef = 1;
  759. // Selects a resource of the container: only resources limits and requests
  760. // (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
  761. // +optional
  762. optional ResourceFieldSelector resourceFieldRef = 2;
  763. // Selects a key of a ConfigMap.
  764. // +optional
  765. optional ConfigMapKeySelector configMapKeyRef = 3;
  766. // Selects a key of a secret in the pod's namespace
  767. // +optional
  768. optional SecretKeySelector secretKeyRef = 4;
  769. }
  770. // Event is a report of an event somewhere in the cluster.
  771. // TODO: Decide whether to store these separately or with the object they apply to.
  772. message Event {
  773. // Standard object's metadata.
  774. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  775. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  776. // The object that this event is about.
  777. optional ObjectReference involvedObject = 2;
  778. // This should be a short, machine understandable string that gives the reason
  779. // for the transition into the object's current status.
  780. // TODO: provide exact specification for format.
  781. // +optional
  782. optional string reason = 3;
  783. // A human-readable description of the status of this operation.
  784. // TODO: decide on maximum length.
  785. // +optional
  786. optional string message = 4;
  787. // The component reporting this event. Should be a short machine understandable string.
  788. // +optional
  789. optional EventSource source = 5;
  790. // The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
  791. // +optional
  792. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time firstTimestamp = 6;
  793. // The time at which the most recent occurrence of this event was recorded.
  794. // +optional
  795. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTimestamp = 7;
  796. // The number of times this event has occurred.
  797. // +optional
  798. optional int32 count = 8;
  799. // Type of this event (Normal, Warning), new types could be added in the future
  800. // +optional
  801. optional string type = 9;
  802. }
  803. // EventList is a list of events.
  804. message EventList {
  805. // Standard list metadata.
  806. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  807. // +optional
  808. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  809. // List of events
  810. repeated Event items = 2;
  811. }
  812. // EventSource contains information for an event.
  813. message EventSource {
  814. // Component from which the event is generated.
  815. // +optional
  816. optional string component = 1;
  817. // Node name on which the event is generated.
  818. // +optional
  819. optional string host = 2;
  820. }
  821. // ExecAction describes a "run in container" action.
  822. message ExecAction {
  823. // Command is the command line to execute inside the container, the working directory for the
  824. // command is root ('/') in the container's filesystem. The command is simply exec'd, it is
  825. // not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use
  826. // a shell, you need to explicitly call out to that shell.
  827. // Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
  828. // +optional
  829. repeated string command = 1;
  830. }
  831. // Represents a Fibre Channel volume.
  832. // Fibre Channel volumes can only be mounted as read/write once.
  833. // Fibre Channel volumes support ownership management and SELinux relabeling.
  834. message FCVolumeSource {
  835. // Required: FC target worldwide names (WWNs)
  836. repeated string targetWWNs = 1;
  837. // Required: FC target lun number
  838. optional int32 lun = 2;
  839. // Filesystem type to mount.
  840. // Must be a filesystem type supported by the host operating system.
  841. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  842. // TODO: how do we prevent errors in the filesystem from compromising the machine
  843. // +optional
  844. optional string fsType = 3;
  845. // Optional: Defaults to false (read/write). ReadOnly here will force
  846. // the ReadOnly setting in VolumeMounts.
  847. // +optional
  848. optional bool readOnly = 4;
  849. }
  850. // FlexVolume represents a generic volume resource that is
  851. // provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
  852. message FlexVolumeSource {
  853. // Driver is the name of the driver to use for this volume.
  854. optional string driver = 1;
  855. // Filesystem type to mount.
  856. // Must be a filesystem type supported by the host operating system.
  857. // Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  858. // +optional
  859. optional string fsType = 2;
  860. // Optional: SecretRef is reference to the secret object containing
  861. // sensitive information to pass to the plugin scripts. This may be
  862. // empty if no secret object is specified. If the secret object
  863. // contains more than one secret, all secrets are passed to the plugin
  864. // scripts.
  865. // +optional
  866. optional LocalObjectReference secretRef = 3;
  867. // Optional: Defaults to false (read/write). ReadOnly here will force
  868. // the ReadOnly setting in VolumeMounts.
  869. // +optional
  870. optional bool readOnly = 4;
  871. // Optional: Extra command options if any.
  872. // +optional
  873. map<string, string> options = 5;
  874. }
  875. // Represents a Flocker volume mounted by the Flocker agent.
  876. // One and only one of datasetName and datasetUUID should be set.
  877. // Flocker volumes do not support ownership management or SELinux relabeling.
  878. message FlockerVolumeSource {
  879. // Name of the dataset stored as metadata -> name on the dataset for Flocker
  880. // should be considered as deprecated
  881. // +optional
  882. optional string datasetName = 1;
  883. // UUID of the dataset. This is unique identifier of a Flocker dataset
  884. // +optional
  885. optional string datasetUUID = 2;
  886. }
  887. // Represents a Persistent Disk resource in Google Compute Engine.
  888. //
  889. // A GCE PD must exist before mounting to a container. The disk must
  890. // also be in the same GCE project and zone as the kubelet. A GCE PD
  891. // can only be mounted as read/write once or read-only many times. GCE
  892. // PDs support ownership management and SELinux relabeling.
  893. message GCEPersistentDiskVolumeSource {
  894. // Unique name of the PD resource in GCE. Used to identify the disk in GCE.
  895. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  896. optional string pdName = 1;
  897. // Filesystem type of the volume that you want to mount.
  898. // Tip: Ensure that the filesystem type is supported by the host operating system.
  899. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  900. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  901. // TODO: how do we prevent errors in the filesystem from compromising the machine
  902. // +optional
  903. optional string fsType = 2;
  904. // The partition in the volume that you want to mount.
  905. // If omitted, the default is to mount by volume name.
  906. // Examples: For volume /dev/sda1, you specify the partition as "1".
  907. // Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
  908. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  909. // +optional
  910. optional int32 partition = 3;
  911. // ReadOnly here will force the ReadOnly setting in VolumeMounts.
  912. // Defaults to false.
  913. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  914. // +optional
  915. optional bool readOnly = 4;
  916. }
  917. // Represents a volume that is populated with the contents of a git repository.
  918. // Git repo volumes do not support ownership management.
  919. // Git repo volumes support SELinux relabeling.
  920. message GitRepoVolumeSource {
  921. // Repository URL
  922. optional string repository = 1;
  923. // Commit hash for the specified revision.
  924. // +optional
  925. optional string revision = 2;
  926. // Target directory name.
  927. // Must not contain or start with '..'. If '.' is supplied, the volume directory will be the
  928. // git repository. Otherwise, if specified, the volume will contain the git repository in
  929. // the subdirectory with the given name.
  930. // +optional
  931. optional string directory = 3;
  932. }
  933. // Represents a Glusterfs mount that lasts the lifetime of a pod.
  934. // Glusterfs volumes do not support ownership management or SELinux relabeling.
  935. message GlusterfsVolumeSource {
  936. // EndpointsName is the endpoint name that details Glusterfs topology.
  937. // More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
  938. optional string endpoints = 1;
  939. // Path is the Glusterfs volume path.
  940. // More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
  941. optional string path = 2;
  942. // ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.
  943. // Defaults to false.
  944. // More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
  945. // +optional
  946. optional bool readOnly = 3;
  947. }
  948. // HTTPGetAction describes an action based on HTTP Get requests.
  949. message HTTPGetAction {
  950. // Path to access on the HTTP server.
  951. // +optional
  952. optional string path = 1;
  953. // Name or number of the port to access on the container.
  954. // Number must be in the range 1 to 65535.
  955. // Name must be an IANA_SVC_NAME.
  956. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2;
  957. // Host name to connect to, defaults to the pod IP. You probably want to set
  958. // "Host" in httpHeaders instead.
  959. // +optional
  960. optional string host = 3;
  961. // Scheme to use for connecting to the host.
  962. // Defaults to HTTP.
  963. // +optional
  964. optional string scheme = 4;
  965. // Custom headers to set in the request. HTTP allows repeated headers.
  966. // +optional
  967. repeated HTTPHeader httpHeaders = 5;
  968. }
  969. // HTTPHeader describes a custom header to be used in HTTP probes
  970. message HTTPHeader {
  971. // The header field name
  972. optional string name = 1;
  973. // The header field value
  974. optional string value = 2;
  975. }
  976. // Handler defines a specific action that should be taken
  977. // TODO: pass structured data to these actions, and document that data here.
  978. message Handler {
  979. // One and only one of the following should be specified.
  980. // Exec specifies the action to take.
  981. // +optional
  982. optional ExecAction exec = 1;
  983. // HTTPGet specifies the http request to perform.
  984. // +optional
  985. optional HTTPGetAction httpGet = 2;
  986. // TCPSocket specifies an action involving a TCP port.
  987. // TCP hooks not yet supported
  988. // TODO: implement a realistic TCP lifecycle hook
  989. // +optional
  990. optional TCPSocketAction tcpSocket = 3;
  991. }
  992. // Represents a host path mapped into a pod.
  993. // Host path volumes do not support ownership management or SELinux relabeling.
  994. message HostPathVolumeSource {
  995. // Path of the directory on the host.
  996. // More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
  997. optional string path = 1;
  998. }
  999. // Represents an ISCSI disk.
  1000. // ISCSI volumes can only be mounted as read/write once.
  1001. // ISCSI volumes support ownership management and SELinux relabeling.
  1002. message ISCSIVolumeSource {
  1003. // iSCSI target portal. The portal is either an IP or ip_addr:port if the port
  1004. // is other than default (typically TCP ports 860 and 3260).
  1005. optional string targetPortal = 1;
  1006. // Target iSCSI Qualified Name.
  1007. optional string iqn = 2;
  1008. // iSCSI target lun number.
  1009. optional int32 lun = 3;
  1010. // Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport.
  1011. // +optional
  1012. optional string iscsiInterface = 4;
  1013. // Filesystem type of the volume that you want to mount.
  1014. // Tip: Ensure that the filesystem type is supported by the host operating system.
  1015. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1016. // More info: http://kubernetes.io/docs/user-guide/volumes#iscsi
  1017. // TODO: how do we prevent errors in the filesystem from compromising the machine
  1018. // +optional
  1019. optional string fsType = 5;
  1020. // ReadOnly here will force the ReadOnly setting in VolumeMounts.
  1021. // Defaults to false.
  1022. // +optional
  1023. optional bool readOnly = 6;
  1024. // iSCSI target portal List. The portal is either an IP or ip_addr:port if the port
  1025. // is other than default (typically TCP ports 860 and 3260).
  1026. // +optional
  1027. repeated string portals = 7;
  1028. }
  1029. // Maps a string key to a path within a volume.
  1030. message KeyToPath {
  1031. // The key to project.
  1032. optional string key = 1;
  1033. // The relative path of the file to map the key to.
  1034. // May not be an absolute path.
  1035. // May not contain the path element '..'.
  1036. // May not start with the string '..'.
  1037. optional string path = 2;
  1038. // Optional: mode bits to use on this file, must be a value between 0
  1039. // and 0777. If not specified, the volume defaultMode will be used.
  1040. // This might be in conflict with other options that affect the file
  1041. // mode, like fsGroup, and the result can be other mode bits set.
  1042. // +optional
  1043. optional int32 mode = 3;
  1044. }
  1045. // Lifecycle describes actions that the management system should take in response to container lifecycle
  1046. // events. For the PostStart and PreStop lifecycle handlers, management of the container blocks
  1047. // until the action is complete, unless the container process fails, in which case the handler is aborted.
  1048. message Lifecycle {
  1049. // PostStart is called immediately after a container is created. If the handler fails,
  1050. // the container is terminated and restarted according to its restart policy.
  1051. // Other management of the container blocks until the hook completes.
  1052. // More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details
  1053. // +optional
  1054. optional Handler postStart = 1;
  1055. // PreStop is called immediately before a container is terminated.
  1056. // The container is terminated after the handler completes.
  1057. // The reason for termination is passed to the handler.
  1058. // Regardless of the outcome of the handler, the container is eventually terminated.
  1059. // Other management of the container blocks until the hook completes.
  1060. // More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details
  1061. // +optional
  1062. optional Handler preStop = 2;
  1063. }
  1064. // LimitRange sets resource usage limits for each kind of resource in a Namespace.
  1065. message LimitRange {
  1066. // Standard object's metadata.
  1067. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1068. // +optional
  1069. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1070. // Spec defines the limits enforced.
  1071. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1072. // +optional
  1073. optional LimitRangeSpec spec = 2;
  1074. }
  1075. // LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
  1076. message LimitRangeItem {
  1077. // Type of resource that this limit applies to.
  1078. // +optional
  1079. optional string type = 1;
  1080. // Max usage constraints on this kind by resource name.
  1081. // +optional
  1082. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> max = 2;
  1083. // Min usage constraints on this kind by resource name.
  1084. // +optional
  1085. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> min = 3;
  1086. // Default resource requirement limit value by resource name if resource limit is omitted.
  1087. // +optional
  1088. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> default = 4;
  1089. // DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
  1090. // +optional
  1091. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> defaultRequest = 5;
  1092. // MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
  1093. // +optional
  1094. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> maxLimitRequestRatio = 6;
  1095. }
  1096. // LimitRangeList is a list of LimitRange items.
  1097. message LimitRangeList {
  1098. // Standard list metadata.
  1099. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1100. // +optional
  1101. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1102. // Items is a list of LimitRange objects.
  1103. // More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md
  1104. repeated LimitRange items = 2;
  1105. }
  1106. // LimitRangeSpec defines a min/max usage limit for resources that match on kind.
  1107. message LimitRangeSpec {
  1108. // Limits is the list of LimitRangeItem objects that are enforced.
  1109. repeated LimitRangeItem limits = 1;
  1110. }
  1111. // List holds a list of objects, which may not be known by the server.
  1112. message List {
  1113. // Standard list metadata.
  1114. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1115. // +optional
  1116. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1117. // List of objects
  1118. repeated k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
  1119. }
  1120. // ListOptions is the query options to a standard REST list call.
  1121. // DEPRECATED: This type has been moved to meta/v1 and will be removed soon.
  1122. // +k8s:openapi-gen=false
  1123. message ListOptions {
  1124. // A selector to restrict the list of returned objects by their labels.
  1125. // Defaults to everything.
  1126. // +optional
  1127. optional string labelSelector = 1;
  1128. // A selector to restrict the list of returned objects by their fields.
  1129. // Defaults to everything.
  1130. // +optional
  1131. optional string fieldSelector = 2;
  1132. // Watch for changes to the described resources and return them as a stream of
  1133. // add, update, and remove notifications. Specify resourceVersion.
  1134. // +optional
  1135. optional bool watch = 3;
  1136. // When specified with a watch call, shows changes that occur after that particular version of a resource.
  1137. // Defaults to changes from the beginning of history.
  1138. // When specified for list:
  1139. // - if unset, then the result is returned from remote storage based on quorum-read flag;
  1140. // - if it's 0, then we simply return what we currently have in cache, no guarantee;
  1141. // - if set to non zero, then the result is at least as fresh as given rv.
  1142. // +optional
  1143. optional string resourceVersion = 4;
  1144. // Timeout for the list/watch call.
  1145. // +optional
  1146. optional int64 timeoutSeconds = 5;
  1147. }
  1148. // LoadBalancerIngress represents the status of a load-balancer ingress point:
  1149. // traffic intended for the service should be sent to an ingress point.
  1150. message LoadBalancerIngress {
  1151. // IP is set for load-balancer ingress points that are IP based
  1152. // (typically GCE or OpenStack load-balancers)
  1153. // +optional
  1154. optional string ip = 1;
  1155. // Hostname is set for load-balancer ingress points that are DNS based
  1156. // (typically AWS load-balancers)
  1157. // +optional
  1158. optional string hostname = 2;
  1159. }
  1160. // LoadBalancerStatus represents the status of a load-balancer.
  1161. message LoadBalancerStatus {
  1162. // Ingress is a list containing ingress points for the load-balancer.
  1163. // Traffic intended for the service should be sent to these ingress points.
  1164. // +optional
  1165. repeated LoadBalancerIngress ingress = 1;
  1166. }
  1167. // LocalObjectReference contains enough information to let you locate the
  1168. // referenced object inside the same namespace.
  1169. message LocalObjectReference {
  1170. // Name of the referent.
  1171. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  1172. // TODO: Add other useful fields. apiVersion, kind, uid?
  1173. // +optional
  1174. optional string name = 1;
  1175. }
  1176. // Represents an NFS mount that lasts the lifetime of a pod.
  1177. // NFS volumes do not support ownership management or SELinux relabeling.
  1178. message NFSVolumeSource {
  1179. // Server is the hostname or IP address of the NFS server.
  1180. // More info: http://kubernetes.io/docs/user-guide/volumes#nfs
  1181. optional string server = 1;
  1182. // Path that is exported by the NFS server.
  1183. // More info: http://kubernetes.io/docs/user-guide/volumes#nfs
  1184. optional string path = 2;
  1185. // ReadOnly here will force
  1186. // the NFS export to be mounted with read-only permissions.
  1187. // Defaults to false.
  1188. // More info: http://kubernetes.io/docs/user-guide/volumes#nfs
  1189. // +optional
  1190. optional bool readOnly = 3;
  1191. }
  1192. // Namespace provides a scope for Names.
  1193. // Use of multiple namespaces is optional.
  1194. message Namespace {
  1195. // Standard object's metadata.
  1196. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1197. // +optional
  1198. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1199. // Spec defines the behavior of the Namespace.
  1200. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1201. // +optional
  1202. optional NamespaceSpec spec = 2;
  1203. // Status describes the current status of a Namespace.
  1204. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1205. // +optional
  1206. optional NamespaceStatus status = 3;
  1207. }
  1208. // NamespaceList is a list of Namespaces.
  1209. message NamespaceList {
  1210. // Standard list metadata.
  1211. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1212. // +optional
  1213. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1214. // Items is the list of Namespace objects in the list.
  1215. // More info: http://kubernetes.io/docs/user-guide/namespaces
  1216. repeated Namespace items = 2;
  1217. }
  1218. // NamespaceSpec describes the attributes on a Namespace.
  1219. message NamespaceSpec {
  1220. // Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
  1221. // More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers
  1222. // +optional
  1223. repeated string finalizers = 1;
  1224. }
  1225. // NamespaceStatus is information about the current status of a Namespace.
  1226. message NamespaceStatus {
  1227. // Phase is the current lifecycle phase of the namespace.
  1228. // More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases
  1229. // +optional
  1230. optional string phase = 1;
  1231. }
  1232. // Node is a worker node in Kubernetes.
  1233. // Each node will have a unique identifier in the cache (i.e. in etcd).
  1234. message Node {
  1235. // Standard object's metadata.
  1236. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1237. // +optional
  1238. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1239. // Spec defines the behavior of a node.
  1240. // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1241. // +optional
  1242. optional NodeSpec spec = 2;
  1243. // Most recently observed status of the node.
  1244. // Populated by the system.
  1245. // Read-only.
  1246. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1247. // +optional
  1248. optional NodeStatus status = 3;
  1249. }
  1250. // NodeAddress contains information for the node's address.
  1251. message NodeAddress {
  1252. // Node address type, one of Hostname, ExternalIP or InternalIP.
  1253. optional string type = 1;
  1254. // The node address.
  1255. optional string address = 2;
  1256. }
  1257. // Node affinity is a group of node affinity scheduling rules.
  1258. message NodeAffinity {
  1259. // If the affinity requirements specified by this field are not met at
  1260. // scheduling time, the pod will not be scheduled onto the node.
  1261. // If the affinity requirements specified by this field cease to be met
  1262. // at some point during pod execution (e.g. due to an update), the system
  1263. // may or may not try to eventually evict the pod from its node.
  1264. // +optional
  1265. optional NodeSelector requiredDuringSchedulingIgnoredDuringExecution = 1;
  1266. // The scheduler will prefer to schedule pods to nodes that satisfy
  1267. // the affinity expressions specified by this field, but it may choose
  1268. // a node that violates one or more of the expressions. The node that is
  1269. // most preferred is the one with the greatest sum of weights, i.e.
  1270. // for each node that meets all of the scheduling requirements (resource
  1271. // request, requiredDuringScheduling affinity expressions, etc.),
  1272. // compute a sum by iterating through the elements of this field and adding
  1273. // "weight" to the sum if the node matches the corresponding matchExpressions; the
  1274. // node(s) with the highest sum are the most preferred.
  1275. // +optional
  1276. repeated PreferredSchedulingTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  1277. }
  1278. // NodeCondition contains condition information for a node.
  1279. message NodeCondition {
  1280. // Type of node condition.
  1281. optional string type = 1;
  1282. // Status of the condition, one of True, False, Unknown.
  1283. optional string status = 2;
  1284. // Last time we got an update on a given condition.
  1285. // +optional
  1286. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastHeartbeatTime = 3;
  1287. // Last time the condition transit from one status to another.
  1288. // +optional
  1289. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  1290. // (brief) reason for the condition's last transition.
  1291. // +optional
  1292. optional string reason = 5;
  1293. // Human readable message indicating details about last transition.
  1294. // +optional
  1295. optional string message = 6;
  1296. }
  1297. // NodeDaemonEndpoints lists ports opened by daemons running on the Node.
  1298. message NodeDaemonEndpoints {
  1299. // Endpoint on which Kubelet is listening.
  1300. // +optional
  1301. optional DaemonEndpoint kubeletEndpoint = 1;
  1302. }
  1303. // NodeList is the whole list of all Nodes which have been registered with master.
  1304. message NodeList {
  1305. // Standard list metadata.
  1306. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1307. // +optional
  1308. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1309. // List of nodes
  1310. repeated Node items = 2;
  1311. }
  1312. // NodeProxyOptions is the query options to a Node's proxy call.
  1313. message NodeProxyOptions {
  1314. // Path is the URL path to use for the current proxy request to node.
  1315. // +optional
  1316. optional string path = 1;
  1317. }
  1318. // NodeResources is an object for conveying resource information about a node.
  1319. // see http://releases.k8s.io/HEAD/docs/design/resources.md for more details.
  1320. message NodeResources {
  1321. // Capacity represents the available resources of a node
  1322. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
  1323. }
  1324. // A node selector represents the union of the results of one or more label queries
  1325. // over a set of nodes; that is, it represents the OR of the selectors represented
  1326. // by the node selector terms.
  1327. message NodeSelector {
  1328. // Required. A list of node selector terms. The terms are ORed.
  1329. repeated NodeSelectorTerm nodeSelectorTerms = 1;
  1330. }
  1331. // A node selector requirement is a selector that contains values, a key, and an operator
  1332. // that relates the key and values.
  1333. message NodeSelectorRequirement {
  1334. // The label key that the selector applies to.
  1335. optional string key = 1;
  1336. // Represents a key's relationship to a set of values.
  1337. // Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
  1338. optional string operator = 2;
  1339. // An array of string values. If the operator is In or NotIn,
  1340. // the values array must be non-empty. If the operator is Exists or DoesNotExist,
  1341. // the values array must be empty. If the operator is Gt or Lt, the values
  1342. // array must have a single element, which will be interpreted as an integer.
  1343. // This array is replaced during a strategic merge patch.
  1344. // +optional
  1345. repeated string values = 3;
  1346. }
  1347. // A null or empty node selector term matches no objects.
  1348. message NodeSelectorTerm {
  1349. // Required. A list of node selector requirements. The requirements are ANDed.
  1350. repeated NodeSelectorRequirement matchExpressions = 1;
  1351. }
  1352. // NodeSpec describes the attributes that a node is created with.
  1353. message NodeSpec {
  1354. // PodCIDR represents the pod IP range assigned to the node.
  1355. // +optional
  1356. optional string podCIDR = 1;
  1357. // External ID of the node assigned by some machine database (e.g. a cloud provider).
  1358. // Deprecated.
  1359. // +optional
  1360. optional string externalID = 2;
  1361. // ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
  1362. // +optional
  1363. optional string providerID = 3;
  1364. // Unschedulable controls node schedulability of new pods. By default, node is schedulable.
  1365. // More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration
  1366. // +optional
  1367. optional bool unschedulable = 4;
  1368. // If specified, the node's taints.
  1369. // +optional
  1370. repeated Taint taints = 5;
  1371. }
  1372. // NodeStatus is information about the current status of a node.
  1373. message NodeStatus {
  1374. // Capacity represents the total resources of a node.
  1375. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity for more details.
  1376. // +optional
  1377. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
  1378. // Allocatable represents the resources of a node that are available for scheduling.
  1379. // Defaults to Capacity.
  1380. // +optional
  1381. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> allocatable = 2;
  1382. // NodePhase is the recently observed lifecycle phase of the node.
  1383. // More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase
  1384. // The field is never populated, and now is deprecated.
  1385. // +optional
  1386. optional string phase = 3;
  1387. // Conditions is an array of current observed node conditions.
  1388. // More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition
  1389. // +optional
  1390. repeated NodeCondition conditions = 4;
  1391. // List of addresses reachable to the node.
  1392. // Queried from cloud provider, if available.
  1393. // More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses
  1394. // +optional
  1395. repeated NodeAddress addresses = 5;
  1396. // Endpoints of daemons running on the Node.
  1397. // +optional
  1398. optional NodeDaemonEndpoints daemonEndpoints = 6;
  1399. // Set of ids/uuids to uniquely identify the node.
  1400. // More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info
  1401. // +optional
  1402. optional NodeSystemInfo nodeInfo = 7;
  1403. // List of container images on this node
  1404. // +optional
  1405. repeated ContainerImage images = 8;
  1406. // List of attachable volumes in use (mounted) by the node.
  1407. // +optional
  1408. repeated string volumesInUse = 9;
  1409. // List of volumes that are attached to the node.
  1410. // +optional
  1411. repeated AttachedVolume volumesAttached = 10;
  1412. }
  1413. // NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
  1414. message NodeSystemInfo {
  1415. // MachineID reported by the node. For unique machine identification
  1416. // in the cluster this field is prefered. Learn more from man(5)
  1417. // machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
  1418. optional string machineID = 1;
  1419. // SystemUUID reported by the node. For unique machine identification
  1420. // MachineID is prefered. This field is specific to Red Hat hosts
  1421. // https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
  1422. optional string systemUUID = 2;
  1423. // Boot ID reported by the node.
  1424. optional string bootID = 3;
  1425. // Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
  1426. optional string kernelVersion = 4;
  1427. // OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
  1428. optional string osImage = 5;
  1429. // ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
  1430. optional string containerRuntimeVersion = 6;
  1431. // Kubelet Version reported by the node.
  1432. optional string kubeletVersion = 7;
  1433. // KubeProxy Version reported by the node.
  1434. optional string kubeProxyVersion = 8;
  1435. // The Operating System reported by the node
  1436. optional string operatingSystem = 9;
  1437. // The Architecture reported by the node
  1438. optional string architecture = 10;
  1439. }
  1440. // ObjectFieldSelector selects an APIVersioned field of an object.
  1441. message ObjectFieldSelector {
  1442. // Version of the schema the FieldPath is written in terms of, defaults to "v1".
  1443. // +optional
  1444. optional string apiVersion = 1;
  1445. // Path of the field to select in the specified API version.
  1446. optional string fieldPath = 2;
  1447. }
  1448. // ObjectMeta is metadata that all persisted resources must have, which includes all objects
  1449. // users must create.
  1450. // DEPRECATED: Use k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta instead - this type will be removed soon.
  1451. // +k8s:openapi-gen=false
  1452. message ObjectMeta {
  1453. // Name must be unique within a namespace. Is required when creating resources, although
  1454. // some resources may allow a client to request the generation of an appropriate name
  1455. // automatically. Name is primarily intended for creation idempotence and configuration
  1456. // definition.
  1457. // Cannot be updated.
  1458. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  1459. // +optional
  1460. optional string name = 1;
  1461. // GenerateName is an optional prefix, used by the server, to generate a unique
  1462. // name ONLY IF the Name field has not been provided.
  1463. // If this field is used, the name returned to the client will be different
  1464. // than the name passed. This value will also be combined with a unique suffix.
  1465. // The provided value has the same validation rules as the Name field,
  1466. // and may be truncated by the length of the suffix required to make the value
  1467. // unique on the server.
  1468. //
  1469. // If this field is specified and the generated name exists, the server will
  1470. // NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
  1471. // ServerTimeout indicating a unique name could not be found in the time allotted, and the client
  1472. // should retry (optionally after the time indicated in the Retry-After header).
  1473. //
  1474. // Applied only if Name is not specified.
  1475. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
  1476. // +optional
  1477. optional string generateName = 2;
  1478. // Namespace defines the space within each name must be unique. An empty namespace is
  1479. // equivalent to the "default" namespace, but "default" is the canonical representation.
  1480. // Not all objects are required to be scoped to a namespace - the value of this field for
  1481. // those objects will be empty.
  1482. //
  1483. // Must be a DNS_LABEL.
  1484. // Cannot be updated.
  1485. // More info: http://kubernetes.io/docs/user-guide/namespaces
  1486. // +optional
  1487. optional string namespace = 3;
  1488. // SelfLink is a URL representing this object.
  1489. // Populated by the system.
  1490. // Read-only.
  1491. // +optional
  1492. optional string selfLink = 4;
  1493. // UID is the unique in time and space value for this object. It is typically generated by
  1494. // the server on successful creation of a resource and is not allowed to change on PUT
  1495. // operations.
  1496. //
  1497. // Populated by the system.
  1498. // Read-only.
  1499. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  1500. // +optional
  1501. optional string uid = 5;
  1502. // An opaque value that represents the internal version of this object that can
  1503. // be used by clients to determine when objects have changed. May be used for optimistic
  1504. // concurrency, change detection, and the watch operation on a resource or set of resources.
  1505. // Clients must treat these values as opaque and passed unmodified back to the server.
  1506. // They may only be valid for a particular resource or set of resources.
  1507. //
  1508. // Populated by the system.
  1509. // Read-only.
  1510. // Value must be treated as opaque by clients and .
  1511. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
  1512. // +optional
  1513. optional string resourceVersion = 6;
  1514. // A sequence number representing a specific generation of the desired state.
  1515. // Populated by the system. Read-only.
  1516. // +optional
  1517. optional int64 generation = 7;
  1518. // CreationTimestamp is a timestamp representing the server time when this object was
  1519. // created. It is not guaranteed to be set in happens-before order across separate operations.
  1520. // Clients may not set this value. It is represented in RFC3339 form and is in UTC.
  1521. //
  1522. // Populated by the system.
  1523. // Read-only.
  1524. // Null for lists.
  1525. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1526. // +optional
  1527. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time creationTimestamp = 8;
  1528. // DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
  1529. // field is set by the server when a graceful deletion is requested by the user, and is not
  1530. // directly settable by a client. The resource is expected to be deleted (no longer visible
  1531. // from resource lists, and not reachable by name) after the time in this field. Once set,
  1532. // this value may not be unset or be set further into the future, although it may be shortened
  1533. // or the resource may be deleted prior to this time. For example, a user may request that
  1534. // a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination
  1535. // signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard
  1536. // termination signal (SIGKILL) to the container and after cleanup, remove the pod from the
  1537. // API. In the presence of network partitions, this object may still exist after this
  1538. // timestamp, until an administrator or automated process can determine the resource is
  1539. // fully terminated.
  1540. // If not set, graceful deletion of the object has not been requested.
  1541. //
  1542. // Populated by the system when a graceful deletion is requested.
  1543. // Read-only.
  1544. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1545. // +optional
  1546. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time deletionTimestamp = 9;
  1547. // Number of seconds allowed for this object to gracefully terminate before
  1548. // it will be removed from the system. Only set when deletionTimestamp is also set.
  1549. // May only be shortened.
  1550. // Read-only.
  1551. // +optional
  1552. optional int64 deletionGracePeriodSeconds = 10;
  1553. // Map of string keys and values that can be used to organize and categorize
  1554. // (scope and select) objects. May match selectors of replication controllers
  1555. // and services.
  1556. // More info: http://kubernetes.io/docs/user-guide/labels
  1557. // +optional
  1558. map<string, string> labels = 11;
  1559. // Annotations is an unstructured key value map stored with a resource that may be
  1560. // set by external tools to store and retrieve arbitrary metadata. They are not
  1561. // queryable and should be preserved when modifying objects.
  1562. // More info: http://kubernetes.io/docs/user-guide/annotations
  1563. // +optional
  1564. map<string, string> annotations = 12;
  1565. // List of objects depended by this object. If ALL objects in the list have
  1566. // been deleted, this object will be garbage collected. If this object is managed by a controller,
  1567. // then an entry in this list will point to this controller, with the controller field set to true.
  1568. // There cannot be more than one managing controller.
  1569. // +optional
  1570. repeated k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference ownerReferences = 13;
  1571. // Must be empty before the object is deleted from the registry. Each entry
  1572. // is an identifier for the responsible component that will remove the entry
  1573. // from the list. If the deletionTimestamp of the object is non-nil, entries
  1574. // in this list can only be removed.
  1575. // +optional
  1576. repeated string finalizers = 14;
  1577. // The name of the cluster which the object belongs to.
  1578. // This is used to distinguish resources with same name and namespace in different clusters.
  1579. // This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
  1580. // +optional
  1581. optional string clusterName = 15;
  1582. }
  1583. // ObjectReference contains enough information to let you inspect or modify the referred object.
  1584. message ObjectReference {
  1585. // Kind of the referent.
  1586. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1587. // +optional
  1588. optional string kind = 1;
  1589. // Namespace of the referent.
  1590. // More info: http://kubernetes.io/docs/user-guide/namespaces
  1591. // +optional
  1592. optional string namespace = 2;
  1593. // Name of the referent.
  1594. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  1595. // +optional
  1596. optional string name = 3;
  1597. // UID of the referent.
  1598. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  1599. // +optional
  1600. optional string uid = 4;
  1601. // API version of the referent.
  1602. // +optional
  1603. optional string apiVersion = 5;
  1604. // Specific resourceVersion to which this reference is made, if any.
  1605. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
  1606. // +optional
  1607. optional string resourceVersion = 6;
  1608. // If referring to a piece of an object instead of an entire object, this string
  1609. // should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].
  1610. // For example, if the object reference is to a container within a pod, this would take on a value like:
  1611. // "spec.containers{name}" (where "name" refers to the name of the container that triggered
  1612. // the event) or if no container name is specified "spec.containers[2]" (container with
  1613. // index 2 in this pod). This syntax is chosen only to have some well-defined way of
  1614. // referencing a part of an object.
  1615. // TODO: this design is not final and this field is subject to change in the future.
  1616. // +optional
  1617. optional string fieldPath = 7;
  1618. }
  1619. // PersistentVolume (PV) is a storage resource provisioned by an administrator.
  1620. // It is analogous to a node.
  1621. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes
  1622. message PersistentVolume {
  1623. // Standard object's metadata.
  1624. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1625. // +optional
  1626. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1627. // Spec defines a specification of a persistent volume owned by the cluster.
  1628. // Provisioned by an administrator.
  1629. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes
  1630. // +optional
  1631. optional PersistentVolumeSpec spec = 2;
  1632. // Status represents the current information/status for the persistent volume.
  1633. // Populated by the system.
  1634. // Read-only.
  1635. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes
  1636. // +optional
  1637. optional PersistentVolumeStatus status = 3;
  1638. }
  1639. // PersistentVolumeClaim is a user's request for and claim to a persistent volume
  1640. message PersistentVolumeClaim {
  1641. // Standard object's metadata.
  1642. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1643. // +optional
  1644. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1645. // Spec defines the desired characteristics of a volume requested by a pod author.
  1646. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
  1647. // +optional
  1648. optional PersistentVolumeClaimSpec spec = 2;
  1649. // Status represents the current information/status of a persistent volume claim.
  1650. // Read-only.
  1651. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
  1652. // +optional
  1653. optional PersistentVolumeClaimStatus status = 3;
  1654. }
  1655. // PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
  1656. message PersistentVolumeClaimList {
  1657. // Standard list metadata.
  1658. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1659. // +optional
  1660. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1661. // A list of persistent volume claims.
  1662. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
  1663. repeated PersistentVolumeClaim items = 2;
  1664. }
  1665. // PersistentVolumeClaimSpec describes the common attributes of storage devices
  1666. // and allows a Source for provider-specific attributes
  1667. message PersistentVolumeClaimSpec {
  1668. // AccessModes contains the desired access modes the volume should have.
  1669. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1
  1670. // +optional
  1671. repeated string accessModes = 1;
  1672. // A label query over volumes to consider for binding.
  1673. // +optional
  1674. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;
  1675. // Resources represents the minimum resources the volume should have.
  1676. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
  1677. // +optional
  1678. optional ResourceRequirements resources = 2;
  1679. // VolumeName is the binding reference to the PersistentVolume backing this claim.
  1680. // +optional
  1681. optional string volumeName = 3;
  1682. // Name of the StorageClass required by the claim.
  1683. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#class-1
  1684. // +optional
  1685. optional string storageClassName = 5;
  1686. }
  1687. // PersistentVolumeClaimStatus is the current status of a persistent volume claim.
  1688. message PersistentVolumeClaimStatus {
  1689. // Phase represents the current phase of PersistentVolumeClaim.
  1690. // +optional
  1691. optional string phase = 1;
  1692. // AccessModes contains the actual access modes the volume backing the PVC has.
  1693. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1
  1694. // +optional
  1695. repeated string accessModes = 2;
  1696. // Represents the actual resources of the underlying volume.
  1697. // +optional
  1698. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 3;
  1699. }
  1700. // PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.
  1701. // This volume finds the bound PV and mounts that volume for the pod. A
  1702. // PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another
  1703. // type of volume that is owned by someone else (the system).
  1704. message PersistentVolumeClaimVolumeSource {
  1705. // ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
  1706. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
  1707. optional string claimName = 1;
  1708. // Will force the ReadOnly setting in VolumeMounts.
  1709. // Default false.
  1710. // +optional
  1711. optional bool readOnly = 2;
  1712. }
  1713. // PersistentVolumeList is a list of PersistentVolume items.
  1714. message PersistentVolumeList {
  1715. // Standard list metadata.
  1716. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  1717. // +optional
  1718. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  1719. // List of persistent volumes.
  1720. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes
  1721. repeated PersistentVolume items = 2;
  1722. }
  1723. // PersistentVolumeSource is similar to VolumeSource but meant for the
  1724. // administrator who creates PVs. Exactly one of its members must be set.
  1725. message PersistentVolumeSource {
  1726. // GCEPersistentDisk represents a GCE Disk resource that is attached to a
  1727. // kubelet's host machine and then exposed to the pod. Provisioned by an admin.
  1728. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  1729. // +optional
  1730. optional GCEPersistentDiskVolumeSource gcePersistentDisk = 1;
  1731. // AWSElasticBlockStore represents an AWS Disk resource that is attached to a
  1732. // kubelet's host machine and then exposed to the pod.
  1733. // More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
  1734. // +optional
  1735. optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 2;
  1736. // HostPath represents a directory on the host.
  1737. // Provisioned by a developer or tester.
  1738. // This is useful for single-node development and testing only!
  1739. // On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster.
  1740. // More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
  1741. // +optional
  1742. optional HostPathVolumeSource hostPath = 3;
  1743. // Glusterfs represents a Glusterfs volume that is attached to a host and
  1744. // exposed to the pod. Provisioned by an admin.
  1745. // More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
  1746. // +optional
  1747. optional GlusterfsVolumeSource glusterfs = 4;
  1748. // NFS represents an NFS mount on the host. Provisioned by an admin.
  1749. // More info: http://kubernetes.io/docs/user-guide/volumes#nfs
  1750. // +optional
  1751. optional NFSVolumeSource nfs = 5;
  1752. // RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.
  1753. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
  1754. // +optional
  1755. optional RBDVolumeSource rbd = 6;
  1756. // ISCSI represents an ISCSI Disk resource that is attached to a
  1757. // kubelet's host machine and then exposed to the pod. Provisioned by an admin.
  1758. // +optional
  1759. optional ISCSIVolumeSource iscsi = 7;
  1760. // Cinder represents a cinder volume attached and mounted on kubelets host machine
  1761. // More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  1762. // +optional
  1763. optional CinderVolumeSource cinder = 8;
  1764. // CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
  1765. // +optional
  1766. optional CephFSVolumeSource cephfs = 9;
  1767. // FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  1768. // +optional
  1769. optional FCVolumeSource fc = 10;
  1770. // Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running
  1771. // +optional
  1772. optional FlockerVolumeSource flocker = 11;
  1773. // FlexVolume represents a generic volume resource that is
  1774. // provisioned/attached using an exec based plugin. This is an
  1775. // alpha feature and may change in future.
  1776. // +optional
  1777. optional FlexVolumeSource flexVolume = 12;
  1778. // AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  1779. // +optional
  1780. optional AzureFileVolumeSource azureFile = 13;
  1781. // VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
  1782. // +optional
  1783. optional VsphereVirtualDiskVolumeSource vsphereVolume = 14;
  1784. // Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
  1785. // +optional
  1786. optional QuobyteVolumeSource quobyte = 15;
  1787. // AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  1788. // +optional
  1789. optional AzureDiskVolumeSource azureDisk = 16;
  1790. // PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
  1791. optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 17;
  1792. // PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
  1793. // +optional
  1794. optional PortworxVolumeSource portworxVolume = 18;
  1795. // ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  1796. // +optional
  1797. optional ScaleIOVolumeSource scaleIO = 19;
  1798. }
  1799. // PersistentVolumeSpec is the specification of a persistent volume.
  1800. message PersistentVolumeSpec {
  1801. // A description of the persistent volume's resources and capacity.
  1802. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity
  1803. // +optional
  1804. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> capacity = 1;
  1805. // The actual volume backing the persistent volume.
  1806. optional PersistentVolumeSource persistentVolumeSource = 2;
  1807. // AccessModes contains all ways the volume can be mounted.
  1808. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes
  1809. // +optional
  1810. repeated string accessModes = 3;
  1811. // ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
  1812. // Expected to be non-nil when bound.
  1813. // claim.VolumeName is the authoritative bind between PV and PVC.
  1814. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#binding
  1815. // +optional
  1816. optional ObjectReference claimRef = 4;
  1817. // What happens to a persistent volume when released from its claim.
  1818. // Valid options are Retain (default) and Recycle.
  1819. // Recycling must be supported by the volume plugin underlying this persistent volume.
  1820. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#recycling-policy
  1821. // +optional
  1822. optional string persistentVolumeReclaimPolicy = 5;
  1823. // Name of StorageClass to which this persistent volume belongs. Empty value
  1824. // means that this volume does not belong to any StorageClass.
  1825. // +optional
  1826. optional string storageClassName = 6;
  1827. }
  1828. // PersistentVolumeStatus is the current status of a persistent volume.
  1829. message PersistentVolumeStatus {
  1830. // Phase indicates if a volume is available, bound to a claim, or released by a claim.
  1831. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#phase
  1832. // +optional
  1833. optional string phase = 1;
  1834. // A human-readable message indicating details about why the volume is in this state.
  1835. // +optional
  1836. optional string message = 2;
  1837. // Reason is a brief CamelCase string that describes any failure and is meant
  1838. // for machine parsing and tidy display in the CLI.
  1839. // +optional
  1840. optional string reason = 3;
  1841. }
  1842. // Represents a Photon Controller persistent disk resource.
  1843. message PhotonPersistentDiskVolumeSource {
  1844. // ID that identifies Photon Controller persistent disk
  1845. optional string pdID = 1;
  1846. // Filesystem type to mount.
  1847. // Must be a filesystem type supported by the host operating system.
  1848. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  1849. optional string fsType = 2;
  1850. }
  1851. // Pod is a collection of containers that can run on a host. This resource is created
  1852. // by clients and scheduled onto hosts.
  1853. message Pod {
  1854. // Standard object's metadata.
  1855. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  1856. // +optional
  1857. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1858. // Specification of the desired behavior of the pod.
  1859. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1860. // +optional
  1861. optional PodSpec spec = 2;
  1862. // Most recently observed status of the pod.
  1863. // This data may not be up to date.
  1864. // Populated by the system.
  1865. // Read-only.
  1866. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  1867. // +optional
  1868. optional PodStatus status = 3;
  1869. }
  1870. // Pod affinity is a group of inter pod affinity scheduling rules.
  1871. message PodAffinity {
  1872. // NOT YET IMPLEMENTED. TODO: Uncomment field once it is implemented.
  1873. // If the affinity requirements specified by this field are not met at
  1874. // scheduling time, the pod will not be scheduled onto the node.
  1875. // If the affinity requirements specified by this field cease to be met
  1876. // at some point during pod execution (e.g. due to a pod label update), the
  1877. // system will try to eventually evict the pod from its node.
  1878. // When there are multiple elements, the lists of nodes corresponding to each
  1879. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  1880. // +optional
  1881. // RequiredDuringSchedulingRequiredDuringExecution []PodAffinityTerm `json:"requiredDuringSchedulingRequiredDuringExecution,omitempty"`
  1882. // If the affinity requirements specified by this field are not met at
  1883. // scheduling time, the pod will not be scheduled onto the node.
  1884. // If the affinity requirements specified by this field cease to be met
  1885. // at some point during pod execution (e.g. due to a pod label update), the
  1886. // system may or may not try to eventually evict the pod from its node.
  1887. // When there are multiple elements, the lists of nodes corresponding to each
  1888. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  1889. // +optional
  1890. repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1;
  1891. // The scheduler will prefer to schedule pods to nodes that satisfy
  1892. // the affinity expressions specified by this field, but it may choose
  1893. // a node that violates one or more of the expressions. The node that is
  1894. // most preferred is the one with the greatest sum of weights, i.e.
  1895. // for each node that meets all of the scheduling requirements (resource
  1896. // request, requiredDuringScheduling affinity expressions, etc.),
  1897. // compute a sum by iterating through the elements of this field and adding
  1898. // "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
  1899. // node(s) with the highest sum are the most preferred.
  1900. // +optional
  1901. repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  1902. }
  1903. // Defines a set of pods (namely those matching the labelSelector
  1904. // relative to the given namespace(s)) that this pod should be
  1905. // co-located (affinity) or not co-located (anti-affinity) with,
  1906. // where co-located is defined as running on a node whose value of
  1907. // the label with key <topologyKey> tches that of any node on which
  1908. // a pod of the set of pods is running
  1909. message PodAffinityTerm {
  1910. // A label query over a set of resources, in this case pods.
  1911. // +optional
  1912. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 1;
  1913. // namespaces specifies which namespaces the labelSelector applies to (matches against);
  1914. // null or empty list means "this pod's namespace"
  1915. repeated string namespaces = 2;
  1916. // This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
  1917. // the labelSelector in the specified namespaces, where co-located is defined as running on a node
  1918. // whose value of the label with key topologyKey matches that of any node on which any of the
  1919. // selected pods is running.
  1920. // For PreferredDuringScheduling pod anti-affinity, empty topologyKey is interpreted as "all topologies"
  1921. // ("all topologies" here means all the topologyKeys indicated by scheduler command-line argument --failure-domains);
  1922. // for affinity and for RequiredDuringScheduling pod anti-affinity, empty topologyKey is not allowed.
  1923. // +optional
  1924. optional string topologyKey = 3;
  1925. }
  1926. // Pod anti affinity is a group of inter pod anti affinity scheduling rules.
  1927. message PodAntiAffinity {
  1928. // NOT YET IMPLEMENTED. TODO: Uncomment field once it is implemented.
  1929. // If the anti-affinity requirements specified by this field are not met at
  1930. // scheduling time, the pod will not be scheduled onto the node.
  1931. // If the anti-affinity requirements specified by this field cease to be met
  1932. // at some point during pod execution (e.g. due to a pod label update), the
  1933. // system will try to eventually evict the pod from its node.
  1934. // When there are multiple elements, the lists of nodes corresponding to each
  1935. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  1936. // +optional
  1937. // RequiredDuringSchedulingRequiredDuringExecution []PodAffinityTerm `json:"requiredDuringSchedulingRequiredDuringExecution,omitempty"`
  1938. // If the anti-affinity requirements specified by this field are not met at
  1939. // scheduling time, the pod will not be scheduled onto the node.
  1940. // If the anti-affinity requirements specified by this field cease to be met
  1941. // at some point during pod execution (e.g. due to a pod label update), the
  1942. // system may or may not try to eventually evict the pod from its node.
  1943. // When there are multiple elements, the lists of nodes corresponding to each
  1944. // podAffinityTerm are intersected, i.e. all terms must be satisfied.
  1945. // +optional
  1946. repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1;
  1947. // The scheduler will prefer to schedule pods to nodes that satisfy
  1948. // the anti-affinity expressions specified by this field, but it may choose
  1949. // a node that violates one or more of the expressions. The node that is
  1950. // most preferred is the one with the greatest sum of weights, i.e.
  1951. // for each node that meets all of the scheduling requirements (resource
  1952. // request, requiredDuringScheduling anti-affinity expressions, etc.),
  1953. // compute a sum by iterating through the elements of this field and adding
  1954. // "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
  1955. // node(s) with the highest sum are the most preferred.
  1956. // +optional
  1957. repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2;
  1958. }
  1959. // PodAttachOptions is the query options to a Pod's remote attach call.
  1960. // ---
  1961. // TODO: merge w/ PodExecOptions below for stdin, stdout, etc
  1962. // and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY
  1963. message PodAttachOptions {
  1964. // Stdin if true, redirects the standard input stream of the pod for this call.
  1965. // Defaults to false.
  1966. // +optional
  1967. optional bool stdin = 1;
  1968. // Stdout if true indicates that stdout is to be redirected for the attach call.
  1969. // Defaults to true.
  1970. // +optional
  1971. optional bool stdout = 2;
  1972. // Stderr if true indicates that stderr is to be redirected for the attach call.
  1973. // Defaults to true.
  1974. // +optional
  1975. optional bool stderr = 3;
  1976. // TTY if true indicates that a tty will be allocated for the attach call.
  1977. // This is passed through the container runtime so the tty
  1978. // is allocated on the worker node by the container runtime.
  1979. // Defaults to false.
  1980. // +optional
  1981. optional bool tty = 4;
  1982. // The container in which to execute the command.
  1983. // Defaults to only container if there is only one container in the pod.
  1984. // +optional
  1985. optional string container = 5;
  1986. }
  1987. // PodCondition contains details for the current condition of this pod.
  1988. message PodCondition {
  1989. // Type is the type of the condition.
  1990. // Currently only Ready.
  1991. // More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
  1992. optional string type = 1;
  1993. // Status is the status of the condition.
  1994. // Can be True, False, Unknown.
  1995. // More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
  1996. optional string status = 2;
  1997. // Last time we probed the condition.
  1998. // +optional
  1999. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastProbeTime = 3;
  2000. // Last time the condition transitioned from one status to another.
  2001. // +optional
  2002. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4;
  2003. // Unique, one-word, CamelCase reason for the condition's last transition.
  2004. // +optional
  2005. optional string reason = 5;
  2006. // Human-readable message indicating details about last transition.
  2007. // +optional
  2008. optional string message = 6;
  2009. }
  2010. // PodExecOptions is the query options to a Pod's remote exec call.
  2011. // ---
  2012. // TODO: This is largely identical to PodAttachOptions above, make sure they stay in sync and see about merging
  2013. // and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY
  2014. message PodExecOptions {
  2015. // Redirect the standard input stream of the pod for this call.
  2016. // Defaults to false.
  2017. // +optional
  2018. optional bool stdin = 1;
  2019. // Redirect the standard output stream of the pod for this call.
  2020. // Defaults to true.
  2021. // +optional
  2022. optional bool stdout = 2;
  2023. // Redirect the standard error stream of the pod for this call.
  2024. // Defaults to true.
  2025. // +optional
  2026. optional bool stderr = 3;
  2027. // TTY if true indicates that a tty will be allocated for the exec call.
  2028. // Defaults to false.
  2029. // +optional
  2030. optional bool tty = 4;
  2031. // Container in which to execute the command.
  2032. // Defaults to only container if there is only one container in the pod.
  2033. // +optional
  2034. optional string container = 5;
  2035. // Command is the remote command to execute. argv array. Not executed within a shell.
  2036. repeated string command = 6;
  2037. }
  2038. // PodList is a list of Pods.
  2039. message PodList {
  2040. // Standard list metadata.
  2041. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2042. // +optional
  2043. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2044. // List of pods.
  2045. // More info: http://kubernetes.io/docs/user-guide/pods
  2046. repeated Pod items = 2;
  2047. }
  2048. // PodLogOptions is the query options for a Pod's logs REST call.
  2049. message PodLogOptions {
  2050. // The container for which to stream logs. Defaults to only container if there is one container in the pod.
  2051. // +optional
  2052. optional string container = 1;
  2053. // Follow the log stream of the pod. Defaults to false.
  2054. // +optional
  2055. optional bool follow = 2;
  2056. // Return previous terminated container logs. Defaults to false.
  2057. // +optional
  2058. optional bool previous = 3;
  2059. // A relative time in seconds before the current time from which to show logs. If this value
  2060. // precedes the time a pod was started, only logs since the pod start will be returned.
  2061. // If this value is in the future, no logs will be returned.
  2062. // Only one of sinceSeconds or sinceTime may be specified.
  2063. // +optional
  2064. optional int64 sinceSeconds = 4;
  2065. // An RFC3339 timestamp from which to show logs. If this value
  2066. // precedes the time a pod was started, only logs since the pod start will be returned.
  2067. // If this value is in the future, no logs will be returned.
  2068. // Only one of sinceSeconds or sinceTime may be specified.
  2069. // +optional
  2070. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time sinceTime = 5;
  2071. // If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line
  2072. // of log output. Defaults to false.
  2073. // +optional
  2074. optional bool timestamps = 6;
  2075. // If set, the number of lines from the end of the logs to show. If not specified,
  2076. // logs are shown from the creation of the container or sinceSeconds or sinceTime
  2077. // +optional
  2078. optional int64 tailLines = 7;
  2079. // If set, the number of bytes to read from the server before terminating the
  2080. // log output. This may not display a complete final line of logging, and may return
  2081. // slightly more or slightly less than the specified limit.
  2082. // +optional
  2083. optional int64 limitBytes = 8;
  2084. }
  2085. // PodPortForwardOptions is the query options to a Pod's port forward call
  2086. // when using WebSockets.
  2087. // The `port` query parameter must specify the port or
  2088. // ports (comma separated) to forward over.
  2089. // Port forwarding over SPDY does not use these options. It requires the port
  2090. // to be passed in the `port` header as part of request.
  2091. message PodPortForwardOptions {
  2092. // List of ports to forward
  2093. // Required when using WebSockets
  2094. // +optional
  2095. repeated int32 ports = 1;
  2096. }
  2097. // PodProxyOptions is the query options to a Pod's proxy call.
  2098. message PodProxyOptions {
  2099. // Path is the URL path to use for the current proxy request to pod.
  2100. // +optional
  2101. optional string path = 1;
  2102. }
  2103. // PodSecurityContext holds pod-level security attributes and common container settings.
  2104. // Some fields are also present in container.securityContext. Field values of
  2105. // container.securityContext take precedence over field values of PodSecurityContext.
  2106. message PodSecurityContext {
  2107. // The SELinux context to be applied to all containers.
  2108. // If unspecified, the container runtime will allocate a random SELinux context for each
  2109. // container. May also be set in SecurityContext. If set in
  2110. // both SecurityContext and PodSecurityContext, the value specified in SecurityContext
  2111. // takes precedence for that container.
  2112. // +optional
  2113. optional SELinuxOptions seLinuxOptions = 1;
  2114. // The UID to run the entrypoint of the container process.
  2115. // Defaults to user specified in image metadata if unspecified.
  2116. // May also be set in SecurityContext. If set in both SecurityContext and
  2117. // PodSecurityContext, the value specified in SecurityContext takes precedence
  2118. // for that container.
  2119. // +optional
  2120. optional int64 runAsUser = 2;
  2121. // Indicates that the container must run as a non-root user.
  2122. // If true, the Kubelet will validate the image at runtime to ensure that it
  2123. // does not run as UID 0 (root) and fail to start the container if it does.
  2124. // If unset or false, no such validation will be performed.
  2125. // May also be set in SecurityContext. If set in both SecurityContext and
  2126. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  2127. // +optional
  2128. optional bool runAsNonRoot = 3;
  2129. // A list of groups applied to the first process run in each container, in addition
  2130. // to the container's primary GID. If unspecified, no groups will be added to
  2131. // any container.
  2132. // +optional
  2133. repeated int64 supplementalGroups = 4;
  2134. // A special supplemental group that applies to all containers in a pod.
  2135. // Some volume types allow the Kubelet to change the ownership of that volume
  2136. // to be owned by the pod:
  2137. //
  2138. // 1. The owning GID will be the FSGroup
  2139. // 2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
  2140. // 3. The permission bits are OR'd with rw-rw----
  2141. //
  2142. // If unset, the Kubelet will not modify the ownership and permissions of any volume.
  2143. // +optional
  2144. optional int64 fsGroup = 5;
  2145. }
  2146. // Describes the class of pods that should avoid this node.
  2147. // Exactly one field should be set.
  2148. message PodSignature {
  2149. // Reference to controller whose pods should avoid this node.
  2150. // +optional
  2151. optional k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference podController = 1;
  2152. }
  2153. // PodSpec is a description of a pod.
  2154. message PodSpec {
  2155. // List of volumes that can be mounted by containers belonging to the pod.
  2156. // More info: http://kubernetes.io/docs/user-guide/volumes
  2157. // +optional
  2158. repeated Volume volumes = 1;
  2159. // List of initialization containers belonging to the pod.
  2160. // Init containers are executed in order prior to containers being started. If any
  2161. // init container fails, the pod is considered to have failed and is handled according
  2162. // to its restartPolicy. The name for an init container or normal container must be
  2163. // unique among all containers.
  2164. // Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes.
  2165. // The resourceRequirements of an init container are taken into account during scheduling
  2166. // by finding the highest request/limit for each resource type, and then using the max of
  2167. // of that value or the sum of the normal containers. Limits are applied to init containers
  2168. // in a similar fashion.
  2169. // Init containers cannot currently be added or removed.
  2170. // Cannot be updated.
  2171. // More info: http://kubernetes.io/docs/user-guide/containers
  2172. repeated Container initContainers = 20;
  2173. // List of containers belonging to the pod.
  2174. // Containers cannot currently be added or removed.
  2175. // There must be at least one container in a Pod.
  2176. // Cannot be updated.
  2177. // More info: http://kubernetes.io/docs/user-guide/containers
  2178. repeated Container containers = 2;
  2179. // Restart policy for all containers within the pod.
  2180. // One of Always, OnFailure, Never.
  2181. // Default to Always.
  2182. // More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy
  2183. // +optional
  2184. optional string restartPolicy = 3;
  2185. // Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
  2186. // Value must be non-negative integer. The value zero indicates delete immediately.
  2187. // If this value is nil, the default grace period will be used instead.
  2188. // The grace period is the duration in seconds after the processes running in the pod are sent
  2189. // a termination signal and the time when the processes are forcibly halted with a kill signal.
  2190. // Set this value longer than the expected cleanup time for your process.
  2191. // Defaults to 30 seconds.
  2192. // +optional
  2193. optional int64 terminationGracePeriodSeconds = 4;
  2194. // Optional duration in seconds the pod may be active on the node relative to
  2195. // StartTime before the system will actively try to mark it failed and kill associated containers.
  2196. // Value must be a positive integer.
  2197. // +optional
  2198. optional int64 activeDeadlineSeconds = 5;
  2199. // Set DNS policy for containers within the pod.
  2200. // One of 'ClusterFirstWithHostNet', 'ClusterFirst' or 'Default'.
  2201. // Defaults to "ClusterFirst".
  2202. // To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
  2203. // +optional
  2204. optional string dnsPolicy = 6;
  2205. // NodeSelector is a selector which must be true for the pod to fit on a node.
  2206. // Selector which must match a node's labels for the pod to be scheduled on that node.
  2207. // More info: http://kubernetes.io/docs/user-guide/node-selection/README
  2208. // +optional
  2209. map<string, string> nodeSelector = 7;
  2210. // ServiceAccountName is the name of the ServiceAccount to use to run this pod.
  2211. // More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md
  2212. // +optional
  2213. optional string serviceAccountName = 8;
  2214. // DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.
  2215. // Deprecated: Use serviceAccountName instead.
  2216. // +k8s:conversion-gen=false
  2217. // +optional
  2218. optional string serviceAccount = 9;
  2219. // AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
  2220. // +optional
  2221. optional bool automountServiceAccountToken = 21;
  2222. // NodeName is a request to schedule this pod onto a specific node. If it is non-empty,
  2223. // the scheduler simply schedules this pod onto that node, assuming that it fits resource
  2224. // requirements.
  2225. // +optional
  2226. optional string nodeName = 10;
  2227. // Host networking requested for this pod. Use the host's network namespace.
  2228. // If this option is set, the ports that will be used must be specified.
  2229. // Default to false.
  2230. // +k8s:conversion-gen=false
  2231. // +optional
  2232. optional bool hostNetwork = 11;
  2233. // Use the host's pid namespace.
  2234. // Optional: Default to false.
  2235. // +k8s:conversion-gen=false
  2236. // +optional
  2237. optional bool hostPID = 12;
  2238. // Use the host's ipc namespace.
  2239. // Optional: Default to false.
  2240. // +k8s:conversion-gen=false
  2241. // +optional
  2242. optional bool hostIPC = 13;
  2243. // SecurityContext holds pod-level security attributes and common container settings.
  2244. // Optional: Defaults to empty. See type description for default values of each field.
  2245. // +optional
  2246. optional PodSecurityContext securityContext = 14;
  2247. // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
  2248. // If specified, these secrets will be passed to individual puller implementations for them to use. For example,
  2249. // in the case of docker, only DockerConfig type secrets are honored.
  2250. // More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
  2251. // +optional
  2252. repeated LocalObjectReference imagePullSecrets = 15;
  2253. // Specifies the hostname of the Pod
  2254. // If not specified, the pod's hostname will be set to a system-defined value.
  2255. // +optional
  2256. optional string hostname = 16;
  2257. // If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
  2258. // If not specified, the pod will not have a domainname at all.
  2259. // +optional
  2260. optional string subdomain = 17;
  2261. // If specified, the pod's scheduling constraints
  2262. // +optional
  2263. optional Affinity affinity = 18;
  2264. // If specified, the pod will be dispatched by specified scheduler.
  2265. // If not specified, the pod will be dispatched by default scheduler.
  2266. // +optional
  2267. optional string schedulerName = 19;
  2268. // If specified, the pod's tolerations.
  2269. // +optional
  2270. repeated Toleration tolerations = 22;
  2271. }
  2272. // PodStatus represents information about the status of a pod. Status may trail the actual
  2273. // state of a system.
  2274. message PodStatus {
  2275. // Current condition of the pod.
  2276. // More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase
  2277. // +optional
  2278. optional string phase = 1;
  2279. // Current service state of pod.
  2280. // More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions
  2281. // +optional
  2282. repeated PodCondition conditions = 2;
  2283. // A human readable message indicating details about why the pod is in this condition.
  2284. // +optional
  2285. optional string message = 3;
  2286. // A brief CamelCase message indicating details about why the pod is in this state.
  2287. // e.g. 'OutOfDisk'
  2288. // +optional
  2289. optional string reason = 4;
  2290. // IP address of the host to which the pod is assigned. Empty if not yet scheduled.
  2291. // +optional
  2292. optional string hostIP = 5;
  2293. // IP address allocated to the pod. Routable at least within the cluster.
  2294. // Empty if not yet allocated.
  2295. // +optional
  2296. optional string podIP = 6;
  2297. // RFC 3339 date and time at which the object was acknowledged by the Kubelet.
  2298. // This is before the Kubelet pulled the container image(s) for the pod.
  2299. // +optional
  2300. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 7;
  2301. // The list has one entry per init container in the manifest. The most recent successful
  2302. // init container will have ready = true, the most recently started container will have
  2303. // startTime set.
  2304. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
  2305. repeated ContainerStatus initContainerStatuses = 10;
  2306. // The list has one entry per container in the manifest. Each entry is currently the output
  2307. // of `docker inspect`.
  2308. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses
  2309. // +optional
  2310. repeated ContainerStatus containerStatuses = 8;
  2311. // The Quality of Service (QOS) classification assigned to the pod based on resource requirements
  2312. // See PodQOSClass type for available QOS classes
  2313. // More info: https://github.com/kubernetes/kubernetes/blob/master/docs/design/resource-qos.md
  2314. // +optional
  2315. optional string qosClass = 9;
  2316. }
  2317. // PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded
  2318. message PodStatusResult {
  2319. // Standard object's metadata.
  2320. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2321. // +optional
  2322. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2323. // Most recently observed status of the pod.
  2324. // This data may not be up to date.
  2325. // Populated by the system.
  2326. // Read-only.
  2327. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2328. // +optional
  2329. optional PodStatus status = 2;
  2330. }
  2331. // PodTemplate describes a template for creating copies of a predefined pod.
  2332. message PodTemplate {
  2333. // Standard object's metadata.
  2334. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2335. // +optional
  2336. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2337. // Template defines the pods that will be created from this pod template.
  2338. // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2339. // +optional
  2340. optional PodTemplateSpec template = 2;
  2341. }
  2342. // PodTemplateList is a list of PodTemplates.
  2343. message PodTemplateList {
  2344. // Standard list metadata.
  2345. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2346. // +optional
  2347. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2348. // List of pod templates
  2349. repeated PodTemplate items = 2;
  2350. }
  2351. // PodTemplateSpec describes the data a pod should have when created from a template
  2352. message PodTemplateSpec {
  2353. // Standard object's metadata.
  2354. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2355. // +optional
  2356. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2357. // Specification of the desired behavior of the pod.
  2358. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2359. // +optional
  2360. optional PodSpec spec = 2;
  2361. }
  2362. // PortworxVolumeSource represents a Portworx volume resource.
  2363. message PortworxVolumeSource {
  2364. // VolumeID uniquely identifies a Portworx volume
  2365. optional string volumeID = 1;
  2366. // FSType represents the filesystem type to mount
  2367. // Must be a filesystem type supported by the host operating system.
  2368. // Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
  2369. optional string fsType = 2;
  2370. // Defaults to false (read/write). ReadOnly here will force
  2371. // the ReadOnly setting in VolumeMounts.
  2372. // +optional
  2373. optional bool readOnly = 3;
  2374. }
  2375. // Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
  2376. // +k8s:openapi-gen=false
  2377. message Preconditions {
  2378. // Specifies the target UID.
  2379. // +optional
  2380. optional string uid = 1;
  2381. }
  2382. // Describes a class of pods that should avoid this node.
  2383. message PreferAvoidPodsEntry {
  2384. // The class of pods.
  2385. optional PodSignature podSignature = 1;
  2386. // Time at which this entry was added to the list.
  2387. // +optional
  2388. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time evictionTime = 2;
  2389. // (brief) reason why this entry was added to the list.
  2390. // +optional
  2391. optional string reason = 3;
  2392. // Human readable message indicating why this entry was added to the list.
  2393. // +optional
  2394. optional string message = 4;
  2395. }
  2396. // An empty preferred scheduling term matches all objects with implicit weight 0
  2397. // (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
  2398. message PreferredSchedulingTerm {
  2399. // Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
  2400. optional int32 weight = 1;
  2401. // A node selector term, associated with the corresponding weight.
  2402. optional NodeSelectorTerm preference = 2;
  2403. }
  2404. // Probe describes a health check to be performed against a container to determine whether it is
  2405. // alive or ready to receive traffic.
  2406. message Probe {
  2407. // The action taken to determine the health of a container
  2408. optional Handler handler = 1;
  2409. // Number of seconds after the container has started before liveness probes are initiated.
  2410. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  2411. // +optional
  2412. optional int32 initialDelaySeconds = 2;
  2413. // Number of seconds after which the probe times out.
  2414. // Defaults to 1 second. Minimum value is 1.
  2415. // More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  2416. // +optional
  2417. optional int32 timeoutSeconds = 3;
  2418. // How often (in seconds) to perform the probe.
  2419. // Default to 10 seconds. Minimum value is 1.
  2420. // +optional
  2421. optional int32 periodSeconds = 4;
  2422. // Minimum consecutive successes for the probe to be considered successful after having failed.
  2423. // Defaults to 1. Must be 1 for liveness. Minimum value is 1.
  2424. // +optional
  2425. optional int32 successThreshold = 5;
  2426. // Minimum consecutive failures for the probe to be considered failed after having succeeded.
  2427. // Defaults to 3. Minimum value is 1.
  2428. // +optional
  2429. optional int32 failureThreshold = 6;
  2430. }
  2431. // Represents a projected volume source
  2432. message ProjectedVolumeSource {
  2433. // list of volume projections
  2434. repeated VolumeProjection sources = 1;
  2435. // Mode bits to use on created files by default. Must be a value between
  2436. // 0 and 0777.
  2437. // Directories within the path are not affected by this setting.
  2438. // This might be in conflict with other options that affect the file
  2439. // mode, like fsGroup, and the result can be other mode bits set.
  2440. // +optional
  2441. optional int32 defaultMode = 2;
  2442. }
  2443. // Represents a Quobyte mount that lasts the lifetime of a pod.
  2444. // Quobyte volumes do not support ownership management or SELinux relabeling.
  2445. message QuobyteVolumeSource {
  2446. // Registry represents a single or multiple Quobyte Registry services
  2447. // specified as a string as host:port pair (multiple entries are separated with commas)
  2448. // which acts as the central registry for volumes
  2449. optional string registry = 1;
  2450. // Volume is a string that references an already created Quobyte volume by name.
  2451. optional string volume = 2;
  2452. // ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.
  2453. // Defaults to false.
  2454. // +optional
  2455. optional bool readOnly = 3;
  2456. // User to map volume access to
  2457. // Defaults to serivceaccount user
  2458. // +optional
  2459. optional string user = 4;
  2460. // Group to map volume access to
  2461. // Default is no group
  2462. // +optional
  2463. optional string group = 5;
  2464. }
  2465. // Represents a Rados Block Device mount that lasts the lifetime of a pod.
  2466. // RBD volumes support ownership management and SELinux relabeling.
  2467. message RBDVolumeSource {
  2468. // A collection of Ceph monitors.
  2469. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2470. repeated string monitors = 1;
  2471. // The rados image name.
  2472. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2473. optional string image = 2;
  2474. // Filesystem type of the volume that you want to mount.
  2475. // Tip: Ensure that the filesystem type is supported by the host operating system.
  2476. // Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2477. // More info: http://kubernetes.io/docs/user-guide/volumes#rbd
  2478. // TODO: how do we prevent errors in the filesystem from compromising the machine
  2479. // +optional
  2480. optional string fsType = 3;
  2481. // The rados pool name.
  2482. // Default is rbd.
  2483. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.
  2484. // +optional
  2485. optional string pool = 4;
  2486. // The rados user name.
  2487. // Default is admin.
  2488. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2489. // +optional
  2490. optional string user = 5;
  2491. // Keyring is the path to key ring for RBDUser.
  2492. // Default is /etc/ceph/keyring.
  2493. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2494. // +optional
  2495. optional string keyring = 6;
  2496. // SecretRef is name of the authentication secret for RBDUser. If provided
  2497. // overrides keyring.
  2498. // Default is nil.
  2499. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2500. // +optional
  2501. optional LocalObjectReference secretRef = 7;
  2502. // ReadOnly here will force the ReadOnly setting in VolumeMounts.
  2503. // Defaults to false.
  2504. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
  2505. // +optional
  2506. optional bool readOnly = 8;
  2507. }
  2508. // RangeAllocation is not a public type.
  2509. message RangeAllocation {
  2510. // Standard object's metadata.
  2511. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2512. // +optional
  2513. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2514. // Range is string that identifies the range represented by 'data'.
  2515. optional string range = 2;
  2516. // Data is a bit array containing all allocated addresses in the previous segment.
  2517. optional bytes data = 3;
  2518. }
  2519. // ReplicationController represents the configuration of a replication controller.
  2520. message ReplicationController {
  2521. // If the Labels of a ReplicationController are empty, they are defaulted to
  2522. // be the same as the Pod(s) that the replication controller manages.
  2523. // Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2524. // +optional
  2525. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2526. // Spec defines the specification of the desired behavior of the replication controller.
  2527. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2528. // +optional
  2529. optional ReplicationControllerSpec spec = 2;
  2530. // Status is the most recently observed status of the replication controller.
  2531. // This data may be out of date by some window of time.
  2532. // Populated by the system.
  2533. // Read-only.
  2534. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2535. // +optional
  2536. optional ReplicationControllerStatus status = 3;
  2537. }
  2538. // ReplicationControllerCondition describes the state of a replication controller at a certain point.
  2539. message ReplicationControllerCondition {
  2540. // Type of replication controller condition.
  2541. optional string type = 1;
  2542. // Status of the condition, one of True, False, Unknown.
  2543. optional string status = 2;
  2544. // The last time the condition transitioned from one status to another.
  2545. // +optional
  2546. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
  2547. // The reason for the condition's last transition.
  2548. // +optional
  2549. optional string reason = 4;
  2550. // A human readable message indicating details about the transition.
  2551. // +optional
  2552. optional string message = 5;
  2553. }
  2554. // ReplicationControllerList is a collection of replication controllers.
  2555. message ReplicationControllerList {
  2556. // Standard list metadata.
  2557. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2558. // +optional
  2559. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2560. // List of replication controllers.
  2561. // More info: http://kubernetes.io/docs/user-guide/replication-controller
  2562. repeated ReplicationController items = 2;
  2563. }
  2564. // ReplicationControllerSpec is the specification of a replication controller.
  2565. message ReplicationControllerSpec {
  2566. // Replicas is the number of desired replicas.
  2567. // This is a pointer to distinguish between explicit zero and unspecified.
  2568. // Defaults to 1.
  2569. // More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
  2570. // +optional
  2571. optional int32 replicas = 1;
  2572. // Minimum number of seconds for which a newly created pod should be ready
  2573. // without any of its container crashing, for it to be considered available.
  2574. // Defaults to 0 (pod will be considered available as soon as it is ready)
  2575. // +optional
  2576. optional int32 minReadySeconds = 4;
  2577. // Selector is a label query over pods that should match the Replicas count.
  2578. // If Selector is empty, it is defaulted to the labels present on the Pod template.
  2579. // Label keys and values that must match in order to be controlled by this replication
  2580. // controller, if empty defaulted to labels on Pod template.
  2581. // More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
  2582. // +optional
  2583. map<string, string> selector = 2;
  2584. // Template is the object that describes the pod that will be created if
  2585. // insufficient replicas are detected. This takes precedence over a TemplateRef.
  2586. // More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
  2587. // +optional
  2588. optional PodTemplateSpec template = 3;
  2589. }
  2590. // ReplicationControllerStatus represents the current status of a replication
  2591. // controller.
  2592. message ReplicationControllerStatus {
  2593. // Replicas is the most recently oberved number of replicas.
  2594. // More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller
  2595. optional int32 replicas = 1;
  2596. // The number of pods that have labels matching the labels of the pod template of the replication controller.
  2597. // +optional
  2598. optional int32 fullyLabeledReplicas = 2;
  2599. // The number of ready replicas for this replication controller.
  2600. // +optional
  2601. optional int32 readyReplicas = 4;
  2602. // The number of available replicas (ready for at least minReadySeconds) for this replication controller.
  2603. // +optional
  2604. optional int32 availableReplicas = 5;
  2605. // ObservedGeneration reflects the generation of the most recently observed replication controller.
  2606. // +optional
  2607. optional int64 observedGeneration = 3;
  2608. // Represents the latest available observations of a replication controller's current state.
  2609. // +optional
  2610. repeated ReplicationControllerCondition conditions = 6;
  2611. }
  2612. // ResourceFieldSelector represents container resources (cpu, memory) and their output format
  2613. message ResourceFieldSelector {
  2614. // Container name: required for volumes, optional for env vars
  2615. // +optional
  2616. optional string containerName = 1;
  2617. // Required: resource to select
  2618. optional string resource = 2;
  2619. // Specifies the output format of the exposed resources, defaults to "1"
  2620. // +optional
  2621. optional k8s.io.apimachinery.pkg.api.resource.Quantity divisor = 3;
  2622. }
  2623. // ResourceQuota sets aggregate quota restrictions enforced per namespace
  2624. message ResourceQuota {
  2625. // Standard object's metadata.
  2626. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2627. // +optional
  2628. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2629. // Spec defines the desired quota.
  2630. // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2631. // +optional
  2632. optional ResourceQuotaSpec spec = 2;
  2633. // Status defines the actual enforced quota and its current usage.
  2634. // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2635. // +optional
  2636. optional ResourceQuotaStatus status = 3;
  2637. }
  2638. // ResourceQuotaList is a list of ResourceQuota items.
  2639. message ResourceQuotaList {
  2640. // Standard list metadata.
  2641. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2642. // +optional
  2643. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2644. // Items is a list of ResourceQuota objects.
  2645. // More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
  2646. repeated ResourceQuota items = 2;
  2647. }
  2648. // ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
  2649. message ResourceQuotaSpec {
  2650. // Hard is the set of desired hard limits for each named resource.
  2651. // More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
  2652. // +optional
  2653. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> hard = 1;
  2654. // A collection of filters that must match each object tracked by a quota.
  2655. // If not specified, the quota matches all objects.
  2656. // +optional
  2657. repeated string scopes = 2;
  2658. }
  2659. // ResourceQuotaStatus defines the enforced hard limits and observed use.
  2660. message ResourceQuotaStatus {
  2661. // Hard is the set of enforced hard limits for each named resource.
  2662. // More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
  2663. // +optional
  2664. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> hard = 1;
  2665. // Used is the current observed total usage of the resource in the namespace.
  2666. // +optional
  2667. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> used = 2;
  2668. }
  2669. // ResourceRequirements describes the compute resource requirements.
  2670. message ResourceRequirements {
  2671. // Limits describes the maximum amount of compute resources allowed.
  2672. // More info: http://kubernetes.io/docs/user-guide/compute-resources/
  2673. // +optional
  2674. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> limits = 1;
  2675. // Requests describes the minimum amount of compute resources required.
  2676. // If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
  2677. // otherwise to an implementation-defined value.
  2678. // More info: http://kubernetes.io/docs/user-guide/compute-resources/
  2679. // +optional
  2680. map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> requests = 2;
  2681. }
  2682. // SELinuxOptions are the labels to be applied to the container
  2683. message SELinuxOptions {
  2684. // User is a SELinux user label that applies to the container.
  2685. // +optional
  2686. optional string user = 1;
  2687. // Role is a SELinux role label that applies to the container.
  2688. // +optional
  2689. optional string role = 2;
  2690. // Type is a SELinux type label that applies to the container.
  2691. // +optional
  2692. optional string type = 3;
  2693. // Level is SELinux level label that applies to the container.
  2694. // +optional
  2695. optional string level = 4;
  2696. }
  2697. // ScaleIOVolumeSource represents a persistent ScaleIO volume
  2698. message ScaleIOVolumeSource {
  2699. // The host address of the ScaleIO API Gateway.
  2700. optional string gateway = 1;
  2701. // The name of the storage system as configured in ScaleIO.
  2702. optional string system = 2;
  2703. // SecretRef references to the secret for ScaleIO user and other
  2704. // sensitive information. If this is not provided, Login operation will fail.
  2705. optional LocalObjectReference secretRef = 3;
  2706. // Flag to enable/disable SSL communication with Gateway, default false
  2707. // +optional
  2708. optional bool sslEnabled = 4;
  2709. // The name of the Protection Domain for the configured storage (defaults to "default").
  2710. // +optional
  2711. optional string protectionDomain = 5;
  2712. // The Storage Pool associated with the protection domain (defaults to "default").
  2713. // +optional
  2714. optional string storagePool = 6;
  2715. // Indicates whether the storage for a volume should be thick or thin (defaults to "thin").
  2716. // +optional
  2717. optional string storageMode = 7;
  2718. // The name of a volume already created in the ScaleIO system
  2719. // that is associated with this volume source.
  2720. optional string volumeName = 8;
  2721. // Filesystem type to mount.
  2722. // Must be a filesystem type supported by the host operating system.
  2723. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  2724. // +optional
  2725. optional string fsType = 9;
  2726. // Defaults to false (read/write). ReadOnly here will force
  2727. // the ReadOnly setting in VolumeMounts.
  2728. // +optional
  2729. optional bool readOnly = 10;
  2730. }
  2731. // Secret holds secret data of a certain type. The total bytes of the values in
  2732. // the Data field must be less than MaxSecretSize bytes.
  2733. message Secret {
  2734. // Standard object's metadata.
  2735. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2736. // +optional
  2737. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2738. // Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN
  2739. // or leading dot followed by valid DNS_SUBDOMAIN.
  2740. // The serialized form of the secret data is a base64 encoded string,
  2741. // representing the arbitrary (possibly non-string) data value here.
  2742. // Described in https://tools.ietf.org/html/rfc4648#section-4
  2743. // +optional
  2744. map<string, bytes> data = 2;
  2745. // stringData allows specifying non-binary secret data in string form.
  2746. // It is provided as a write-only convenience method.
  2747. // All keys and values are merged into the data field on write, overwriting any existing values.
  2748. // It is never output when reading from the API.
  2749. // +k8s:conversion-gen=false
  2750. // +optional
  2751. map<string, string> stringData = 4;
  2752. // Used to facilitate programmatic handling of secret data.
  2753. // +optional
  2754. optional string type = 3;
  2755. }
  2756. // SecretEnvSource selects a Secret to populate the environment
  2757. // variables with.
  2758. //
  2759. // The contents of the target Secret's Data field will represent the
  2760. // key-value pairs as environment variables.
  2761. message SecretEnvSource {
  2762. // The Secret to select from.
  2763. optional LocalObjectReference localObjectReference = 1;
  2764. // Specify whether the Secret must be defined
  2765. // +optional
  2766. optional bool optional = 2;
  2767. }
  2768. // SecretKeySelector selects a key of a Secret.
  2769. message SecretKeySelector {
  2770. // The name of the secret in the pod's namespace to select from.
  2771. optional LocalObjectReference localObjectReference = 1;
  2772. // The key of the secret to select from. Must be a valid secret key.
  2773. optional string key = 2;
  2774. // Specify whether the Secret or it's key must be defined
  2775. // +optional
  2776. optional bool optional = 3;
  2777. }
  2778. // SecretList is a list of Secret.
  2779. message SecretList {
  2780. // Standard list metadata.
  2781. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2782. // +optional
  2783. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2784. // Items is a list of secret objects.
  2785. // More info: http://kubernetes.io/docs/user-guide/secrets
  2786. repeated Secret items = 2;
  2787. }
  2788. // Adapts a secret into a projected volume.
  2789. //
  2790. // The contents of the target Secret's Data field will be presented in a
  2791. // projected volume as files using the keys in the Data field as the file names.
  2792. // Note that this is identical to a secret volume source without the default
  2793. // mode.
  2794. message SecretProjection {
  2795. optional LocalObjectReference localObjectReference = 1;
  2796. // If unspecified, each key-value pair in the Data field of the referenced
  2797. // Secret will be projected into the volume as a file whose name is the
  2798. // key and content is the value. If specified, the listed keys will be
  2799. // projected into the specified paths, and unlisted keys will not be
  2800. // present. If a key is specified which is not present in the Secret,
  2801. // the volume setup will error unless it is marked optional. Paths must be
  2802. // relative and may not contain the '..' path or start with '..'.
  2803. // +optional
  2804. repeated KeyToPath items = 2;
  2805. // Specify whether the Secret or its key must be defined
  2806. // +optional
  2807. optional bool optional = 4;
  2808. }
  2809. // Adapts a Secret into a volume.
  2810. //
  2811. // The contents of the target Secret's Data field will be presented in a volume
  2812. // as files using the keys in the Data field as the file names.
  2813. // Secret volumes support ownership management and SELinux relabeling.
  2814. message SecretVolumeSource {
  2815. // Name of the secret in the pod's namespace to use.
  2816. // More info: http://kubernetes.io/docs/user-guide/volumes#secrets
  2817. // +optional
  2818. optional string secretName = 1;
  2819. // If unspecified, each key-value pair in the Data field of the referenced
  2820. // Secret will be projected into the volume as a file whose name is the
  2821. // key and content is the value. If specified, the listed keys will be
  2822. // projected into the specified paths, and unlisted keys will not be
  2823. // present. If a key is specified which is not present in the Secret,
  2824. // the volume setup will error unless it is marked optional. Paths must be
  2825. // relative and may not contain the '..' path or start with '..'.
  2826. // +optional
  2827. repeated KeyToPath items = 2;
  2828. // Optional: mode bits to use on created files by default. Must be a
  2829. // value between 0 and 0777. Defaults to 0644.
  2830. // Directories within the path are not affected by this setting.
  2831. // This might be in conflict with other options that affect the file
  2832. // mode, like fsGroup, and the result can be other mode bits set.
  2833. // +optional
  2834. optional int32 defaultMode = 3;
  2835. // Specify whether the Secret or it's keys must be defined
  2836. // +optional
  2837. optional bool optional = 4;
  2838. }
  2839. // SecurityContext holds security configuration that will be applied to a container.
  2840. // Some fields are present in both SecurityContext and PodSecurityContext. When both
  2841. // are set, the values in SecurityContext take precedence.
  2842. message SecurityContext {
  2843. // The capabilities to add/drop when running containers.
  2844. // Defaults to the default set of capabilities granted by the container runtime.
  2845. // +optional
  2846. optional Capabilities capabilities = 1;
  2847. // Run container in privileged mode.
  2848. // Processes in privileged containers are essentially equivalent to root on the host.
  2849. // Defaults to false.
  2850. // +optional
  2851. optional bool privileged = 2;
  2852. // The SELinux context to be applied to the container.
  2853. // If unspecified, the container runtime will allocate a random SELinux context for each
  2854. // container. May also be set in PodSecurityContext. If set in both SecurityContext and
  2855. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  2856. // +optional
  2857. optional SELinuxOptions seLinuxOptions = 3;
  2858. // The UID to run the entrypoint of the container process.
  2859. // Defaults to user specified in image metadata if unspecified.
  2860. // May also be set in PodSecurityContext. If set in both SecurityContext and
  2861. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  2862. // +optional
  2863. optional int64 runAsUser = 4;
  2864. // Indicates that the container must run as a non-root user.
  2865. // If true, the Kubelet will validate the image at runtime to ensure that it
  2866. // does not run as UID 0 (root) and fail to start the container if it does.
  2867. // If unset or false, no such validation will be performed.
  2868. // May also be set in PodSecurityContext. If set in both SecurityContext and
  2869. // PodSecurityContext, the value specified in SecurityContext takes precedence.
  2870. // +optional
  2871. optional bool runAsNonRoot = 5;
  2872. // Whether this container has a read-only root filesystem.
  2873. // Default is false.
  2874. // +optional
  2875. optional bool readOnlyRootFilesystem = 6;
  2876. }
  2877. // SerializedReference is a reference to serialized object.
  2878. message SerializedReference {
  2879. // The reference to an object in the system.
  2880. // +optional
  2881. optional ObjectReference reference = 1;
  2882. }
  2883. // Service is a named abstraction of software service (for example, mysql) consisting of local port
  2884. // (for example 3306) that the proxy listens on, and the selector that determines which pods
  2885. // will answer requests sent through the proxy.
  2886. message Service {
  2887. // Standard object's metadata.
  2888. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2889. // +optional
  2890. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2891. // Spec defines the behavior of a service.
  2892. // http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2893. // +optional
  2894. optional ServiceSpec spec = 2;
  2895. // Most recently observed status of the service.
  2896. // Populated by the system.
  2897. // Read-only.
  2898. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
  2899. // +optional
  2900. optional ServiceStatus status = 3;
  2901. }
  2902. // ServiceAccount binds together:
  2903. // * a name, understood by users, and perhaps by peripheral systems, for an identity
  2904. // * a principal that can be authenticated and authorized
  2905. // * a set of secrets
  2906. message ServiceAccount {
  2907. // Standard object's metadata.
  2908. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
  2909. // +optional
  2910. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  2911. // Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount.
  2912. // More info: http://kubernetes.io/docs/user-guide/secrets
  2913. // +optional
  2914. repeated ObjectReference secrets = 2;
  2915. // ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
  2916. // in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets
  2917. // can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet.
  2918. // More info: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret
  2919. // +optional
  2920. repeated LocalObjectReference imagePullSecrets = 3;
  2921. // AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted.
  2922. // Can be overridden at the pod level.
  2923. // +optional
  2924. optional bool automountServiceAccountToken = 4;
  2925. }
  2926. // ServiceAccountList is a list of ServiceAccount objects
  2927. message ServiceAccountList {
  2928. // Standard list metadata.
  2929. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2930. // +optional
  2931. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2932. // List of ServiceAccounts.
  2933. // More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts
  2934. repeated ServiceAccount items = 2;
  2935. }
  2936. // ServiceList holds a list of services.
  2937. message ServiceList {
  2938. // Standard list metadata.
  2939. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
  2940. // +optional
  2941. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  2942. // List of services
  2943. repeated Service items = 2;
  2944. }
  2945. // ServicePort contains information on service's port.
  2946. message ServicePort {
  2947. // The name of this port within the service. This must be a DNS_LABEL.
  2948. // All ports within a ServiceSpec must have unique names. This maps to
  2949. // the 'Name' field in EndpointPort objects.
  2950. // Optional if only one ServicePort is defined on this service.
  2951. // +optional
  2952. optional string name = 1;
  2953. // The IP protocol for this port. Supports "TCP" and "UDP".
  2954. // Default is TCP.
  2955. // +optional
  2956. optional string protocol = 2;
  2957. // The port that will be exposed by this service.
  2958. optional int32 port = 3;
  2959. // Number or name of the port to access on the pods targeted by the service.
  2960. // Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
  2961. // If this is a string, it will be looked up as a named port in the
  2962. // target Pod's container ports. If this is not specified, the value
  2963. // of the 'port' field is used (an identity map).
  2964. // This field is ignored for services with clusterIP=None, and should be
  2965. // omitted or set equal to the 'port' field.
  2966. // More info: http://kubernetes.io/docs/user-guide/services#defining-a-service
  2967. // +optional
  2968. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString targetPort = 4;
  2969. // The port on each node on which this service is exposed when type=NodePort or LoadBalancer.
  2970. // Usually assigned by the system. If specified, it will be allocated to the service
  2971. // if unused or else creation of the service will fail.
  2972. // Default is to auto-allocate a port if the ServiceType of this Service requires one.
  2973. // More info: http://kubernetes.io/docs/user-guide/services#type--nodeport
  2974. // +optional
  2975. optional int32 nodePort = 5;
  2976. }
  2977. // ServiceProxyOptions is the query options to a Service's proxy call.
  2978. message ServiceProxyOptions {
  2979. // Path is the part of URLs that include service endpoints, suffixes,
  2980. // and parameters to use for the current proxy request to service.
  2981. // For example, the whole request URL is
  2982. // http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy.
  2983. // Path is _search?q=user:kimchy.
  2984. // +optional
  2985. optional string path = 1;
  2986. }
  2987. // ServiceSpec describes the attributes that a user creates on a service.
  2988. message ServiceSpec {
  2989. // The list of ports that are exposed by this service.
  2990. // More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
  2991. repeated ServicePort ports = 1;
  2992. // Route service traffic to pods with label keys and values matching this
  2993. // selector. If empty or not present, the service is assumed to have an
  2994. // external process managing its endpoints, which Kubernetes will not
  2995. // modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
  2996. // Ignored if type is ExternalName.
  2997. // More info: http://kubernetes.io/docs/user-guide/services#overview
  2998. // +optional
  2999. map<string, string> selector = 2;
  3000. // clusterIP is the IP address of the service and is usually assigned
  3001. // randomly by the master. If an address is specified manually and is not in
  3002. // use by others, it will be allocated to the service; otherwise, creation
  3003. // of the service will fail. This field can not be changed through updates.
  3004. // Valid values are "None", empty string (""), or a valid IP address. "None"
  3005. // can be specified for headless services when proxying is not required.
  3006. // Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if
  3007. // type is ExternalName.
  3008. // More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
  3009. // +optional
  3010. optional string clusterIP = 3;
  3011. // type determines how the Service is exposed. Defaults to ClusterIP. Valid
  3012. // options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
  3013. // "ExternalName" maps to the specified externalName.
  3014. // "ClusterIP" allocates a cluster-internal IP address for load-balancing to
  3015. // endpoints. Endpoints are determined by the selector or if that is not
  3016. // specified, by manual construction of an Endpoints object. If clusterIP is
  3017. // "None", no virtual IP is allocated and the endpoints are published as a
  3018. // set of endpoints rather than a stable IP.
  3019. // "NodePort" builds on ClusterIP and allocates a port on every node which
  3020. // routes to the clusterIP.
  3021. // "LoadBalancer" builds on NodePort and creates an
  3022. // external load-balancer (if supported in the current cloud) which routes
  3023. // to the clusterIP.
  3024. // More info: http://kubernetes.io/docs/user-guide/services#overview
  3025. // +optional
  3026. optional string type = 4;
  3027. // externalIPs is a list of IP addresses for which nodes in the cluster
  3028. // will also accept traffic for this service. These IPs are not managed by
  3029. // Kubernetes. The user is responsible for ensuring that traffic arrives
  3030. // at a node with this IP. A common example is external load-balancers
  3031. // that are not part of the Kubernetes system. A previous form of this
  3032. // functionality exists as the deprecatedPublicIPs field. When using this
  3033. // field, callers should also clear the deprecatedPublicIPs field.
  3034. // +optional
  3035. repeated string externalIPs = 5;
  3036. // deprecatedPublicIPs is deprecated and replaced by the externalIPs field
  3037. // with almost the exact same semantics. This field is retained in the v1
  3038. // API for compatibility until at least 8/20/2016. It will be removed from
  3039. // any new API revisions. If both deprecatedPublicIPs *and* externalIPs are
  3040. // set, deprecatedPublicIPs is used.
  3041. // +k8s:conversion-gen=false
  3042. // +optional
  3043. repeated string deprecatedPublicIPs = 6;
  3044. // Supports "ClientIP" and "None". Used to maintain session affinity.
  3045. // Enable client IP based session affinity.
  3046. // Must be ClientIP or None.
  3047. // Defaults to None.
  3048. // More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
  3049. // +optional
  3050. optional string sessionAffinity = 7;
  3051. // Only applies to Service Type: LoadBalancer
  3052. // LoadBalancer will get created with the IP specified in this field.
  3053. // This feature depends on whether the underlying cloud-provider supports specifying
  3054. // the loadBalancerIP when a load balancer is created.
  3055. // This field will be ignored if the cloud-provider does not support the feature.
  3056. // +optional
  3057. optional string loadBalancerIP = 8;
  3058. // If specified and supported by the platform, this will restrict traffic through the cloud-provider
  3059. // load-balancer will be restricted to the specified client IPs. This field will be ignored if the
  3060. // cloud-provider does not support the feature."
  3061. // More info: http://kubernetes.io/docs/user-guide/services-firewalls
  3062. // +optional
  3063. repeated string loadBalancerSourceRanges = 9;
  3064. // externalName is the external reference that kubedns or equivalent will
  3065. // return as a CNAME record for this service. No proxying will be involved.
  3066. // Must be a valid DNS name and requires Type to be ExternalName.
  3067. // +optional
  3068. optional string externalName = 10;
  3069. }
  3070. // ServiceStatus represents the current status of a service.
  3071. message ServiceStatus {
  3072. // LoadBalancer contains the current status of the load-balancer,
  3073. // if one is present.
  3074. // +optional
  3075. optional LoadBalancerStatus loadBalancer = 1;
  3076. }
  3077. message Sysctl {
  3078. optional string name = 1;
  3079. optional string value = 2;
  3080. }
  3081. // TCPSocketAction describes an action based on opening a socket
  3082. message TCPSocketAction {
  3083. // Number or name of the port to access on the container.
  3084. // Number must be in the range 1 to 65535.
  3085. // Name must be an IANA_SVC_NAME.
  3086. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 1;
  3087. }
  3088. // The node this Taint is attached to has the effect "effect" on
  3089. // any pod that that does not tolerate the Taint.
  3090. message Taint {
  3091. // Required. The taint key to be applied to a node.
  3092. optional string key = 1;
  3093. // Required. The taint value corresponding to the taint key.
  3094. // +optional
  3095. optional string value = 2;
  3096. // Required. The effect of the taint on pods
  3097. // that do not tolerate the taint.
  3098. // Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
  3099. optional string effect = 3;
  3100. // TimeAdded represents the time at which the taint was added.
  3101. // It is only written for NoExecute taints.
  3102. // +optional
  3103. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time timeAdded = 4;
  3104. }
  3105. // The pod this Toleration is attached to tolerates any taint that matches
  3106. // the triple <key,value,effect> using the matching operator <operator>.
  3107. message Toleration {
  3108. // Key is the taint key that the toleration applies to. Empty means match all taint keys.
  3109. // If the key is empty, operator must be Exists; this combination means to match all values and all keys.
  3110. // +optional
  3111. optional string key = 1;
  3112. // Operator represents a key's relationship to the value.
  3113. // Valid operators are Exists and Equal. Defaults to Equal.
  3114. // Exists is equivalent to wildcard for value, so that a pod can
  3115. // tolerate all taints of a particular category.
  3116. // +optional
  3117. optional string operator = 2;
  3118. // Value is the taint value the toleration matches to.
  3119. // If the operator is Exists, the value should be empty, otherwise just a regular string.
  3120. // +optional
  3121. optional string value = 3;
  3122. // Effect indicates the taint effect to match. Empty means match all taint effects.
  3123. // When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
  3124. // +optional
  3125. optional string effect = 4;
  3126. // TolerationSeconds represents the period of time the toleration (which must be
  3127. // of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
  3128. // it is not set, which means tolerate the taint forever (do not evict). Zero and
  3129. // negative values will be treated as 0 (evict immediately) by the system.
  3130. // +optional
  3131. optional int64 tolerationSeconds = 5;
  3132. }
  3133. // Volume represents a named volume in a pod that may be accessed by any container in the pod.
  3134. message Volume {
  3135. // Volume's name.
  3136. // Must be a DNS_LABEL and unique within the pod.
  3137. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  3138. optional string name = 1;
  3139. // VolumeSource represents the location and type of the mounted volume.
  3140. // If not specified, the Volume is implied to be an EmptyDir.
  3141. // This implied behavior is deprecated and will be removed in a future version.
  3142. optional VolumeSource volumeSource = 2;
  3143. }
  3144. // VolumeMount describes a mounting of a Volume within a container.
  3145. message VolumeMount {
  3146. // This must match the Name of a Volume.
  3147. optional string name = 1;
  3148. // Mounted read-only if true, read-write otherwise (false or unspecified).
  3149. // Defaults to false.
  3150. // +optional
  3151. optional bool readOnly = 2;
  3152. // Path within the container at which the volume should be mounted. Must
  3153. // not contain ':'.
  3154. optional string mountPath = 3;
  3155. // Path within the volume from which the container's volume should be mounted.
  3156. // Defaults to "" (volume's root).
  3157. // +optional
  3158. optional string subPath = 4;
  3159. }
  3160. // Projection that may be projected along with other supported volume types
  3161. message VolumeProjection {
  3162. // information about the secret data to project
  3163. optional SecretProjection secret = 1;
  3164. // information about the downwardAPI data to project
  3165. optional DownwardAPIProjection downwardAPI = 2;
  3166. // information about the configMap data to project
  3167. optional ConfigMapProjection configMap = 3;
  3168. }
  3169. // Represents the source of a volume to mount.
  3170. // Only one of its members may be specified.
  3171. message VolumeSource {
  3172. // HostPath represents a pre-existing file or directory on the host
  3173. // machine that is directly exposed to the container. This is generally
  3174. // used for system agents or other privileged things that are allowed
  3175. // to see the host machine. Most containers will NOT need this.
  3176. // More info: http://kubernetes.io/docs/user-guide/volumes#hostpath
  3177. // ---
  3178. // TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
  3179. // mount host directories as read/write.
  3180. // +optional
  3181. optional HostPathVolumeSource hostPath = 1;
  3182. // EmptyDir represents a temporary directory that shares a pod's lifetime.
  3183. // More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
  3184. // +optional
  3185. optional EmptyDirVolumeSource emptyDir = 2;
  3186. // GCEPersistentDisk represents a GCE Disk resource that is attached to a
  3187. // kubelet's host machine and then exposed to the pod.
  3188. // More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
  3189. // +optional
  3190. optional GCEPersistentDiskVolumeSource gcePersistentDisk = 3;
  3191. // AWSElasticBlockStore represents an AWS Disk resource that is attached to a
  3192. // kubelet's host machine and then exposed to the pod.
  3193. // More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
  3194. // +optional
  3195. optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 4;
  3196. // GitRepo represents a git repository at a particular revision.
  3197. // +optional
  3198. optional GitRepoVolumeSource gitRepo = 5;
  3199. // Secret represents a secret that should populate this volume.
  3200. // More info: http://kubernetes.io/docs/user-guide/volumes#secrets
  3201. // +optional
  3202. optional SecretVolumeSource secret = 6;
  3203. // NFS represents an NFS mount on the host that shares a pod's lifetime
  3204. // More info: http://kubernetes.io/docs/user-guide/volumes#nfs
  3205. // +optional
  3206. optional NFSVolumeSource nfs = 7;
  3207. // ISCSI represents an ISCSI Disk resource that is attached to a
  3208. // kubelet's host machine and then exposed to the pod.
  3209. // More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md
  3210. // +optional
  3211. optional ISCSIVolumeSource iscsi = 8;
  3212. // Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
  3213. // More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
  3214. // +optional
  3215. optional GlusterfsVolumeSource glusterfs = 9;
  3216. // PersistentVolumeClaimVolumeSource represents a reference to a
  3217. // PersistentVolumeClaim in the same namespace.
  3218. // More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims
  3219. // +optional
  3220. optional PersistentVolumeClaimVolumeSource persistentVolumeClaim = 10;
  3221. // RBD represents a Rados Block Device mount on the host that shares a pod's lifetime.
  3222. // More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
  3223. // +optional
  3224. optional RBDVolumeSource rbd = 11;
  3225. // FlexVolume represents a generic volume resource that is
  3226. // provisioned/attached using an exec based plugin. This is an
  3227. // alpha feature and may change in future.
  3228. // +optional
  3229. optional FlexVolumeSource flexVolume = 12;
  3230. // Cinder represents a cinder volume attached and mounted on kubelets host machine
  3231. // More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  3232. // +optional
  3233. optional CinderVolumeSource cinder = 13;
  3234. // CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
  3235. // +optional
  3236. optional CephFSVolumeSource cephfs = 14;
  3237. // Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
  3238. // +optional
  3239. optional FlockerVolumeSource flocker = 15;
  3240. // DownwardAPI represents downward API about the pod that should populate this volume
  3241. // +optional
  3242. optional DownwardAPIVolumeSource downwardAPI = 16;
  3243. // FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  3244. // +optional
  3245. optional FCVolumeSource fc = 17;
  3246. // AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  3247. // +optional
  3248. optional AzureFileVolumeSource azureFile = 18;
  3249. // ConfigMap represents a configMap that should populate this volume
  3250. // +optional
  3251. optional ConfigMapVolumeSource configMap = 19;
  3252. // VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
  3253. // +optional
  3254. optional VsphereVirtualDiskVolumeSource vsphereVolume = 20;
  3255. // Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
  3256. // +optional
  3257. optional QuobyteVolumeSource quobyte = 21;
  3258. // AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  3259. // +optional
  3260. optional AzureDiskVolumeSource azureDisk = 22;
  3261. // PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
  3262. optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 23;
  3263. // Items for all in one resources secrets, configmaps, and downward API
  3264. optional ProjectedVolumeSource projected = 26;
  3265. // PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
  3266. // +optional
  3267. optional PortworxVolumeSource portworxVolume = 24;
  3268. // ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  3269. // +optional
  3270. optional ScaleIOVolumeSource scaleIO = 25;
  3271. }
  3272. // Represents a vSphere volume resource.
  3273. message VsphereVirtualDiskVolumeSource {
  3274. // Path that identifies vSphere volume vmdk
  3275. optional string volumePath = 1;
  3276. // Filesystem type to mount.
  3277. // Must be a filesystem type supported by the host operating system.
  3278. // Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  3279. // +optional
  3280. optional string fsType = 2;
  3281. }
  3282. // The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
  3283. message WeightedPodAffinityTerm {
  3284. // weight associated with matching the corresponding podAffinityTerm,
  3285. // in the range 1-100.
  3286. optional int32 weight = 1;
  3287. // Required. A pod affinity term, associated with the corresponding weight.
  3288. optional PodAffinityTerm podAffinityTerm = 2;
  3289. }