Skip to content

Commit

Permalink
Updating readme and adding some more inputs
Browse files Browse the repository at this point in the history
  • Loading branch information
GavinDmello committed Apr 15, 2021
1 parent 02aa3c7 commit dcf4392
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ jobs:
with:
repo_name: user/app
tag_name: latest
check_thresholds: true
risk_threshold: 0
env:
ACCESS_KEY: ${{ secrets.ACCESS_KEY }}
SECRET_KEY: ${{ secrets.SECRET_KEY }}
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# container-security-action
Tenable's Container security action

This action can be used to trigger a container security scan for your build images. The user must have a Tenable.io account and also a license for container security. The action will upload the image to the tenable registry which kicks of the scan. This detailed results for each scan can be found within the container security dashboard on Tenable.io. The results can also be
Specifying the given thresholds, SLAs can be enforced before deployments.

## Usage

Describe how to use your action here.
This action can be used to trigger a container security scan for your build images. The user must have a Tenable.io account and also a license for container security. The action will upload the image to the tenable registry which kicks off the scan. The detailed results for each scan can be found within the container security dashboard on Tenable.io.
Users can specify thresholds within their workflows to enforce SLAs.

### Example workflow

Expand Down Expand Up @@ -69,7 +65,8 @@ The Tenable.io access key and secret key need to be set in your repository secre
ACCESS_KEY: ${{ secrets.ACCESS_KEY }}
SECRET_KEY: ${{ secrets.SECRET_KEY }}
```
The action uses these secrets to push the image to the tenable registry and to get the scan results.
The action uses these secrets to push the image to the tenable registry and to get the scan results. The access and secret key can be
generated by accessing `Tenable.io -> Settings -> My Account -> API Keys -> Generate`. It is important that these keys should not be shared publicly.

### Using outputs

Expand Down

0 comments on commit dcf4392

Please sign in to comment.