Deploying kubescape on Kubernetes

kubescape

Plural

Multi-cloud K8s single pane of glass for security.

security

Install with Plural

Available bundles

<div align="center"> <img src="docs/kubescape.png" width="300" alt="logo"> </div> --- [![build](https://github.com/kubescape/kubescape/actions/workflows/build.yaml/badge.svg)](https://github.com/kubescape/kubescape/actions/workflows/build.yaml) [![Go Report Card](https://goreportcard.com/badge/github.com/kubescape/kubescape)](https://goreportcard.com/report/github.com/kubescape/kubescape) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/kubescape/kubescape) :sunglasses: [Want to contribute?](#being-a-part-of-the-team) :innocent: Kubescape is a K8s open-source tool providing a Kubernetes single pane of glass, including risk analysis, security compliance, RBAC visualizer, and image vulnerability scanning. Kubescape scans K8s clusters, YAML files, and HELM charts, detecting misconfigurations according to multiple frameworks (such as the [NSA-CISA](https://www.armosec.io/blog/kubernetes-hardening-guidance-summary-by-armo/?utm_source=github&utm_medium=repository), [MITRE ATT&CK®](https://www.microsoft.com/security/blog/2021/03/23/secure-containerized-environments-with-updated-threat-matrix-for-kubernetes/)), software vulnerabilities, and RBAC (role-based-access-control) violations at early stages of the CI/CD pipeline, calculates risk score instantly and shows risk trends over time. It has become one of the fastest-growing Kubernetes tools among developers due to its easy-to-use CLI interface, flexible output formats, and automated scanning capabilities, saving Kubernetes users and admins precious time, effort, and resources. Kubescape integrates natively with other DevOps tools, including Jenkins, CircleCI, Github workflows, Prometheus, and Slack, and supports multi-cloud K8s deployments like EKS, GKE, and AKS. </br> # Kubescape CLI: <img src="docs/demo.gif"> </br> # TL;DR ## Install: ```sh curl -s https://raw.githubusercontent.com/kubescape/kubescape/master/install.sh | /bin/bash ``` *OR:* [Install on windows](#install-on-windows) [Install on macOS](#install-on-macos) [Install on NixOS or Linux/macOS via nix](#install-on-nixos-or-with-nix-community) ## Run: ```sh kubescape scan --submit --enable-host-scan --verbose ``` <img src="docs/summary.png"> </br> > Kubescape is an open source project. We welcome your feedback and ideas for improvement. We’re also aiming to collaborate with the Kubernetes community to help make the tests more robust and complete as Kubernetes develops. </br> ## Architecture in short ### CLI <img src="docs/ks-cli-arch.png" width="300"> ### Operator <img src="docs/ks-operator-arch.png" width="300"> ### Please [star ⭐](https://github.com/kubescape/kubescape/stargazers) the repo if you want us to continue developing and improving Kubescape 😀 </br> # Being a part of the team ## Community We invite you to our community! We are excited about this project and want to return the love we get. We hold community meetings in [Zoom](https://us02web.zoom.us/j/84020231442) on the first Tuesday of every month at 14:00 GMT! :sunglasses: ## Contributions [Want to contribute?](https://github.com/kubescape/kubescape/blob/master/CONTRIBUTING.md) Want to discuss something? Have an issue? Please make sure that you follow our [Code Of Conduct](https://github.com/kubescape/kubescape/blob/master/CODE_OF_CONDUCT.md) . * Feel free to pick a task from the [issues](https://github.com/kubescape/kubescape/issues?q=is%3Aissue+is%3Aopen+label%3A%22open+for+contribution%22), [roadmap](docs/roadmap.md) or suggest a feature of your own. [Contact us](MAINTAINERS.md) directly for more information :) * [Open an issue](https://github.com/kubescape/kubescape/issues/new/choose) , we are trying to respond within 48 hours * [Join us](https://discord.com/invite/WKZRaCtBxN) in the discussion on our discord server! [<img src="docs/discord-banner.png" width="100" alt="logo" align="center">](https://discord.com/invite/WKZRaCtBxN) ![discord](https://img.shields.io/discord/893048809884643379) # Options and examples [Kubescape docs](https://hub.armosec.io/docs?utm_source=github&utm_medium=repository) ## Playground * [Kubescape playground](https://killercoda.com/saiyampathak/scenario/kubescape) ## Tutorials * [Overview](https://youtu.be/wdBkt_0Qhbg) * [How To Secure Kubernetes Clusters With Kubescape And Armo](https://youtu.be/ZATGiDIDBQk) * [Scan Kubernetes YAML files](https://youtu.be/Ox6DaR7_4ZI) * [Scan Kubescape on an air-gapped environment (offline support)](https://youtu.be/IGXL9s37smM) * [Managing exceptions in the Kubescape SaaS version](https://youtu.be/OzpvxGmCR80) * [Configure and run customized frameworks](https://youtu.be/12Sanq_rEhs) * Customize control configurations: - [Kubescape CLI](https://youtu.be/955psg6TVu4) - [Kubescape SaaS](https://youtu.be/lIMVSVhH33o) ## Install on Windows <details><summary>Windows</summary> **Requires powershell v5.0+** ``` powershell iwr -useb https://raw.githubusercontent.com/kubescape/kubescape/master/install.ps1 | iex ``` Note: if you get an error you might need to change the execution policy (i.e. enable Powershell) with ``` powershell Set-ExecutionPolicy RemoteSigned -scope CurrentUser ``` </details> ## Install on macOS <details><summary>MacOS</summary> 1. ```sh brew tap kubescape/tap ``` 2. ```sh brew install kubescape-cli ``` </details> ## Install on NixOS or with nix (Community) <details><summary>Nix/NixOS</summary> Direct issues installing `kubescape` via `nix` through the channels mentioned [here](https://nixos.wiki/wiki/Support) You can use `nix` on Linux or macOS and on other platforms unofficially. Try it out in an ephemeral shell: `nix-shell -p kubescape` Install declarative as usual NixOS: ```nix # your other config ... environment.systemPackages = with pkgs; [ # your other packages ... kubescape ]; ``` home-manager: ```nix # your other config ... home.packages = with pkgs; [ # your other packages ... kubescape ]; ``` Or to your profile (not preferred): `nix-env --install -A nixpkgs.kubescape` </details> ## Usage & Examples ### Examples #### Scan a running Kubernetes cluster and submit results to the [Kubescape SaaS version](https://cloud.armosec.io?utm_source=github&utm_medium=repository) ``` kubescape scan --submit --enable-host-scan --verbose ``` > Read [here](https://hub.armosec.io/docs/host-sensor?utm_source=github&utm_medium=repository) more about the `enable-host-scan` flag #### Scan a running Kubernetes cluster with [`nsa`](https://www.nsa.gov/Press-Room/News-Highlights/Article/Article/2716980/nsa-cisa-release-kubernetes-hardening-guidance/) framework and submit results to the [Kubescape SaaS version](https://cloud.armosec.io?utm_source=github&utm_medium=repository) ``` kubescape scan framework nsa --submit ``` #### Scan a running Kubernetes cluster with [`MITRE ATT&CK®`](https://www.microsoft.com/security/blog/2021/03/23/secure-containerized-environments-with-updated-threat-matrix-for-kubernetes/) framework and submit results to the [Kubescape SaaS version](https://cloud.armosec.io?utm_source=github&utm_medium=repository) ``` kubescape scan framework mitre --submit ``` #### Scan a running Kubernetes cluster with a specific control using the control name or control ID. [List of controls](https://hub.armosec.io/docs/controls?utm_source=github&utm_medium=repository) ``` kubescape scan control "Privileged container" ``` #### Scan using an alternative kubeconfig file ``` kubescape scan --kubeconfig cluster.conf ``` #### Scan specific namespaces ``` kubescape scan --include-namespaces development,staging,production ``` #### Scan cluster and exclude some namespaces ``` kubescape scan --exclude-namespaces kube-system,kube-public ``` #### Scan local `yaml`/`json` files before deploying. [Take a look at the demonstration](https://youtu.be/Ox6DaR7_4ZI). Submit the results in case the directory is a git repo. [docs](https://hub.armosec.io/docs/repository-scanning?utm_source=github&utm_medium=repository) ``` kubescape scan *.yaml --submit ``` #### Scan Kubernetes manifest files from a git repository [and submit the results](https://hub.armosec.io/docs/repository-scanning?utm_source=github&utm_medium=repository) ``` kubescape scan https://github.com/kubescape/kubescape --submit ``` #### Display all scanned resources (including the resources which passed) ``` kubescape scan --verbose ``` #### Output in `json` format > Add the `--format-version v2` flag ``` kubescape scan --format json --format-version v2 --output results.json ``` #### Output in `junit xml` format ``` kubescape scan --format junit --output results.xml ``` #### Output in `pdf` format - Contributed by [@alegrey91](https://github.com/alegrey91) ``` kubescape scan --format pdf --output results.pdf ``` #### Output in `prometheus` metrics format - Contributed by [@Joibel](https://github.com/Joibel) ``` kubescape scan --format prometheus ``` #### Output in `html` format ``` kubescape scan --format html --output results.html ``` #### Scan with exceptions, objects with exceptions will be presented as `exclude` and not `fail` [Full documentation](examples/exceptions/README.md) ``` kubescape scan --exceptions examples/exceptions/exclude-kube-namespaces.json ``` #### Scan Helm charts ``` kubescape scan </path/to/directory> --submit ``` > Kubescape will load the default value file #### Scan Kustomize Directory ``` kubescape scan </path/to/directory> --submit ``` > Kubescape will generate Kubernetes Yaml Objects using 'Kustomize' file and scans them for security. ### Offline/Air-gaped Environment Support [Video tutorial](https://youtu.be/IGXL9s37smM) It is possible to run Kubescape offline! #### Download all artifacts 1. Download and save in local directory, if path not specified, will save all in `~/.kubescape` ``` kubescape download artifacts --output path/to/local/dir ``` 2. Copy the downloaded artifacts to the air-gaped/offline environment 3. Scan using the downloaded artifacts ``` kubescape scan --use-artifacts-from path/to/local/dir ``` #### Download a single artifact You can also download a single artifact and scan with the `--use-from` flag 1. Download and save in a file, if the file name is not specified, will save in `~/.kubescape/<framework name>.json` ``` kubescape download framework nsa --output /path/nsa.json ``` 2. Copy the downloaded artifacts to the air-gaped/offline environment 3. Scan using the downloaded framework ``` kubescape scan framework nsa --use-from /path/nsa.json ``` ## Scan Periodically using Helm [Please follow the instructions here](https://hub.armosec.io/docs/installation-of-armo-in-cluster?utm_source=github&utm_medium=repository) [helm chart repo](https://github.com/armosec/armo-helm) # Integrations ## VS Code Extension ![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/kubescape.kubescape?label=VScode) ![Open VSX](https://img.shields.io/open-vsx/dt/kubescape/kubescape?label=openVSX&color=yellowgreen) Scan the YAML files while writing them using the [vs code extension](https://github.com/armosec/vscode-kubescape/blob/master/README.md) ## Lens Extension View Kubescape scan results directly in [Lens IDE](https://k8slens.dev/) using kubescape [Lens extension](https://github.com/armosec/lens-kubescape/blob/master/README.md) # Building Kubescape ## Build on Windows <details><summary>Windows</summary> 1. Install MSYS2 & build libgit _(needed only for the first time)_ ``` build.bat all ``` > You can install MSYS2 separately by running `build.bat install` and build libgit2 separately by running `build.bat build` 2. Build kubescape ``` make build ``` OR ``` go build -tags=static . ``` </details> ## Build on Linux/MacOS <details><summary>Linux / MacOS</summary> 1. Install libgit2 dependency _(needed only for the first time)_ ``` make libgit2 ``` > `cmake` is required to build libgit2. You can install it by running `sudo apt-get install cmake` (Linux) or `brew install cmake` (macOS) 2. Build kubescape ``` make build ``` OR ``` go build -tags=static . ``` 3. Test ``` make test ``` </details> ## Build on pre-configured killercoda's ubuntu playground * [Pre-configured Killercoda's Ubuntu Playground](https://killercoda.com/suhas-gumma/scenario/kubescape-build-for-development) <details><summary> Pre-programmed actions executed by the playground </summary> * Clone the official GitHub repository of `Kubescape`. * [Automate the build process on Linux](https://github.com/kubescape/kubescape#build-on-linuxmacos) * The entire process involves executing multiple commands in order and it takes around 5-6 minutes to execute them all. </details> <details> <summary>Instructions to use the playground</summary> * Apply changes you wish to make to the kubescape directory using text editors like `Vim`. * [Build on Linux](https://github.com/kubescape/kubescape#build-on-linuxmacos) * Now, you can use Kubescape just like a normal user. Instead of using `kubescape`, use `./kubescape`. (Make sure you are inside kubescape directory because the command will execute the binary named `kubescape` in `kubescape directory`) </details> ## VS code configuration samples You can use the sample files below to setup your VS code environment for building and debugging purposes. <details><summary>.vscode/settings.json</summary> ```json5 // .vscode/settings.json { "go.testTags": "static", "go.buildTags": "static", "go.toolsEnvVars": { "CGO_ENABLED": "1" } } ``` </details> <details><summary>.vscode/launch.json</summary> ```json5 // .vscode/launch.json { "version": "0.2.0", "configurations": [ { "name": "Launch Package", "type": "go", "request": "launch", "mode": "auto", "program": "${workspaceFolder}/main.go", "args": [ "scan", "--logger", "debug" ], "buildFlags": "-tags=static" } ] } ``` </details> # Under the hood ## Technology Kubescape is based on the [OPA engine](https://github.com/open-policy-agent/opa) and ARMO's posture controls. The tools retrieve Kubernetes objects from the API server and run a set of [rego's snippets](https://www.openpolicyagent.org/docs/latest/policy-language/) developed by [ARMO](https://www.armosec.io?utm_source=github&utm_medium=repository). The results by default are printed in a pretty "console friendly" manner, but they can be retrieved in JSON format for further processing. Kubescape is an open source project, we welcome your feedback and ideas for improvement. We’re also aiming to collaborate with the Kubernetes community to help make the tests more robust and complete as Kubernetes develops. ## Thanks to all the contributors ❤️ <a href = "https://github.com/kubescape/kubescape/graphs/contributors"> <img src = "https://contrib.rocks/image?repo=kubescape/kubescape"/> </a>

https://github.com/armosec/kubescape

master

No items found.

Why Plural?

Open source

Plural is community-focused, open source, and free to use.

Deploy on Kubernetes

Deploy OSS on Kubernetes right on your own cloud.

No vendor lock-in

Eject your configuration whenever—no commitment necessary.

Day 2 operations

Application-specific runbooks and dashboards.

Deploying kubescape on Kubernetes

Use Plural to deploy and manage kubescape on Kubernetes, in your cloud.

kubescape

Why Plural?

Open source

Deploy on Kubernetes

No vendor lock-in

Day 2 operations

You might also like...

hydra

oauth2-proxy

vault

Product

Company

Resources

Contact

Deploying kubescape on Kubernetes

Use Plural to deploy and manage kubescape on Kubernetes, in your cloud.

kubescape

Why Plural?

Open source

Deploy on Kubernetes

No vendor lock-in

Day 2 operations

You might also like...

hydra

oauth2-proxy

vault

Product

Company

Resources

Contact

Newsletter