...

Text file src/github.com/openshift/api/operatorcontrolplane/v1alpha1/0000_10-pod-network-connectivity-check.crd.yaml

Documentation: github.com/openshift/api/operatorcontrolplane/v1alpha1

     1apiVersion: apiextensions.k8s.io/v1
     2kind: CustomResourceDefinition
     3metadata:
     4  annotations:
     5    api-approved.openshift.io: https://github.com/openshift/api/pull/639
     6    include.release.openshift.io/self-managed-high-availability: "true"
     7    include.release.openshift.io/single-node-developer: "true"
     8  name: podnetworkconnectivitychecks.controlplane.operator.openshift.io
     9spec:
    10  group: controlplane.operator.openshift.io
    11  names:
    12    kind: PodNetworkConnectivityCheck
    13    listKind: PodNetworkConnectivityCheckList
    14    plural: podnetworkconnectivitychecks
    15    singular: podnetworkconnectivitycheck
    16  scope: Namespaced
    17  versions:
    18    - name: v1alpha1
    19      schema:
    20        openAPIV3Schema:
    21          description: "PodNetworkConnectivityCheck \n Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support."
    22          type: object
    23          required:
    24            - spec
    25          properties:
    26            apiVersion:
    27              description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    28              type: string
    29            kind:
    30              description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    31              type: string
    32            metadata:
    33              type: object
    34            spec:
    35              description: Spec defines the source and target of the connectivity check
    36              type: object
    37              required:
    38                - sourcePod
    39                - targetEndpoint
    40              properties:
    41                sourcePod:
    42                  description: SourcePod names the pod from which the condition will be checked
    43                  type: string
    44                  pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
    45                targetEndpoint:
    46                  description: EndpointAddress to check. A TCP address of the form host:port. Note that if host is a DNS name, then the check would fail if the DNS name cannot be resolved. Specify an IP address for host to bypass DNS name lookup.
    47                  type: string
    48                  pattern: ^\S+:\d*$
    49                tlsClientCert:
    50                  description: TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource.
    51                  type: object
    52                  required:
    53                    - name
    54                  properties:
    55                    name:
    56                      description: name is the metadata.name of the referenced secret
    57                      type: string
    58            status:
    59              description: Status contains the observed status of the connectivity check
    60              type: object
    61              properties:
    62                conditions:
    63                  description: Conditions summarize the status of the check
    64                  type: array
    65                  items:
    66                    description: PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity.
    67                    type: object
    68                    required:
    69                      - lastTransitionTime
    70                      - status
    71                      - type
    72                    properties:
    73                      lastTransitionTime:
    74                        description: Last time the condition transitioned from one status to another.
    75                        type: string
    76                        format: date-time
    77                        nullable: true
    78                      message:
    79                        description: Message indicating details about last transition in a human readable format.
    80                        type: string
    81                      reason:
    82                        description: Reason for the condition's last status transition in a machine readable format.
    83                        type: string
    84                      status:
    85                        description: Status of the condition
    86                        type: string
    87                      type:
    88                        description: Type of the condition
    89                        type: string
    90                failures:
    91                  description: Failures contains logs of unsuccessful check actions
    92                  type: array
    93                  items:
    94                    description: LogEntry records events
    95                    type: object
    96                    required:
    97                      - success
    98                      - time
    99                    properties:
   100                      latency:
   101                        description: Latency records how long the action mentioned in the entry took.
   102                        type: string
   103                        nullable: true
   104                      message:
   105                        description: Message explaining status in a human readable format.
   106                        type: string
   107                      reason:
   108                        description: Reason for status in a machine readable format.
   109                        type: string
   110                      success:
   111                        description: Success indicates if the log entry indicates a success or failure.
   112                        type: boolean
   113                      time:
   114                        description: Start time of check action.
   115                        type: string
   116                        format: date-time
   117                        nullable: true
   118                outages:
   119                  description: Outages contains logs of time periods of outages
   120                  type: array
   121                  items:
   122                    description: OutageEntry records time period of an outage
   123                    type: object
   124                    required:
   125                      - start
   126                    properties:
   127                      end:
   128                        description: End of outage detected
   129                        type: string
   130                        format: date-time
   131                        nullable: true
   132                      endLogs:
   133                        description: EndLogs contains log entries related to the end of this outage. Should contain the success entry that resolved the outage and possibly a few of the failure log entries that preceded it.
   134                        type: array
   135                        items:
   136                          description: LogEntry records events
   137                          type: object
   138                          required:
   139                            - success
   140                            - time
   141                          properties:
   142                            latency:
   143                              description: Latency records how long the action mentioned in the entry took.
   144                              type: string
   145                              nullable: true
   146                            message:
   147                              description: Message explaining status in a human readable format.
   148                              type: string
   149                            reason:
   150                              description: Reason for status in a machine readable format.
   151                              type: string
   152                            success:
   153                              description: Success indicates if the log entry indicates a success or failure.
   154                              type: boolean
   155                            time:
   156                              description: Start time of check action.
   157                              type: string
   158                              format: date-time
   159                              nullable: true
   160                      message:
   161                        description: Message summarizes outage details in a human readable format.
   162                        type: string
   163                      start:
   164                        description: Start of outage detected
   165                        type: string
   166                        format: date-time
   167                        nullable: true
   168                      startLogs:
   169                        description: StartLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.
   170                        type: array
   171                        items:
   172                          description: LogEntry records events
   173                          type: object
   174                          required:
   175                            - success
   176                            - time
   177                          properties:
   178                            latency:
   179                              description: Latency records how long the action mentioned in the entry took.
   180                              type: string
   181                              nullable: true
   182                            message:
   183                              description: Message explaining status in a human readable format.
   184                              type: string
   185                            reason:
   186                              description: Reason for status in a machine readable format.
   187                              type: string
   188                            success:
   189                              description: Success indicates if the log entry indicates a success or failure.
   190                              type: boolean
   191                            time:
   192                              description: Start time of check action.
   193                              type: string
   194                              format: date-time
   195                              nullable: true
   196                successes:
   197                  description: Successes contains logs successful check actions
   198                  type: array
   199                  items:
   200                    description: LogEntry records events
   201                    type: object
   202                    required:
   203                      - success
   204                      - time
   205                    properties:
   206                      latency:
   207                        description: Latency records how long the action mentioned in the entry took.
   208                        type: string
   209                        nullable: true
   210                      message:
   211                        description: Message explaining status in a human readable format.
   212                        type: string
   213                      reason:
   214                        description: Reason for status in a machine readable format.
   215                        type: string
   216                      success:
   217                        description: Success indicates if the log entry indicates a success or failure.
   218                        type: boolean
   219                      time:
   220                        description: Start time of check action.
   221                        type: string
   222                        format: date-time
   223                        nullable: true
   224      served: true
   225      storage: true
   226      subresources:
   227        status: {}

View as plain text