Azure / azure-cli

Azure Command-Line Interface
MIT License
4.02k stars 2.99k forks source link

--enable-addons -a argument description is not properly formatted #28177

Open alexanderankin opened 10 months ago

alexanderankin commented 10 months ago

Describe the bug

this page (https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-create) has a description of --enable-addons -a but that description contains newlines but is contained in a paragraph tag which removes those new lines.

Related command

az aks create (from https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-create)

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

the text should appear like this instead:

These addons are available:
- http_application_routing : configure ingress with automatic public DNS name creation.

- monitoring               : turn on Log Analytics monitoring. Uses the Log Analytics Default Workspace if it exists, else creates one.
Specify "--workspace-resource-id" to use an existing workspace.
Specify "--enable-msi-auth-for-monitoring" to use Managed Identity Auth.
Specify "--enable-syslog" to enable syslog data collection from nodes. Note MSI must be enabled
Specify "--data-collection-settings" to configure data collection settings

If monitoring addon is enabled --no-wait argument will have no effect

- azure-policy             : enable Azure policy. The Azure Policy add-on for AKS enables at-scale enforcements and safeguards on your clusters in a centralized, consistent manner.
Learn more at aka.ms/aks/policy.

- virtual-node             : enable AKS Virtual Node.
Requires --aci-subnet-name to provide the name of an existing subnet for the Virtual Node to use.
aci-subnet-name must be in the same vnet which is specified by --vnet-subnet-id (required as well).

- confcom                  : enable confcom addon, this will enable SGX device plugin by default.
- open-service-mesh        : enable Open Service Mesh addon.
- azure-keyvault-secrets-provider : enable Azure Keyvault Secrets Provider addon.

Environment Summary

n/a

Additional context

No response

yonzhan commented 10 months ago

Thank you for opening this issue, we will look into it.