-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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
cx: desktop settings reporting #21646
Open
sarahsanders-docker
wants to merge
12
commits into
docker:main
Choose a base branch
from
sarahsanders-docker:compliance-reporting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
10a855a
Add compliance-reporting.md to generate URL
sarahsanders-docker 015867f
Add content
sarahsanders-docker c887430
First proofread
sarahsanders-docker 521ca0e
Add company option to choose profile page flow
sarahsanders-docker c85301a
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker a81c344
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker ea3783e
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker 500361f
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker 5dda91b
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker 451b944
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker 23bf3ca
Update content/manuals/security/for-admins/hardened-desktop/settings-…
sarahsanders-docker 00897ff
Update nit for bolding
sarahsanders-docker File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
...ecurity/for-admins/hardened-desktop/settings-management/compliance-reporting.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
description: Understand how to use the Desktop settings reporting dashboard | ||
keywords: Settings Management, docker desktop, hardened desktop, reporting, compliance | ||
title: Desktop settings reporting | ||
linkTitle: Desktop Settings Reporting | ||
weight: 30 | ||
--- | ||
|
||
Desktop settings reporting is a feature of Desktop Settings Management that tracks and reports user compliance with the settings that are assigned to them. This lets you track the application of settings and monitor what actions they need to take to make users compliant. | ||
|
||
This guide provides steps for accessing the reporting dashboard, viewing compliance status, and resolving non-compliant users. | ||
|
||
## Access Desktop settings reporting | ||
|
||
1. Sign in to the [Admin Console](https://app.docker.com/admin). | ||
2. Select your organization or company from the **Choose profile** page. | ||
3. Under Docker Desktop, select **Reporting**. | ||
|
||
This opens the Desktop settings reporting dashboard. From here you can: | ||
|
||
- Use the **Search** field to search by username or email address | ||
- Filter by policies | ||
- Hide or un-hide compliant users | ||
- View a user’s compliance status and what policy is assigned to the user | ||
- Download a CSV file of user compliance information | ||
|
||
## View compliance status | ||
|
||
1. Sign in to the [Admin Console](https://app.docker.com/admin). | ||
2. Select your organization or company from the **Choose profile** page. | ||
3. Under Docker Desktop, select **Reporting**. | ||
4. By default, non-compliant users are displayed. | ||
5. Optional. Select the **Hide compliant users** checkbox to show both compliant and non-compliant users. | ||
6. Use the **Search** field to search by username or email address. | ||
7. Hover over a user’s compliance status indicator to quickly view their status. | ||
8. Select a username to view more details about their compliance status, and for steps to resolve non-compliant users. | ||
|
||
## Resolve compliance status | ||
|
||
To resolve compliance status, you must view a user's compliance status details by selecting their username from the Desktop settings reporting page. These details include the following information: | ||
|
||
- **Compliance status**: Indicates whether the user is compliant with the settings applied to them | ||
- **Domain status**: Indicates whether the user’s email address is associated with a verified domain | ||
- **Settings status**: Indicates whether the user has settings applied to them | ||
- **Resolution steps**: If a user is non-compliant, this provides information on how to resolve the user’s compliance status | ||
|
||
### Compliant | ||
|
||
When a user is compliant, a **Compliant** icon appears next to their name on the Desktop settings reporting dashboard. Select a compliant user to open their compliance status details. Compliant users have the following status details: | ||
|
||
- **Compliance status**: Compliant | ||
- **Domain status**: Verified domain | ||
- **Settings status**: Compliant | ||
- **User is compliant** indicator | ||
|
||
No resolution steps are needed for compliant users. | ||
|
||
### Non-compliant | ||
|
||
When a user is non-compliant, a **Non-compliant** or **Unknown** icon appears next to their name on the Desktop settings reporting dashboard. Non-compliant users must have their compliance status resolved: | ||
|
||
1. Select a username from the Desktop settings reporting dashboard. | ||
2. On the compliance status details page, follow the resolution steps provided to resolve the compliance status. | ||
3. Refresh the page to ensure the resolution steps resolved the compliance status. |
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.
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.
Question: Is "dashboard" the right word?
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.
@aevesdocker @ajthilakan curious for your thoughts
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.
We usually reserve 'dashboard' when referring to the whole of the product as opposed to a page within a product - Docker Desktop Dashboard or Scout Dashboard etc. So yeh I'd rephrase this sentence some how.