deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-06-15 02:13:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

mcc ent create content

Browse Source
This commit is contained in:
Nidhi Doshi
2024-09-19 11:02:08 -07:00
parent 1384c3d407
commit 70038cd3c9
1 changed files with 183 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

289
windows/deployment/do/mcc-ent-create-resource-and-cache.md
View File

@ -16,134 +16,211 @@ appliesto:
ms.date: 06/03/2024
---
<!--
Remove all the comments in this template before you sign-off or merge to the main branch.
# Create MCC resource and cache nodes
This template provides the basic structure of a How-to article pattern. See the
[instructions - How-to](../level4/article-how-to-guide.md) in the pattern library.
You can provide feedback about this template at: https://aka.ms/patterns-feedback
How-to is a procedure-based article pattern that show the user how to complete a task in their own environment. A task is a work activity that has a definite beginning and ending, is observable, consist of two or more definite steps, and leads to a product, service, or decision.
-->
<!-- 1. H1 -----------------------------------------------------------------------------
Required: Use a "<verb> * <noun>" format for your H1. Pick an H1 that clearly conveys the task the user will complete.
For example: "Migrate data from regular tables to ledger tables" or "Create a new Azure SQL Database".
* Include only a single H1 in the article.
* Don't start with a gerund.
* Don't include "Tutorial" in the H1.
-->
# "<verb> * <noun>"
TODO: Add your heading
<!-- 2. Introductory paragraph ----------------------------------------------------------
Required: Lead with a light intro that describes, in customer-friendly language, what the customer will do. Answer the fundamental “why would I want to do this?” question. Keep it short.
Readers should have a clear idea of what they will do in this article after reading the introduction.
* Introduction immediately follows the H1 text.
* Introduction section should be between 1-3 paragraphs.
* Don't use a bulleted list of article H2 sections.
Example: In this article, you will migrate your user databases from IBM Db2 to SQL Server by using SQL Server Migration Assistant (SSMA) for Db2.
-->
TODO: Add your introductory paragraph
<!---Avoid notes, tips, and important boxes. Readers tend to skip over them. Better to put that info directly into the article text.
-->
<!-- 3. Prerequisites --------------------------------------------------------------------
Required: Make Prerequisites the first H2 after the H1.
* Provide a bulleted list of items that the user needs.
* Omit any preliminary text to the list.
* If there aren't any prerequisites, list "None" in plain text, not as a bulleted item.
-->
This article outlines how to create and configure your Microsoft Connected Cache for Enterprise cache nodes. The creation and configuration of your cache node takes place in Azure portal. The deployment of your cache node requires downloading an installer script that will need to be run on your cache server.
## Prerequisites
1. **Azure Pay-As-You-Go subscription**: Microsoft Connected Cache is a completely free-of-charge service hosted in Azure. You'll need to have a Pay-As-You-Go subscription in order to onboard to our service. To create a subscription, go to [Pay-As-You-Go subscription page](https://azure.microsoft.com/offers/ms-azr-0003p/).
2. **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.
For more information on sizing and OS requirements, please visit [Host OS Requirement]()
TODO: List the prerequisites
## Create MCC resource
<!-- 4. Task H2s ------------------------------------------------------------------------------
# [Azure CLI](#tab/cli)
Required: Multiple procedures should be organized in H2 level sections. A section contains a major grouping of steps that help users complete a task. Each section is represented as an H2 in the article.
### Prerequisites
For portal-based procedures, minimize bullets and numbering.
* An Azure CLI environment:
* Each H2 should be a major step in the task.
* Phrase each H2 title as "<verb> * <noun>" to describe what they'll do in the step.
* Don't start with a gerund.
* Don't number the H2s.
* Begin each H2 with a brief explanation for context.
* Provide a ordered list of procedural steps.
* Provide a code block, diagram, or screenshot if appropriate
* An image, code block, or other graphical element comes after numbered step it illustrates.
* If necessary, optional groups of steps can be added into a section.
* If necessary, alternative groups of steps can be added into a section.
* Use the Bash environment in [Azure Cloud Shell](../cloud-shell/quickstart.md).
-->
:::image type:::
## "\<verb\> * \<noun\>"
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
* Or, if you prefer to run CLI reference commands locally, [install the Azure CLI](/cli/azure/install-azure-cli)
## "\<verb\> * \<noun\>"
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
* Sign in to the Azure CLI by using the [az login](/cli/azure/reference-index#az-login) command.
## "\<verb\> * \<noun\>"
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
* Run [az version](/cli/azure/reference-index#az-version) to find the version and dependent libraries that are installed. To upgrade to the latest version, run [az upgrade](/cli/azure/reference-index#az-upgrade).
<!-- 5. Next step/Related content------------------------------------------------------------------------
* Install Azure CLI extension **mcc** by following the instructions [here](https://learn.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview#how-to-install-extensions).
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
- For Next step, provide one link to the next step in a sequence. Use the blue box format
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
* Resource group under which an MCC resource can be created. Use the [az group create](https://learn.microsoft.com/en-us/cli/azure/group?view=azure-cli-latest#az-group-create) command to create a new Resource group if you don't already have one.
-->
Replace the following placeholders with your own information:
* *\<resource-group>*: An existing resource group in your subscription.
* *\<mcc-resource-name>*: A name for your Microsoft Connected Cache for Enterprise resource.
* *\<location>*: The Azure region where your Microsoft Connected Cache will be located.
```azurecli-interactive
az mcc ent resource create --mcc-resource-name <mymccresource> --resource-group <myrg> --location <region>
```
# [Azure portal](#tab/portal)
1. In the [Azure portal](https://portal.azure.com), select **Create a Resource** and search for "Microsoft Connected Cache for Enterprise and Education".
2. Select Microsoft Connected Cache for Enterprise resource. When prompted, choose the subscription, resource group, and location for the resource. Also, enter a name for the resource and click Review + Create.
3. After a few moments, you'll see a "Validation successful" message, indicating you can move onto the next step and select Create.
4. The creation of the resource may take a few minutes. After a successful creation, you'll see a Deployment complete page as below. Select Go to resource to create cache nodes.
---
## Create cache node
# [Azure CLI](#tab/cli)
Use the command below to create a new cache node if you don't already have one.
Replace the following placeholders with your own information:
* *\<resource-group>*: An existing resource group in your subscription.
* *\<mcc-resource-name>*: A name for your Microsoft Connected Cache for Enterprise resource.
* *\<cache-node-name>*: The Azure region where your Microsoft Connected Cache will be located.
* *\<host-os>*: The OS on which cache node will be provisioned.
Accepted values: windows, linux
```azurecli-interactive
az mcc ent node create --cache-node-name <mycachenode> --mcc-resource-name <mymccresource> --resource-group <myrg> --host-os <linux>
```
<br>
[!NOTE]
To ensure cache node has been created successfully, please run the following command before continuing with cache node configuration.
```azurecli-interactive
az mcc ent node show --cache-node-name <mycachenode> --mcc-resource-name <mymccresource> --resource-group <myrg>
```
In the output look for cacheNodeState. If cacheNodeState = Not Configured, you can continue with cache node configuration.
If cacheNodeState = Registration in Progress, then the cache node is still in process of being created. Please wait for a minute or two more and run the command again.
# [Azure portal](#tab/portal)
1. Open Azure portal and navigate to the Microsoft Connected Cache for Enterprise resource that you created.
2. Under Cache Node Management, click on Cache Nodes and then on + Create Cache Node.
3. Provide a name for your cache node and select the host OS you plan to deploy the cache node on and click create. Please note, cache node names have to be unique under the Microsoft Connected Cache resource.
The creation of cache node may take a few minutes. Please click Refresh to see your recently created cache node.
Once the status changes to Not Configured, you can now configure your cache node.
---
### Configure cache node
# [Azure CLI](#tab/cli)
Use the command below to configure cache node for **Linux** host os
Replace the following placeholders with your own information:
* *\<resource-group>*: An existing resource group in your subscription.
* *\<mcc-resource-name>*: A name for your Microsoft Connected Cache for Enterprise resource.
* *\<cache-node-name>*: The Azure region where your Microsoft Connected Cache will be located.
* *\<physical-path>*: The cache drive path. You can add upto 9 cache drives.
* *\<size-in-gb>*: The size of cache drive. Must be at least 50 Gb.
* *\<proxy>*: If proxy needs to be enabled or not.<br>
Accepted values: enabled, disabled
If proxy is set to enabled, you must provide proxy host and proxy port information
* *\<proxy-host>*: The proxy host name or ip address
* *\<proxy-port>*: Proxy port
* *\<auto-update-ring>*: Update ring the cache node should have.<br>
Accepted values: slow, fast.
If update ring is set to slow, you must provide the day of week, time of day and week of month the cache node should be updated.
* *\<auto-update-day>*: The day of the week cache node should be updated. Week starts from Monday.<br>
Accepted values: 1,2,3,4,5,6,7
* *\<auto-update-time>*: The time of day cache node should be updated in 24 hour format (hh:mm)
* *\<auto-update-week>*: The week of month cache node should be updated.<br>
Accepted values: 1,2,3,4
```azurecli-interactive
az mcc ent node update --cache-node-name <mycachenode> --mcc-resource-name <mymccresource> --resource-group <myrg>
--cache-drive "[{physical-path:</physical/path>,size-in-gb:<size of cache drive>},{</physical/path>,size-in-gb:<size of cache drive>}...]"> --proxy <enabled> --proxy-host <"proxy host name"> --proxy-port <proxy port> --auto-update-day <day of week> --auto-update-time <time of day> --auto-update-week <week of month> --auto-update-ring <update ring>
```
<br>
<br>
Use the command below to configure cache node for **Windows** host os
Replace the following placeholders with your own information:
* *\<resource-group>*: An existing resource group in your subscription.
* *\<mcc-resource-name>*: A name for your Microsoft Connected Cache for Enterprise resource.
* *\<cache-node-name>*: The Azure region where your Microsoft Connected Cache will be located.
* *\<physical-path>*: The cache drive path.<br>
Accepted value: /var/mcc
* *\<size-in-gb>*: The size of cache drive. Must be at least 50 Gb.
* *\<proxy>*: If proxy needs to be enabled or not.<br>
Accepted values: enabled, disabled
If proxy is set to enabled, you must provide proxy host and proxy port information
* *\<proxy-host>*: The proxy host name or ip address
* *\<proxy-port>*: Proxy port
* *\<auto-update-ring>*: Update ring the cache node should have.<br>
Accepted values: slow, fast.
If update ring is set to slow, you must provide the day of week, time of day and week of month the cache node should be updated.
* *\<auto-update-day>*: The day of the week cache node should be updated. Week starts from Monday.<br>
Accepted values: 1,2,3,4,5,6,7
* *\<auto-update-time>*: The time of day cache node should be updated in 24 hour format (hh:mm)
* *\<auto-update-week>*: The week of month cache node should be updated.<br>
Accepted values: 1,2,3,4
```azurecli-interactive
az mcc ent node update --cache-node-name <mycachenode> --mcc-resource-name <mymccresource> --resource-group <myrg>
--cache-drive "[{physical-path:/var/mcc,size-in-gb:<size of cache drive>}]" --proxy <enabled> --proxy-host <"proxy host name"> --proxy-port <proxy port> --auto-update-day <day of week> --auto-update-time <time of day> --auto-update-week <week of month> --auto-update-ring <update ring>
```
# [Azure portal](#tab/portal)
Please enter required values to configure your cache node. To learn more about the definitions of each field, review the Configuration fields at the bottom of this article.
Don't forget to click save after adding configuration information.
---
## Next step
The next step is to provision the cache node on the server.
TODO: Add your next step link(s)
# [Azure portal](#tab/portal)
To provision MCC on Windows host machine, please visit: Provision Windows cache node
To provision MCC on Linux host machine, please visit: Provision Linux cache node
> [!div class="nextstepaction"]
> [Write concepts](article-concept.md)
# [Azure CLI](#tab/cli/)
To provision cache node using Azure CLI, please visit: Bulk management of cache nodes
<!-- OR -->
---
## Related content
### General configuration fields
TODO: Add your next step link(s)
| 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|
|**Host OS** | Linux or Windows| This is the host operating system that the cache node will be deployed on.|
- [Write concepts](article-concept.md)
### Storage fields
<!--
Remove all the comments in this template before you sign-off or merge to the main branch.
-->
<br>
[!Important]
Cache node for Linux
All cache drives must have full read/write permissions set or the cache node will not function. For example, in a terminal you can run: sudo chmod 777 /path/to/cachedrivefolder
<br>
| Field Name |Expected Value |Description|
|---|---|---|
|**Cache drive folder**| File path string |Up to 9 drive folders accessible by the cache node can be configured for each cache node to configure cache storage. Enter the location of the folder in Ubuntu where the external physical drive is mounted. For example: /dev/sda3/. Each cache drive should have read/write permissions configured. Ensure your disks are mounted and visit Attach a data disk to a Linux VM for more information.|
|**Cache drive size in gigabytes**| Integer in GB| Set the size of each drive configured for the cache node. Minimum cache drive size is 50 GB.|
Cache node for Windows
| Field Name |Expected Value |Description|
|---|---|---|
|**Cache drive folder**| File path string /var/mcc| This is the folder path where content will be cached. You cannot change the folder path.|
|**Cache drive size in gigabytes**| Integer in GB| Set the size of each drive configured for the cache node. Minimum cache drive size is 50 GB. |
Proxy settings
You can choose to enable or disable proxy settings on your cache node.
<br>
[!IMPORTANT]
Enabling or disabling the proxy settings after your cache node has been deployed will require running the provisioning script again. This will ensure that proxy changes are in effect on the cache node.
| Field Name |Expected Value |Description|
|---|---|---|
|**Proxy host name**| String or number| Proxy host name or address|
|**Proxy port**| Integer| Proxy port