Cluster Manager: How to manage the Cluster Manager in Operator Nexus
The Cluster Manager is deployed in the operator's Azure subscription to manage the lifecycle of Operator Nexus Infrastructure Clusters.
Before you begin
You'll need:
- Azure Subscription ID - The Azure subscription ID where Cluster Manager needs to be created (should be the same subscription ID of the Network Fabric Controller).
- Network Fabric Controller ID - Network Fabric Controller and Cluster Manager have a 1:1 association. You'll need the resource ID of the Network Fabric Controller associated with the Cluster Manager.
- Log Analytics Workspace ID - The resource ID of the Log Analytics Workspace used for the logs collection.
- Azure Region - The Cluster Manager should be created in the same Azure region as the Network Fabric Controller.
This Azure region should be used in the
Location
field of the Cluster Manager and all associated Operator Nexus instances.
Global arguments
Some arguments that are available for every Azure CLI command
- --debug - prints even more information about CLI operations, used for debugging purposes. If you find a bug, provide output generated with the
--debug
flag on when submitting a bug report. - --help -h - prints CLI reference information about commands and their arguments and lists available subgroups and commands.
- --only-show-errors - Only show errors, suppressing warnings.
- --output -o - specifies the output format. The available output formats are Json, Jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. By default the CLI outputs Json.
- --query - uses the JMESPath query language to filter the output returned from Azure services.
- --verbose - prints information about resources created in Azure during an operation, and other useful information
Cluster Manager elements
Elements | Description |
---|---|
Name, ID, location, tags, type | Name: User friendly name ID: < Resource ID > Location: Azure region where the Cluster Manager is created. Values from: az account list -locations .Tags: Resource tags Type: Microsoft.NetworkCloud/clusterManagers |
managerExtendedLocation | The ExtendedLocation associated with the Cluster Manager |
managedResourceGroupConfiguration | Information about the Managed Resource Group |
fabricControllerId | A reference to the Network Fabric Controller that is 1:1 with this Cluster Manager |
analyticsWorkspaceId | This workspace will be where any logs that 's relevant to the customer will be relayed. |
clusterVersions[] | List of ClusterAvailableVersions objects. Cluster versions that the manager supports. Will be used as an input in the cluster clusterVersion property. |
provisioningState | Succeeded, Failed, Canceled, Provisioning, Accepted, Updating |
detailedStatus | Detailed statuses that provide additional information about the status of the Cluster Manager. |
detailedStatusMessage | Descriptive message about the current detailedStatus. |
Create a Cluster Manager
Use the az networkcloud clustermanager create
command to create a Cluster Manager. This command creates a new Cluster Manager or updates the properties of the Cluster Manager if it exists. If you have multiple Azure subscriptions, select the appropriate subscription ID using the az account set command.
az networkcloud clustermanager create \
--name <Cluster Manager name> \
--location <region> \
--analytics-workspace-id <log analytics workspace ID>
--fabric-controller-id <Fabric controller ID associated with this Cluster Manager>
--managed-resource-group-configuration < name=<Managed Resource group Name> location=<Managed Resource group location> >
--tags <key=value key=value>
--resource-group <Resource Group Name>
--subscription <subscription ID>
- Arguments
- --name -n [Required] - The name of the Cluster Manager.
- --fabric-controller-id [Required] - The resource ID of the Network Fabric Controller that is associated with the Cluster Manager.
- --resource-group -g [Required] - Name of resource group. You can configure the default resource group using
az configure --defaults group=<name>
. - --analytics-workspace-id - The resource ID of the Log Analytics Workspace that is used for the logs collection
- --location -l - Location. Azure region where the Cluster Manager is created. Values from:
az account list -locations
. You can configure the default location usingaz configure --defaults location=<location>
. - --managed-resource-group-configuration - The configuration of the managed resource group associated with the resource.
- Usage: --managed-resource-group-configuration location=XX name=XX
- location: The region of the managed resource group. If not specified, the region of the parent resource is chosen.
- name: The name for the managed resource group. If not specified, a unique name is automatically generated.
- wait/--no-wait - Wait for command to complete or don't wait for the long-running operation to finish.
- --tags - Space-separated tags: key[=value] [key[=value]...]. Use '' to clear existing tags
- --subscription - Name or ID of subscription. You can configure the default subscription using
az account set -s NAME_OR_ID
.
List/show Cluster Manager(s)
List and show commands are used to get a list of existing Cluster Managers or the properties of a specific Cluster Manager.
List Cluster Managers in resource group
This command lists the Cluster Managers in the specified Resource group.
az networkcloud clustermanager list --resource-group <Azure Resource group>
List Cluster Managers in subscription
This command lists the Cluster Managers in the specified subscription.
az networkcloud clustermanager list --subscription <subscription ID>
Show Cluster Manager properties
This command lists the properties of the specified Cluster Manager.
az networkcloud clustermanager show \
--name <Cluster Manager name> \
--resource-group <Resource group Name>
--subscription <subscription ID>
List/show command arguments
- --name -n - The name of the Cluster Manager.
- --IDs - One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource ID' arguments.
- --resource-group -g - Name of resource group. You can configure the default group using
az configure --defaults group=<name>
. - --subscription - Name or ID of subscription. You can configure the default subscription using
az account set -s NAME_OR_ID
.
Update Cluster Manager
This command is used to patch properties of the provided Cluster Manager, or update the tags assigned to the Cluster Manager. Properties and tag updates can be done independently.
az networkcloud clustermanager update \
--name <Cluster Manager name> \
--tags < <key1=value1> <key2=value2>>
--resource-group <Resource group Name>
--subscription <subscription ID>
- Arguments
- --tags - TSpace-separated tags: key[=value] [key[=value] ...]. Use '' to clear existing tags.
- --name -n - The name of the Cluster Manager.
- --IDs - One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource ID' arguments.
- --resource-group -g - Name of resource group. You can configure the default group using
az configure --defaults group=<name>
. - --subscription - Name or ID of subscription. You can configure the default subscription using
az account set -s NAME_OR_ID
.
Delete Cluster Manager
This command is used to Delete the provided Cluster Manager.
Warning
A Cluster Manager that has an existing associated Network Fabric Controller, or any Clusters that reference this Cluster Manager may not be deleted.
az networkcloud clustermanager delete \
--name <Cluster Manager name> \
--resource-group <Resource Group Name>
--subscription <subscription ID>
- Arguments
- --no-wait - Don't wait for the long-running operation to complete.
- --yes -y - Don't prompt for confirmation.
- --name -n - The name of the Cluster Manager.
- --IDs - One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource ID' arguments.
- --resource-group -g - Name of resource group. You can configure the default group using
az configure --defaults group=<name>
. - --subscription - Name or ID of subscription. You can configure the default subscription using
az account set -s NAME_OR_ID
.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for