-
Notifications
You must be signed in to change notification settings - Fork 104
RADAR Event state #1183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
RADAR Event state #1183
Conversation
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
content/hcp-docs/content/docs/vault-radar/manage/event-workflow.mdx
Outdated
Show resolved
Hide resolved
…w.mdx Co-authored-by: Jonathan Frappier <[email protected]>
content/hcp-docs/content/docs/vault-radar/manage/event-workflow.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ## Event states | ||
|
|
||
| - **New** - the default state when HCP Vault Radar creates a new event |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: the default status?
content/hcp-docs/content/docs/vault-radar/manage/event-workflow.mdx
Outdated
Show resolved
Hide resolved
content/hcp-docs/content/docs/vault-radar/manage/event-workflow.mdx
Outdated
Show resolved
Hide resolved
| --- | ||
| page_title: HCP Vault Radar event workflow | ||
| description: >- | ||
| HCP Vault Radar event workflow and its states |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Do we need to change the terminology to status? I see state used a bunch in this page 😅
| - **Secret Revoked** - set by a developer to confirm they revoked the secret value. | ||
| - **Resolved** - set by a developer to confirm remediation is complete | ||
| - **False Positive** - set by a developer to confirm the event is a false positive | ||
| - **Ignore Rule** - set automatically when a developer uses the inline ignore rule or sets an ignore rule within a repo via YAML file. To learn more about [inline ignore rules](./write-inline-ignore-rules). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Should we also add that Ignore Rule can't be set manually too? I saw it was called out for Notified ?
| - **Resolved** - set by a developer to confirm remediation is complete | ||
| - **False Positive** - set by a developer to confirm the event is a false positive | ||
| - **Ignore Rule** - set automatically when a developer uses the inline ignore rule or sets an ignore rule within a repo via YAML file. To learn more about [inline ignore rules](./write-inline-ignore-rules). | ||
| - **Not Important** - sets automatically when an event meets a global ignore rule's criteria. To learn more about [global ignore rules](./write-global-ignore-rules). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Users can also set the event status to Not Important manually right. I think it would be nice to distinguish between False Positive and Not Important using an example to avoid any confusion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And do we include any more information around other times we automatically put it in Not Important status? We have a list in the code, but includes when the secret is in a test file, in a readme file, etc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, there should be a corresponding tag in the event details when we automatically set it to Not Important
Please go to the
Previewtab and select the appropriate template: