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

Add documentation for Configuration Profiles #21073

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

Conversation

aheck
Copy link
Contributor

@aheck aheck commented Oct 7, 2024

Description

Documentation for the Configuration Profiles feature.

DO NOT MERGE BEFORE POS-2712 HAS BEEN MERGED!!!

Related issues or tickets

https://docker.atlassian.net/browse/POS-2712

Reviews

  • Technical review
  • Editorial review
  • Product review

Copy link

netlify bot commented Oct 7, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit c530318
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6703efb690d68b0008fb6c61
😎 Deploy Preview https://deploy-preview-21073--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.

@dvdksn dvdksn added the status/do-not-merge Pull requests that are awaiting some event or decision before they can be merged. label Oct 7, 2024
@aevesdocker aevesdocker modified the milestone: 4.36 Oct 8, 2024
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

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

Thanks @aheck! Just style guide and formatting nits.
Can we also add a link to this new method on this page and add a 'new' badge too?

@@ -47,6 +47,88 @@ There are many ways to deploy the registry key, for example using an MDM solutio
7. Test the GPO. Test the GPO on a small set of machines first to ensure it behaves as expected. You can use the `gpupdate /force` command on a test machine to manually refresh its group policy settings and check the registry to confirm the changes.
8. Once verified, you can proceed with broader deployment. Monitor the deployment to ensure the settings are applied correctly across the organization's computers.

## Configuration Profiles method (Mac only)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Configuration Profiles method (Mac only)
## Configuration profiles method (Mac only)

>
> The configuration profiles method is available with Docker Desktop version 4.35 and later.

Configuration Profiles are a feature of macOS that allows administrators to distribute
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Configuration Profiles are a feature of macOS that allows administrators to distribute
Configuration profiles are a feature of macOS that let administrators distribute

> The configuration profiles method is available with Docker Desktop version 4.35 and later.

Configuration Profiles are a feature of macOS that allows administrators to distribute
configuration information to the Macs they manage. Is is the safest method to
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
configuration information to the Macs they manage. Is is the safest method to
configuration information to the Macs they manage. It is the safest method to

protected by Apples' System Integrity Protection (SIP) and can therefore not be
tampered with by the users.

1. Save the the following XML code to a file with the suffix `.mobileconfig` (e.g.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Save the the following XML code to a file with the suffix `.mobileconfig` (e.g.
1. Save the the following XML code to a file with the suffix `.mobileconfig`, for example

tampered with by the users.

1. Save the the following XML code to a file with the suffix `.mobileconfig` (e.g.
`docker.mobileconfig`):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`docker.mobileconfig`):
`docker.mobileconfig`:


2. Change the placeholder `Your Company Name` to the name of your company.

3. The names of the allowed organizations are stored in the `allowedOrgs`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
3. The names of the allowed organizations are stored in the `allowedOrgs`
3. Add your organization name. The names of the allowed organizations are stored in the `allowedOrgs`

<string>yourcompany</string>
```

or a list of organization names, separated by semicolon:
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd move this up to line 113, I wouldn't split it and I've just show the multi-org example for simplicity.

```

4. Use a MDM solution to distribute your modified `.mobileconfig` file to your
macOS clients. Sign-in is now enforced on all of those devices.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
macOS clients. Sign-in is now enforced on all of those devices.
macOS clients.
Sign-in is now enforced on all of those devices.


> [!NOTE]
>
> The configuration profiles method is available with Docker Desktop version 4.35 and later.
Copy link
Contributor

Choose a reason for hiding this comment

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

@KatTomrushka keep me honest here - won't this be announced in 4.36? so we should align here too to keep consistent? Also is it EA or straight to GA?

Choose a reason for hiding this comment

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

Correct, 4.35 is coming out on 10 Oct (although might well be delayed). The macOS config profiles along with the PKG installer are aimed for 4.36 which is the earliest possible release to get proper Customer 0 and product readiness.
In addition, as all other enterprise enablement features, it would be EAP first not straight to GA.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok perfecto, thank you!

@aheck Let's change this to The configuration profiles method is in [Early Access](/manuals/release-lifecycle.md) and is available with Docker Desktop version 4.36 and later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/security status/do-not-merge Pull requests that are awaiting some event or decision before they can be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants