feat(docs): add markdown based documentation #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
We are yet to decide on which license to use for this github action. |
nyrahul
requested changes
Sep 5, 2024
README.md
Outdated
|
|
||
| To learn more about KubeArmor please visit, https://kubearmor.io/ | ||
|
|
||
| We install KubeArmor in systemd mode in the GitHub runner and that lets us watch over |
There was a problem hiding this comment.
Suggested change
| We install KubeArmor in systemd mode in the GitHub runner and that lets us watch over | |
| This Action installs KubeArmor in systemd mode in the GitHub runner and watches over |
README.md
Outdated
| @@ -1,3 +1,190 @@ | |||
| # report-action | |||
| # CI/CD Security by AccuKnox | |||
Comment on lines
+20
to
+22
| - Detect and prevent potential supply chain attacks in CI/CD environments | ||
| - Gain real-time visibility into your pipeline's security posture | ||
| - Streamline the integration of security practices into your DevOps workflow |
There was a problem hiding this comment.
Suggested change
| - Detect and prevent potential supply chain attacks in CI/CD environments | |
| - Gain real-time visibility into your pipeline's security posture | |
| - Streamline the integration of security practices into your DevOps workflow | |
| - Detect and prevent potential supply chain attacks in CI/CD environments | |
| - Gain real-time visibility into your pipeline's security posture | |
| - Streamline the integration of security practices into your DevOps workflow | |
| Ensure application best practices by: | |
| * Applying app hardening policies and checking whether it deviates during GH workflow execution. | |
| * Identifying if there are any unknown processes spawning during CI/CD workflow execution. | |
| * Identifying if any unwanted network connections are started in the pipeline. |
| Other than providing the baseline as an initial security posture, you can also write your | ||
| own security policies and have a more granular control on the CI/CD pipeline. | ||
|
|
||
| Here is an example of a security policy |
There was a problem hiding this comment.
Remove the below YAML policy and provide a realistic policy from existing template
There was a problem hiding this comment.
Added a more realistic policy.
README.md
Outdated
| For example: | ||
|  | ||
|
|
||
| <em>We will also support standard network policies in the coming realeases.</em> |
There was a problem hiding this comment.
Suggested change
| <em>We will also support standard network policies in the coming realeases.</em> | |
| <em>Support for network policies in the coming releases.</em> |
README.md
Outdated
| lines in your GitHub workflow and you are all set to go. | ||
|
|
||
| ```yaml | ||
| - name: AccuKnox CI/CD scan |
There was a problem hiding this comment.
Suggested change
| - name: AccuKnox CI/CD scan | |
| - name: AccuKnox CI/CD Monitor |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.