-
Notifications
You must be signed in to change notification settings - Fork 1.4k
{AKS} Clarify model parameter #9145
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
Conversation
|
rule | cmd_name | rule_message | suggest_message |
---|---|---|---|
aks agent | cmd aks agent update parameter api_key : added property type=string |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR improves the documentation and clarity of the --model
parameter for the AKS agent command, making it clearer how to specify different LLM providers and models.
- Updated the
--model
parameter description to clarify that it requires both provider and model/deployment name - Added comprehensive help documentation with examples for different providers (OpenAI vs Azure OpenAI)
- Minor fixes including making the prompt parameter optional and fixing parameter naming
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
setup.py | Version bump from 1.0.0b1 to 1.0.0b2 |
_params.py | Updated model parameter description, made prompt optional, fixed api_key parameter name |
_help.py | Added detailed documentation for model parameter with provider-specific examples |
HISTORY.rst | Added changelog entry documenting the model parameter clarification |
|
long-summary: |- | ||
The --model parameter determines which large language model (LLM) and provider will be used to analyze your cluster. | ||
For OpenAI, use the model name directly (e.g., gpt-4o). | ||
For Azure OpenAI, use `azure/<deployment name>` (e.g., azure/my-gpt4.1-deployment). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since we recommend using model name as deployment name, let's also use the same pattern for example here, e.g. azure/gpt-4.1?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Done.
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Squashed cherry-pick of PR Azure#9145 commits:\n- clarify model parameter\n- adjust command example to pretty print recommendation\n- fix disallowed html tag in deployment name\n- update examples to use model name as deployment name\n- remove redundant starting space in parameter help\n\nExcluded changes to HISTORY.rst and setup.py as requested.
* feat: Improve user experience of az aks agent with aks-mcp Enhance the user experience of az aks agent, including: 1. Use aks-mcp by default, offering an opt-out flag --no-aks-mcp. 2. Disable duplicated built-in toolsets when using aks-mcp. 3. Manage the lifecycle of aks-mcp binary, including downloading, updating, health checking and gracefully stopping. 4. Offer status subcommand to display the system status. Refine system prompt. 5. Smart toolset refreshment when switching between mcp and traditional mode. * use --status instead of status * address ai comments * style * add pytest-asyncio dependency * fix unit tests * fix(aks-agent/mcp): eliminate “Event loop is closed” shutdown error - Launch aks-mcp via subprocess.Popen instead of asyncio.create_subprocess_exec to avoid asyncio transport GC on a closed loop. - Add robust teardown: terminate → wait(timeout) → kill fallback, and explicitly close stdin/stdout/stderr pipes. - Make is_server_running use Popen.poll() safely. - Minor: update MCP prompt to prefer kubectl node listing when Azure Compute ops are blocked by read-only policy. * {AKS} Clarify model parameter (cherry-pick PR #9145) Squashed cherry-pick of PR #9145 commits:\n- clarify model parameter\n- adjust command example to pretty print recommendation\n- fix disallowed html tag in deployment name\n- update examples to use model name as deployment name\n- remove redundant starting space in parameter help\n\nExcluded changes to HISTORY.rst and setup.py as requested. * chore: Add nilo19 and mainerd to aks agent owners * chore(aks-agent): fix flake8 issues (E306, E261, W291) * chore(aks-agent): flake8 E261 fix in mcp_manager.py (two spaces before inline comment)
/azp run |
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>
locally? (pip install azdev
required)python scripts/ci/test_index.py -q
locally? (pip install wheel==0.30.0
required)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.json
automatically.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
.