[fleet] Update az fleet memeber help text
#9065
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Azure CLI fleet extension's help text to clarify that fleet members can now support both AKS and Arc cluster types, expanding beyond just managed clusters. The changes update documentation to reflect this broader capability.
Key Changes:
- Updated help text parameter descriptions to be more generic and accurate
- Added separate examples for both AKS and Arc cluster member creation
- Incremented version number to reflect the documentation update
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/fleet/setup.py | Version bump from 1.6.1 to 1.6.2 |
| src/fleet/azext_fleet/_help.py | Updated parameter description and added examples for both AKS and Arc clusters |
| src/fleet/HISTORY.rst | Added changelog entry documenting the help text updates |
| examples: | ||
| - name: Create a member and assign it to an update group. | ||
| text: az fleet member create -g MyFleetResourceGroup -f MyFleetName -n NameOfMember --update-group group1 --member-cluster-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyFleetResourceGroup/providers/Microsoft.ContainerService/managedClusters/MyManagedCluster" | ||
| - name: Create an AKS Cluster member and assign it to an update group. |
There was a problem hiding this comment.
The word 'Cluster' should not be capitalized in 'AKS Cluster member' as it's not part of the proper noun. It should be 'Create an AKS cluster member and assign it to an update group.'
| - name: Create an AKS Cluster member and assign it to an update group. | |
| - name: Create an AKS cluster member and assign it to an update group. |
| text: az fleet member create -g MyFleetResourceGroup -f MyFleetName -n NameOfMember --update-group group1 --member-cluster-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyFleetResourceGroup/providers/Microsoft.ContainerService/managedClusters/MyManagedCluster" | ||
| - name: Create an AKS Cluster member and assign it to an update group. | ||
| text: az fleet member create -g MyFleetResourceGroup -f MyFleetName -n NameOfMember --update-group group1 --member-cluster-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ClusterResourceGroupName/providers/Microsoft.ContainerService/managedClusters/ClusterName" | ||
| - name: Create an Arc Cluster member and assign it to an update group. |
There was a problem hiding this comment.
The word 'Cluster' should not be capitalized in 'Arc Cluster member' as it's not part of the proper noun. It should be 'Create an Arc cluster member and assign it to an update group.'
| - name: Create an Arc Cluster member and assign it to an update group. | |
| - name: Create an Arc cluster member and assign it to an update group. |
|
|
[Release] Update index.json for extension [ fleet-1.6.2 ] : https://dev.azure.com/msazure/One/_build/results?buildId=134273372&view=results |
* update help text * bump version --------- Co-authored-by: Sean Hobbs <[email protected]>
4 participants
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
Updates 'az fleet member` help text for newly supported member cluster type.
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.