diff --git a/README.md b/README.md index 9952842cf7..dcf6c3d681 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#
Kyverno - Kubernetes Native Policy Management
+# Kyverno - Kubernetes Native Policy Management ![logo](documentation/images/Kyverno_Horizontal.png) diff --git a/documentation/installation.md b/documentation/installation.md index 0aa98a49cd..c925374d97 100644 --- a/documentation/installation.md +++ b/documentation/installation.md @@ -2,19 +2,27 @@ # Installation -To install Kyverno in your cluster run: +To install Kyverno in your cluster run the following command on a host with kubectl access: - `kubectl create -f https://github.com/nirmata/kyverno/raw/master/definitions/install.yaml` +````sh +kubectl create -f https://github.com/nirmata/kyverno/raw/master/definitions/install.yaml +```` -To check if the Kyverno controller is running use: +To check the Kyverno controller status, run the command: - `kubectl get pods -n kyverno` +````sh +kubectl get pods -n kyverno +```` -If the Kyverno controller doesn't start, you can check its status and logs for errors: +If the Kyverno controller is not running, you can check its status and logs for errors: - `kubectl describe pod -n kyverno` +````sh +kubectl describe pod -n kyverno +```` - `kubectl logs -n kyverno` +````sh +kubectl logs -n kyverno +```` # Installing in a Development Environment @@ -22,9 +30,8 @@ To run Kyverno in a development environment see: https://github.com/nirmata/kyve # Try Kyverno without a Kubernetes cluster -To write and test policies without installing Kyverno in a Kubernetes cluster you can try the [Kyverno CLI](documentation/testing-policies-cli.md). - +The [Kyverno CLI](documentation/testing-policies-cli.md) allows you to write and test policies without installing Kyverno in a Kubernetes cluster. --- -*Read Next >> [Writing Policies](/documentation/writing-policies.md)* \ No newline at end of file +*Read Next >> [Writing Policies](/documentation/writing-policies.md)*