From ae1763fe8470dfa55afc5ce9383b391c1d6d5b21 Mon Sep 17 00:00:00 2001 From: amirbenv <74685902+amirbenv@users.noreply.github.com> Date: Wed, 6 Jan 2021 17:34:45 -0800 Subject: [PATCH 1/4] Update README.md --- README.md | 91 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 47 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 217d8d9f7..240317377 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,10 @@ [![community](https://img.shields.io/discourse/status?server=https%3A%2F%2Fcommunity.accurics.com)](https://community.accurics.com) [![Documentation Status](https://readthedocs.com/projects/accurics-terrascan/badge/?version=latest)](https://docs.accurics.com/projects/accurics-terrascan/en/latest/?badge=latest) -Detect compliance and security violations across Infrastructure as Code to mitigate risk before provisioning cloud native infrastructure. +Detect security vulnerabilities and compliance violations across your Infrastructure as Code. Mitigate risks before provisioning cloud native infrastructure. Run locally or integrate with your CI\CD. -* GitHub Repo: https://github.com/accurics/terrascan -* Documentation: https://docs.accurics.com +* Documentation: https://docs.accurics.com/projects/accurics-terrascan/en/latest/ * Discuss: https://community.accurics.com ## Features @@ -21,7 +20,11 @@ Detect compliance and security violations across Infrastructure as Code to mitig * Scanning of Kubernetes (JSON/YAML), Helm v3, and Kustomize v3 * Support for AWS, Azure, GCP, Kubernetes and GitHub -## Installing + +## Quick Start +### Step 1: Install +Terrascan's binary for your architecture can be found on the [releases](https://github.com/accurics/terrascan/releases) + Terrascan's binary for your architecture can be found on the [releases](https://github.com/accurics/terrascan/releases) page. Here's an example of how to install it: ```sh @@ -34,44 +37,7 @@ $ tar -xvf terrascan.tar.gz $ install terrascan /usr/local/bin $ terrascan ``` - -If you have go installed, Terrascan can be installed with `go get` -``` -$ export GO111MODULE=on -$ go get -u github.com/accurics/terrascan/cmd/terrascan - go: downloading github.com/accurics/terrascan v1.2.0 - go: found github.com/accurics/terrascan/cmd/terrascan in github.com/accurics/terrascan v1.2.0 - ... -$ terrascan -``` - -### Install via `brew` - -[Homebrew](https://brew.sh/) users can install by: - -```sh -$ brew install terrascan -``` - -### Docker -Terrascan is also available as a Docker image and can be used as follows - -```sh -$ docker run accurics/terrascan -``` - -### Building Terrascan -Terrascan can be built locally. This is helpful if you want to be on the latest version or when developing Terrascan. - -```sh -$ git clone git@github.com:accurics/terrascan.git -$ cd terrascan -$ make build -$ ./bin/terrascan -``` - -## Getting started - +### Step 2: Run To scan your code for security issues you can run the following (defaults to scanning Terraform). ```sh @@ -109,8 +75,45 @@ Flags: Use "terrascan [command] --help" for more information about a command. ``` -## Documentation -To learn more about Terrascan check out the documentation https://docs.accurics.com where we include a getting started guide, Terrascan's architecture, a breakdown of it's commands, and a deep dive into policies. + + +## Other Installation Options + +If you have go installed, Terrascan can be installed with `go get` +``` +$ export GO111MODULE=on +$ go get -u github.com/accurics/terrascan/cmd/terrascan + go: downloading github.com/accurics/terrascan v1.2.0 + go: found github.com/accurics/terrascan/cmd/terrascan in github.com/accurics/terrascan v1.2.0 + ... +$ terrascan +``` + +### Install via `brew` + +[Homebrew](https://brew.sh/) users can install by: + +```sh +$ brew install terrascan +``` + +### Docker +Terrascan is also available as a Docker image and can be used as follows + +```sh +$ docker run accurics/terrascan +``` + +### Building Terrascan +Terrascan can be built locally. This is helpful if you want to be on the latest version or when developing Terrascan. + +```sh +$ git clone git@github.com:accurics/terrascan.git +$ cd terrascan +$ make build +$ ./bin/terrascan +``` + ## Developing Terrascan To learn more about developing and contributing to Terrascan refer to the [contributing guide](CONTRIBUTING.md). From bcb5790f705666cb9c03075ebac84985772990b1 Mon Sep 17 00:00:00 2001 From: amirbenv <74685902+amirbenv@users.noreply.github.com> Date: Wed, 6 Jan 2021 17:43:27 -0800 Subject: [PATCH 2/4] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 240317377..246dd063c 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,10 @@ Flags: Use "terrascan [command] --help" for more information about a command. ``` +### Step 3: Integrate with CI\CD +Please refer to our documentation to integrate with your pipeline: +https://docs.accurics.com/projects/accurics-terrascan/en/latest/cicd/ + ## Other Installation Options From 9ae91283903e23f52984052109bb6daa949f63a4 Mon Sep 17 00:00:00 2001 From: amirbenv <74685902+amirbenv@users.noreply.github.com> Date: Fri, 8 Jan 2021 15:39:03 -0800 Subject: [PATCH 3/4] Update README.md Co-authored-by: Devang Gaur --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 246dd063c..48a4be901 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Use "terrascan [command] --help" for more information about a command. ``` ### Step 3: Integrate with CI\CD -Please refer to our documentation to integrate with your pipeline: +Please refer to our [documentation to integrate with your pipeline](https://docs.accurics.com/projects/accurics-terrascan/en/latest/cicd/) https://docs.accurics.com/projects/accurics-terrascan/en/latest/cicd/ From 5f48ba93681682acda05940813bc7b9b333dcf60 Mon Sep 17 00:00:00 2001 From: amirbenv <74685902+amirbenv@users.noreply.github.com> Date: Fri, 8 Jan 2021 15:39:09 -0800 Subject: [PATCH 4/4] Update README.md Co-authored-by: Devang Gaur --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 48a4be901..0e73ffed4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Detect security vulnerabilities and compliance violations across your Infrastructure as Code. Mitigate risks before provisioning cloud native infrastructure. Run locally or integrate with your CI\CD. -* Documentation: https://docs.accurics.com/projects/accurics-terrascan/en/latest/ +* Documentation: https://docs.accurics.com/projects/accurics-terrascan * Discuss: https://community.accurics.com ## Features