aboutsummaryrefslogtreecommitdiffstats
path: root/test/security/k8s/README
blob: 4f14e37db6e7a3cff5670920c9d5f769beb6d3e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
##############################
K8s secure configuration check
##############################

Utility for checking if Kubernetes cluster configuration follows security recommendations.

***************
Getting started
***************

Prerequisites
=============

Build
-----

- make
- go_

.. _go: https://golang.org/doc/install

Run
---

- `Rancher CLI`_
- Docker_ (required to perform selected Rancher CLI calls)

.. _`Rancher CLI`: https://rancher.com/docs/rancher/v1.6/en/cli
.. _Docker: https://docs.docker.com/install

Test
----

- Ginkgo_

.. _Ginkgo: https://onsi.github.io/ginkgo/#getting-ginkgo

Running
=======

Calling::

  make run

will build and run configuration check executable. It is the default target.

Testing
=======

Calling::

  make test

will run tests.