Skip to content

Commit 256da1a

Browse files
cx: desktop settings reporting (#21646)
## Description - Added guide on desktop settings reporting NOTE: To go out with DD 4.40 release in EA ## Related issues or tickets [ENGDOCS-2346](https://docker.atlassian.net/browse/ENGDOCS-2346) ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review [ENGDOCS-2346]: https://docker.atlassian.net/browse/ENGDOCS-2346?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Allie Sadler <[email protected]>
1 parent 805cc31 commit 256da1a

File tree

3 files changed

+105
-1
lines changed

3 files changed

+105
-1
lines changed
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
description: Understand how to use the Desktop settings reporting dashboard
3+
keywords: Settings Management, docker desktop, hardened desktop, reporting, compliance
4+
title: Desktop settings reporting
5+
linkTitle: Desktop settings reporting
6+
weight: 30
7+
params:
8+
sidebar:
9+
badge:
10+
color: violet
11+
text: EA
12+
---
13+
14+
{{< summary-bar feature_name="Compliance reporting" >}}
15+
16+
Desktop settings reporting is a feature of Desktop Settings Management that
17+
tracks and reports user compliance with the settings policies that are assigned
18+
to them. This lets administrators track the application of settings and
19+
monitor what actions they need to take to make users compliant.
20+
21+
This guide provides steps for accessing Desktop settings reporting, viewing
22+
compliance status, and resolving non-compliant users.
23+
24+
## Access Desktop settings reporting
25+
26+
> [!IMPORTANT]
27+
>
28+
> Desktop settings reporting is in Early Access and is being rolled out
29+
> gradually. You may not see this setting in the Admin Console yet.
30+
31+
1. Sign in to the [Admin Console](https://app.docker.com/admin).
32+
2. Select your organization or company from the **Choose profile** page.
33+
3. Under Docker Desktop, select **Reporting**.
34+
35+
This opens the Desktop settings reporting page. From here you can:
36+
37+
- Use the **Search** field to search by username or email address
38+
- Filter by policies
39+
- Hide or un-hide compliant users
40+
- View a user’s compliance status and what policy is assigned to the user
41+
- Download a CSV file of user compliance information
42+
43+
## View compliance status
44+
45+
> [!WARNING]
46+
>
47+
> Users on Docker Desktop versions older than 4.40 may appear non-compliant
48+
> because older versions can't report compliance. To ensure accurate
49+
> compliance status, users must update to Docker Desktop version 4.40 and later.
50+
51+
1. Sign in to the [Admin Console](https://app.docker.com/admin).
52+
2. Select your organization or company from the **Choose profile** page.
53+
3. Under Docker Desktop, select **Reporting**. By default, non-compliant users
54+
are displayed.
55+
4. Optional. Select the **Hide compliant users** checkbox to show both compliant
56+
and non-compliant users.
57+
5. Use the **Search** field to search by username or email address.
58+
6. Hover over a user’s compliance status indicator to quickly view their status.
59+
7. Select a username to view more details about their compliance status, and for
60+
steps to resolve non-compliant users.
61+
62+
## Resolve compliance status
63+
64+
To resolve compliance status, you must view a user's compliance status details
65+
by selecting their username from the Desktop settings reporting page.
66+
These details include the following information:
67+
68+
- **Compliance status**: Indicates whether the user is compliant with the
69+
settings applied to them
70+
- **Domain status**: Indicates whether the user’s email address is associated
71+
with a verified domain
72+
- **Settings status**: Indicates whether the user has settings applied to them
73+
- **Resolution steps**: If a user is non-compliant, this provides information
74+
on how to resolve the user’s compliance status
75+
76+
### Compliant
77+
78+
When a user is compliant, a **Compliant** icon appears next to their name on the
79+
Desktop settings reporting dashboard. Select a compliant user to open their
80+
compliance status details. Compliant users have the following status details:
81+
82+
- **Compliance status**: Compliant
83+
- **Domain status**: Verified domain
84+
- **Settings status**: Compliant
85+
- **User is compliant** indicator
86+
87+
No resolution steps are needed for compliant users.
88+
89+
### Non-compliant
90+
91+
When a user is non-compliant, a **Non-compliant** or **Unknown** icon appears
92+
next to their name on the Desktop settings reporting dashboard. Non-compliant
93+
users must have their compliance status resolved:
94+
95+
1. Select a username from the Desktop settings reporting dashboard.
96+
2. On the compliance status details page, follow the resolution steps provided
97+
to resolve the compliance status.
98+
3. Refresh the page to ensure the resolution steps resolved the compliance
99+
status.

content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ keywords: admin, controls, rootless, enhanced container isolation
44
title: Configure Settings Management with a JSON file
55
linkTitle: Use a JSON file
66
weight: 10
7-
aliases:
7+
aliases:
88
- /desktop/hardened-desktop/settings-management/configure/
99
- /security/for-admins/hardened-desktop/settings-management/configure/
1010
---

data/summary.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ Cache backend API:
6262
Company:
6363
subscription: [Business]
6464
for: Administrators
65+
Compliance reporting:
66+
subscription: [Business]
67+
for: Administrators
68+
requires: Docker Desktop 4.40 and later
69+
availability: Early Access
6570
Compose attach:
6671
requires: Docker Compose [2.20.0](/manuals/compose/releases/release-notes.md#2200) and later
6772
Compose bridge:

0 commit comments

Comments
 (0)