Merge branch 'main' into nidos_working

This commit is contained in:
Nidhi Doshi
2022-09-12 14:57:26 -07:00
committed by GitHub
73 changed files with 664 additions and 411 deletions

View File

@ -1,92 +1,82 @@
- name: Delivery Optimization for Windows client
- name: Delivery Optimization for Windows client and Microsoft Connected Cache
href: index.yml
- name: What's new
href: whats-new-do.md
items:
- name: Get started
items:
- name: What is Delivery Optimization
href: waas-delivery-optimization.md
- name: What's new
href: whats-new-do.md
- name: Delivery Optimization Frequently Asked Questions
href: waas-delivery-optimization-faq.yml
- name: Configure Delivery Optimization
- name: Delivery Optimization
items:
- name: What is Delivery Optimization
href: waas-delivery-optimization.md
- name: Delivery Optimization Frequently Asked Questions
href: waas-delivery-optimization-faq.yml
- name: Configure Delivery Optimization for Windows clients
items:
- name: Windows client Delivery Optimization settings
href: waas-delivery-optimization-setup.md#recommended-delivery-optimization-settings
- name: Configure Delivery Optimization settings using Microsoft Intune
href: /mem/intune/configuration/delivery-optimization-windows
- name: Resources for Delivery Optimization
items:
- name: Set up Delivery Optimization for Windows
href: waas-delivery-optimization-setup.md
- name: Delivery Optimization reference
href: waas-delivery-optimization-reference.md
- name: Delivery Optimization client-service communication
href: delivery-optimization-workflow.md
- name: Using a proxy with Delivery Optimization
href: delivery-optimization-proxy.md
- name: Microsoft Connected Cache
items:
- name: MCC overview
href: waas-microsoft-connected-cache.md
- name: MCC for Enterprise and Education
href: mcc-enterprise.md
- name: MCC for ISPs
items:
- name: Configure Windows Clients
items:
- name: Windows Delivery Optimization settings
href: waas-delivery-optimization-setup.md#recommended-delivery-optimization-settings
- name: Windows Delivery Optimization Frequently Asked Questions
href: ../do/waas-delivery-optimization-faq.yml
- name: Configure Microsoft Endpoint Manager
items:
- name: Delivery Optimization settings in Microsoft Intune
href: /mem/intune/configuration/delivery-optimization-windows
- name: Microsoft Connected Cache
items:
- name: MCC overview
href: waas-microsoft-connected-cache.md
- name: MCC for Enterprise and Education
href: mcc-enterprise.md
- name: MCC for ISPs
items:
- name: MCC for ISPs Overview
href: mcc-isp.md
- 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: How-to guides
items:
- name: Operator sign up and service onboarding
href: mcc-isp-signup.md
- name: Create the MCC 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
href: mcc-isp-verify-cache-node.md
- name: Update 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: MCC for ISP Community Forum
href: link-to-come
- name: FAQs
href: mcc-isp-faq.md
- name: Common Issues
href: mcc-isp-common-issues.md
- name: Enhancing VM performance
href: mcc-isp-vm-performance.md
- name: Support
href: mcc-isp-support.md
- name: Overview
href: mcc-isp-overview.md
- 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 MCC 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
href: mcc-isp-verify-cache-node.md
- name: Update 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: MCC for ISPs (Private Preview)
href: mcc-isp.md
- name: Content endpoints for Delivery Optimization and Microsoft Connected Cache
href: delivery-optimization-endpoints.md
- name: Resources
items:
- name: Set up Delivery Optimization for Windows
href: waas-delivery-optimization-setup.md
- name: Delivery Optimization reference
href: waas-delivery-optimization-reference.md
- name: Delivery Optimization client-service communication
href: delivery-optimization-workflow.md
- name: Using a proxy with Delivery Optimization
href: delivery-optimization-proxy.md
- name: Content endpoints for Delivery Optimization and Microsoft Connected Cache
href: delivery-optimization-endpoints.md

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

View File

@ -0,0 +1,28 @@
# Cache node configuration
All cache node configuration will take place within Azure portal. This article outlines all of the settings that you will be able to configure.
## Settings
| 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
| 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
| Field Name | Expected Value| Description |
| -- | --- | --- |
| **Manual touting - 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

@ -0,0 +1,18 @@
# Client Routing
Before serving traffic to your customers, client routing configuration is needed. During the configuration of your cache node in Azure portal, you will 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 are not 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.

View File

@ -0,0 +1,35 @@
# Configure client routing for cache node
All configuration routing takes place within the Azure Portal. There are two main methods to route clients to your cache node:
- **Manual Routing**: Providing the CIDR blocks that represent the client IP address space, which should be routed to the MCC node.
- **BGP Routing**: BGP neighborship sessions from the cache node to the router or route server will be initiated automatically based on the portal configuration.
> [!NOTE]
> Only IPv4 addresses are supported at this time. Entering IPv6 addresses will result in an error.
## Manual Routing
1. To configure client routing using manually entered CIDR blocks, navigate to **Settings** >> **Routing Information**.
1. Select **Manual prefix entry** as the Prefix Source.
1. Paste in the CIDR blocks, with each IP range separated by a comma.
1. Lastly, press Save to save your changes.
## BGP Routing
1. To configure client routing using BGP, navigate to **Settings** >> **Routing Information**.
1. Select **BGP** as the Prefix source.
1. Click on **Add neighbor** to add the ASN(s) and IP address(es) of your BGP neighbors.
1. If you'd like to download your BGP routes, click on the **Download Routes** button.
1. Lastly, press Save to save your changes.
1. From your end, establish a neighborship from your router to MCC's host machine. Use the IP address of the host machine that's running the MCC container.
> [!NOTE]
> With the BGP configuration, you're essentially setting up an iBGP neighbor in your public ASN. For example, when you initiate the BGP session from the router to the cache node, you would use your own ASN.
> [!NOTE]
> Make sure there aren't any firewall rules blocking this connection.
To verify that BGP has been configured properly and that Microsoft Connected Cache services are receiving the route advertisements, wait about five minutes before refreshing cache node settings page and view the BGP routes received.
If after five minutes, you don't see traffic, navigate to [Support and Troubleshooting](mcc-isp-support.md) for more information.

View File

@ -0,0 +1,32 @@
# Device Provisioning
Once the user executes the provisioning script, resources are created behind the scenes resulting in the successful cache node installation.
The device provisioning 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 is not 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. |

View File

@ -3,21 +3,19 @@
## Metrics
Within Azure portal, there are a number of metrics that are available to monitor cache node health and performance.
### Available Metrics
- **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
Within Azure portal, you are able to build your custom metrics using the following available metrics:
### Viewing your metrics
To view the metrics associated with your cache nodes, navigate to the **Overview** tab within Azure portal.
| 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|
[[ include screenshot of an example view]]
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 are unable to view metrics for your cache node, it may be that your cache node is unhealthy, inactive, or hasn't been fully configured.
To learn more about how to build your custom metrics, visit [Azure Monitor](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/data-platform-metrics) for details.

View File

@ -1,19 +1,19 @@
# Uninstall your cache node
There are two main steps required to uninstall your cache node:
1. Delete your cache node from the Azure portal
1. Remove your cache node from Azure portal
1. Run the uninstall script to cleanly remove MCC from your server
## Delete your cache node from the Azure portal
Navigate to your Overview page. On the top bar, click on **Delete**.
## Remove your cache node from Azure portal
Within Azure portal, navigate to **Cache Nodes**, then select the cache node you wish to delete. Once selected, click **Delete** on the top bar to remove this cache node from your account.
## Run the uninstall script to cleanly remove MCC from your server
In the installer zip file, you'll find the file **uninstallmcc.sh**. This script uninstalls MCC and all the related components. Before you run this script, contact the MCC team. Only run it if you're facing issues with MCC installation.
In the installer zip file, you'll find the file **uninstallmcc.sh**. This script uninstalls MCC and all the related components. Only run it if you're facing issues with MCC installation.
> [!WARNING]
> Be cautious before running this script. It will also erase existing IoT workflows in this VM.
The **uninstallmcc.sh** script removes the following components:
@ -29,4 +29,7 @@ To run the script, use the following commands:
```bash
sudo chmod +x uninstallmcc.sh
sudo ./uninstallmcc.sh
```
```

View File

@ -2,6 +2,7 @@
Microsoft will release updates for MCC periodically to improve performance, functionality, and security. Updates will not 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, [[*********]].
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 our Tech Community page.

View File

@ -1,26 +1,14 @@
# Verify cache node functionality
### Verify client side
Sign in to the Connected Cache server or use SSH. Run the following command from a terminal to see the running modules (containers):
### Verify functionality on Azure portal
```bash
sudo iotedge list
```
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.
If the cache server is running properly, you will see the containers **edgeAgent**, **edgeHub**, and **[Your Cache Node name]** listed, all with the status **running**.
### Verify functionality on the server
If it lists the **edgeAgent** and **edgeHub** containers, but doesn't include **MCC**, view the status of the IoT Edge security manager using the command:
It can take a few minutes for the container to deploy after you've saved the configuration.
```bash
sudo journalctl -u iotedge -f
```
This command provides the current status of the starting and stopping of a container or the container pull and start.
### Verify server side
It can take a few minutes for the container to deploy.
To validate a properly functioning MCC, run the following command in the terminal of the cache server or any device in the network. Replace `<CacheServerIP>` with the IP address of the cache server.
@ -46,4 +34,6 @@ 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 [common issues](#common-issues) section.
If the test fails, for more information, see the [FAQs](#mcc-isp-faq) section.

View File

@ -0,0 +1,38 @@
# Traffic Estimation
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 will use these estimations to recommend hardware or VM configurations. You can view these recommendations within the Azure portal.
Note that 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 endpoints]().
## Cache performance
To make sure you are maximizing the performance of your cache node, please note the following:
### OS requirements
The MCC 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.40GHz , total 32core
- 48GB, Micron Technology 18ASF1G72PDZ-2G1A1, Speed: 2133 MT/s
- 4 - Transcend SSD230s 1TB SATA Drives
- Intel Corporation Ethernet 10G 2P X520 Adapter (Link Aggregated)
### Virtual Machines
If you are using a virtual machine as your server, please refer to [VM performance](mcc-isp-vm-performance.md) for tips on how to improve your VM performance.