github.com/verrazzano/verrazzano@v1.7.0/platform-operator/helm_config/charts/verrazzano-application-operator/crds/oam.verrazzano.io_metricstraits.yaml (about)

     1  # Copyright (c) 2020, 2022, Oracle and/or its affiliates.
     2  # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
     3  ---
     4  apiVersion: apiextensions.k8s.io/v1
     5  kind: CustomResourceDefinition
     6  metadata:
     7    annotations:
     8      controller-gen.kubebuilder.io/version: v0.9.2
     9    creationTimestamp: null
    10    name: metricstraits.oam.verrazzano.io
    11  spec:
    12    group: oam.verrazzano.io
    13    names:
    14      kind: MetricsTrait
    15      listKind: MetricsTraitList
    16      plural: metricstraits
    17      singular: metricstrait
    18    scope: Namespaced
    19    versions:
    20    - name: v1alpha1
    21      schema:
    22        openAPIV3Schema:
    23          description: MetricsTrait specifies the metrics trait API.
    24          properties:
    25            apiVersion:
    26              description: 'APIVersion defines the versioned schema of this representation
    27                of an object. Servers should convert recognized schemas to the latest
    28                internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    29              type: string
    30            kind:
    31              description: 'Kind is a string value representing the REST resource this
    32                object represents. Servers may infer this from the endpoint the client
    33                submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    34              type: string
    35            metadata:
    36              type: object
    37            spec:
    38              description: MetricsTraitSpec specifies the desired state of a metrics
    39                trait.
    40              properties:
    41                enabled:
    42                  description: Specifies whether metrics collection is enabled. Defaults
    43                    to `true`.
    44                  type: boolean
    45                path:
    46                  description: The HTTP path for the related metrics endpoint. Defaults
    47                    to `/metrics`.
    48                  type: string
    49                port:
    50                  description: The HTTP port for the related metrics trait. Defaults
    51                    to `8080`.
    52                  type: integer
    53                ports:
    54                  description: The HTTP endpoints for the related metrics.
    55                  items:
    56                    description: PortSpec defines an HTTP port and path combination.
    57                    properties:
    58                      path:
    59                        description: The HTTP path for the related metrics endpoint.
    60                          Defaults to `/metrics`.
    61                        type: string
    62                      port:
    63                        description: The HTTP port for the related metrics trait. Defaults
    64                          to `8080`.
    65                        type: integer
    66                    type: object
    67                  type: array
    68                scraper:
    69                  description: The Prometheus deployment used to scrape the related
    70                    metrics endpoints. By default, the Verrazzano-supplied Prometheus
    71                    component is used to scrape the endpoint.
    72                  type: string
    73                secret:
    74                  description: The name of an opaque secret (for example, `username`
    75                    and `password`) within the workload’s namespace for metrics endpoint
    76                    access.
    77                  type: string
    78                workloadRef:
    79                  description: The WorkloadReference of the workload to which this trait
    80                    applies. This value is populated by the OAM runtime when an ApplicationConfiguration
    81                    resource is processed.  When the ApplicationConfiguration is processed,
    82                    a trait and a workload resource are created from the content of
    83                    the ApplicationConfiguration. The WorkloadReference is provided
    84                    in the trait by OAM to ensure that the trait controller can find
    85                    the workload associated with the component containing the trait
    86                    within the original ApplicationConfiguration.
    87                  properties:
    88                    apiVersion:
    89                      description: APIVersion of the referenced object.
    90                      type: string
    91                    kind:
    92                      description: Kind of the referenced object.
    93                      type: string
    94                    name:
    95                      description: Name of the referenced object.
    96                      type: string
    97                    uid:
    98                      description: UID of the referenced object.
    99                      type: string
   100                  required:
   101                  - apiVersion
   102                  - kind
   103                  - name
   104                  type: object
   105              required:
   106              - workloadRef
   107              type: object
   108            status:
   109              description: The observed state of a metrics trait and related resources.
   110              properties:
   111                conditions:
   112                  description: Conditions of the resource.
   113                  items:
   114                    description: A Condition that may apply to a resource.
   115                    properties:
   116                      lastTransitionTime:
   117                        description: LastTransitionTime is the last time this condition
   118                          transitioned from one status to another.
   119                        format: date-time
   120                        type: string
   121                      message:
   122                        description: A Message containing details about this condition's
   123                          last transition from one status to another, if any.
   124                        type: string
   125                      reason:
   126                        description: A Reason for this condition's last transition from
   127                          one status to another.
   128                        type: string
   129                      status:
   130                        description: Status of this condition; is it currently True,
   131                          False, or Unknown?
   132                        type: string
   133                      type:
   134                        description: Type of this condition. At most one of each condition
   135                          type may apply to a resource at any point in time.
   136                        type: string
   137                    required:
   138                    - lastTransitionTime
   139                    - reason
   140                    - status
   141                    - type
   142                    type: object
   143                  type: array
   144                resources:
   145                  description: Related resources affected by this metrics trait.
   146                  items:
   147                    description: QualifiedResourceRelation identifies a specific related
   148                      resource.
   149                    properties:
   150                      apiversion:
   151                        description: API version of the related resource.
   152                        type: string
   153                      kind:
   154                        description: Kind of the related resource.
   155                        type: string
   156                      name:
   157                        description: Name of the related resource.
   158                        type: string
   159                      namespace:
   160                        description: Namespace of the related resource.
   161                        type: string
   162                      role:
   163                        description: Role of the related resource, for example, `Deployment`.
   164                        type: string
   165                    required:
   166                    - apiversion
   167                    - kind
   168                    - name
   169                    - namespace
   170                    - role
   171                    type: object
   172                  type: array
   173              type: object
   174          type: object
   175      served: true
   176      storage: true
   177      subresources:
   178        status: {}