From 114b2af304d2bb140d63a541fecc3d44f2594d58 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Mon, 18 Nov 2024 17:09:48 +0000 Subject: [PATCH] pkg-4.36 (#21394) ## Description Fixes merge conflicts (caused by DD IA revamp) on original PR. Already SME approved https://github.com/docker/docs/pull/21030 ## Related issues or tickets ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review --- _vale/config/vocabularies/Docker/accept.txt | 1 + content/manuals/desktop/release-notes.md | 2 +- .../install/enterprise-deployment/_index.md | 11 ++++ .../{msi => enterprise-deployment}/faq.md | 9 ++- .../msi-install-and-configure.md} | 21 +++---- .../pkg-install-and-configure.md | 55 +++++++++++++++++++ .../use-intune.md | 29 +++++++++- .../enterprise-deployment/use-jamf-pro.md | 29 ++++++++++ .../desktop/setup/install/msi/_index.md | 25 --------- 9 files changed, 141 insertions(+), 41 deletions(-) create mode 100644 content/manuals/desktop/setup/install/enterprise-deployment/_index.md rename content/manuals/desktop/setup/install/{msi => enterprise-deployment}/faq.md (96%) rename content/manuals/desktop/setup/install/{msi/install-and-configure.md => enterprise-deployment/msi-install-and-configure.md} (93%) create mode 100644 content/manuals/desktop/setup/install/enterprise-deployment/pkg-install-and-configure.md rename content/manuals/desktop/setup/install/{msi => enterprise-deployment}/use-intune.md (58%) create mode 100644 content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md delete mode 100644 content/manuals/desktop/setup/install/msi/_index.md diff --git a/_vale/config/vocabularies/Docker/accept.txt b/_vale/config/vocabularies/Docker/accept.txt index e6e8715c6c..690a930219 100644 --- a/_vale/config/vocabularies/Docker/accept.txt +++ b/_vale/config/vocabularies/Docker/accept.txt @@ -71,6 +71,7 @@ Nuxeo OAuth OTel Okta +PKG Postgres PowerShell Python diff --git a/content/manuals/desktop/release-notes.md b/content/manuals/desktop/release-notes.md index 46b5408a6a..f420338141 100644 --- a/content/manuals/desktop/release-notes.md +++ b/content/manuals/desktop/release-notes.md @@ -219,7 +219,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec - [Host networking](/manuals/engine/network/drivers/host.md#docker-desktop) support on Docker Desktop is now generally available. - If you authenticate via the CLI, you can now authenticate through a browser-based flow, removing the need for manual PAT generation. - Windows now supports automatic reclamation of disk space in Docker Desktop for WSL2 installations [using a managed virtual hard disk](/manuals/desktop/features/wsl/best-practices.md). -- Deploying Docker Desktop via the [MSI installer](/manuals/desktop/setup/install/msi/_index.md) is now generally available. +- Deploying Docker Desktop via the [MSI installer](/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md) is now generally available. - Two new methods to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) (windows registry key and `.plist` file) are now generally available. - Fresh installations of Docker Desktop now use the containerd image store by default. - [Compose Bridge](/manuals/compose/bridge/_index.md) (Experimental) is now available from the Compose file viewer. Easily convert and deploy your Compose project to a Kubernetes cluster. diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/_index.md b/content/manuals/desktop/setup/install/enterprise-deployment/_index.md new file mode 100644 index 0000000000..6797126bab --- /dev/null +++ b/content/manuals/desktop/setup/install/enterprise-deployment/_index.md @@ -0,0 +1,11 @@ +--- +title: Enterprise deployment +weight: 50 +description: If you're an IT admin, learn how to deploy Docker Desktop at scale +keywords: msi, docker desktop, windows, installation, mac, pkg, enterprise +build: + render: never +aliases: +- /desktop/install/msi/ +- /desktop/setup/install/msi/ +--- \ No newline at end of file diff --git a/content/manuals/desktop/setup/install/msi/faq.md b/content/manuals/desktop/setup/install/enterprise-deployment/faq.md similarity index 96% rename from content/manuals/desktop/setup/install/msi/faq.md rename to content/manuals/desktop/setup/install/enterprise-deployment/faq.md index f537e1eeeb..2ca516dbcf 100644 --- a/content/manuals/desktop/setup/install/msi/faq.md +++ b/content/manuals/desktop/setup/install/enterprise-deployment/faq.md @@ -1,12 +1,15 @@ --- -title: MSI FAQs -description: Frequently asked questions for deploying Docker Desktop with Microsoft installer -keywords: msi, deploy, docker desktop, faqs +title: FAQs +description: Frequently asked questions for deploying Docker Desktop at scale +keywords: msi, deploy, docker desktop, faqs, pkg tags: [FAQ] aliases: - /desktop/install/msi/faq/ +- /desktop/setup/install/msi/faq/ --- +## MSI + ### What happens to user data if they have an older Docker Desktop installation (i.e. `.exe`)? If they have an older `.exe` installation, users must [uninstall](/manuals/desktop/uninstall.md) this version before using the new MSI version. This deletes all Docker containers, images, volumes, and other Docker-related data local to the machine, and removes the files generated by the application. For older versions, users should [backup](/manuals/desktop/settings-and-maintenance/backup-and-restore.md) any containers that they want to keep. diff --git a/content/manuals/desktop/setup/install/msi/install-and-configure.md b/content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md similarity index 93% rename from content/manuals/desktop/setup/install/msi/install-and-configure.md rename to content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md index fe07e03f83..e17641c0ab 100644 --- a/content/manuals/desktop/setup/install/msi/install-and-configure.md +++ b/content/manuals/desktop/setup/install/enterprise-deployment/msi-install-and-configure.md @@ -1,23 +1,26 @@ --- -title: Install and configure +title: Use the MSI installer description: Understand how to use the MSI installer. Also explore additional configuration options. keywords: msi, windows, docker desktop, install, deploy, configure +weight: 10 aliases: - /desktop/install/msi/install-and-configure/ +- /desktop/setup/install/msi/install-and-configure/ --- +> [!NOTE] +> +> The MSI installer is available to all company and organization owners with a Business subscription and Docker Desktop version 4.32 and later. + +The MSI package supports various MDM (Mobile Device Management) solutions, making it ideal for bulk installations and eliminating the need for manual setups by individual users. With this package, IT administrators can ensure standardized, policy-driven installations of Docker Desktop, enhancing efficiency and software management across their organizations. + ## Install interactively 1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization. - 2. Under **Security and access**, select the **Deploy Docker Desktop** page. - -3. Select the **Download MSI installer** button. - +3. From the **Windows OS** tab, select the **Download MSI installer** button. 4. Once downloaded, double-click `Docker Desktop Installer.msi` to run the installer. - 5. Once you've accepted the license agreement, you can choose the install location. By default, Docker Desktop is installed at `C:\Program Files\Docker\Docker`. - 6. Configure the Docker Desktop installation. You can: - Create a desktop shortcut @@ -27,9 +30,7 @@ aliases: - Disable Windows Container usage - Select the engine for Docker Desktop. Either WSL or Hyper-V. If your system only supports one of the two options, you won't be able to select which backend to use. - 7. Follow the instructions on the installation wizard to authorize the installer and proceed with the install. - 8. When the installation is successful, select **Finish** to complete the installation process. If your administrator account is different to your user account, you must add the user to the **docker-users** group: @@ -44,7 +45,7 @@ If your administrator account is different to your user account, you must add th > > Docker Desktop notifies you when an update is available. To update Docker Desktop, download the latest installer from the Docker Admin Console. Navigate to the **Deploy Docker Desktop** page > under **Security and access**. > -> To keep up to date with new releases, check the [release notes](https://docs.docker.com/desktop/release-notes/) page. +> To keep up to date with new releases, check the [release notes](/manuals/desktop/release-notes.md) page. ## Install from the command line diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/pkg-install-and-configure.md b/content/manuals/desktop/setup/install/enterprise-deployment/pkg-install-and-configure.md new file mode 100644 index 0000000000..34f9c9c31b --- /dev/null +++ b/content/manuals/desktop/setup/install/enterprise-deployment/pkg-install-and-configure.md @@ -0,0 +1,55 @@ +--- +title: Use the PKG installer +description: Understand how to use the PKG installer. Also explore additional configuration options. +keywords: PKG, mac, docker desktop, install, deploy, configure +weight: 20 +params: + sidebar: + badge: + color: violet + text: EA +--- + +{{% restricted title="Early Access" %}} +The PKG installer is currently an [Early Access](/manuals/release-lifecycle.md) feature and is available to all company and organization owners with a Business subscription and Docker Desktop version 4.36 and later. +{{% /restricted %}} + +The PKG package supports various MDM (Mobile Device Management) solutions, making it ideal for bulk installations and eliminating the need for manual setups by individual users. With this package, IT administrators can ensure standardized, policy-driven installations of Docker Desktop, enhancing efficiency and software management across their organizations. + +## Install interactively + +1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization. +2. Under **Security and access**, select the **Deploy Docker Desktop** page. +3. From the **macOS** tab, select the **Download PKG installer** button. +4. Once downloaded, double-click `Docker.pkg` to run the installer. +5. Follow the instructions on the installation wizard to authorize the installer and proceed with the install. + - **Introduction**: Select `Continue`. + - **License**: Review the license agreement and select `Agree`. + - **Destination Select**: This step is optional. It is recommended that you don't change the default installation destination (usually `Macintosh HD`). Select `Continue`. + - **Installation Type**: Select `Install`. + - **Installation**: Authenticate using your administrator password or Touch ID. + - **Summary**: After the installation completes, select `Close`. + +> [!NOTE] +> +> When installing Docker Desktop with the PKG, in-app updates are automatically disabled. This feature ensures your organization maintains the required Docker Desktop version. For Docker Desktop installed with the .dmg installer, in-app updates remain supported. +> +> Docker Desktop notifies you when an update is available. To update Docker Desktop, download the latest installer from the Docker Admin Console. Navigate to the **Deploy Docker Desktop** page > under **Security and access**. +> +> To keep up to date with new releases, check the [release notes](/manuals/desktop/release-notes.md) page. + +## Install from the command line + +1. In the [Docker Admin Console](http://admin.docker.com/), navigate to your organization. +2. Under **Security and access**, select the **Deploy Docker Desktop** page. +3. From the **macOS** tab, select the **Download PKG installer** button. +4. From your terminal, run the following command: + + ```console + $ sudo installer -pkg "/path/to/Docker.pkg" -target /Applications + ``` + +## Additional resources + +- See how you can deploy Docker Desktop for Mac via [Intune](use-intune.md) or [Jamf Pro](use-jamf-pro.md) +- Explore how to [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/methods.md#plist-method-mac-only) for your users. \ No newline at end of file diff --git a/content/manuals/desktop/setup/install/msi/use-intune.md b/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md similarity index 58% rename from content/manuals/desktop/setup/install/msi/use-intune.md rename to content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md index 38c6a31d15..7e7637c4e2 100644 --- a/content/manuals/desktop/setup/install/msi/use-intune.md +++ b/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md @@ -2,18 +2,23 @@ title: Use Intune description: Use Intune, Microsoft's cloud-based device management tool, to deploy Docker Desktop keywords: microsoft, windows, docker desktop, deploy, mdm, enterprise, administrator +weight: 30 aliases: - /desktop/install/msi/use-intune/ +- /desktop/setup/install/msi/use-intune/ --- -Learn how to deploy Docker Desktop using Intune, Microsoft's cloud-based device management tool. +Learn how to deploy Docker Desktop for Windows and Mac using Intune, Microsoft's cloud-based device management tool. + +{{< tabs >}} +{{< tab name="Windows" >}} 1. Sign in to your Intune admin center. 2. Add a new app. Select **Apps**, then **Windows**, then **Add**. 3. For the app type, select **Windows app (Win32)** 4. Select the `intunewin` package. 5. Complete any relevant details such as the description, publisher, or app version and then select **Next**. -6. Optional: On the **Program** tab, you can update the **Install command** field to suit your needs. The field is pre-populated with `msiexec /i "DockerDesktop.msi" /qn`. See the [Common installation scenarios](install-and-configure.md) for examples on the changes you can make. +6. Optional: On the **Program** tab, you can update the **Install command** field to suit your needs. The field is pre-populated with `msiexec /i "DockerDesktop.msi" /qn`. See the [Common installation scenarios](msi-install-and-configure.md) for examples on the changes you can make. > [!TIP] > @@ -25,6 +30,26 @@ Learn how to deploy Docker Desktop using Intune, Microsoft's cloud-based device 7. Complete the rest of the tabs and then review and create the app. +{{< /tab >}} +{{< tab name="Mac" >}} + +First, upload the package: + +1. Sign in to your Intune admin center. +2. Add a new app. Select **Apps**, then **macOSs**, then **Add**. +3. Select **Line-of-business app** and then **Select**. +4. Upload the `Docker.pkg` file and fill in the required details. + +Next, assign the app: + +1. Once the app is added, navigate to **Assignments** in Intune. +2. Select **Add group** and choose the user or device groups you want to assign the app to. +3. Select **Save**. + +{{< /tab >}} +{{< /tabs >}} + ## Additional resources - [Explore the FAQs](faq.md). +- Learn how to [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) for your users. \ No newline at end of file diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md b/content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md new file mode 100644 index 0000000000..2aa0e6ace1 --- /dev/null +++ b/content/manuals/desktop/setup/install/enterprise-deployment/use-jamf-pro.md @@ -0,0 +1,29 @@ +--- +title: Use Jamf Pro +description: Use Jamf Pro to deploy Docker Desktop +keywords: jamf, mac, docker desktop, deploy, mdm, enterprise, administrator, +weight: 40 +--- + +Learn how to deploy Docker Desktop for Mac using Jamf Pro. + +First, upload the package: + +1. From the Jamf pro console, Navigate to **Computers** > **Management Settings** > **Computer Management** > **Packages**. +2. Select **New** to add a new package. +3. Upload the `Docker.pkg` file. + +Next, create a policy for deployment: + +1. Navigate to **Computers** > **Policies**. +2. Select **New**to create a new policy. +3. Enter a name for the policy, for example "Deploy Docker Desktop". +4. Under the **Packages** tab, add the Docker package you uploaded. +5. Configure the scope to target the devices or device groups you want to install Docker on. +6. Save the policy and deploy. + +For more information, see [Jamf Pro's official documentation](https://learn.jamf.com/en-US/bundle/jamf-pro-documentation-current/page/Policies.html). + +## Additional resources + +- Learn how to [Enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) for your users. \ No newline at end of file diff --git a/content/manuals/desktop/setup/install/msi/_index.md b/content/manuals/desktop/setup/install/msi/_index.md deleted file mode 100644 index 7214ed4596..0000000000 --- a/content/manuals/desktop/setup/install/msi/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Deploy with Microsoft installer -linkTitle: Use the MSI installer -weight: 50 -description: If you're an IT admin, learn how to deploy Docker Desktop with Microsoft installer -keywords: msi, docker desktop, windows, installation -aliases: -- /desktop/install/msi/ ---- - -> [!NOTE] -> -> The MSI installer is available to all company and organization owners with a Business subscription and Docker Desktop version 4.32 and later. - -Docker offers a 64-bit Microsoft Installer (MSI) package designed to assist IT administrators in customizing and deploying Docker Desktop across multiple users or machines in an enterprise environment. - -The MSI package supports various MDM (Mobile Device Management) solutions, making it ideal for bulk installations and eliminating the need for manual setups by individual users. With this package, IT administrators can ensure standardized, policy-driven installations of Docker Desktop, enhancing efficiency and software management across their organizations. - -Whether you're looking to implement scripted installations or integrate Docker Desktop with existing MDM solutions, this MSI package is an essential resource. - -## What's next - -- [Use the Microsoft installer and read the configuration options](install-and-configure.md) -- [Read the FAQs](faq.md) -- [Install with Intune](use-intune.md)