blob: f69eb6ee821b2bac106eb34f3c65b2520e8edd10 [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 Wieczorekff3ebac2019-06-27 16:11:34 +020022Run
23---
24
25- `Rancher CLI`_
26- Docker_ (required to perform selected Rancher CLI calls)
27
28.. _`Rancher CLI`: https://rancher.com/docs/rancher/v1.6/en/cli
29.. _Docker: https://docs.docker.com/install
30
Pawel Wieczorekcc752912019-05-26 11:40:36 +020031Running
32=======
33
34Calling::
35
36 make run
37
38will build and run configuration check executable. It is the default target.