github.com/cilium/cilium@v1.16.2/api/v1/health/openapi.yaml (about)

     1  ---
     2  swagger: '2.0'
     3  info:
     4    title: Cilium-Health API
     5    description: Cilium Health Checker
     6    version: v1beta
     7  x-schemes:
     8  - unix
     9  basePath: "/v1beta"
    10  produces:
    11  - application/json
    12  consumes:
    13  - application/json
    14  paths:
    15    "/healthz":
    16      get:
    17        summary: Get health of Cilium node
    18        description: |
    19          Returns health and status information of the local node including
    20          load and uptime, as well as the status of related components including
    21          the Cilium daemon.
    22        responses:
    23          '200':
    24            description: Success
    25            schema:
    26              "$ref": "#/definitions/HealthResponse"
    27          '500':
    28            description: Failed to contact local Cilium daemon
    29            x-go-name: Failed
    30            schema:
    31              "$ref": "../openapi.yaml#/definitions/Error"
    32    "/status/probe":
    33      put:
    34        summary: Run synchronous connectivity probe to determine status of the Cilium cluster
    35        description: |
    36          Runs a synchronous probe to all other cilium-health instances and
    37          returns the connectivity status.
    38        tags:
    39        - connectivity
    40        responses:
    41          '200':
    42            description: Success
    43            schema:
    44              "$ref": "#/definitions/HealthStatusResponse"
    45          '403':
    46            description: Forbidden
    47          '500':
    48            description: Internal error occurred while conducting connectivity probe
    49            x-go-name: Failed
    50            schema:
    51              "$ref": "../openapi.yaml#/definitions/Error"
    52    "/status":
    53      get:
    54        summary: Get connectivity status of the Cilium cluster
    55        description: |
    56          Returns the connectivity status to all other cilium-health instances
    57          using interval-based probing.
    58        tags:
    59        - connectivity
    60        responses:
    61          '200':
    62            description: Success
    63            schema:
    64              "$ref": "#/definitions/HealthStatusResponse"
    65  definitions:
    66    StatusResponse:
    67      type: object
    68      description: Status of Cilium daemon
    69      x-go-type:
    70        type: StatusResponse
    71        import:
    72          package: "github.com/cilium/cilium/api/v1/models"
    73          alias: "ciliumModels"
    74        hint:
    75          kind: object
    76          nullable: true
    77    HealthResponse:
    78      description: Health and status information of local node
    79      type: object
    80      properties:
    81        cilium:
    82          description: Status of Cilium daemon
    83          "$ref": "#/definitions/StatusResponse"
    84        uptime:
    85          description: Uptime of cilium-health instance
    86          type: string
    87        system-load:
    88          description: System load on node
    89          "$ref": "#/definitions/LoadResponse"
    90    LoadResponse:
    91      description: System load on node
    92      type: object
    93      properties:
    94        last1min:
    95          description: Load average over the past minute
    96          type: string
    97        last5min:
    98          description: Load average over the past 5 minutes
    99          type: string
   100        last15min:
   101          description: Load average over the past 15 minutes
   102          type: string
   103    HealthStatusResponse:
   104      description: Connectivity status to other daemons
   105      type: object
   106      properties:
   107        timestamp:
   108          type: string
   109        local:
   110          description: Description of the local node
   111          "$ref": "#/definitions/SelfStatus"
   112        nodes:
   113          description: Connectivity status to each other node
   114          type: array
   115          items:
   116            "$ref": "#/definitions/NodeStatus"
   117    SelfStatus:
   118      description: Description of the cilium-health node
   119      type: object
   120      properties:
   121        name:
   122          description: Name associated with this node
   123          type: string
   124    NodeStatus:
   125      description: Connectivity status of a remote cilium-health instance
   126      type: object
   127      properties:
   128        name:
   129          description: Identifying name for the node
   130          type: string
   131        host:
   132          description: Connectivity status to cilium-health instance on node IP
   133          "$ref": "#/definitions/HostStatus"
   134        health-endpoint:
   135          description: Connectivity status to simulated endpoint on the node
   136          "$ref": "#/definitions/EndpointStatus"
   137        endpoint:
   138          description: |
   139            DEPRECATED: Please use the health-endpoint field instead, which
   140            supports reporting the status of different addresses for the endpoint
   141          "$ref": "#/definitions/PathStatus"
   142    HostStatus:
   143      description: |
   144        Connectivity status to host cilium-health instance via different paths,
   145        probing via all known IP addresses
   146      properties:
   147        primary-address:
   148          "$ref": "#/definitions/PathStatus"
   149        secondary-addresses:
   150          type: array
   151          items:
   152            "$ref": "#/definitions/PathStatus"
   153    EndpointStatus:
   154      description: |
   155        Connectivity status to host cilium-health endpoints via different paths
   156      properties:
   157        primary-address:
   158          "$ref": "#/definitions/PathStatus"
   159        secondary-addresses:
   160          type: array
   161          items:
   162            "$ref": "#/definitions/PathStatus"
   163    PathStatus:
   164      description: |
   165        Connectivity status via different paths, for example using different
   166        policies or service redirection
   167      type: object
   168      properties:
   169        ip:
   170          description: IP address queried for the connectivity status
   171          type: string
   172        icmp:
   173          description: Basic ping connectivity status to node IP
   174          "$ref": "#/definitions/ConnectivityStatus"
   175        http:
   176          description: Connectivity status without policy applied
   177          "$ref": "#/definitions/ConnectivityStatus"
   178    ConnectivityStatus:
   179      description: Connectivity status of a path
   180      type: object
   181      properties:
   182        latency:
   183          description: Round trip time to node in nanoseconds
   184          type: integer
   185        status:
   186          type: string
   187          description: Human readable status/error/warning message