Skip to content
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

scout: ootb policy → policy types #21028

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Sep 30, 2024

Description

Changes how policies are configured, updates naming from ootb policies to "default configurations" and "policy types"

@github-actions github-actions bot added area/build Relates to Dockerfiles or docker build command area/scout Relates to Docker Scout labels Sep 30, 2024
Copy link

netlify bot commented Sep 30, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 4976dae
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/66faa6ebaa91a7000881099e
😎 Deploy Preview https://deploy-preview-21028--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

content/manuals/build/building/best-practices.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/_index.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
content/manuals/scout/release-notes/platform.md Outdated Show resolved Hide resolved
@dvdksn dvdksn force-pushed the scout-policy-no-custom-ootb branch 3 times, most recently from 3e67564 to aeaee7a Compare September 30, 2024 12:14
content/manuals/scout/policy/_index.md Show resolved Hide resolved
Comment on lines +36 to +37
- If the **Configure** button is grayed out, it means the selected policy
has no configurable parameters.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: Just want to mention that the button being greyed out also means that the user already has an existing policy. We are not allowing users to create a new policy with the same configuration - they will just have two or more policies that do the same thing. The button will not be grayed out if they have deleted that policy so they can re-create it if they need to.

Don't know if it's worth mentioning any of this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just added a section on how to recover deleted policies... hopefully that covers this case.

content/manuals/scout/policy/configure.md Outdated Show resolved Hide resolved
@@ -109,31 +117,32 @@ The following policy parameters are configurable in a custom version:

For more information about configuring policies, see [Configure policies](./configure.md).

### No AGPL v3 licenses
### Compliant Licenses
Copy link

@Daniel-Kolev Daniel-Kolev Sep 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought (non-blocking): I've noticed some of the policy types do mention their default configuration but this one doesn't. We should probably include a description here and any other policy that don't mention what it does by default. Another proposal is to take those descriptions into a new section that describes the default set of policies that new orgs get. Should keep things separated. Maybe as a next step. Don't want to block this PR.

@dvdksn dvdksn changed the title scout: ootb policy → default policy configurations scout: ootb policy → policy types Sep 30, 2024
@dvdksn dvdksn requested a review from a team September 30, 2024 15:00
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

reflect internal requirements and standards. You can also disable a policy
altogether if it isn't relevant to you. For more information, see [Configure
policies](./configure.md).
- [Severity-Based Vulnerability](#severity-based-vulnerability)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dvdksn Looks like the policy names are in sentence case on the Scout website, but they are in title case here. Is this intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, these type names are not published yet

Copy link

@Daniel-Kolev Daniel-Kolev Oct 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right. We haven't yet deployed the FE changes. Future values are based on this notion doc and some of these do not align. For example:
"Severity-Based Vulnerability" -> "Severity-based Vulnerability"
"Up-to-Date Base Images" -> "Up-to-date Base Images"

Haven't checked all.

Copy link

@Daniel-Kolev Daniel-Kolev Oct 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also can you update any other place they are shown (titles as well)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, just saw your comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Relates to Dockerfiles or docker build command area/scout Relates to Docker Scout status/review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants