test/security/k8s/README

##############################
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
---

.. note:: Below applies to Rancher-based clusters (e.g. Casablanca)

- `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.