From bebb078cdad414d1fb17fba33cf2a11de6327cc0 Mon Sep 17 00:00:00 2001 From: hadar-co Date: Thu, 10 Feb 2022 19:40:26 +0200 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d801baf..e6a80b5 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,25 @@ This plugin extends the Datree CLI's capabilities to allow scanning resources wi To learn more about Datree, visit the [datree website](https://www.datree.io/). +
+ ## Supported Platforms This plugin supports **MacOS** and **Linux**. +

## Installation +### Via Krew +1. Install [krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) +2. Install the datree plugin: +``` +kubectl krew install datree +``` ### Manual installation 1. [Download the installation script](https://github.com/datreeio/kubectl-datree/releases/latest/download/manual_install.sh) from this repository. 2. Open a terminal at the location of the script. -3. Run ```/bin/sh manual_install.sh``` (an administrator password will be required to complete the installation). +3. Run ```/bin/sh manual_install.sh``` (an administrator password will be required to complete the installation). + +
## Usage ``` @@ -31,6 +42,8 @@ options: Running 'kubectl datree test' with no arguments is equivalent to 'kubectl datree test -- -n default' ``` +
+ ## Specification The plugin supports the following resource types: * pod @@ -45,6 +58,8 @@ The plugin supports the following resource types: When running against a given namespace, only resources of these types will be checked. +
+ ## Examples This command will fetch all resources within the namespace "exmpl", and execute a policy check against them: ```