Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Issue] Preflight UX enhancement #4365

Open
2 tasks
hemarina opened this issue Sep 20, 2024 · 5 comments
Open
2 tasks

[Issue] Preflight UX enhancement #4365

hemarina opened this issue Sep 20, 2024 · 5 comments

Comments

@hemarina
Copy link
Contributor

hemarina commented Sep 20, 2024

  • Add error suggestions or guidance based on preflight error. Increases readability of error messages for users with no Azure background.
  • Considering guide users with terminal commands.
@SophCarp
Copy link
Collaborator

@hemarina could I have the text of the error?

@rajeshkamal5050
Copy link
Contributor

rajeshkamal5050 commented Sep 24, 2024

@SophCarp this PR #4329 has screenshots of the error message. Note: The complete message (anything starts from Message:) is not generated by azd. The core of the error and message comes from ARM service. cc @weikanglim @vhvb1989

@SophCarp
Copy link
Collaborator

SophCarp commented Dec 9, 2024

Current Error message (line separation by me)

Error: 
Deployment failed: 
error deploying infrastructure: 
calling preflight validate api failing to resource group: 
Preflight validation check for resource(s) for container service aks in resource group rg-hemarina-nodejs-1 failed. 
Message: The VM size of the Standard_B4ms is not allowed in your subscription location ‘australiacentral’. For more details please visit https://aka.ms/aks/quotas-skus-regions. Details:

Thoughts:

  • The goal is to tell the user their deployment failed because of a preflight check for a specific service. The customer needs to know the service that has the issue and the message for that issue.
  • I think names or resources or resource groups should have single-quotations around them to indicate they are names.
  • lines 3 and 4 of the error seem redundant

Questions:

  • is aks the name of the container service? is "container service" the resource type? as in a container app?
  • Will there be potentially multiple resources that will fail in this preflight?
     
    Proposed error message:
ERROR: 
Deployment failed:
Preflight validation check failed for resource(s) 'aks' in resource group 'rg-hemarina-nodejs'.
Message: the VM size of the Standard_B4ms is not allowed in your subscription location ‘australiacentral’. For more details please visit https://aka.ms/aks/quotas-skus-regions.

@hemarina @rajeshkamal5050 thoughts?

@SophCarp
Copy link
Collaborator

Notes from meeting discussion:

Preflight validation check failed for .... is dependent on other folks - @hemarina will follow up with them to see if the line can be improved.

Preflight validation check is a key word that customers should have access to so they can google it or recognize the pattern. Alternate wording COULD be Validation check for resources - I think that also works and is a little more readable.

We can definitely suggest customers use --debug for more verbose logs and make this error less verbose generally.

@hemarina
Copy link
Contributor Author

hemarina commented Dec 13, 2024

Share status:
Issue created in preflight team: https://stackoverflow.microsoft.com/questions/437081

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants