From fd2b560979e9aef3e12226ffbc0f668549255c38 Mon Sep 17 00:00:00 2001 From: David Wertenteil Date: Mon, 4 Sep 2023 21:03:55 +0300 Subject: [PATCH] update readme Signed-off-by: David Wertenteil --- cmd/image/README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/cmd/image/README.md b/cmd/image/README.md index 3fb5d620..e305c899 100644 --- a/cmd/image/README.md +++ b/cmd/image/README.md @@ -7,7 +7,7 @@ It uses [grype](https://github.com/anchore/grype) under the hood for scanning th ```bash -kubescape image scan [flags] +kubescape image scan [flags] ``` ### Flags @@ -31,7 +31,7 @@ We will demonstrate how to use the scan command with an example of [nginx](https 1. In a terminal, run the `kubescape image scan` command: ```bash - sudo kubescape image scan nginx:1.22 + kubescape image scan nginx:1.22 ``` 2. You will get an output like below: @@ -85,20 +85,26 @@ We will demonstrate how to use the scan command with an example of [nginx](https What now? ───────── * Run with '--verbose'/'-v' flag for detailed vulnerabilities view - * Install Kubescape in your cluster for continuous monitoring and a full vulnerability report: https://github.com/kubescape/helm-charts/tree/main/charts/kubescape-cloud-operator + * Install Kubescape in your cluster for continuous monitoring and a full vulnerability report: https://github.com/kubescape/helm-charts/tree/main/charts/kubescape-operator ``` # Patch Command The patch command is used for patching container images with vulnerabilities. -It uses [copa](https://github.com/project-copacetic/copacetic) and [buildkit](https://github.com/moby/buildkit) under the hood for patching the container images, and [grype](https://github.com/anchore/grype) as the engine for scanning the images (at the moment). +It uses [copa](https://github.com/project-copacetic/copacetic) and [buildkit](https://github.com/moby/buildkit) under the hood for patching the container images, and [grype](https://github.com/anchore/grype) as the engine for scanning the images. ## Usage ```bash -kubescape image patch [flags] +kubescape image patch [flags] ``` +### Pre-requisites + +- [docker](https://docs.docker.com/desktop/install/linux-install/#generic-installation-steps) daemon must be installed and running. +- [buildkit](https://github.com/moby/buildkit) daemon must be installed + +### Running the patch command The patch command can be run in 2 ways: 1. **With sudo privileges** @@ -148,11 +154,6 @@ The patch command can be run in 2 ways: We will demonstrate how to use the patch command with an example of [nginx](https://www.nginx.com/) image. -### Pre-requisites - -- [docker](https://docs.docker.com/desktop/install/linux-install/#generic-installation-steps) daemon must be installed and running. -- [buildkit](https://github.com/moby/buildkit) daemon must be installed - ### Steps 1. Run `buildkitd` service: