blob: b9e2dd5d20cb7150429874697d9ffd72cbc747a6 [file] [log] [blame]
Pawel Wieczorekcc752912019-05-26 11:40:36 +02001##############################
2K8s secure configuration check
3##############################
4
5Utility for checking if Kubernetes cluster configuration follows security recommendations.
6
7***************
8Getting started
9***************
10
11Prerequisites
12=============
13
Pawel Wieczorekff3ebac2019-06-27 16:11:34 +020014Build
15-----
16
Pawel Wieczorekcc752912019-05-26 11:40:36 +020017- make
18- go_
19
20.. _go: https://golang.org/doc/install
21
Pawel Wieczorek056ef4c2019-07-08 14:17:55 +020022Test
23----
24
25- Ginkgo_
26
27.. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo
28
Pawel Wieczorekcc752912019-05-26 11:40:36 +020029Running
30=======
31
32Calling::
33
34 make run
35
36will build and run configuration check executable. It is the default target.
Pawel Wieczorek056ef4c2019-07-08 14:17:55 +020037
38Testing
39=======
40
41Calling::
42
43 make test
44
45will run tests.