diff --git a/windows/deployment/do/TOC.yml b/windows/deployment/do/TOC.yml index d486ab4862..560f759c03 100644 --- a/windows/deployment/do/TOC.yml +++ b/windows/deployment/do/TOC.yml @@ -45,10 +45,10 @@ href: mcc-ent-create-resource-and-cache.md - name: Configure, provision and deploy cache node items: - - name: Configure and provision cache node on Linux - href: mcc-ent-configure-provision-linux.md - - name: Configure and provision cache node on Windows - href: mcc-ent-configure-provision-windows.md + - name: Deploy MCC to Linux + href: mcc-ent-deploy-linux.md + - name: Deploy MCC to Windows + href: mcc-ent-deploy-windows.md - name: Using CLI to create and manage cache nodes href: mcc-ent-manage-cache-using-CLI.md - name: Verify cache node functionality @@ -57,8 +57,8 @@ href: mcc-ent-monitor-cache.md - name: Update MCC href: mcc-ent-update-cache.md - - name: Uninstalling cache node - href: mcc-ent-uninstall-cache-node.md + - name: Uninstall cache node + href: mcc-ent-uninstall.md - name: Resources items: - name: Frequent Asked Questions diff --git a/windows/deployment/do/mcc-ent-deploy-linux.md b/windows/deployment/do/mcc-ent-deploy-linux.md new file mode 100644 index 0000000000..c15dd8a281 --- /dev/null +++ b/windows/deployment/do/mcc-ent-deploy-linux.md @@ -0,0 +1,38 @@ +--- +title: Deploy cache software to a Linux host machine +description: How to deploy Microsoft Connected Cache for Enterprise and Education cache software to a Linux host machine. +author: chrisjlin +ms.author: lichris +manager: naengler +ms.service: windows-client +ms.subservice: itpro-updates +ms.topic: how-to +ms.date: 09/27/2024 +appliesto: +- ✅ Supported Linux distributions +- ✅ Microsoft Connected Cache for Enterprise and Education +--- + +# Deploy your Connected Cache to a Linux host machine + +This article describes how to deploy Microsoft Connected Cache for Enterprise and Education (MCCE) caching software to a Linux host machine. + +Before deploying MCCE to a Linux host machine, ensure that the host machine meets all [requirements](mcc-enterprise-prerequisites.md), and that you have [created and configured your MCC Azure resource](https://aka.ms/mccent-create-resources). + +## Steps to deploy MCCE to Linux + +1. Within the Azure portal, navigate to the "Provisioning" tab of your cache node and copy the provisioning command. +1. Download the provisioning package using the button at the top of the Cache Node Configuration page and extract the package onto the host machine. +1. Open a command line window *as administrator* on the host machine, then change directory to the extracted provisioning package. +1. Set access permissions to allow the `provisionmcc.sh` script within the provisioning package directory to execute. +1. Run the provisioning command on the host machine. + +## Next step + +> [!div class="nextstepaction"] +> [Verify cache node functionality](mcc-enterprise-verify-functionality.md) + +## Related content + +- [Deploy to a Windows host machine](mcc-enterprise-deploy-windows.md) +- [Uninstall MCCE](mcc-enterprise-uninstall.md) \ No newline at end of file diff --git a/windows/deployment/do/mcc-ent-deploy-windows.md b/windows/deployment/do/mcc-ent-deploy-windows.md new file mode 100644 index 0000000000..e75da9ca97 --- /dev/null +++ b/windows/deployment/do/mcc-ent-deploy-windows.md @@ -0,0 +1,44 @@ +--- +title: Deploy cache software to a Windows host machine +description: How to deploy Microsoft Connected Cache for Enterprise and Education cache software to a Windows host machine. +author: chrisjlin +ms.author: lichris +manager: naengler +ms.service: windows-client +ms.subservice: itpro-updates +ms.topic: how-to +ms.date: 09/27/2024 +appliesto: +- ✅ Windows 11 +- ✅ Microsoft Connected Cache for Enterprise and Education +--- + +# Deploy your Connected Cache to a Windows host machine + +This article describes how to deploy Microsoft Connected Cache for Enterprise and Education (MCCE) caching software to a Windows host machine. + +Deploying MCCE to a Windows host machine requires designating a [Group Managed Service Account (gMSA)](https://learn.microsoft.com/en-us/windows-server/security/group-managed-service-accounts/getting-started-with-group-managed-service-accounts) or a [Local User Account](https://support.microsoft.com/en-us/windows/create-a-local-user-or-administrator-account-in-windows-20de74e0-ac7f-3502-a866-32915af2a34d) as the MCCE runtime account. This prevents tampering with the MCC container and the cached content on the host machine. + +Before deploying MCCE to a Windows host machine, ensure that the host machine meets all [requirements](mcc-enterprise-prerequisites.md), and that you have [created and configured your MCC Azure resource](https://aka.ms/mccent-create-resources). + +## Steps to deploy MCCE to Windows + +1. Within the Azure portal, navigate to the "Provisioning" tab of your cache node and copy the provisioning command. +1. Download the provisioning package using the button at the top of the Cache Node Configuration page and extract the package onto the host machine. +1. Open a PowerShell windows *as administrator* on the host machine, then change directory to the extracted provisioning package. +1. Set the Execution Policy to "Unrestricted" to allow the provisioning scripts to run. +1. Create a `$User` environment variable containing the username of the account you intend to designate as the MCC runtime account. For gMSAs, the value should be formatted as `"Domain\Username$"`. For Local User accounts, `$User` should be formatted as `"LocalMachineName\Username"`. + - If you're using a Local User account as the MCCE runtime account, you'll also need to create a [PSCredential Object](https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.pscredential?view=powershellsdk-7.4.0) named `$myLocalAccountCredential`. +1. Run the provisioning command on the host machine. + +## Next step + +> [!div class="nextstepaction"] +> [Verify cache node functionality](mcc-enterprise-verify-functionality.md) + + + +## Related content + +- [Deploy to a Linux host machine](mcc-enterprise-deploy-linux.md) +- [Uninstall MCCE](mcc-enterprise-uninstall.md) \ No newline at end of file diff --git a/windows/deployment/do/mcc-ent-prerequisites.md b/windows/deployment/do/mcc-ent-prerequisites.md index 1e33e85158..a53dc8e4a8 100644 --- a/windows/deployment/do/mcc-ent-prerequisites.md +++ b/windows/deployment/do/mcc-ent-prerequisites.md @@ -1,60 +1,74 @@ --- title: Requirements for MCC for Enterprise and Education -description: Overview of prerequisites and recommendations for using Microsoft Connected Cache (MCC) for Enterprise and Education. +description: Overview of prerequisites and recommendations for using Microsoft Connected Cache for Enterprise and Education (MCCE). ms.service: windows-client ms.subservice: itpro-updates ms.topic: conceptual -ms.author: carmenf -author: cmknox -manager: aaroncz -ms.reviewer: mstewart -ms.collection: tier3 +ms.author: lichris +author: chrisjlin +manager: naengler appliesto: - ✅ Windows 11 -- ✅ Windows 10 -- - ✅ Microsoft Connected Cache for Enterprise and Education -ms.date: 05/23/2024 +- ✅ Microsoft Connected Cache for Enterprise and Education +ms.date: 09/27/2024 --- -# Requirements of Microsoft Connected Cache for Enterprise and Education (early preview) +# Microsoft Connected Cache for Enterprise and Education Requirements (Public Preview) -> [!NOTE] -> As we near the release of public preview, we have paused onboarding. Please continue to submit the form to express interest so we can follow up with you once public preview of Microsoft Connected Cache for Enteprise and Education is available. To register your interest, fill out the form located at [https://aka.ms/MSConnectedCacheSignup](https://aka.ms/MSConnectedCacheSignup). +This article details the requirements and recommendations for using Microsoft Connected Cache for Enterprise and Education (MCCE). -## Enterprise requirements for MCC +## Licensing requirements -1. **Azure subscription**: MCC management portal is hosted within Azure and is used to create the Connected Cache [Azure resource](/azure/cloud-adoption-framework/govern/resource-consistency/resource-access-management) and IoT Hub resource. Both are free services. +- **Valid Azure subscription**: To use the Microsoft Connected Cache for Enterprise and Education (MCCE) service, you'll need a valid Azure subscription that can be used to provision the necessary [Azure resources](/azure/cloud-adoption-framework/govern/resource-consistency/resource-access-management). - Your Azure subscription ID is first used to provision MCC services, and enable access to the preview. The MCC server requirement for an Azure subscription costs you nothing. If you don't have an Azure subscription already, you can create an Azure [pay-as-you-go](https://azure.microsoft.com/offers/ms-azr-0003p/) account, which requires a credit card for verification purposes. For more information, see the [Azure Free Account FAQ](https://azure.microsoft.com/free/free-account-faq/). + If you don't have an Azure subscription already, you can create an Azure [pay-as-you-go](https://azure.microsoft.com/offers/ms-azr-0003p/) account, which requires a credit card for verification purposes. For more information, see the [Azure Free Account FAQ](https://azure.microsoft.com/free/free-account-faq/). + + The Azure resources used for MCCE will be free to you during this public preview. + +- **E3/E5 or A3/A5 license**: Your organization must have one of the following license subscriptions for each device that downloads content from an MCCE cache node. + + - [Windows Enterprise E3 or E5](https://learn.microsoft.com/en-us/windows/whats-new/windows-licensing#windows-11-enterprise), included in [Microsoft 365 F3, E3, or E5](https://www.microsoft.com/en-us/microsoft-365/enterprise/microsoft365-plans-and-pricing?msockid=32c407b43d5968050f2b13443c746916) + - Windows Education A3 or A5, included in [Microsoft 365 A3 or A5](https://www.microsoft.com/en-us/education/products/microsoft-365?msockid=32c407b43d5968050f2b13443c746916#Education-plans) + +## Cache node host machine requirements - The resources used for the preview and in the future when this product is ready for production will be free to you, like other caching solutions. -1. **Hardware to host MCC**: The recommended configuration serves approximately 35,000 managed devices, downloading a 2-GB payload in 24-hour timeframe at a sustained rate of 6.5 Gbps. - > [!NOTE] - > Azure VMs are not currently supported. If you'd like to install your cache node on VMWare, see the [Appendix](mcc-enterprise-appendix.md) for a few additional configurations. + > If you'd like to install your cache node on VMWare, see the [Appendix](mcc-enterprise-appendix.md) for a few additional configurations. - **EFLOW requires Hyper-V support** - - On Windows client, enable the Hyper-V feature. - - On Windows Server, install the Hyper-V role and create a default network switch. - - For more requirements, see [EFLOW requirements](/azure/iot-edge/iot-edge-for-linux-on-windows#prerequisites). +### General requirements - Disk recommendations: - - Using an SSD is recommended as cache read speed of SSD is superior to HDD +- Any previous installations of MCC must be [uninstalled](mcc-enterprise-update-uninstall.md) before installing the latest version of MCC. +- [These listed endpoints](delivery-optimization-endpoints.md) must be reachable by the host machine. +- The host machine must have no other services / applications utilizing port 80 (for example, ConfigManager or Distribution Point). +- The host machine must have at least 4 GB of free memory. - NIC requirements: - - Multiple NICs on a single MCC instance aren't supported. - - 1 Gbps NIC is the minimum speed recommended but any NIC is supported. - - For best performance, NIC and BIOS should support SR-IOV. +### Additional requirements for Windows host machines - VM networking: - - An external virtual switch to support outbound and inbound network communication (created during the installation process) -1. **Content endpoints**: If you're using a proxy or firewall, certain endpoints must be allowed through in order for your MCC to cache and serve content. See [Delivery Optimization and Microsoft Connected Cache content type endpoints](delivery-optimization-endpoints.md) for the list of required endpoints. +- The Windows host machine must be using Windows 11 or Windows Server 2022 with the Latest Cumulative Update (LCU) applied. + - Windows 11 must have [OS Build 22631.3296](https://support.microsoft.com/en-us/topic/march-12-2024-kb5035853-os-builds-22621-3296-and-22631-3296-a69ac07f-e893-4d16-bbe1-554b7d9dd39b) or later + - Windows Server 2022 must have [OS Build 20348.2227](https://support.microsoft.com/en-us/topic/january-9-2024-kb5034129-os-build-20348-2227-6958a36f-efaf-4ef5-a576-c5931072a89a) or later +- The Windows host machine must support nested virtualization. +- The Windows host machine must have [WSL2 installed](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command). -## Sizing recommendations +### Additional requirements for Linux host machines + +- The Linux host machine must be using one of the following Operating Systems: + + - Ubuntu 20.04 + - Red Hat Enterprise Linux (RHEL) 8.* or 9.* + - If using RHEL, the default container engine (Podman) must be replaced with [Moby](https://github.com/moby/moby#readme) + +### Networking recommendations for host machines + +- Multiple network interface cards (NICs) on a single MCC instance aren't supported. +- 1 Gbps NIC is the minimum speed recommended but any NIC is supported. +- The NIC and BIOS should support SR-IOV for best performance. + +### Host machine sizing recommendations | Component | Branch Office / Small Enterprise | Large Enterprise | | -- | --- | --- | -| OS| Windows Server 2019*/2022
Windows 10*/11 (Pro or Enterprise) with Hyper-V Support

* Windows 10 and Windows Server 2019 build 17763 or later | Same | +| OS| Windows Server 2022
Windows 11 (Pro or Enterprise) | Same | |NIC | 1 Gbps | 5 Gbps | |Disk | SSD
1 drive
50 GB each |SSD
1 drive
200 GB each | |Memory | 4 GB | 8 GB | diff --git a/windows/deployment/do/mcc-ent-uninstall-cache-node.md b/windows/deployment/do/mcc-ent-uninstall-cache-node.md index 1aa10c6c08..69eb8b733b 100644 --- a/windows/deployment/do/mcc-ent-uninstall-cache-node.md +++ b/windows/deployment/do/mcc-ent-uninstall-cache-node.md @@ -1,149 +1,35 @@ --- -title: MCC for Enterprise uninstall -description: Microsoft Connected Cache for Enterprise. Learn about uninstall +title: Uninstall MCC for Enterprise and Education +description: Details on how to uninstall Microsoft Connected Cache for Enterprise and Education (MCCE) from a host machine. ms.service: windows-client ms.subservice: itpro-updates ms.topic: how-to -manager: aaroncz -ms.author: nidos -author: doshnid -ms.reviewer: mstewart -ms.collection: tier3 +ms.author: lichris +author: chrisjlin +manager: naengler appliesto: - ✅ Windows 11 -- ✅ Windows 10 -- ✅ Microsoft Connected Cache for Enterprise -ms.date: 06/03/2024 +- ✅ Supported Linux distributions +- ✅ Microsoft Connected Cache for Enterprise and Education +ms.date: 09/27/2024 --- - +## Steps to uninstall MCCE from a Linux host machine - - -# " * " -TODO: Add your heading - - - -TODO: Add your introductory paragraph - - - - - -## Prerequisites - -TODO: List the prerequisites - - - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - - - -## Next step - -TODO: Add your next step link(s) - -> [!div class="nextstepaction"] -> [Write concepts](article-concept.md) - - - -## Related content - -TODO: Add your next step link(s) - -- [Write concepts](article-concept.md) - - +The `uninstallmcc.sh` script within the provisioning package uninstalls the MCCE caching software and all related components, including: +- IoT Edge +- IoT Edge Agent +- IoT Edge Hub +- MCC +- Moby CLI +- Moby engine diff --git a/windows/deployment/do/mcc-ent-update-cache.md b/windows/deployment/do/mcc-ent-update-cache-node.md similarity index 100% rename from windows/deployment/do/mcc-ent-update-cache.md rename to windows/deployment/do/mcc-ent-update-cache-node.md diff --git a/windows/deployment/do/mcc-ent-verify-cache-node.md b/windows/deployment/do/mcc-ent-verify-cache-node.md index be12905760..d782443c2e 100644 --- a/windows/deployment/do/mcc-ent-verify-cache-node.md +++ b/windows/deployment/do/mcc-ent-verify-cache-node.md @@ -1,149 +1,46 @@ --- -title: MCC for Enterprise verify cache node -description: Microsoft Connected Cache for Enterprise. Learn about verifying cache node +title: Verify cache node functionality +description: How to verify functionality of a Microsoft Connected Cache for Enterprise and Education cache node. +author: chrisjlin +ms.author: lichris +manager: naengler ms.service: windows-client ms.subservice: itpro-updates ms.topic: how-to -manager: aaroncz -ms.author: nidos -author: doshnid -ms.reviewer: mstewart -ms.collection: tier3 +ms.date: 09/27/2024 appliesto: -- ✅ Windows 11 -- ✅ Windows 10 -- ✅ Microsoft Connected Cache for Enterprise -ms.date: 06/03/2024 +- ✅ Windows-hosted MCCE cache nodes +- ✅ Linux-hosted MCCE cache nodes +- ✅ Microsoft Connected Cache for Enterprise and Education --- - +1. To verify that the MCCE container on the host machine is running and reachable, run the following command from the host machine: - + If successful, the Windows client device should begin to download a small image file from the MCCE cache node. -# " * " -TODO: Add your heading +1. To check how much content an individual Windows client has pulled from an MCCE cache node, open the [Delivery Optimization activity monitor](https://learn.microsoft.com/en-us/microsoft-365-apps/updates/delivery-optimization#viewing-data-about-the-use-of-delivery-optimization) on the Windows client device. - - -TODO: Add your introductory paragraph - - - - - -## Prerequisites - -TODO: List the prerequisites - - - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - -## "\ * \" -TODO: Add introduction sentence(s) -[Include a sentence or two to explain only what is needed to complete the procedure.] -TODO: Add ordered list of procedure steps -1. Step 1 -1. Step 2 -1. Step 3 - - - -## Next step - -TODO: Add your next step link(s) - -> [!div class="nextstepaction"] -> [Write concepts](article-concept.md) - - + You should see a donut chart titled Download Statistics. If the Windows client has pulled content from the cache node, you'll see a segment of the donut labeled "From Microsoft cache server". ## Related content -TODO: Add your next step link(s) - -- [Write concepts](article-concept.md) - - - +- [Monitor cache node usage](mcc-enterprise-monitoring.md) +- [Troubleshoot cache node](mcc-enterprise-support-troubleshoot.md) \ No newline at end of file