formatting changes, restructure of the TOC and combining articles for clarity

This commit is contained in:
Amy Zhou 2022-09-30 14:50:34 -07:00
parent 3987c7b54e
commit c2f955153d
9 changed files with 279 additions and 114 deletions

View File

@ -33,45 +33,25 @@
href: mcc-enterprise.md
- name: MCC for ISPs
items:
- name: Concepts
items:
- name: Device provisioning
href: mcc-isp-device-provisioning.md
- name: Client routing
href: mcc-isp-client-routing.md
- name: Cache node configuration
href: mcc-isp-cache-node-configuration.md
- name: Traffic estimation
href: mcc-traffic-estimation.md
- name: How-to guides
items:
- name: Operator sign up and service onboarding
href: mcc-isp-signup.md
- name: Create the cache node in Azure portal
href: mcc-isp-create.md
- name: Provision and deploy cache node to your server
href: mcc-isp-provision-deploy.md
- name: Configure client routing for cache node
href: mcc-isp-configure-routing.md
- name: Verify cache node functionality
- name: Create, provision, and deploy the cache node in Azure portal
href: mcc-isp-create-provision-deploy.md
- name: Verify cache node functionality and monitor health and performance
href: mcc-isp-verify-cache-node.md
- name: Update your cache node
- name: Update or uninstall your cache node
href: mcc-isp-update.md
- name: Monitor cache node health and performance
href: mcc-isp-monitor.md
- name: Uninstall your cache node
href: mcc-isp-uninstall.md
- name: Resources
items:
- name: Community forum
href: link-to-come
- name: FAQs
href: mcc-isp-faq.md
- name: Enhancing VM performance
href: mcc-isp-vm-performance.md
- name: Support and troubleshooting
href: mcc-isp-support.md
- name: Version History
- name: Version history
href: mcc-version-history.md
- name: MCC for ISPs (Private Preview)
href: mcc-isp.md

View File

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 222 KiB

View File

Before

Width:  |  Height:  |  Size: 253 KiB

After

Width:  |  Height:  |  Size: 253 KiB

View File

@ -0,0 +1,142 @@
---
title: Create, provision, and deploy the cache node in Azure portal
manager: dougeby
description: Instructions for creating, provisioning, and deploying Microsoft Connected Cache for ISP on Azure portal
keywords: updates, downloads, network, bandwidth
ms.prod: w10
ms.mktglfcycl: deploy
audience: itpro
author: nidos
ms.localizationpriority: medium
ms.author: nidos
ms.collection: M365-modern-desktop
ms.topic: article
---
# Create, provision, and deploy the cache node in Azure portal
**Applies to**
- Windows 10
- Windows 11
This article outlines how to create, provision, and deploy your Microsoft Connected Cache nodes. The creation and provisioning of your cache node takes place in Azure portal. The deployment of your cache node will require downloading an installer script that will be run on your cache server.
> [!IMPORTANT]
> Before you can create your Microsoft Connected Cache, you will need to complete the sign up process [here](windows\deployment\do\mcc-isp-signup.md). You cannot proceed without signing up for our service.
## Create cache node
1. Open [Azure portal](https://www.portal.azure.com) and navigate to the **Microsoft Connected Cache** resource.
1. Navigate to **Settings** > **Cache nodes** and select **Create Cache Node**.
:::image type="content" source="images/createcachenode.png" alt-text="Screenshot of the create cache node page in the Azure portal":::
1. Provide a name for your cache node and select **Create** to create your cache node.
:::image type="content" source="images/cachenodename.png" alt-text="Screenshot of the create cache node page in the Azure portal, with the cache node name input field.":::
## Provision cache node
During the provisioning of your cache node, there are many fields for you to configure your cache node. To learn more about the definitions of each field, view [Configuration fields](#configuration-fields) at the bottom of this article.
### Client routing
Before serving traffic to your customers, client routing configuration is needed. During the configuration of your cache node in Azure portal, you'll be able to route your clients to your cache node.
Microsoft Connected Cache offers two ways for you to route your clients to your cache node. The first method of manual entry involves uploading a comma-separated list of CIDR blocks that represents the clients. The second method of setting BGP (Border Gateway Protocol) is more automatic and dynamic, which is set up by establishing neighborships with other ASNs. All routing methods are set up within Azure portal.
Once client routing and other settings are configured, your cache node will be able to download content and serve traffic to your customers.
At this time, only IPv4 addresses are supported. IPv6 addresses aren't supported.
#### Manual routing
You can manually upload a list of your CIDR blocks in Azure portal to enable manual routing of your customers to your cache node.
#### BGP routing
BGP (Border Gateway Protocol) routing is another method offered for client routing. BGP dynamically retrieves CIDR ranges by exchanging information with routers to understand reachable networks. For an automatic method of routing traffic, you can choose to configure BGP routing in Azure portal.
1. Navigate to **Settings** > **Cache nodes**. Select the cache node you wish to provision.
:::image type="content" source="images/numberedprovmcc.png" alt-text="Screenshot of the Azure portal depicting the cache node configuration page of a cache node. This screenshot shows all of the fields you can choose to configure the cache node.":::
1. Enter the max allowable egress that your hardware can support.
1. Under **Cache storage**, specify the location of the cache drives to store content along with the size of the cache drives in Gigabytes.
**Note:** Up to nine cache drives are supported.
1. Under **Routing information**, select the routing method you would like to use. For more information see [Client routing](#client-routing).
- If you choose **Manual routing**, enter your address range/CIDR blocks.
- If you choose **BGP routing**, enter the ASN and IP addresses of the neighborship.
**Note:** **Prefix count** and **IP Space** will stop showing 0 when BGP is successfully established.
## Deploy cache node
Once the user executes the deployment script, resources are created behind the scenes resulting in the successful cache node installation. The script takes the input of different IDs outlined below to create an IoT Central and an IoT Edge device. Even though Microsoft Connected Cache scenario isn't related to IoT, IoT Central and IoT Edge are installed for management and communication operation purposes.
### Components installed during provisioning
#### IoT Central
IoT Central is the main hub that handles all messaging and requests from IoT Edge devices. To learn more about the interaction between IoT Edge and IoT Central, view [IoT Central](https://docs.microsoft.com/en-us/azure/iot-central/core/concepts-iot-edge) documentation.
#### IoT Edge
IoT Edge performs several functions important to manage MCC on your edge device:
1. Installs and updates MCC on your edge device.
1. Maintains Azure IoT Edge security standards on your edge device.
1. Ensures that MCC is always running.
1. Reports MCC health and usage to the cloud for remote monitoring.
### Components of the device provisioning script
There are five IDs that the device provisioning script takes as input in order to successfully provision and install your cache server. The provisioning script will automatically include these keys, with no input necessary from the user.
| ID | Description |
| -- | --- |
| Customer ID | The Azure subscription ID that the cache node is created in. |
| Cache node ID | The unique alphanumeric ID of the cache node being provisioned. |
| Customer key | |
| Cache node name | The name of the cache node. |
| Tenant ID | The unique ID associated with the Azure account. |
:::image type="content" source="images/numbereddeploymcc.png" alt-text="Screenshot of the server provisioning tab within cache node configuration in Azure portal.":::
1. After completing cache node provisioning, navigate to the **Server provisioning** tab. Select **Download provisioning package** to download the installation package to your server.
1. Open a terminal window in the directory where you would like to deploy your cache node and run the following command to change the access permission to the Bash script:
```bash
sudo chmod +x installmcc.sh
```
1. Run the deployment script that is shown for your cache node in Azure portal by copying and pasting the script in your terminal. The script may take a few minutes to run. If there were no errors, you have set up your cache node successfully. To verify the server is set up correctly, follow the steps verification steps [here](windows\deployment\do\mcc-isp-verify-cache-node.md).
## General configuration fields
| Field Name | Expected Value| Description |
| -- | --- | --- |
| **Cache node name** | Alphanumeric string that contains no spaces | The name of the cache node. You may choose names based on location like Seattle-1. This name must be unique and can't be changed later. |
| **Server IP address** | IPv4 address | IP address of your MCC server. This address is used to route end-user devices in your network to the server for Microsoft content downloads. The IP address must be publicly accessible. |
| **Max allowable egress (Mbps)** | Integer in Mbps | The maximum egress (Mbps) of your MCC based on the specifications of your hardware. For example, 10,000 Mbps.|
| **Enable cache node** | Enable or Disable | You can choose to enable or disable a cache node at any time. |
### Storage fields
| Field Name | Expected Value| Description |
| -- | --- | --- |
| **Cache drive** | File path string | Up to 9 drives can be configured for each cache node to configure cache storage. Enter the file path to each drive. For example: /dev/folder/ |
| **Cache drive size in gigabytes** | Integer in GB | Set the size of each drive configured for the cache node. |
### Client routing fields
| Field Name | Expected Value| Description |
| -- | --- | --- |
| **Manual routing - Address range/CIDR blocks** | IPv4 CIDR notation | The IP address range (CIDR blocks) that should be routed to the MCC server as a comma separated list. For example: 2.21.234.0/24, 3.22.235.0/24, 4.23.236.0/24 |
| **BGP - Neighbor ASN** | ASN | When configuring BGP, enter the ASN(s) of your neighbors that you want to establish. |
| **BGP - Neighbor IP address** | IPv4 address | When configuring BGP, enter the IP address(es) of neighbors that you want to establish. |

View File

@ -1,55 +0,0 @@
---
title: Create Microsoft Connected Cache for ISP
manager: dougeby
description: Creating Microsoft Connected Cache for ISP on Azure portal
keywords: updates, downloads, network, bandwidth
ms.prod: w10
ms.mktglfcycl: deploy
audience: itpro
author: nidos
ms.localizationpriority: medium
ms.author: nidos
ms.collection: M365-modern-desktop
ms.topic: article
---
# Create Microsoft Connected Cache for ISP
**Applies to**
- Windows 10
- Windows 11
<br/>
> [!IMPORTANT]
> Before you can create your Microsoft Connected Cache, you will need to complete the sign up process [here](windows\deployment\do\mcc-isp-signup.md).
<br/>
<br/>
## Create Cache Node
<br/>
1. Navigate to 'Cache nodes' under Settings and click 'Create Cache Node'.
<br/>
:::image type="content" source="images/createcachenode.png" alt-text="createcachenode":::
<br/>
<br/>
2. Provide a name for your cache node and click 'Create' to create your cache node.
<br/>
:::image type="content" source="images/cachenodename.png" alt-text="cachenodename":::
<br/>
Once your cache node is created follow the instructions on [Provisioning and Deploying MCC](windows\deployment\do\mcc-isp-provision-deploy.md) to provision and deploy the cache node.

View File

@ -1,5 +1,5 @@
---
title: Service onboarding for Microsoft Connected Cache for ISP
title: Operator sign up and service onboarding
manager: dougeby
description: Service onboarding for Microsoft Connected Cache for ISP
keywords: updates, downloads, network, bandwidth
@ -13,46 +13,74 @@ ms.collection: M365-modern-desktop
ms.topic: article
---
# Service Onboarding for Microsoft Connected Cache for ISP
# Operator sign up and service onboarding for Microsoft Connected Cache
**Applies to**
- Windows 10
- Windows 11
<br/>
This article details the process of signing up for Microsoft Connected Cache for Internet Service Providers (Public Preview).
## Resource creation and sign up process
1. Navigate to your [Azure portal](https://www.portal.azure.com). In the top search bar, search for **Microsoft Connected Cache**.
<br/>
:::image type="content" source="images/searchmcc.png" alt-text="Screenshot of the Azure portal which shows the Microsoft Connected Cache resource in Azure marketplace.":::
1. Search for 'Microsoft Connected Cache' and go through the process of creating a resource by selecting the region and enter a name for your cache resource name.
1. Select **Create** to create a **Microsoft Connected Cache**. When prompted, enter a name for your cache resource.
:::image type="content" source="images/searchmcc.png" alt-text="searchmcc":::
> [!IMPORTANT]
> After your resource has been created, we need some information to verify your network operator status and approve you to host Microsoft Connected Cache nodes. Please ensure that your [Peering DB](https://www.peeringdb.com/) organization information is up to date as this information will be used for verification. The NOC contact email will be used to send verification information.
1. Navigate to **Settings** > **Sign up**. Enter your organization ASN. Indicate whether you are a transit provider. If so, additionally, please include any ASN(s) for downstream network operators that you may transit traffic for.
<br/>
:::image type="content" source="images/signup1.png" alt-text="Screenshot of the sign up page in the Microsoft Connected Cache resource page in Azure portal.":::
> [!IMPORTANT]
After your resource has been created, we need some information to verify you network operator status and approve you to host a Microsoft Connected Cache nodes.
> Please ensure that your [Peering DB](https://www.peeringdb.com/) organization information is up to date as this information will be used for verification.
<br/>
1. Once we verify the information entered, a verification code will be sent to the NOC email address provided on [Peering DB](https://www.peeringdb.com/). Once you receive the email, navigate to your Azure portal > **Microsoft Connected Cache** > **Settings** > **Verify operator**, and enter the verification code sent to the NOC email address.
2. Add your organization ASN below. The NOC contact email will be used to send verification information. Additionally, please include any ASN(s) for downstream network operators that you may transit traffic for.
**Note:** Verification codes expire in 24 hours. You will need to generate a new code if it expires.
:::image type="content" source="images/signup1.png" alt-text="sign up for mcc":::
:::image type="content" source="images/verification.png" alt-text="Screenshot of the signup verification page on Azure portal for Microsoft Connected Cache.":::
<br/>
Once verified, follow the instructions on [Create, provision, and deploy cache node](windows\deployment\do\mcc-isp-create-provision-deploy.md) to create your cache node.
3. Once we verify the information entered, a verification code will be sent to the NOC email address provided on Peering DB. In the Azure portal operator verification blade enter the verification code sent to the NOC email address.
**Note:** The verification code will expire in 24 hours. You will need to generate a new code if it expires.
## Traffic estimation
:::image type="content" source="images/verification.png" alt-text="operatorverification":::
During the sign-up process, Microsoft will provide you with a traffic estimation based on your ASN(s). We make estimations based on our predictions on historical data about Microsoft content download volume. We'll use these estimations to recommend hardware or VM configurations. You can view these recommendations within the Azure portal.
<br/>
<br/>
Once verified follow the instruction on [Create Microsoft Connected Cache for ISP](windows\deployment\do\mcc-isp-create.md) to create your cache node.
We make these estimations based on the Microsoft content types that Microsoft Connected Cache serves. To learn more about the types of content that are supported, see [Delivery Optimization and Microsoft Connected Cache content type endpoints](delivery-optimization-endpoints.md).
### Cache performance
To make sure you're maximizing the performance of your cache node, note the following:
#### OS requirements
The Microsoft Connected Cache module is optimized for Ubuntu 20.04 LTS. Install Ubuntu 20.04 LTS on a physical server or VM of your choice.
#### NIC requirements
- Multiple NICs on a single MCC instance are supported using a _link aggregated_ configuration.
- 10 Gbps NIC is the minimum speed recommended, but any NIC is supported.
#### Drive performance
The maximum number of disks supported is 9. When configuring your drives, we recommend SSD drives as cache read speed of SSD is superior to HDD. In addition, using multiple disks is recommended to improve cache performance.
RAID disk configurations are discouraged as cache performance will be impacted. If using RAID disk configurations, ensure striping.
### Hardware configuration example
There are many hardware configurations that suit Microsoft Connected Cache. As an example, below is the hardware configuration of a customer who is able to egress 40 Gbps of traffic.
**Dell PowerEdge R330**
- 2 x Intel(R) Xeon(R) CPU E5-2630 v3 @ 2.40 GHz , total 32 core
- 48 GB, Micron Technology 18ASF1G72PDZ-2G1A1, Speed: 2133 MT/s
- 4 - Transcend SSD230s 1 TB SATA Drives
- Intel Corporation Ethernet 10G 2P X520 Adapter (Link Aggregated)
### Virtual machines
Microsoft Connected Cache supports both physical and virtual machines as cache servers. If you're using a virtual machine as your server, refer to [VM performance](mcc-isp-vm-performance.md) for tips on how to improve your VM performance.

View File

@ -1,7 +1,7 @@
---
title: Update your cache node
title: Update or uninstall your cache node
manager: dougeby
description: How to update your cache node
description: How to update or uninstall your cache node
keywords: updates, downloads, network, bandwidth
ms.prod: w10
ms.mktglfcycl: deploy
@ -13,11 +13,48 @@ ms.collection: M365-modern-desktop
ms.topic: article
---
# Update your cache node
# Update or uninstall your cache node
This article details how to update or uninstall your cache node.
## Update cache node
Microsoft will release updates for Microsoft Connected Cache periodically to improve performance, functionality, and security. Updates won't require any action from the customer. Instead, when an update is available, your cache node will automatically update during low traffic hours with minimal to no impact to your end customers.
To view which version your cache nodes are currently on, navigate to the **Cache nodes** tab to view the versions in the list view.
To view update release notes, visit [Version History](mcc-version-history.md).
To view update release notes, visit [Version history](mcc-version-history.md).
## Uninstall cache node
There are two main steps required to uninstall your cache node:
1. Remove your cache node from Azure portal
1. Run the uninstall script to cleanly remove MCC from your server
You must complete both steps to ensure a clean uninstall of your cache node.
### Remove your cache node from Azure portal
Within [Azure portal](https://www.portal.azure.com), navigate to **Cache Nodes**, then select the cache node you wish to delete. Once selected, select **Delete** on the top bar to remove this cache node from your account.
### Run the uninstall script to cleanly remove Microsoft Connected Cache from your server
In the installer zip file, you'll find the file **uninstallmcc.sh**. This script uninstalls Microsoft Connected Cache and all the related components. Only run it if you're facing issues with Microsoft Connected Cache installation.
The **uninstallmcc.sh** script removes the following components:
- IoT Edge
- Edge Agent
- Edge Hub
- MCC
- Moby CLI
- Moby engine
To run the script, use the following commands:
```bash
sudo chmod +x uninstallmcc.sh
sudo ./uninstallmcc.sh
```

View File

@ -1,5 +1,5 @@
---
title: Verify cache node functionality
title: Verify cache node functionality and monitor health and performance
manager: dougeby
description: How to verify the functionality of a cache node
keywords: updates, downloads, network, bandwidth
@ -13,13 +13,15 @@ ms.collection: M365-modern-desktop
ms.topic: article
---
# Verify cache node functionality
# Verify cache node functionality and monitor health and performance
### Verify functionality on Azure portal
This article details how to verify that your cache node(s) are functioning properly and serving traffic. In addition, this article details
Log into Azure portal and navigate to the Overview page. Select the **Monitoring** tab to verify the functionality of your server(s) by validating the number of healthy nodes shown. If you see any **Unhealthy nodes**, select the "Diagnose and Solve" link to troubleshoot and resolve the issue.
## Verify functionality on Azure portal
### Verify functionality on the server
Log into [Azure portal](https://www.portal.azure.com) and navigate to the **Overview** page. Select the **Monitoring** tab to verify the functionality of your server(s) by validating the number of healthy nodes shown. If you see any **Unhealthy nodes**, select the **Diagnose and Solve** link to troubleshoot and resolve the issue.
## Verify functionality on the server
It can take a few minutes for the container to deploy after you've saved the configuration.
@ -47,6 +49,34 @@ Similarly, enter the following URL into a web browser on any device on the netwo
http://<CacheServerIP>/mscomtest/wuidt.gif?cacheHostOrigin=au.download.windowsupdate.com
```
If the test fails, for more information, see the [FAQs](#mcc-isp-faq) section.
## Monitor cache node health and performance
Within Azure portal, there are many charts and graphs that are available to monitor cache node health and performance.
### Available Metrics
Within Azure portal, you're able to build your custom charts and graphs using the following available metrics:
| Metric name | Description |
| -- | ---- |
| **Cache Efficiency** | Cache efficiency is defined as the total cache hit bytes divided by all bytes requested. The higher this value (0 - 100%), the more efficient the cache node is. |
| **Healthy nodes** | The number of cache nodes that are reporting as healthy|
| **Unhealthy nodes**| The number of cache nodes that are reporting as unhealthy|
| **Maximum in**| The maximum egress (in Gbps) of inbound traffic|
| **Maximum out**| The maximum egress (in Gbps) of outbound traffic|
| **Average in**| The average egress (in Gbps) of inbound traffic|
| **Average out**| The average egress (in Gbps) of outbound traffic|
To learn more about how to build your custom charts and graphs, visit [Azure Monitor](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/data-platform-metrics) for details.
### Monitoring your metrics
To view the metrics associated with your cache nodes, navigate to the Overview >> Monitoring tab within Azure portal.
:::image type="content" source="images/mcc-img-metrics.PNG" alt-text="Screenshot of the Azure portal displaying the metrics view in the Overview tab":::
You can choose to monitor the health and performance of all cache nodes or one by one by using the dropdown menu. The **Egress bits per second** graph shows your inbound and outbound traffic of your cache nodes over time. You can change the time range (1 hour, 12 hours, 1 day, 7 days, 14 days, and 30 days) by selecting the time range of choice on the top bar.
If you're unable to view metrics for your cache node, it may be that your cache node is unhealthy, inactive, or hasn't been fully configured.

View File

@ -13,8 +13,11 @@ ms.collection: M365-modern-desktop
ms.topic: article
---
# Current Version
### Version 1332
# Version History
Microsoft periodically releases software updates for your cache nodes to improve performance, caching efficiency, and other bug fixes. These updates will be performed automatically at low-traffic hours, requiring no
## Current Version
#### Version 1332
Released September 15, 2022
Version notes: