Skip to content

Commit 678c7ef

Browse files
sarahsanders-dockersarahsanders-docker
committed
Update formatting, add summary.yaml file, update example
1 parent fb0b8d6 commit 678c7ef

File tree

3 files changed

+70
-71
lines changed

3 files changed

+70
-71
lines changed

‎content/manuals/security/for-admins/hardened-desktop/settings-management/configure-admin-console.md‎

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,7 @@ params:
1111
text: EA
1212
---
1313

14-
{{< summary-bar
15-
subscription="domain"
16-
subscriptionText="Business"
17-
lifecycle="rocket_launch"
18-
lifecycleText="EA"
19-
admin="admin_panel_settings"
20-
adminText="Admin"
21-
>}}
14+
{{< summary-bar feature_name="Admin Console" >}}
2215

2316
This page contains information for administrators on how to configure Settings Management with the Docker Admin Console. You can specify and lock configuration parameters to create a standardized Docker Desktop environment across your Docker company or organization.
2417

@@ -28,38 +21,38 @@ This page contains information for administrators on how to configure Settings M
2821
- [Verify your domain](/manuals/security/for-admins/single-sign-on/configure.md#step-one-add-and-verify-your-domain).
2922
- [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md). The Settings Management feature requires a Docker Business
3023
subscription, therefore your Docker Desktop users must authenticate to your
31-
organization for configurations to take effect.
24+
organization for configurations to take effect.
3225

3326
## Create a settings policy
3427

35-
1. Within the [Docker Admin Console](https://admin.docker.com/) navigate to the company or organization you want to define a settings policy for.
36-
2. Under the **Security and access** section, select **Desktop Settings Management**.
28+
1. Within the [Docker Admin Console](https://admin.docker.com/) navigate to the company or organization you want to define a settings policy for.
29+
2. Under the **Security and access** section, select **Desktop Settings Management**.
3730
3. In the top-right corner, select **Create a settings policy**.
3831
4. Give your settings policy a name and an optional description.
3932

4033
> [!TIP]
4134
>
42-
> If you have already configured Settings Management with an `admin-settings.json` file for an organization, you can upload it using the **Upload existing settings** button which then automatically populates the form for you.
35+
> If you have already configured Settings Management with an `admin-settings.json` file for an organization, you can upload it using the **Upload existing settings** button which then automatically populates the form for you.
4336
>
4437
> Settings policies deployed via the Docker Admin Console take precedence over manually deployed `admin-settings.json` files.
4538
4639
5. Assign the setting policy to all your users within the company or organization, or specific users.
4740

4841
> [!NOTE]
4942
>
50-
> If a settings policy is assigned to all users, it sets the policy as the global default policy. You can only have one global settings policy at a time.
51-
> If a user already has a user-specific settings policy assigned, the user-specific policy takes precedence over a global policy.
43+
> If a settings policy is assigned to all users, it sets the policy as the global default policy. You can only have one global settings policy at a time.
44+
> If a user already has a user-specific settings policy assigned, the user-specific policy takes precedence over a global policy.
5245
5346
> [!TIP]
5447
>
55-
> Before setting a global settings policy, it is recommended that you first test it as a user-specific policy to make sure you're happy with the changes before proceeding.
48+
> Before setting a global settings policy, it is recommended that you first test it as a user-specific policy to make sure you're happy with the changes before proceeding.
5649
5750
6. Configure the settings for the policy. Go through each setting and select your chosen setting state. You can choose:
58-
- **User-defined**. Your developers are able to control and change this setting.
51+
- **User-defined**. Your developers are able to control and change this setting.
5952
- **Always enabled**. This means the setting is turned on and your users won't be able to edit this setting from Docker Desktop or the CLI.
6053
- **Enabled**. The setting is turned on and users can edit this setting from Docker Desktop or the CLI.
6154
- **Always disabled**. This means the setting is turned off and your users won't be able to edit this setting from Docker Desktop or the CLI.
62-
- **Disabled**. The setting is turned off and users can edit this setting from Docker Desktop or the CLI.
55+
- **Disabled**. The setting is turned off and users can edit this setting from Docker Desktop or the CLI.
6356
7. Select **Create**
6457

6558
For the settings policy to take effect:
@@ -74,13 +67,13 @@ To avoid disrupting your users' workflows, Docker doesn't automatically require
7467

7568
> [!NOTE]
7669
>
77-
> Settings are synced to Docker Desktop and the CLI when a user is signed in and starts Docker Desktop, and then every 60 minutes.
70+
> Settings are synced to Docker Desktop and the CLI when a user is signed in and starts Docker Desktop, and then every 60 minutes.
7871
7972
If your settings policy needs to be rolled back, either delete the policy or edit the policy to set individual settings to **User-defined**.
8073

8174
## Settings policy actions
8275

8376
From the **Actions** menu on the **Desktop Settings Management** page in the Docker Admin Console, you can:
84-
- Edit or delete an existing settings policy.
77+
- Edit or delete an existing settings policy.
8578
- Export a settings policy as an `admin-settings.json` file.
86-
- Promote a policy that is applied to a select group of users, to be the new global default policy for all users.
79+
- Promote a policy that is applied to a select group of users, to be the new global default policy for all users.

‎data/summary.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Summary bar icon library:
2+
# 1. Subscription:
3+
# - Label: Business | Icon: domain
4+
# - Label: Team | Icon: groups
5+
# - Label: Pro | Icon: person_add
6+
# - Label: Personal | Icon: person
7+
# - Label: Available to all | Icon: public
8+
# 2. Availability:
9+
# - Label: Experimental | Icon: science
10+
# - Label: Beta | Icon: bolt
11+
# - Label: Early access | Icon: rocket_launch
12+
# - Label: GA | Icon: check_circle
13+
# - Label: Retired | Icon: package_2
14+
# 3. Minimum version:
15+
# - Label: Version [version_number] | Icon: browser_updated
16+
17+
# Instructions for adding summary bar: Create a new feature and fill out each
18+
# line as needed. In your markdown file, use the following syntax to call the
19+
# summary bar: {{< summary-bar feature_name="your feature name here" >}
20+
21+
features:
22+
- name: Admin Console
23+
subscriptionIcon: domain
24+
subscriptionText: Business
25+
availabilityIcon: rocket_launch
26+
availabilityText: Early access
27+
versionIcon: null
28+
versionText: null

‎layouts/shortcodes/summary-bar.html‎

Lines changed: 29 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,37 @@
1-
<!--
2-
Summary bar icon library:
3-
4-
1. Subscription:
5-
- Label: Business | Icon: domain
6-
- Label: Team | Icon: groups
7-
- Label: Pro | Icon: person_add
8-
- Label: Personal | Icon: person
9-
- Label: Available to all | Icon: public
10-
11-
2. Release lifecycle:
12-
- Label: Experimental | Icon: science
13-
- Label: Beta | Icon: bolt
14-
- Label: EA | Icon: rocket_launch
15-
- Label: GA | Icon: check_circle
16-
- Label: Retired | Icon: package_2
17-
18-
3. Minimum version:
19-
- Label: Version [version_number] | Icon: browser_updated
20-
21-
-->
22-
231
<link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded" rel="stylesheet">
242

25-
<div class="flex items-center gap-4 p-4 bg-background-light dark:bg-background-dark rounded-none">
26-
<span class="text-base text-black dark:text-white">Available for:</span>
27-
{{ if .Get "subscription" }}
28-
<div class="flex items-center gap-2">
29-
<span class="material-symbols-rounded text-sm text-black dark:text-white">
30-
{{ .Get "subscription" }}
31-
</span>
32-
<span class="text-sm text-black dark:text-white">{{ .Get "subscriptionText" }}</span>
33-
</div>
34-
{{ end }}
35-
{{ if .Get "lifecycle" }}
36-
<div class="flex items-center gap-2">
37-
<span class="material-symbols-rounded text-sm text-black dark:text-white">
38-
{{ .Get "lifecycle" }}
3+
{{ $featureName := .Get "feature_name" }}
4+
{{ $feature := index (where site.Data.summary.features "name" $featureName) 0 }}
5+
{{ if $feature }}
6+
<div class="flex flex-col p-4 bg-background-light dark:bg-background-dark rounded-none summary-bar"
7+
style="border-left: 4px solid #677285; padding-left: 16px; padding-top: 8px; padding-bottom: 8px; margin-top: 8px; margin-bottom: 8px;">
8+
9+
<div class="flex flex-col gap-0.5">
10+
<div class="flex items-center gap-1">
11+
<span class="text-black dark:text-white font-bold">Subscription:</span>
12+
<span class="text-black dark:text-white">{{ $feature.subscriptionText }}</span>
13+
<span class="material-symbols-rounded text-black dark:text-white">
14+
s {{ $feature.subscriptionIcon }}
3915
</span>
40-
<span class="text-sm text-black dark:text-white">{{ .Get "lifecycleText" }}</span>
4116
</div>
42-
{{ end }}
43-
{{ if .Get "version" }}
44-
<div class="flex items-center gap-2">
45-
<span class="material-symbols-rounded text-sm text-black dark:text-white">
46-
{{ .Get "version" }}
17+
18+
<div class="flex items-center gap-1">
19+
<span class="text-black dark:text-white font-bold">Availability:</span>
20+
<span class="text-black dark:text-white">{{ $feature.availabilityText }}</span>
21+
<span class="material-symbols-rounded text-black dark:text-white">
22+
{{ $feature.availabilityIcon }}
4723
</span>
48-
<span class="text-sm text-black dark:text-white">{{ .Get "versionText" }}</span>
4924
</div>
50-
{{ end }}
51-
{{ if .Get "admin" }}
52-
<div class="flex items-center gap-2">
53-
<span class="material-symbols-rounded text-sm text-black dark:text-white">
54-
{{ .Get "admin" }}
25+
26+
{{ if $feature.versionText }}
27+
<div class="flex items-center gap-1">
28+
<span class="text-black dark:text-white font-bold">Minimum version:</span>
29+
<span class="text-black dark:text-white">{{ $feature.versionText }}</span>
30+
<span class="material-symbols-rounded text-black dark:text-white">
31+
{{ $feature.versionIcon }}
5532
</span>
56-
<span class="text-sm text-black dark:text-white">{{ .Get "adminText" }}</span>
5733
</div>
58-
{{ end }}
59-
</div>
34+
{{ end }}
35+
</div>
36+
</div>
37+
{{ end }}

0 commit comments

Comments
 (0)