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

     1  // Code generated by go-swagger; DO NOT EDIT.
     2  
     3  package server
     4  
     5  // This file was generated by the swagger tool.
     6  // Editing this file might prove futile when you re-run the swagger generate command
     7  
     8  import (
     9  	"encoding/json"
    10  )
    11  
    12  var (
    13  	// SwaggerJSON embedded version of the swagger document used at generation time
    14  	SwaggerJSON json.RawMessage
    15  	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
    16  	FlatSwaggerJSON json.RawMessage
    17  )
    18  
    19  func init() {
    20  	SwaggerJSON = json.RawMessage([]byte(`{
    21    "consumes": [
    22      "application/json"
    23    ],
    24    "produces": [
    25      "application/json"
    26    ],
    27    "swagger": "2.0",
    28    "info": {
    29      "description": "Cilium Health Checker",
    30      "title": "Cilium-Health API",
    31      "version": "v1beta"
    32    },
    33    "basePath": "/v1beta",
    34    "paths": {
    35      "/healthz": {
    36        "get": {
    37          "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",
    38          "summary": "Get health of Cilium node",
    39          "responses": {
    40            "200": {
    41              "description": "Success",
    42              "schema": {
    43                "$ref": "#/definitions/HealthResponse"
    44              }
    45            },
    46            "500": {
    47              "description": "Failed to contact local Cilium daemon",
    48              "schema": {
    49                "$ref": "../openapi.yaml#/definitions/Error"
    50              },
    51              "x-go-name": "Failed"
    52            }
    53          }
    54        }
    55      },
    56      "/status": {
    57        "get": {
    58          "description": "Returns the connectivity status to all other cilium-health instances\nusing interval-based probing.\n",
    59          "tags": [
    60            "connectivity"
    61          ],
    62          "summary": "Get connectivity status of the Cilium cluster",
    63          "responses": {
    64            "200": {
    65              "description": "Success",
    66              "schema": {
    67                "$ref": "#/definitions/HealthStatusResponse"
    68              }
    69            }
    70          }
    71        }
    72      },
    73      "/status/probe": {
    74        "put": {
    75          "description": "Runs a synchronous probe to all other cilium-health instances and\nreturns the connectivity status.\n",
    76          "tags": [
    77            "connectivity"
    78          ],
    79          "summary": "Run synchronous connectivity probe to determine status of the Cilium cluster",
    80          "responses": {
    81            "200": {
    82              "description": "Success",
    83              "schema": {
    84                "$ref": "#/definitions/HealthStatusResponse"
    85              }
    86            },
    87            "500": {
    88              "description": "Internal error occurred while conducting connectivity probe",
    89              "schema": {
    90                "$ref": "../openapi.yaml#/definitions/Error"
    91              },
    92              "x-go-name": "Failed"
    93            }
    94          }
    95        }
    96      }
    97    },
    98    "definitions": {
    99      "ConnectivityStatus": {
   100        "description": "Connectivity status of a path",
   101        "type": "object",
   102        "properties": {
   103          "latency": {
   104            "description": "Round trip time to node in nanoseconds",
   105            "type": "integer"
   106          },
   107          "status": {
   108            "description": "Human readable status/error/warning message",
   109            "type": "string"
   110          }
   111        }
   112      },
   113      "HealthResponse": {
   114        "description": "Health and status information of local node",
   115        "type": "object",
   116        "properties": {
   117          "cilium": {
   118            "description": "Status of Cilium daemon",
   119            "$ref": "../openapi.yaml#/definitions/StatusResponse"
   120          },
   121          "system-load": {
   122            "description": "System load on node",
   123            "$ref": "#/definitions/LoadResponse"
   124          },
   125          "uptime": {
   126            "description": "Uptime of cilium-health instance",
   127            "type": "string"
   128          }
   129        }
   130      },
   131      "HealthStatusResponse": {
   132        "description": "Connectivity status to other daemons",
   133        "type": "object",
   134        "properties": {
   135          "local": {
   136            "description": "Description of the local node",
   137            "$ref": "#/definitions/SelfStatus"
   138          },
   139          "nodes": {
   140            "description": "Connectivity status to each other node",
   141            "type": "array",
   142            "items": {
   143              "$ref": "#/definitions/NodeStatus"
   144            }
   145          },
   146          "timestamp": {
   147            "type": "string"
   148          }
   149        }
   150      },
   151      "HostStatus": {
   152        "description": "Connectivity status to host cilium-health instance via different paths,\nprobing via all known IP addresses\n",
   153        "properties": {
   154          "primary-address": {
   155            "$ref": "#/definitions/PathStatus"
   156          },
   157          "secondary-addresses": {
   158            "type": "array",
   159            "items": {
   160              "$ref": "#/definitions/PathStatus"
   161            }
   162          }
   163        }
   164      },
   165      "LoadResponse": {
   166        "description": "System load on node",
   167        "type": "object",
   168        "properties": {
   169          "last15min": {
   170            "description": "Load average over the past 15 minutes",
   171            "type": "string"
   172          },
   173          "last1min": {
   174            "description": "Load average over the past minute",
   175            "type": "string"
   176          },
   177          "last5min": {
   178            "description": "Load average over the past 5 minutes",
   179            "type": "string"
   180          }
   181        }
   182      },
   183      "NodeStatus": {
   184        "description": "Connectivity status of a remote cilium-health instance",
   185        "type": "object",
   186        "properties": {
   187          "endpoint": {
   188            "description": "Connectivity status to simulated endpoint on node IP",
   189            "$ref": "#/definitions/PathStatus"
   190          },
   191          "host": {
   192            "description": "Connectivity status to cilium-health instance on node IP",
   193            "$ref": "#/definitions/HostStatus"
   194          },
   195          "name": {
   196            "description": "Identifying name for the node",
   197            "type": "string"
   198          }
   199        }
   200      },
   201      "PathStatus": {
   202        "description": "Connectivity status via different paths, for example using different\npolicies or service redirection\n",
   203        "type": "object",
   204        "properties": {
   205          "http": {
   206            "description": "Connectivity status without policy applied",
   207            "$ref": "#/definitions/ConnectivityStatus"
   208          },
   209          "icmp": {
   210            "description": "Basic ping connectivity status to node IP",
   211            "$ref": "#/definitions/ConnectivityStatus"
   212          },
   213          "ip": {
   214            "description": "IP address queried for the connectivity status",
   215            "type": "string"
   216          }
   217        }
   218      },
   219      "SelfStatus": {
   220        "description": "Description of the cilium-health node",
   221        "type": "object",
   222        "properties": {
   223          "name": {
   224            "description": "Name associated with this node",
   225            "type": "string"
   226          }
   227        }
   228      }
   229    },
   230    "x-schemes": [
   231      "unix"
   232    ]
   233  }`))
   234  	FlatSwaggerJSON = json.RawMessage([]byte(`{
   235    "consumes": [
   236      "application/json"
   237    ],
   238    "produces": [
   239      "application/json"
   240    ],
   241    "swagger": "2.0",
   242    "info": {
   243      "description": "Cilium Health Checker",
   244      "title": "Cilium-Health API",
   245      "version": "v1beta"
   246    },
   247    "basePath": "/v1beta",
   248    "paths": {
   249      "/healthz": {
   250        "get": {
   251          "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",
   252          "summary": "Get health of Cilium node",
   253          "responses": {
   254            "200": {
   255              "description": "Success",
   256              "schema": {
   257                "$ref": "#/definitions/HealthResponse"
   258              }
   259            },
   260            "500": {
   261              "description": "Failed to contact local Cilium daemon",
   262              "schema": {
   263                "$ref": "#/definitions/error"
   264              },
   265              "x-go-name": "Failed"
   266            }
   267          }
   268        }
   269      },
   270      "/status": {
   271        "get": {
   272          "description": "Returns the connectivity status to all other cilium-health instances\nusing interval-based probing.\n",
   273          "tags": [
   274            "connectivity"
   275          ],
   276          "summary": "Get connectivity status of the Cilium cluster",
   277          "responses": {
   278            "200": {
   279              "description": "Success",
   280              "schema": {
   281                "$ref": "#/definitions/HealthStatusResponse"
   282              }
   283            }
   284          }
   285        }
   286      },
   287      "/status/probe": {
   288        "put": {
   289          "description": "Runs a synchronous probe to all other cilium-health instances and\nreturns the connectivity status.\n",
   290          "tags": [
   291            "connectivity"
   292          ],
   293          "summary": "Run synchronous connectivity probe to determine status of the Cilium cluster",
   294          "responses": {
   295            "200": {
   296              "description": "Success",
   297              "schema": {
   298                "$ref": "#/definitions/HealthStatusResponse"
   299              }
   300            },
   301            "500": {
   302              "description": "Internal error occurred while conducting connectivity probe",
   303              "schema": {
   304                "$ref": "#/definitions/error"
   305              },
   306              "x-go-name": "Failed"
   307            }
   308          }
   309        }
   310      }
   311    },
   312    "definitions": {
   313      "ConnectivityStatus": {
   314        "description": "Connectivity status of a path",
   315        "type": "object",
   316        "properties": {
   317          "latency": {
   318            "description": "Round trip time to node in nanoseconds",
   319            "type": "integer"
   320          },
   321          "status": {
   322            "description": "Human readable status/error/warning message",
   323            "type": "string"
   324          }
   325        }
   326      },
   327      "HealthResponse": {
   328        "description": "Health and status information of local node",
   329        "type": "object",
   330        "properties": {
   331          "cilium": {
   332            "$ref": "#/definitions/statusResponse"
   333          },
   334          "system-load": {
   335            "description": "System load on node",
   336            "$ref": "#/definitions/LoadResponse"
   337          },
   338          "uptime": {
   339            "description": "Uptime of cilium-health instance",
   340            "type": "string"
   341          }
   342        }
   343      },
   344      "HealthStatusResponse": {
   345        "description": "Connectivity status to other daemons",
   346        "type": "object",
   347        "properties": {
   348          "local": {
   349            "description": "Description of the local node",
   350            "$ref": "#/definitions/SelfStatus"
   351          },
   352          "nodes": {
   353            "description": "Connectivity status to each other node",
   354            "type": "array",
   355            "items": {
   356              "$ref": "#/definitions/NodeStatus"
   357            }
   358          },
   359          "timestamp": {
   360            "type": "string"
   361          }
   362        }
   363      },
   364      "HostStatus": {
   365        "description": "Connectivity status to host cilium-health instance via different paths,\nprobing via all known IP addresses\n",
   366        "properties": {
   367          "primary-address": {
   368            "$ref": "#/definitions/PathStatus"
   369          },
   370          "secondary-addresses": {
   371            "type": "array",
   372            "items": {
   373              "$ref": "#/definitions/PathStatus"
   374            }
   375          }
   376        }
   377      },
   378      "LoadResponse": {
   379        "description": "System load on node",
   380        "type": "object",
   381        "properties": {
   382          "last15min": {
   383            "description": "Load average over the past 15 minutes",
   384            "type": "string"
   385          },
   386          "last1min": {
   387            "description": "Load average over the past minute",
   388            "type": "string"
   389          },
   390          "last5min": {
   391            "description": "Load average over the past 5 minutes",
   392            "type": "string"
   393          }
   394        }
   395      },
   396      "NodeStatus": {
   397        "description": "Connectivity status of a remote cilium-health instance",
   398        "type": "object",
   399        "properties": {
   400          "endpoint": {
   401            "description": "Connectivity status to simulated endpoint on node IP",
   402            "$ref": "#/definitions/PathStatus"
   403          },
   404          "host": {
   405            "description": "Connectivity status to cilium-health instance on node IP",
   406            "$ref": "#/definitions/HostStatus"
   407          },
   408          "name": {
   409            "description": "Identifying name for the node",
   410            "type": "string"
   411          }
   412        }
   413      },
   414      "PathStatus": {
   415        "description": "Connectivity status via different paths, for example using different\npolicies or service redirection\n",
   416        "type": "object",
   417        "properties": {
   418          "http": {
   419            "description": "Connectivity status without policy applied",
   420            "$ref": "#/definitions/ConnectivityStatus"
   421          },
   422          "icmp": {
   423            "description": "Basic ping connectivity status to node IP",
   424            "$ref": "#/definitions/ConnectivityStatus"
   425          },
   426          "ip": {
   427            "description": "IP address queried for the connectivity status",
   428            "type": "string"
   429          }
   430        }
   431      },
   432      "SelfStatus": {
   433        "description": "Description of the cilium-health node",
   434        "type": "object",
   435        "properties": {
   436          "name": {
   437            "description": "Name associated with this node",
   438            "type": "string"
   439          }
   440        }
   441      },
   442      "error": {
   443        "type": "string"
   444      },
   445      "statusResponse": {
   446        "description": "Health and status information of daemon",
   447        "type": "object",
   448        "properties": {
   449          "cilium": {
   450            "description": "Status of an individual component",
   451            "type": "object",
   452            "properties": {
   453              "msg": {
   454                "description": "Human readable status/error/warning message",
   455                "type": "string"
   456              },
   457              "state": {
   458                "description": "State the component is in",
   459                "type": "string",
   460                "enum": [
   461                  "Ok",
   462                  "Warning",
   463                  "Failure",
   464                  "Disabled"
   465                ]
   466              }
   467            }
   468          },
   469          "cluster": {
   470            "description": "Status of cluster",
   471            "properties": {
   472              "ciliumHealth": {
   473                "description": "Status of an individual component",
   474                "type": "object",
   475                "properties": {
   476                  "msg": {
   477                    "description": "Human readable status/error/warning message",
   478                    "type": "string"
   479                  },
   480                  "state": {
   481                    "description": "State the component is in",
   482                    "type": "string",
   483                    "enum": [
   484                      "Ok",
   485                      "Warning",
   486                      "Failure",
   487                      "Disabled"
   488                    ]
   489                  }
   490                }
   491              },
   492              "nodes": {
   493                "description": "List of known nodes",
   494                "type": "array",
   495                "items": {
   496                  "description": "Known node in the cluster",
   497                  "properties": {
   498                    "health-endpoint-address": {
   499                      "description": "Addressing information of a node for all address families",
   500                      "type": "object",
   501                      "properties": {
   502                        "ipv4": {
   503                          "description": "Addressing information",
   504                          "type": "object",
   505                          "properties": {
   506                            "address-type": {
   507                              "description": "Node address type, one of HostName, ExternalIP or InternalIP",
   508                              "type": "string"
   509                            },
   510                            "alloc-range": {
   511                              "description": "Address pool to be used for local endpoints",
   512                              "type": "string"
   513                            },
   514                            "enabled": {
   515                              "description": "True if address family is enabled",
   516                              "type": "boolean"
   517                            },
   518                            "ip": {
   519                              "description": "IP address of node",
   520                              "type": "string"
   521                            }
   522                          }
   523                        },
   524                        "ipv6": {
   525                          "description": "Addressing information",
   526                          "type": "object",
   527                          "properties": {
   528                            "address-type": {
   529                              "description": "Node address type, one of HostName, ExternalIP or InternalIP",
   530                              "type": "string"
   531                            },
   532                            "alloc-range": {
   533                              "description": "Address pool to be used for local endpoints",
   534                              "type": "string"
   535                            },
   536                            "enabled": {
   537                              "description": "True if address family is enabled",
   538                              "type": "boolean"
   539                            },
   540                            "ip": {
   541                              "description": "IP address of node",
   542                              "type": "string"
   543                            }
   544                          }
   545                        }
   546                      }
   547                    },
   548                    "name": {
   549                      "description": "Name of the node including the cluster association. This is typically\n\u003cclustername\u003e/\u003chostname\u003e.\n",
   550                      "type": "string"
   551                    },
   552                    "primary-address": {
   553                      "description": "Addressing information of a node for all address families",
   554                      "type": "object",
   555                      "properties": {
   556                        "ipv4": {
   557                          "description": "Addressing information",
   558                          "type": "object",
   559                          "properties": {
   560                            "address-type": {
   561                              "description": "Node address type, one of HostName, ExternalIP or InternalIP",
   562                              "type": "string"
   563                            },
   564                            "alloc-range": {
   565                              "description": "Address pool to be used for local endpoints",
   566                              "type": "string"
   567                            },
   568                            "enabled": {
   569                              "description": "True if address family is enabled",
   570                              "type": "boolean"
   571                            },
   572                            "ip": {
   573                              "description": "IP address of node",
   574                              "type": "string"
   575                            }
   576                          }
   577                        },
   578                        "ipv6": {
   579                          "description": "Addressing information",
   580                          "type": "object",
   581                          "properties": {
   582                            "address-type": {
   583                              "description": "Node address type, one of HostName, ExternalIP or InternalIP",
   584                              "type": "string"
   585                            },
   586                            "alloc-range": {
   587                              "description": "Address pool to be used for local endpoints",
   588                              "type": "string"
   589                            },
   590                            "enabled": {
   591                              "description": "True if address family is enabled",
   592                              "type": "boolean"
   593                            },
   594                            "ip": {
   595                              "description": "IP address of node",
   596                              "type": "string"
   597                            }
   598                          }
   599                        }
   600                      }
   601                    },
   602                    "secondary-addresses": {
   603                      "description": "Alternative addresses assigned to the node",
   604                      "type": "array",
   605                      "items": {
   606                        "description": "Addressing information",
   607                        "type": "object",
   608                        "properties": {
   609                          "address-type": {
   610                            "description": "Node address type, one of HostName, ExternalIP or InternalIP",
   611                            "type": "string"
   612                          },
   613                          "alloc-range": {
   614                            "description": "Address pool to be used for local endpoints",
   615                            "type": "string"
   616                          },
   617                          "enabled": {
   618                            "description": "True if address family is enabled",
   619                            "type": "boolean"
   620                          },
   621                          "ip": {
   622                            "description": "IP address of node",
   623                            "type": "string"
   624                          }
   625                        }
   626                      }
   627                    }
   628                  }
   629                }
   630              },
   631              "self": {
   632                "description": "Name of local node (if available)",
   633                "type": "string"
   634              }
   635            }
   636          },
   637          "container-runtime": {
   638            "description": "Status of an individual component",
   639            "type": "object",
   640            "properties": {
   641              "msg": {
   642                "description": "Human readable status/error/warning message",
   643                "type": "string"
   644              },
   645              "state": {
   646                "description": "State the component is in",
   647                "type": "string",
   648                "enum": [
   649                  "Ok",
   650                  "Warning",
   651                  "Failure",
   652                  "Disabled"
   653                ]
   654              }
   655            }
   656          },
   657          "controllers": {
   658            "description": "Collection of controller statuses",
   659            "type": "array",
   660            "items": {
   661              "description": "Status of a controller",
   662              "type": "object",
   663              "properties": {
   664                "configuration": {
   665                  "description": "Configuration of controller",
   666                  "type": "object",
   667                  "properties": {
   668                    "error-retry": {
   669                      "description": "Retry on error",
   670                      "type": "boolean"
   671                    },
   672                    "error-retry-base": {
   673                      "description": "Base error retry back-off time",
   674                      "type": "string",
   675                      "format": "duration"
   676                    },
   677                    "interval": {
   678                      "description": "Regular synchronization interval",
   679                      "type": "string",
   680                      "format": "duration"
   681                    }
   682                  }
   683                },
   684                "name": {
   685                  "description": "Name of controller",
   686                  "type": "string"
   687                },
   688                "status": {
   689                  "description": "Current status of controller",
   690                  "type": "object",
   691                  "properties": {
   692                    "consecutive-failure-count": {
   693                      "description": "Number of consecutive errors since last success",
   694                      "type": "integer"
   695                    },
   696                    "failure-count": {
   697                      "description": "Total number of failed runs",
   698                      "type": "integer"
   699                    },
   700                    "last-failure-msg": {
   701                      "description": "Error message of last failed run",
   702                      "type": "string"
   703                    },
   704                    "last-failure-timestamp": {
   705                      "description": "Timestamp of last error",
   706                      "type": "string",
   707                      "format": "date-time"
   708                    },
   709                    "last-success-timestamp": {
   710                      "description": "Timestamp of last success",
   711                      "type": "string",
   712                      "format": "date-time"
   713                    },
   714                    "success-count": {
   715                      "description": "Total number of successful runs",
   716                      "type": "integer"
   717                    }
   718                  }
   719                },
   720                "uuid": {
   721                  "description": "UUID of controller",
   722                  "type": "string",
   723                  "format": "uuid"
   724                }
   725              }
   726            }
   727          },
   728          "ipam": {
   729            "description": "Status of IP address management",
   730            "properties": {
   731              "allocations": {
   732                "description": "Map of allocated IPs\n",
   733                "type": "object",
   734                "additionalProperties": {
   735                  "type": "string"
   736                }
   737              },
   738              "ipv4": {
   739                "type": "array",
   740                "items": {
   741                  "type": "string"
   742                }
   743              },
   744              "ipv6": {
   745                "type": "array",
   746                "items": {
   747                  "type": "string"
   748                }
   749              },
   750              "status": {
   751                "type": "string"
   752              }
   753            }
   754          },
   755          "kubernetes": {
   756            "description": "Status of Kubernetes integration",
   757            "type": "object",
   758            "properties": {
   759              "k8s-api-versions": {
   760                "type": "array",
   761                "items": {
   762                  "type": "string"
   763                }
   764              },
   765              "msg": {
   766                "description": "Human readable status/error/warning message",
   767                "type": "string"
   768              },
   769              "state": {
   770                "description": "State the component is in",
   771                "type": "string",
   772                "enum": [
   773                  "Ok",
   774                  "Warning",
   775                  "Failure",
   776                  "Disabled"
   777                ]
   778              }
   779            }
   780          },
   781          "kvstore": {
   782            "description": "Status of an individual component",
   783            "type": "object",
   784            "properties": {
   785              "msg": {
   786                "description": "Human readable status/error/warning message",
   787                "type": "string"
   788              },
   789              "state": {
   790                "description": "State the component is in",
   791                "type": "string",
   792                "enum": [
   793                  "Ok",
   794                  "Warning",
   795                  "Failure",
   796                  "Disabled"
   797                ]
   798              }
   799            }
   800          },
   801          "nodeMonitor": {
   802            "description": "Status of the node monitor",
   803            "properties": {
   804              "cpus": {
   805                "description": "Number of CPUs to listen on for events.",
   806                "type": "integer"
   807              },
   808              "lost": {
   809                "description": "Number of samples lost by perf.",
   810                "type": "integer"
   811              },
   812              "npages": {
   813                "description": "Number of pages used for the perf ring buffer.",
   814                "type": "integer"
   815              },
   816              "pagesize": {
   817                "description": "Pages size used for the perf ring buffer.",
   818                "type": "integer"
   819              },
   820              "unknown": {
   821                "description": "Number of unknown samples.",
   822                "type": "integer"
   823              }
   824            }
   825          },
   826          "proxy": {
   827            "description": "Status of proxy",
   828            "type": "object",
   829            "properties": {
   830              "ip": {
   831                "description": "IP address that the proxy listens on",
   832                "type": "string"
   833              },
   834              "port-range": {
   835                "description": "Port range used for proxying",
   836                "type": "string"
   837              }
   838            }
   839          },
   840          "stale": {
   841            "description": "List of stale information in the status",
   842            "type": "object",
   843            "additionalProperties": {
   844              "description": "Timestamp when the probe was started",
   845              "type": "string",
   846              "format": "date-time"
   847            }
   848          }
   849        }
   850      }
   851    },
   852    "x-schemes": [
   853      "unix"
   854    ]
   855  }`))
   856  }