Skip to content

Commit

Permalink
Update: updated readme further, with information about scoring
Browse files Browse the repository at this point in the history
Signed-off-by: deggja <danieldagfinrud@gmail.com>
  • Loading branch information
deggja committed Nov 24, 2023
1 parent f1f77de commit db99105
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You are welcome to contribute!

Open an issue or create a pull request if there is some functionality missing that you would like.

## Installation via Homebrew
## Installation via Homebrew for Mac

You can install `netfetch` using our Homebrew tap:

Expand All @@ -20,6 +20,8 @@ brew tap deggja/netfetch https://github.com/deggja/netfetch
brew install netfetch
```

For specific Linux distros, Windows etc. Check the latest release for a downloadable binary.

### Prerequisites

Before you begin, ensure you have the following:
Expand All @@ -28,11 +30,11 @@ Before you begin, ensure you have the following:
- Access to a Kubernetes cluster with configured `kubectl`.
- Sufficient permissions to list namespaces and network policies in the cluster.

### Basic Usage
### Basic usage

The primary command provided by `netfetch` is `scan`. This command scans all non-system Kubernetes namespaces for network policies.

#### Command Structure
#### Command structure

```sh
netfetch scan
Expand All @@ -44,6 +46,12 @@ You can also specifiy namespaces when running netfetch.
netfetch scan default
```

## Netfetch score

The `netfetch` tool provides a score at the end of each scan. The score ranges from 1 to 42, with 1 being the lowest and 42 being the highest possible score.

This score reflects the security posture of your Kubernetes namespaces based on network policies and pod coverage. If changes are made based on recommendations from the initial scan, rerunning `netfetch` will likely result in an improved score.

## License

[MIT License], see [LICENSE](LICENSE).

0 comments on commit db99105

Please sign in to comment.