0prometheus-operator-0prometheusruleCustomResourceDefinition.yaml 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. apiVersion: apiextensions.k8s.io/v1beta1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. creationTimestamp: null
  5. name: prometheusrules.monitoring.coreos.com
  6. spec:
  7. group: monitoring.coreos.com
  8. names:
  9. kind: PrometheusRule
  10. plural: prometheusrules
  11. scope: Namespaced
  12. validation:
  13. openAPIV3Schema:
  14. properties:
  15. apiVersion:
  16. description: 'APIVersion defines the versioned schema of this representation
  17. of an object. Servers should convert recognized schemas to the latest
  18. internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
  19. type: string
  20. kind:
  21. description: 'Kind is a string value representing the REST resource this
  22. object represents. Servers may infer this from the endpoint the client
  23. submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
  24. type: string
  25. metadata:
  26. description: ObjectMeta is metadata that all persisted resources must have,
  27. which includes all objects users must create.
  28. properties:
  29. annotations:
  30. description: 'Annotations is an unstructured key value map stored with
  31. a resource that may be set by external tools to store and retrieve
  32. arbitrary metadata. They are not queryable and should be preserved
  33. when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
  34. type: object
  35. clusterName:
  36. description: The name of the cluster which the object belongs to. This
  37. is used to distinguish resources with same name and namespace in different
  38. clusters. This field is not set anywhere right now and apiserver is
  39. going to ignore it if set in create or update request.
  40. type: string
  41. creationTimestamp:
  42. description: Time is a wrapper around time.Time which supports correct
  43. marshaling to YAML and JSON. Wrappers are provided for many of the
  44. factory methods that the time package offers.
  45. format: date-time
  46. type: string
  47. deletionGracePeriodSeconds:
  48. description: Number of seconds allowed for this object to gracefully
  49. terminate before it will be removed from the system. Only set when
  50. deletionTimestamp is also set. May only be shortened. Read-only.
  51. format: int64
  52. type: integer
  53. deletionTimestamp:
  54. description: Time is a wrapper around time.Time which supports correct
  55. marshaling to YAML and JSON. Wrappers are provided for many of the
  56. factory methods that the time package offers.
  57. format: date-time
  58. type: string
  59. finalizers:
  60. description: Must be empty before the object is deleted from the registry.
  61. Each entry is an identifier for the responsible component that will
  62. remove the entry from the list. If the deletionTimestamp of the object
  63. is non-nil, entries in this list can only be removed.
  64. items:
  65. type: string
  66. type: array
  67. generateName:
  68. description: |-
  69. GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
  70. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
  71. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
  72. type: string
  73. generation:
  74. description: A sequence number representing a specific generation of
  75. the desired state. Populated by the system. Read-only.
  76. format: int64
  77. type: integer
  78. initializers:
  79. description: Initializers tracks the progress of initialization.
  80. properties:
  81. pending:
  82. description: Pending is a list of initializers that must execute
  83. in order before this object is visible. When the last pending
  84. initializer is removed, and no failing result is set, the initializers
  85. struct will be set to nil and the object is considered as initialized
  86. and visible to all clients.
  87. items:
  88. description: Initializer is information about an initializer that
  89. has not yet completed.
  90. properties:
  91. name:
  92. description: name of the process that is responsible for initializing
  93. this object.
  94. type: string
  95. required:
  96. - name
  97. type: array
  98. result:
  99. description: Status is a return value for calls that don't return
  100. other objects.
  101. properties:
  102. apiVersion:
  103. description: 'APIVersion defines the versioned schema of this
  104. representation of an object. Servers should convert recognized
  105. schemas to the latest internal value, and may reject unrecognized
  106. values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
  107. type: string
  108. code:
  109. description: Suggested HTTP return code for this status, 0 if
  110. not set.
  111. format: int32
  112. type: integer
  113. details:
  114. description: StatusDetails is a set of additional properties
  115. that MAY be set by the server to provide additional information
  116. about a response. The Reason field of a Status object defines
  117. what attributes will be set. Clients must ignore fields that
  118. do not match the defined type of each attribute, and should
  119. assume that any attribute may be empty, invalid, or under
  120. defined.
  121. properties:
  122. causes:
  123. description: The Causes array includes more details associated
  124. with the StatusReason failure. Not all StatusReasons may
  125. provide detailed causes.
  126. items:
  127. description: StatusCause provides more information about
  128. an api.Status failure, including cases when multiple
  129. errors are encountered.
  130. properties:
  131. field:
  132. description: |-
  133. The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
  134. Examples:
  135. "name" - the field "name" on the current resource
  136. "items[0].name" - the field "name" on the first array entry in "items"
  137. type: string
  138. message:
  139. description: A human-readable description of the cause
  140. of the error. This field may be presented as-is
  141. to a reader.
  142. type: string
  143. reason:
  144. description: A machine-readable description of the
  145. cause of the error. If this value is empty there
  146. is no information available.
  147. type: string
  148. type: array
  149. group:
  150. description: The group attribute of the resource associated
  151. with the status StatusReason.
  152. type: string
  153. kind:
  154. description: 'The kind attribute of the resource associated
  155. with the status StatusReason. On some operations may differ
  156. from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
  157. type: string
  158. name:
  159. description: The name attribute of the resource associated
  160. with the status StatusReason (when there is a single name
  161. which can be described).
  162. type: string
  163. retryAfterSeconds:
  164. description: If specified, the time in seconds before the
  165. operation should be retried. Some errors may indicate
  166. the client must take an alternate action - for those errors
  167. this field may indicate how long to wait before taking
  168. the alternate action.
  169. format: int32
  170. type: integer
  171. uid:
  172. description: 'UID of the resource. (when there is a single
  173. resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
  174. type: string
  175. kind:
  176. description: 'Kind is a string value representing the REST resource
  177. this object represents. Servers may infer this from the endpoint
  178. the client submits requests to. Cannot be updated. In CamelCase.
  179. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
  180. type: string
  181. message:
  182. description: A human-readable description of the status of this
  183. operation.
  184. type: string
  185. metadata:
  186. description: ListMeta describes metadata that synthetic resources
  187. must have, including lists and various status objects. A resource
  188. may have only one of {ObjectMeta, ListMeta}.
  189. properties:
  190. continue:
  191. description: continue may be set if the user set a limit
  192. on the number of items returned, and indicates that the
  193. server has more data available. The value is opaque and
  194. may be used to issue another request to the endpoint that
  195. served this list to retrieve the next set of available
  196. objects. Continuing a consistent list may not be possible
  197. if the server configuration has changed or more than a
  198. few minutes have passed. The resourceVersion field returned
  199. when using this continue value will be identical to the
  200. value in the first response, unless you have received
  201. this token from an error message.
  202. type: string
  203. resourceVersion:
  204. description: 'String that identifies the server''s internal
  205. version of this object that can be used by clients to
  206. determine when objects have changed. Value must be treated
  207. as opaque by clients and passed unmodified back to the
  208. server. Populated by the system. Read-only. More info:
  209. https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency'
  210. type: string
  211. selfLink:
  212. description: selfLink is a URL representing this object.
  213. Populated by the system. Read-only.
  214. type: string
  215. reason:
  216. description: A machine-readable description of why this operation
  217. is in the "Failure" status. If this value is empty there is
  218. no information available. A Reason clarifies an HTTP status
  219. code but does not override it.
  220. type: string
  221. status:
  222. description: 'Status of the operation. One of: "Success" or
  223. "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status'
  224. type: string
  225. required:
  226. - pending
  227. labels:
  228. description: 'Map of string keys and values that can be used to organize
  229. and categorize (scope and select) objects. May match selectors of
  230. replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
  231. type: object
  232. name:
  233. description: 'Name must be unique within a namespace. Is required when
  234. creating resources, although some resources may allow a client to
  235. request the generation of an appropriate name automatically. Name
  236. is primarily intended for creation idempotence and configuration definition.
  237. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
  238. type: string
  239. namespace:
  240. description: |-
  241. Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
  242. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
  243. type: string
  244. ownerReferences:
  245. description: List of objects depended by this object. If ALL objects
  246. in the list have been deleted, this object will be garbage collected.
  247. If this object is managed by a controller, then an entry in this list
  248. will point to this controller, with the controller field set to true.
  249. There cannot be more than one managing controller.
  250. items:
  251. description: OwnerReference contains enough information to let you
  252. identify an owning object. Currently, an owning object must be in
  253. the same namespace, so there is no namespace field.
  254. properties:
  255. apiVersion:
  256. description: API version of the referent.
  257. type: string
  258. blockOwnerDeletion:
  259. description: If true, AND if the owner has the "foregroundDeletion"
  260. finalizer, then the owner cannot be deleted from the key-value
  261. store until this reference is removed. Defaults to false. To
  262. set this field, a user needs "delete" permission of the owner,
  263. otherwise 422 (Unprocessable Entity) will be returned.
  264. type: boolean
  265. controller:
  266. description: If true, this reference points to the managing controller.
  267. type: boolean
  268. kind:
  269. description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
  270. type: string
  271. name:
  272. description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
  273. type: string
  274. uid:
  275. description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
  276. type: string
  277. required:
  278. - apiVersion
  279. - kind
  280. - name
  281. - uid
  282. type: array
  283. resourceVersion:
  284. description: |-
  285. An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
  286. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
  287. type: string
  288. selfLink:
  289. description: SelfLink is a URL representing this object. Populated by
  290. the system. Read-only.
  291. type: string
  292. uid:
  293. description: |-
  294. UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
  295. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  296. type: string
  297. spec:
  298. description: PrometheusRuleSpec contains specification parameters for a
  299. Rule.
  300. properties:
  301. groups:
  302. description: Content of Prometheus rule file
  303. items:
  304. description: RuleGroup is a list of sequentially evaluated recording
  305. and alerting rules.
  306. properties:
  307. interval:
  308. type: string
  309. name:
  310. type: string
  311. rules:
  312. items:
  313. description: Rule describes an alerting or recording rule.
  314. properties:
  315. alert:
  316. type: string
  317. annotations:
  318. type: object
  319. expr:
  320. anyOf:
  321. - type: string
  322. - type: integer
  323. for:
  324. type: string
  325. labels:
  326. type: object
  327. record:
  328. type: string
  329. required:
  330. - expr
  331. type: array
  332. required:
  333. - name
  334. - rules
  335. type: array
  336. version: v1