8.8 KiB
title, description, ms.service, ms.subservice, ms.topic, manager, ms.author, author, ms.reviewer, ms.collection, appliesto, ms.date
| title | description | ms.service | ms.subservice | ms.topic | manager | ms.author | author | ms.reviewer | ms.collection | appliesto | ms.date | |||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Manage MCCE cache nodes using CLI | Details on how to manage Microsoft Connected Cache for Enterprise (MCCE) cache nodes via Azure CLI commands. | windows-client | itpro-updates | how-to | aaroncz | nidos | doshnid | mstewart | tier3 |
|
06/03/2024 |
Manage cache nodes using CLI
This article outlines how to create, configure, and deploy Microsoft Connected Cache for Enterprise (MCCE) cache nodes using Azure CLI.
Prerequisites:
- Install Azure CLI: How to install the Azure CLI
- Install MCC extension: Install the MCC extension.
1. Create a Resource group
The first step is to create a resource group if you don't already have one. An Azure resource group is a logical container into which Azure resources are deployed and managed.
To create a resource group, use az group create. You can find more details on this CLI command here.
az group create --name myrg --location westus
Once the resource group is created, you'll need to create a Microsoft Connected Cache for Enterprise resource.
2. Create an MCCE Azure resource
An MCCE Azure resource is a top-level Azure resource under which cache nodes can be created.
To create an MCCE Azure resource, use az mcc ent resource create
az mcc ent resource create --mcc-resource-name mymccresource --resource-group myrg
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully started creating MCC resource.
The next step is to create a cache node under this resource.
3. Create a cache node
To create a cache node, use az mcc ent node create
az mcc ent node create --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg --host-os linux
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully started creating cache node.
4. Confirm cache node creation
Before you can start configuring your cache node, you need to confirm that the cache node was successfully created.
To confirm cache node creation, use az mcc ent node show
az mcc ent node show --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg
Important
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.
Once successful cache node creation is confirmed, you can proceed to configure the cache node.
5. Configure cache node
To configure your cache node, use az mcc ent node update
The below example configures a Linux cache node with proxy enabled:
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>
Note
For a cache node that is to be deployed on Windows host OS, the physical path of the cache drive must be /var/mcc.
Note
Proxy info changes, required to provision cache node.
Important
In the output, look for operationStatus. operationStatus = Succeeded indicates that our services have successfully updated the cache node.
Important
Please save values for physicalPath, sizeInGb, proxyPort, proxyHostName as these values will be needed to create the provisioning script.
6. Get provisioning details for the cache node
After successfully configuring the cache node, the next step is to deploy the cache node to a host machine. To deploy the cache node, you'll need to create a provisioning script with relevant information.
To get the relevant information for provisioning script, use az mcc ent node get-provisioning-details
az mcc ent node get-provisioning-details --cache-node-name mycachenode --mcc-resource-name mymccresource --resource-group myrg
Save the resulting values for cacheNodeId, customerKey, mccResourceId, registrationKey. These GUIDs are needed to create the provisioning script.
7. Deploy cache node
Deploy cache node to Linux host machine
Before you deploy your cache node to a Linux host machine, make sure you have met the prerequisites listed here: Host machine requirements
Use the following link to download and extract the Linux-compatible MCCE provisioning package onto the host machine.
Download MCCE provisioning package for Linux host machine
Important
Before you execute the provisioning command, make sure you change directory to the extracted provisioning package and set the script execution permissions by running the command below.
sudo chmod +x provisionmcc.sh
Replace the values in the following provisioning command before running it.
sudo ./provisionmcc.sh customerid="enter mccResourceId here" cachenodeid=" enter cacheNodeId here " customerkey=" enter customerKey here " registrationkey="enter registrationKey here" drivepathandsizeingb="enter physicalPath value,enter sizeInGb value here" shoulduseproxy="true" proxyurl=http://enter proxy hostname:enter port
Important
'shoulduseproxy' parameter is required, whether or not your network uses proxy to access internet.
Deploy cache node to Windows host machine
Before you deploy your cache node to a Windows host machine, make sure you have met the prerequisites listed here: Host machine requirements
Use the following link to download and extract the Windows-compatible MCCE provisioning package onto the host machine.
Download MCCE provisioning package for Windows host machine
Important
Before you execute the provisioning command, make sure you change directory to the extracted provisioning package and set the script execution permissions by running the command below.
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process
If you're using a Group Managed Service Account, replace the values in the following provisioning command before running it.
./provisionmcconwsl.ps1 -installationFolder c:\mccwsl01 -customerid enter mccResourceId here -cachenodeid enter cacheNodeId here -customerkey enter customerKey here -registrationkey enter registration key -cacheDrives "/var/mcc,enter drive size" -shouldUseProxy $true -proxyurl " http://enter proxy host name:enter port" -mccRunTimeAccount $User
Important
'shoulduseproxy' parameter is required, whether or not your network uses proxy to access internet.
If you're using Local User account or Domain User account, replace the values in the following provisioning command before running it.
./provisionmcconwsl.ps1 -installationFolder c:\mccwsl01 -customerid enter mccResourceId here -cachenodeid enter cacheNodeId here -customerkey enter customerKey here -registrationkey enter registration key -cacheDrives "/var/mcc,enter drive size" -shouldUseProxy $true -proxyurl " http://enter proxy host name:enter port" -mccRunTimeAccount $User -mccLocalAccountCredential $myLocalAccountCredential
Important
'shoulduseproxy' parameter is required, whether or not your network uses proxy to access internet.
Next step
To verify cache node functionality, see Verify cache node functionality
Sample script:
Below is a pseudo code that shows how the above can be scripted for bulk creation and configuration of cache node.