Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gadinaor committed Mar 2, 2020
1 parent d735f2c commit 846f2b6
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# *Alcide Advisor* Action

[![](https://github.com/alcideio/advisor-action/workflows/Test/badge.svg?branch=master)](https://github.com/alcideio/advisor-action/actions)
![Alcide Advisor](https://codelab.alcide.io/images/card-frontpage/frontpage-alcide-advisor.png "Alcide Advisor")


A GitHub Action to add security scanning of your Kubernetes cluster as part of your pipeline workflow.
Expand All @@ -9,6 +9,7 @@ To customize the scan [Create Alcide Advisor Account](https://www.alcide.io/pric

## About *Alcide Advisor*


Alcide Advisor is an agentless service for Kubernetes audit and compliance that’s built to ensure a frictionless and secured DevSecOps workflow by layering a hygiene scan of Kubernetes cluster & workloads early in the development process and before moving to production. With Alcide Advisor, you can cover the following security checks:
* Kubernetes infrastructure vulnerability scanning.
* Hunting misplaced secrets, or excessive priviliges for secret access.
Expand Down Expand Up @@ -41,6 +42,8 @@ For more information on inputs, see the [API Documentation](https://developer.gi
- 'alcide_apikey': Alcide API Key - to run advisor scan with customized profile an api-key is needed - login to your account to obtain one
- 'alcide_apiserver': Alcide API Server - The api server provisioned to your account

![Alcide Kubernetes Advisor](https://d2908q01vomqb2.cloudfront.net/77de68daecd823babbb58edb1c8e14d7106e83bb/2019/06/19/Alcide-Advisor-Amazon-EKS-1.png "Alcide Kubernetes Advisor")

### Example Workflow

Create a workflow (eg: `.github/workflows/advisor-scan.yml`):
Expand Down Expand Up @@ -77,7 +80,7 @@ jobs:
kubectl get storageclass standard
- name: Scan Local Cluster
uses: alcideio/advisor-action@v1.0.4
uses: alcideio/advisor-action@v1.1.0
with:
exclude_namespaces: '-'
include_namespaces: '*'
Expand All @@ -92,6 +95,12 @@ jobs:
This uses [@alcideio/advisor-action](https://www.github.com/alcideio/advisor-action) GitHub Action to security scan your Kubernetes cluster configuration.
## Additional References
* [Alcide Advisor Overview](https://www.alcide.io/kubernetes-advisor)
* [Alcide Advisor on GitHub](https://github.com/alcideio/advisor)
* [Alcide Codelabs](https://codelab.alcide.io)
## Code of conduct
Participation in the Helm community is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).

0 comments on commit 846f2b6

Please sign in to comment.