Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

Commit 005ab57

Browse files
authored
Update README.md
1 parent c78133e commit 005ab57

File tree

1 file changed

+1
-26
lines changed

1 file changed

+1
-26
lines changed

README.md

+1-26
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [NOT PRODUCTION READY] EC2 Vulnerability Scanfor Amazon Inspector (Plus Jira Intergration)
1+
# [NOT PRODUCTION READY] EC2 Vulnerability Scan for Amazon Inspector (Plus Jira Intergration)
22

33
Amazon Inspector is a vulnerability management service that scans AWS workloads for known software vulnerabilities.
44

@@ -29,15 +29,11 @@ jobs:
2929
daily_job:
3030
runs-on: ubuntu-latest
3131

32-
# change this to match your GitHub Secrets environment
3332
environment:
3433
name: your_github_secrets_environment
3534

3635
steps:
3736

38-
# modify this block based on how you authenticate to AWS
39-
# make sure you have permission to access the Inspector ScanEC2 API
40-
# https://docs.aws.amazon.com/inspector/latest/user/configure-cicd-account.html#cicd-iam-role
4137
- name: Configure AWS credentials
4238
uses: aws-actions/configure-aws-credentials@v4
4339
with:
@@ -65,27 +61,15 @@ jobs:
6561
jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
6662
jira-project-key: ${{ secrets.JIRA_PROJECT_KEY }}
6763

68-
# If enabled, this setting will display Inspector's vulnerability scan findings
69-
# as a GitHub actions step summary. See here for an example step summary:
70-
# https://github.com/aws-actions/vulnerability-scan-github-action-for-amazon-inspector/actions/runs/8800085041
7164
display_vulnerability_findings: "enabled"
7265

73-
# Set vulnerability thresholds; if the number of vulnerabilities is
74-
# equal to or greater than any of the specified thresholds, this
75-
# action will set the 'vulnerability_threshold_exceeded'
76-
# output flag to 1.
7766
critical_threshold: 1
7867
high_threshold: 1
7968
medium_threshold: 1
8069
low_threshold: 1
8170
other_threshold: 1
8271

83-
# Additional input arguments are available to control scan behavior.
84-
# See 'action.yml' for additional input/output options.
8572

86-
87-
# The following steps illustrate how to
88-
# display scan results in the GitHub Actions job terminal.
8973
- name: Display Inspector vulnerability scan results (JSON)
9074
run: cat ${{ steps.inspector.outputs.inspector_scan_results }}
9175

@@ -95,9 +79,6 @@ jobs:
9579
- name: Display Inspector vulnerability scan results (Markdown)
9680
run: cat ${{ steps.inspector.outputs.inspector_scan_results_markdown }}
9781

98-
99-
# The following steps illustrate how to
100-
# upload scan results as a GitHub actions job artifact
10182
- name: Upload Scan Results
10283
uses: actions/upload-artifact@v4
10384
with:
@@ -106,12 +87,6 @@ jobs:
10687
${{ steps.inspector.outputs.inspector_scan_results }}
10788
${{ steps.inspector.outputs.inspector_scan_results_csv }}
10889
${{ steps.inspector.outputs.inspector_scan_results_markdown }}
109-
110-
# This step illustrates how to add custom logic if
111-
# the vulnerability threshold is exceeded. This example
112-
# simply prints the 'vulnerability_threshold_exceeded' value
113-
# to the GitHub actions job terminal.
114-
# Replace 'echo' with 'exit' if you want to fail the job.
11590
- name: On vulnerability threshold exceeded
11691
run: echo ${{ steps.inspector.outputs.vulnerability_threshold_exceeded }}
11792

0 commit comments

Comments
 (0)