XTesting/kubespray/docs/netcheck.md

   1 # Network Checker Application
   2
   3 With the ``deploy_netchecker`` var enabled (defaults to false), Kubespray deploys a
   4 Network Checker Application from the 3rd side `mirantis/k8s-netchecker` docker
   5 images. It consists of the server and agents trying to reach the server by usual
   6 for Kubernetes applications network connectivity meanings. Therefore, this
   7 automatically verifies a pod to pod connectivity via the cluster IP and checks
   8 if DNS resolve is functioning as well.
   9
  10 The checks are run by agents on a periodic basis and cover standard and host network
  11 pods as well. The history of performed checks may be found in the agents' application
  12 logs.
  13
  14 To get the most recent and cluster-wide network connectivity report, run from
  15 any of the cluster nodes:
  16
  17 ```ShellSession
  18 curl http://localhost:31081/api/v1/connectivity_check
  19 ```
  20
  21 Note that Kubespray does not invoke the check but only deploys the application, if
  22 requested.
  23
  24 There are related application specific variables:
  25
  26 ```yml
  27 netchecker_port: 31081
  28 agent_report_interval: 15
  29 netcheck_namespace: default
  30 ```
  31
  32 Note that the application verifies DNS resolve for FQDNs comprising only the
  33 combination of the ``netcheck_namespace.dns_domain`` vars, for example the
  34 ``netchecker-service.default.svc.cluster.local``. If you want to deploy the application
  35 to the non default namespace, make sure as well to adjust the ``searchdomains`` var
  36 so the resulting search domain records to contain that namespace, like:
  37
  38 ```yml
  39 search: foospace.cluster.local default.cluster.local ...
  40 nameserver: ...
  41 ```