test/security/k8s/README

   1 ##############################
   2 K8s secure configuration check
   3 ##############################
   4
   5 Utility for checking if Kubernetes cluster configuration follows security recommendations.
   6
   7 ***************
   8 Getting started
   9 ***************
  10
  11 Prerequisites
  12 =============
  13
  14 Build
  15 -----
  16
  17 - make
  18 - go_
  19
  20 .. _go: https://golang.org/doc/install
  21
  22 Run
  23 ---
  24
  25 .. note:: Below applies to Rancher-based clusters (e.g. Casablanca)
  26
  27 - `Rancher CLI`_
  28 - Docker_ (required to perform selected Rancher CLI calls)
  29
  30 .. _`Rancher CLI`: https://rancher.com/docs/rancher/v1.6/en/cli
  31 .. _Docker: https://docs.docker.com/install
  32
  33 Test
  34 ----
  35
  36 - Ginkgo_
  37
  38 .. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo
  39
  40 Running
  41 =======
  42
  43 Calling::
  44
  45   make run
  46
  47 will build and run configuration check executable. It is the default target.
  48
  49 Testing
  50 =======
  51
  52 Calling::
  53
  54   make test
  55
  56 will run tests.