github.com/m3db/m3@v1.5.0/scripts/vagrant/provision/manifests/kube-prometheus/0prometheus-operator-0prometheusruleCustomResourceDefinition.yaml (about)

     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  
    71                  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).
    72  
    73                  Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
    74                type: string
    75              generation:
    76                description: A sequence number representing a specific generation of
    77                  the desired state. Populated by the system. Read-only.
    78                format: int64
    79                type: integer
    80              initializers:
    81                description: Initializers tracks the progress of initialization.
    82                properties:
    83                  pending:
    84                    description: Pending is a list of initializers that must execute
    85                      in order before this object is visible. When the last pending
    86                      initializer is removed, and no failing result is set, the initializers
    87                      struct will be set to nil and the object is considered as initialized
    88                      and visible to all clients.
    89                    items:
    90                      description: Initializer is information about an initializer that
    91                        has not yet completed.
    92                      properties:
    93                        name:
    94                          description: name of the process that is responsible for initializing
    95                            this object.
    96                          type: string
    97                      required:
    98                      - name
    99                    type: array
   100                  result:
   101                    description: Status is a return value for calls that don't return
   102                      other objects.
   103                    properties:
   104                      apiVersion:
   105                        description: 'APIVersion defines the versioned schema of this
   106                          representation of an object. Servers should convert recognized
   107                          schemas to the latest internal value, and may reject unrecognized
   108                          values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
   109                        type: string
   110                      code:
   111                        description: Suggested HTTP return code for this status, 0 if
   112                          not set.
   113                        format: int32
   114                        type: integer
   115                      details:
   116                        description: StatusDetails is a set of additional properties
   117                          that MAY be set by the server to provide additional information
   118                          about a response. The Reason field of a Status object defines
   119                          what attributes will be set. Clients must ignore fields that
   120                          do not match the defined type of each attribute, and should
   121                          assume that any attribute may be empty, invalid, or under
   122                          defined.
   123                        properties:
   124                          causes:
   125                            description: The Causes array includes more details associated
   126                              with the StatusReason failure. Not all StatusReasons may
   127                              provide detailed causes.
   128                            items:
   129                              description: StatusCause provides more information about
   130                                an api.Status failure, including cases when multiple
   131                                errors are encountered.
   132                              properties:
   133                                field:
   134                                  description: |-
   135                                    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.
   136  
   137                                    Examples:
   138                                      "name" - the field "name" on the current resource
   139                                      "items[0].name" - the field "name" on the first array entry in "items"
   140                                  type: string
   141                                message:
   142                                  description: A human-readable description of the cause
   143                                    of the error.  This field may be presented as-is
   144                                    to a reader.
   145                                  type: string
   146                                reason:
   147                                  description: A machine-readable description of the
   148                                    cause of the error. If this value is empty there
   149                                    is no information available.
   150                                  type: string
   151                            type: array
   152                          group:
   153                            description: The group attribute of the resource associated
   154                              with the status StatusReason.
   155                            type: string
   156                          kind:
   157                            description: 'The kind attribute of the resource associated
   158                              with the status StatusReason. On some operations may differ
   159                              from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   160                            type: string
   161                          name:
   162                            description: The name attribute of the resource associated
   163                              with the status StatusReason (when there is a single name
   164                              which can be described).
   165                            type: string
   166                          retryAfterSeconds:
   167                            description: If specified, the time in seconds before the
   168                              operation should be retried. Some errors may indicate
   169                              the client must take an alternate action - for those errors
   170                              this field may indicate how long to wait before taking
   171                              the alternate action.
   172                            format: int32
   173                            type: integer
   174                          uid:
   175                            description: 'UID of the resource. (when there is a single
   176                              resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
   177                            type: string
   178                      kind:
   179                        description: 'Kind is a string value representing the REST resource
   180                          this object represents. Servers may infer this from the endpoint
   181                          the client submits requests to. Cannot be updated. In CamelCase.
   182                          More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   183                        type: string
   184                      message:
   185                        description: A human-readable description of the status of this
   186                          operation.
   187                        type: string
   188                      metadata:
   189                        description: ListMeta describes metadata that synthetic resources
   190                          must have, including lists and various status objects. A resource
   191                          may have only one of {ObjectMeta, ListMeta}.
   192                        properties:
   193                          continue:
   194                            description: continue may be set if the user set a limit
   195                              on the number of items returned, and indicates that the
   196                              server has more data available. The value is opaque and
   197                              may be used to issue another request to the endpoint that
   198                              served this list to retrieve the next set of available
   199                              objects. Continuing a consistent list may not be possible
   200                              if the server configuration has changed or more than a
   201                              few minutes have passed. The resourceVersion field returned
   202                              when using this continue value will be identical to the
   203                              value in the first response, unless you have received
   204                              this token from an error message.
   205                            type: string
   206                          resourceVersion:
   207                            description: 'String that identifies the server''s internal
   208                              version of this object that can be used by clients to
   209                              determine when objects have changed. Value must be treated
   210                              as opaque by clients and passed unmodified back to the
   211                              server. Populated by the system. Read-only. More info:
   212                              https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency'
   213                            type: string
   214                          selfLink:
   215                            description: selfLink is a URL representing this object.
   216                              Populated by the system. Read-only.
   217                            type: string
   218                      reason:
   219                        description: A machine-readable description of why this operation
   220                          is in the "Failure" status. If this value is empty there is
   221                          no information available. A Reason clarifies an HTTP status
   222                          code but does not override it.
   223                        type: string
   224                      status:
   225                        description: 'Status of the operation. One of: "Success" or
   226                          "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status'
   227                        type: string
   228                required:
   229                - pending
   230              labels:
   231                description: 'Map of string keys and values that can be used to organize
   232                  and categorize (scope and select) objects. May match selectors of
   233                  replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
   234                type: object
   235              name:
   236                description: 'Name must be unique within a namespace. Is required when
   237                  creating resources, although some resources may allow a client to
   238                  request the generation of an appropriate name automatically. Name
   239                  is primarily intended for creation idempotence and configuration definition.
   240                  Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
   241                type: string
   242              namespace:
   243                description: |-
   244                  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.
   245  
   246                  Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
   247                type: string
   248              ownerReferences:
   249                description: List of objects depended by this object. If ALL objects
   250                  in the list have been deleted, this object will be garbage collected.
   251                  If this object is managed by a controller, then an entry in this list
   252                  will point to this controller, with the controller field set to true.
   253                  There cannot be more than one managing controller.
   254                items:
   255                  description: OwnerReference contains enough information to let you
   256                    identify an owning object. An owning object must be in the same
   257                    namespace as the dependent, or be cluster-scoped, so there is no
   258                    namespace field.
   259                  properties:
   260                    apiVersion:
   261                      description: API version of the referent.
   262                      type: string
   263                    blockOwnerDeletion:
   264                      description: If true, AND if the owner has the "foregroundDeletion"
   265                        finalizer, then the owner cannot be deleted from the key-value
   266                        store until this reference is removed. Defaults to false. To
   267                        set this field, a user needs "delete" permission of the owner,
   268                        otherwise 422 (Unprocessable Entity) will be returned.
   269                      type: boolean
   270                    controller:
   271                      description: If true, this reference points to the managing controller.
   272                      type: boolean
   273                    kind:
   274                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   275                      type: string
   276                    name:
   277                      description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
   278                      type: string
   279                    uid:
   280                      description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
   281                      type: string
   282                  required:
   283                  - apiVersion
   284                  - kind
   285                  - name
   286                  - uid
   287                type: array
   288              resourceVersion:
   289                description: |-
   290                  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.
   291  
   292                  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
   293                type: string
   294              selfLink:
   295                description: SelfLink is a URL representing this object. Populated by
   296                  the system. Read-only.
   297                type: string
   298              uid:
   299                description: |-
   300                  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.
   301  
   302                  Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
   303                type: string
   304          spec:
   305            description: PrometheusRuleSpec contains specification parameters for a
   306              Rule.
   307            properties:
   308              groups:
   309                description: Content of Prometheus rule file
   310                items:
   311                  description: RuleGroup is a list of sequentially evaluated recording
   312                    and alerting rules.
   313                  properties:
   314                    interval:
   315                      type: string
   316                    name:
   317                      type: string
   318                    rules:
   319                      items:
   320                        description: Rule describes an alerting or recording rule.
   321                        properties:
   322                          alert:
   323                            type: string
   324                          annotations:
   325                            type: object
   326                          expr:
   327                            anyOf:
   328                            - type: string
   329                            - type: integer
   330                          for:
   331                            type: string
   332                          labels:
   333                            type: object
   334                          record:
   335                            type: string
   336                        required:
   337                        - expr
   338                      type: array
   339                  required:
   340                  - name
   341                  - rules
   342                type: array
   343    version: v1