| Pawel Wieczorek | cc75291 | 2019-05-26 11:40:36 +0200 | [diff] [blame] | 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 | |
| Pawel Wieczorek | ff3ebac | 2019-06-27 16:11:34 +0200 | [diff] [blame] | 14 | Build |
| 15 | ----- |
| 16 | |
| Pawel Wieczorek | cc75291 | 2019-05-26 11:40:36 +0200 | [diff] [blame] | 17 | - make |
| 18 | - go_ |
| 19 | |
| 20 | .. _go: https://golang.org/doc/install |
| 21 | |
| Pawel Wieczorek | ff3ebac | 2019-06-27 16:11:34 +0200 | [diff] [blame] | 22 | Run |
| 23 | --- |
| 24 | |
| Pawel Wieczorek | 0dc16f1 | 2019-08-30 16:59:37 +0200 | [diff] [blame] | 25 | .. note:: Below applies to Rancher-based clusters (e.g. Casablanca) |
| 26 | |
| Pawel Wieczorek | ff3ebac | 2019-06-27 16:11:34 +0200 | [diff] [blame] | 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 | |
| Pawel Wieczorek | 056ef4c | 2019-07-08 14:17:55 +0200 | [diff] [blame] | 33 | Test |
| 34 | ---- |
| 35 | |
| 36 | - Ginkgo_ |
| 37 | |
| 38 | .. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo |
| 39 | |
| Pawel Wieczorek | cc75291 | 2019-05-26 11:40:36 +0200 | [diff] [blame] | 40 | Running |
| 41 | ======= |
| 42 | |
| 43 | Calling:: |
| 44 | |
| 45 | make run |
| 46 | |
| 47 | will build and run configuration check executable. It is the default target. |
| Pawel Wieczorek | 056ef4c | 2019-07-08 14:17:55 +0200 | [diff] [blame] | 48 | |
| 49 | Testing |
| 50 | ======= |
| 51 | |
| 52 | Calling:: |
| 53 | |
| 54 | make test |
| 55 | |
| 56 | will run tests. |