Skip to content

[Bug Bash] quota_check.md documentation missing instructions. #374

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

Closed
nitya opened this issue Apr 5, 2025 · 5 comments
Closed

[Bug Bash] quota_check.md documentation missing instructions. #374

nitya opened this issue Apr 5, 2025 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@nitya
Copy link
Member

nitya commented Apr 5, 2025

File: quota_check.md

The repo README.md instructs us to check quota with this script.

Problem 1: Script location

  1. The quota_check.md asks us to run ./quota_check_params.sh.
  2. It should ask us to run ./scripts/quota_check_params.sh since we are in root of repo.

Enhancement 2: Azure login

  1. Neither repo nor quota_check.md specify that you should be logged into Azure before running the script.
  2. This means your first run will always result in an error (especially if using Codespaces). Here is the sample input from my run
./scripts/quota_check_params.sh 
🔄 Fetching available Azure subscriptions...
WARNING: Please run "az login" to access your accounts.
❌ ERROR: No active Azure subscriptions found. Please log in using 'az login' and ensure you have an active subscription.

Suggestion:

  1. Add a step before asking user to login using az login
  2. Make a note that if this is run in Codespaces, it will automatically use the device code auth flow.
@nitya
Copy link
Member Author

nitya commented Apr 5, 2025

Enhancement 1:
Once the user has figured out the "location" they want to use, there is actually no clear guidance on where this location information will be used. You are just told that defaults exist and can be changed but there is no hint as to where those changes happen.

  • Suggestion: Explain that the azd up command will use the default values but will allow you to specify an alternate at runtime so you can override the selection before command executes.

Enhancement 2:
Support a --verbose mode in the script so that we can choose to just run it without verbose output by default and see the final table (and not the per-region script check outputs).

  • Otherwise I got sidetracked initially by seeing the yellow warning icons.

Enhancement 3
Specify that the final table of results will give you quota per-model requested. I mistakenly thought that if I specified multiple models at command line, that it would only show me region that would have all requested models with requested quota.

  • It took me a minute to realize I had to look at the table and see which regions had multiple rows listed (so I had 3 models specified then I had to review table for regions that had 3 rows listed, so I knew all models were available in desired quota there.

@Roopan-Microsoft
Copy link
Contributor

Hi @nitya - Thanks for the feedback.

We already added the steps for navigating to scripts folder and then we are asking them to execute it.

Image

We are currently looking into below enhancements

  • Running az login before executing the script
  • Enhancement 2: we are checking if we can hide those.
  • Enhancement 3: we will brief that.

Can you brief on Enhancement 1 please?

@nitya
Copy link
Member Author

nitya commented Apr 7, 2025

Ah - got it. I was looking at the Examples and didn't see the script directions were later on.

Enhancement 1: Was actually very trivial. The Configuration says

When you start the deployment, most parameters will have default values, but you can update the following settings:

Just suggesting it be clarified by the italicized comments below because folks who have not used azd before may not know where these defaults are used.

When you start the deployment using azd up, most parameters will have default values, but you can update the following settings interactively during that workflow:

@Roopan-Microsoft Roopan-Microsoft added the documentation Improvements or additions to documentation label Apr 8, 2025
@Roopan-Microsoft
Copy link
Contributor

Thanks @nitya for the feedback, we will work on this.

@Roopan-Microsoft
Copy link
Contributor

@nitya - Provided the verbose options and added the link for customizing the parameters.

Closing the issue for now.

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

No branches or pull requests

2 participants