github.com/kubearmor/cilium@v1.6.12/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          '500':
    46            description: Internal error occurred while conducting connectivity probe
    47            x-go-name: Failed
    48            schema:
    49              "$ref": "../openapi.yaml#/definitions/Error"
    50    "/status":
    51      get:
    52        summary: Get connectivity status of the Cilium cluster
    53        description: |
    54          Returns the connectivity status to all other cilium-health instances
    55          using interval-based probing.
    56        tags:
    57        - connectivity
    58        responses:
    59          '200':
    60            description: Success
    61            schema:
    62              "$ref": "#/definitions/HealthStatusResponse"
    63  definitions:
    64    HealthResponse:
    65      description: Health and status information of local node
    66      type: object
    67      properties:
    68        cilium:
    69          description: Status of Cilium daemon
    70          "$ref": "../openapi.yaml#/definitions/StatusResponse"
    71        uptime:
    72          description: Uptime of cilium-health instance
    73          type: string
    74        system-load:
    75          description: System load on node
    76          "$ref": "#/definitions/LoadResponse"
    77    LoadResponse:
    78      description: System load on node
    79      type: object
    80      properties:
    81        last1min:
    82          description: Load average over the past minute
    83          type: string
    84        last5min:
    85          description: Load average over the past 5 minutes
    86          type: string
    87        last15min:
    88          description: Load average over the past 15 minutes
    89          type: string
    90    HealthStatusResponse:
    91      description: Connectivity status to other daemons
    92      type: object
    93      properties:
    94        timestamp:
    95          type: string
    96        local:
    97          description: Description of the local node
    98          "$ref": "#/definitions/SelfStatus"
    99        nodes:
   100          description: Connectivity status to each other node
   101          type: array
   102          items:
   103            "$ref": "#/definitions/NodeStatus"
   104    SelfStatus:
   105      description: Description of the cilium-health node
   106      type: object
   107      properties:
   108        name:
   109          description: Name associated with this node
   110          type: string
   111    NodeStatus:
   112      description: Connectivity status of a remote cilium-health instance
   113      type: object
   114      properties:
   115        name:
   116          description: Identifying name for the node
   117          type: string
   118        host:
   119          description: Connectivity status to cilium-health instance on node IP
   120          "$ref": "#/definitions/HostStatus"
   121        endpoint:
   122          description: Connectivity status to simulated endpoint on node IP
   123          "$ref": "#/definitions/PathStatus"
   124    HostStatus:
   125      description: |
   126        Connectivity status to host cilium-health instance via different paths,
   127        probing via all known IP addresses
   128      properties:
   129        primary-address:
   130          "$ref": "#/definitions/PathStatus"
   131        secondary-addresses:
   132          type: array
   133          items:
   134            "$ref": "#/definitions/PathStatus"
   135    PathStatus:
   136      description: |
   137        Connectivity status via different paths, for example using different
   138        policies or service redirection
   139      type: object
   140      properties:
   141        ip:
   142          description: IP address queried for the connectivity status
   143          type: string
   144        icmp:
   145          description: Basic ping connectivity status to node IP
   146          "$ref": "#/definitions/ConnectivityStatus"
   147        http:
   148          description: Connectivity status without policy applied
   149          "$ref": "#/definitions/ConnectivityStatus"
   150    ConnectivityStatus:
   151      description: Connectivity status of a path
   152      type: object
   153      properties:
   154        latency:
   155          description: Round trip time to node in nanoseconds
   156          type: integer
   157        status:
   158          type: string
   159          description: Human readable status/error/warning message