diff --git a/windows/deployment/do/TOC.yml b/windows/deployment/do/TOC.yml index 0c6da8d908..e32a385de6 100644 --- a/windows/deployment/do/TOC.yml +++ b/windows/deployment/do/TOC.yml @@ -33,8 +33,8 @@ href: mcc-enterprise.md - name: MCC for ISPs items: - - name: MCC for ISPs Overview - href: mcc-isp.md + - name: MCC for ISP overview + href: mcc-isp-overview.md - name: Concepts items: - name: Device Provisioning @@ -73,6 +73,8 @@ 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 diff --git a/windows/deployment/do/mcc-isp-cache-node-configuration.md b/windows/deployment/do/mcc-isp-cache-node-configuration.md index 615536c999..623b883947 100644 --- a/windows/deployment/do/mcc-isp-cache-node-configuration.md +++ b/windows/deployment/do/mcc-isp-cache-node-configuration.md @@ -1,2 +1,16 @@ # 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. + +| 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. | +| **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. | +| **Cache drive size in gigabytes** | Integer in GB | Set the size of each drive configured for the cache node. | +| **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 | +| **Neighbor ASN** | Integer ASN | When configuring BGP, enter the ASN(s) of your neighbors that you want to establish. | +| **Neighbor IP address** | Ipv4 address | When configuring BGP, enter the IP address(es) of neighbors that you want to establish. | + diff --git a/windows/deployment/do/mcc-isp-configure-routing.md b/windows/deployment/do/mcc-isp-configure-routing.md index e69de29bb2..6e928549e4 100644 --- a/windows/deployment/do/mcc-isp-configure-routing.md +++ b/windows/deployment/do/mcc-isp-configure-routing.md @@ -0,0 +1,37 @@ +# 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. + +a. Make sure there aren't any firewall rules blocking this connection. +b. Verify that the BGP connection has been established and that you're advertising routes to the MCC. +c. Wait five minutes to refresh the cache node page in the Azure portal to see the BGP routes. + +1. If there are errors: + - Inspect the installer logs, which are in the following path: `/etc/mccresourcecreation/` + - For more information, see [Troubleshoot your IoT Edge device](/azure/iot-edge/troubleshoot). + diff --git a/windows/deployment/do/mcc-isp-device-provisioning.md b/windows/deployment/do/mcc-isp-device-provisioning.md index daf2216cb8..db4500f250 100644 --- a/windows/deployment/do/mcc-isp-device-provisioning.md +++ b/windows/deployment/do/mcc-isp-device-provisioning.md @@ -1,5 +1,15 @@ +# Device Provisioning + 1. Overview of device provisioning 2. Components that are installed during provisioning -3. Talk about the unique IDs in the device provisioning script \ No newline at end of file +3. Talk about the unique IDs in the device provisioning script + +| ID | Description | +| -- | --- | +| Customer ID | | +| Cache node ID | | +| Customer key | | +| Cache node name | | +| Tenant ID | | diff --git a/windows/deployment/do/mcc-isp-monitor.md b/windows/deployment/do/mcc-isp-monitor.md index 0fbf21f6bb..010e84009f 100644 --- a/windows/deployment/do/mcc-isp-monitor.md +++ b/windows/deployment/do/mcc-isp-monitor.md @@ -14,7 +14,7 @@ Within Azure portal, there are a number of metrics that are available to monitor - **Average out**: The average egress (in Gbps) of outbound traffic ### Viewing your metrics -To view the metrics associated with your cache nodes, navigate to the **Overview** tab within Azure portal. +To view the metrics associated with your cache nodes, navigate to the **Overview** >> **Monitoring** tab within Azure portal. [[ include screenshot of an example view]] diff --git a/windows/deployment/do/mcc-isp-overview.md b/windows/deployment/do/mcc-isp-overview.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/windows/deployment/do/mcc-isp-uninstall.md b/windows/deployment/do/mcc-isp-uninstall.md index 9aeb0a7462..1b563f5fd7 100644 --- a/windows/deployment/do/mcc-isp-uninstall.md +++ b/windows/deployment/do/mcc-isp-uninstall.md @@ -1,16 +1,16 @@ # 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. @@ -29,4 +29,5 @@ To run the script, use the following commands: ```bash sudo chmod +x uninstallmcc.sh sudo ./uninstallmcc.sh -``` \ No newline at end of file +``` + diff --git a/windows/deployment/do/mcc-isp-verify-cache-node.md b/windows/deployment/do/mcc-isp-verify-cache-node.md index 78593909c6..32088f271f 100644 --- a/windows/deployment/do/mcc-isp-verify-cache-node.md +++ b/windows/deployment/do/mcc-isp-verify-cache-node.md @@ -1,24 +1,10 @@ # Verify cache node functionality -### Verify client side +### Verify functionality on Azure portal -Sign in to the Connected Cache server or use SSH. Run the following command from a terminal to see the running modules (containers): +Log into Azure portal and navigate to the Overview page. Select the **Monitoring** tab to verify the functionality of your server. If you see **All systems go** for your cache node, your server is successfully deployed and running. If you see **Error detected** for your cache node or other warning messages, select the "Diagnose and Solve" link to troubleshoot and resolve the issue. -```bash -sudo iotedge list -``` - -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**. - -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: - -```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 +### Verify functionality on the server It can take a few minutes for the container to deploy. @@ -46,4 +32,4 @@ Similarly, enter the following URL into a web browser on any device on the netwo http:///mscomtest/wuidt.gif?cacheHostOrigin=au.download.windowsupdate.com ``` -If the test fails, for more information, see the [common issues](#common-issues) section. \ No newline at end of file +If the test fails, for more information, see the [FAQs](#mcc-isp-faq) section. \ No newline at end of file