Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hadar-co authored Feb 10, 2022
1 parent 2dfa757 commit bebb078
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
<!--👉 **Docs:** [https://hub.datree.io/kubectl-plugin](https://hub.datree.io/kubectl-plugin/#utm_source=github&utm_medium=organic_oss) !-->

<br/>

## Supported Platforms
This plugin supports **MacOS** and **Linux**.
<br/><br/>

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

<br/>

## Usage
```
Expand All @@ -31,6 +42,8 @@ options:
Running 'kubectl datree test' with no arguments is equivalent to 'kubectl datree test -- -n default'
```

<br/>

## Specification
The plugin supports the following resource types:
* pod
Expand All @@ -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.

<br/>

## Examples
This command will fetch all resources within the namespace "exmpl", and execute a policy check against them:
```
Expand Down

0 comments on commit bebb078

Please sign in to comment.