github.com/cilium/cilium@v1.16.2/api/v1/health/server/embedded_spec.go (about)

     1  // Code generated by go-swagger; DO NOT EDIT.
     2  
     3  // Copyright Authors of Cilium
     4  // SPDX-License-Identifier: Apache-2.0
     5  
     6  package server
     7  
     8  // This file was generated by the swagger tool.
     9  // Editing this file might prove futile when you re-run the swagger generate command
    10  
    11  import (
    12  	"encoding/json"
    13  )
    14  
    15  var (
    16  	// SwaggerJSON embedded version of the swagger document used at generation time
    17  	SwaggerJSON json.RawMessage
    18  	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
    19  	FlatSwaggerJSON json.RawMessage
    20  )
    21  
    22  func init() {
    23  	SwaggerJSON = json.RawMessage([]byte(`{
    24    "consumes": [
    25      "application/json"
    26    ],
    27    "produces": [
    28      "application/json"
    29    ],
    30    "swagger": "2.0",
    31    "info": {
    32      "description": "Cilium Health Checker",
    33      "title": "Cilium-Health API",
    34      "version": "v1beta"
    35    },
    36    "basePath": "/v1beta",
    37    "paths": {
    38      "/healthz": {
    39        "get": {
    40          "description": "Returns health and status information of the local node including\nload and uptime, as well as the status of related components including\nthe Cilium daemon.\n",
    41          "summary": "Get health of Cilium node",
    42          "responses": {
    43            "200": {
    44              "description": "Success",
    45              "schema": {
    46                "$ref": "#/definitions/HealthResponse"
    47              }
    48            },
    49            "500": {
    50              "description": "Failed to contact local Cilium daemon",
    51              "schema": {
    52                "$ref": "../openapi.yaml#/definitions/Error"
    53              },
    54              "x-go-name": "Failed"
    55            }
    56          }
    57        }
    58      },
    59      "/status": {
    60        "get": {
    61          "description": "Returns the connectivity status to all other cilium-health instances\nusing interval-based probing.\n",
    62          "tags": [
    63            "connectivity"
    64          ],
    65          "summary": "Get connectivity status of the Cilium cluster",
    66          "responses": {
    67            "200": {
    68              "description": "Success",
    69              "schema": {
    70                "$ref": "#/definitions/HealthStatusResponse"
    71              }
    72            }
    73          }
    74        }
    75      },
    76      "/status/probe": {
    77        "put": {
    78          "description": "Runs a synchronous probe to all other cilium-health instances and\nreturns the connectivity status.\n",
    79          "tags": [
    80            "connectivity"
    81          ],
    82          "summary": "Run synchronous connectivity probe to determine status of the Cilium cluster",
    83          "responses": {
    84            "200": {
    85              "description": "Success",
    86              "schema": {
    87                "$ref": "#/definitions/HealthStatusResponse"
    88              }
    89            },
    90            "403": {
    91              "description": "Forbidden"
    92            },
    93            "500": {
    94              "description": "Internal error occurred while conducting connectivity probe",
    95              "schema": {
    96                "$ref": "../openapi.yaml#/definitions/Error"
    97              },
    98              "x-go-name": "Failed"
    99            }
   100          }
   101        }
   102      }
   103    },
   104    "definitions": {
   105      "ConnectivityStatus": {
   106        "description": "Connectivity status of a path",
   107        "type": "object",
   108        "properties": {
   109          "latency": {
   110            "description": "Round trip time to node in nanoseconds",
   111            "type": "integer"
   112          },
   113          "status": {
   114            "description": "Human readable status/error/warning message",
   115            "type": "string"
   116          }
   117        }
   118      },
   119      "EndpointStatus": {
   120        "description": "Connectivity status to host cilium-health endpoints via different paths\n",
   121        "properties": {
   122          "primary-address": {
   123            "$ref": "#/definitions/PathStatus"
   124          },
   125          "secondary-addresses": {
   126            "type": "array",
   127            "items": {
   128              "$ref": "#/definitions/PathStatus"
   129            }
   130          }
   131        }
   132      },
   133      "HealthResponse": {
   134        "description": "Health and status information of local node",
   135        "type": "object",
   136        "properties": {
   137          "cilium": {
   138            "description": "Status of Cilium daemon",
   139            "$ref": "#/definitions/StatusResponse"
   140          },
   141          "system-load": {
   142            "description": "System load on node",
   143            "$ref": "#/definitions/LoadResponse"
   144          },
   145          "uptime": {
   146            "description": "Uptime of cilium-health instance",
   147            "type": "string"
   148          }
   149        }
   150      },
   151      "HealthStatusResponse": {
   152        "description": "Connectivity status to other daemons",
   153        "type": "object",
   154        "properties": {
   155          "local": {
   156            "description": "Description of the local node",
   157            "$ref": "#/definitions/SelfStatus"
   158          },
   159          "nodes": {
   160            "description": "Connectivity status to each other node",
   161            "type": "array",
   162            "items": {
   163              "$ref": "#/definitions/NodeStatus"
   164            }
   165          },
   166          "timestamp": {
   167            "type": "string"
   168          }
   169        }
   170      },
   171      "HostStatus": {
   172        "description": "Connectivity status to host cilium-health instance via different paths,\nprobing via all known IP addresses\n",
   173        "properties": {
   174          "primary-address": {
   175            "$ref": "#/definitions/PathStatus"
   176          },
   177          "secondary-addresses": {
   178            "type": "array",
   179            "items": {
   180              "$ref": "#/definitions/PathStatus"
   181            }
   182          }
   183        }
   184      },
   185      "LoadResponse": {
   186        "description": "System load on node",
   187        "type": "object",
   188        "properties": {
   189          "last15min": {
   190            "description": "Load average over the past 15 minutes",
   191            "type": "string"
   192          },
   193          "last1min": {
   194            "description": "Load average over the past minute",
   195            "type": "string"
   196          },
   197          "last5min": {
   198            "description": "Load average over the past 5 minutes",
   199            "type": "string"
   200          }
   201        }
   202      },
   203      "NodeStatus": {
   204        "description": "Connectivity status of a remote cilium-health instance",
   205        "type": "object",
   206        "properties": {
   207          "endpoint": {
   208            "description": "DEPRECATED: Please use the health-endpoint field instead, which\nsupports reporting the status of different addresses for the endpoint\n",
   209            "$ref": "#/definitions/PathStatus"
   210          },
   211          "health-endpoint": {
   212            "description": "Connectivity status to simulated endpoint on the node",
   213            "$ref": "#/definitions/EndpointStatus"
   214          },
   215          "host": {
   216            "description": "Connectivity status to cilium-health instance on node IP",
   217            "$ref": "#/definitions/HostStatus"
   218          },
   219          "name": {
   220            "description": "Identifying name for the node",
   221            "type": "string"
   222          }
   223        }
   224      },
   225      "PathStatus": {
   226        "description": "Connectivity status via different paths, for example using different\npolicies or service redirection\n",
   227        "type": "object",
   228        "properties": {
   229          "http": {
   230            "description": "Connectivity status without policy applied",
   231            "$ref": "#/definitions/ConnectivityStatus"
   232          },
   233          "icmp": {
   234            "description": "Basic ping connectivity status to node IP",
   235            "$ref": "#/definitions/ConnectivityStatus"
   236          },
   237          "ip": {
   238            "description": "IP address queried for the connectivity status",
   239            "type": "string"
   240          }
   241        }
   242      },
   243      "SelfStatus": {
   244        "description": "Description of the cilium-health node",
   245        "type": "object",
   246        "properties": {
   247          "name": {
   248            "description": "Name associated with this node",
   249            "type": "string"
   250          }
   251        }
   252      },
   253      "StatusResponse": {
   254        "description": "Status of Cilium daemon",
   255        "type": "object",
   256        "x-go-type": {
   257          "hint": {
   258            "kind": "object",
   259            "nullable": true
   260          },
   261          "import": {
   262            "alias": "ciliumModels",
   263            "package": "github.com/cilium/cilium/api/v1/models"
   264          },
   265          "type": "StatusResponse"
   266        }
   267      }
   268    },
   269    "x-schemes": [
   270      "unix"
   271    ]
   272  }`))
   273  	FlatSwaggerJSON = json.RawMessage([]byte(`{
   274    "consumes": [
   275      "application/json"
   276    ],
   277    "produces": [
   278      "application/json"
   279    ],
   280    "swagger": "2.0",
   281    "info": {
   282      "description": "Cilium Health Checker",
   283      "title": "Cilium-Health API",
   284      "version": "v1beta"
   285    },
   286    "basePath": "/v1beta",
   287    "paths": {
   288      "/healthz": {
   289        "get": {
   290          "description": "Returns health and status information of the local node including\nload and uptime, as well as the status of related components including\nthe Cilium daemon.\n",
   291          "summary": "Get health of Cilium node",
   292          "responses": {
   293            "200": {
   294              "description": "Success",
   295              "schema": {
   296                "$ref": "#/definitions/HealthResponse"
   297              }
   298            },
   299            "500": {
   300              "description": "Failed to contact local Cilium daemon",
   301              "schema": {
   302                "$ref": "#/definitions/error"
   303              },
   304              "x-go-name": "Failed"
   305            }
   306          }
   307        }
   308      },
   309      "/status": {
   310        "get": {
   311          "description": "Returns the connectivity status to all other cilium-health instances\nusing interval-based probing.\n",
   312          "tags": [
   313            "connectivity"
   314          ],
   315          "summary": "Get connectivity status of the Cilium cluster",
   316          "responses": {
   317            "200": {
   318              "description": "Success",
   319              "schema": {
   320                "$ref": "#/definitions/HealthStatusResponse"
   321              }
   322            }
   323          }
   324        }
   325      },
   326      "/status/probe": {
   327        "put": {
   328          "description": "Runs a synchronous probe to all other cilium-health instances and\nreturns the connectivity status.\n",
   329          "tags": [
   330            "connectivity"
   331          ],
   332          "summary": "Run synchronous connectivity probe to determine status of the Cilium cluster",
   333          "responses": {
   334            "200": {
   335              "description": "Success",
   336              "schema": {
   337                "$ref": "#/definitions/HealthStatusResponse"
   338              }
   339            },
   340            "403": {
   341              "description": "Forbidden"
   342            },
   343            "500": {
   344              "description": "Internal error occurred while conducting connectivity probe",
   345              "schema": {
   346                "$ref": "#/definitions/error"
   347              },
   348              "x-go-name": "Failed"
   349            }
   350          }
   351        }
   352      }
   353    },
   354    "definitions": {
   355      "ConnectivityStatus": {
   356        "description": "Connectivity status of a path",
   357        "type": "object",
   358        "properties": {
   359          "latency": {
   360            "description": "Round trip time to node in nanoseconds",
   361            "type": "integer"
   362          },
   363          "status": {
   364            "description": "Human readable status/error/warning message",
   365            "type": "string"
   366          }
   367        }
   368      },
   369      "EndpointStatus": {
   370        "description": "Connectivity status to host cilium-health endpoints via different paths\n",
   371        "properties": {
   372          "primary-address": {
   373            "$ref": "#/definitions/PathStatus"
   374          },
   375          "secondary-addresses": {
   376            "type": "array",
   377            "items": {
   378              "$ref": "#/definitions/PathStatus"
   379            }
   380          }
   381        }
   382      },
   383      "HealthResponse": {
   384        "description": "Health and status information of local node",
   385        "type": "object",
   386        "properties": {
   387          "cilium": {
   388            "description": "Status of Cilium daemon",
   389            "$ref": "#/definitions/StatusResponse"
   390          },
   391          "system-load": {
   392            "description": "System load on node",
   393            "$ref": "#/definitions/LoadResponse"
   394          },
   395          "uptime": {
   396            "description": "Uptime of cilium-health instance",
   397            "type": "string"
   398          }
   399        }
   400      },
   401      "HealthStatusResponse": {
   402        "description": "Connectivity status to other daemons",
   403        "type": "object",
   404        "properties": {
   405          "local": {
   406            "description": "Description of the local node",
   407            "$ref": "#/definitions/SelfStatus"
   408          },
   409          "nodes": {
   410            "description": "Connectivity status to each other node",
   411            "type": "array",
   412            "items": {
   413              "$ref": "#/definitions/NodeStatus"
   414            }
   415          },
   416          "timestamp": {
   417            "type": "string"
   418          }
   419        }
   420      },
   421      "HostStatus": {
   422        "description": "Connectivity status to host cilium-health instance via different paths,\nprobing via all known IP addresses\n",
   423        "properties": {
   424          "primary-address": {
   425            "$ref": "#/definitions/PathStatus"
   426          },
   427          "secondary-addresses": {
   428            "type": "array",
   429            "items": {
   430              "$ref": "#/definitions/PathStatus"
   431            }
   432          }
   433        }
   434      },
   435      "LoadResponse": {
   436        "description": "System load on node",
   437        "type": "object",
   438        "properties": {
   439          "last15min": {
   440            "description": "Load average over the past 15 minutes",
   441            "type": "string"
   442          },
   443          "last1min": {
   444            "description": "Load average over the past minute",
   445            "type": "string"
   446          },
   447          "last5min": {
   448            "description": "Load average over the past 5 minutes",
   449            "type": "string"
   450          }
   451        }
   452      },
   453      "NodeStatus": {
   454        "description": "Connectivity status of a remote cilium-health instance",
   455        "type": "object",
   456        "properties": {
   457          "endpoint": {
   458            "description": "DEPRECATED: Please use the health-endpoint field instead, which\nsupports reporting the status of different addresses for the endpoint\n",
   459            "$ref": "#/definitions/PathStatus"
   460          },
   461          "health-endpoint": {
   462            "description": "Connectivity status to simulated endpoint on the node",
   463            "$ref": "#/definitions/EndpointStatus"
   464          },
   465          "host": {
   466            "description": "Connectivity status to cilium-health instance on node IP",
   467            "$ref": "#/definitions/HostStatus"
   468          },
   469          "name": {
   470            "description": "Identifying name for the node",
   471            "type": "string"
   472          }
   473        }
   474      },
   475      "PathStatus": {
   476        "description": "Connectivity status via different paths, for example using different\npolicies or service redirection\n",
   477        "type": "object",
   478        "properties": {
   479          "http": {
   480            "description": "Connectivity status without policy applied",
   481            "$ref": "#/definitions/ConnectivityStatus"
   482          },
   483          "icmp": {
   484            "description": "Basic ping connectivity status to node IP",
   485            "$ref": "#/definitions/ConnectivityStatus"
   486          },
   487          "ip": {
   488            "description": "IP address queried for the connectivity status",
   489            "type": "string"
   490          }
   491        }
   492      },
   493      "SelfStatus": {
   494        "description": "Description of the cilium-health node",
   495        "type": "object",
   496        "properties": {
   497          "name": {
   498            "description": "Name associated with this node",
   499            "type": "string"
   500          }
   501        }
   502      },
   503      "StatusResponse": {
   504        "description": "Status of Cilium daemon",
   505        "type": "object",
   506        "x-go-type": {
   507          "hint": {
   508            "kind": "object",
   509            "nullable": true
   510          },
   511          "import": {
   512            "alias": "ciliumModels",
   513            "package": "github.com/cilium/cilium/api/v1/models"
   514          },
   515          "type": "StatusResponse"
   516        }
   517      },
   518      "error": {
   519        "type": "string"
   520      }
   521    },
   522    "x-schemes": [
   523      "unix"
   524    ]
   525  }`))
   526  }