updating help docs for 'az containerapp sessionpool create' when usi…#9432
updating help docs for 'az containerapp sessionpool create' when usi…#9432Ajsalemo wants to merge 1 commit intoAzure:mainfrom
Conversation
…g a CustomContainer
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
Hi @Ajsalemo, |
|
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>
|
|
Thank you for your contribution @Ajsalemo! We will review the pull request and get back to you soon. |
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
Hi @Ajsalemo Release SuggestionsModule: containerapp
Notes
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the help documentation for the az containerapp sessionpool create command to clarify that the --image parameter expects a fully qualified image name rather than just an image name.
- Updated four example commands to use
myregistry.azurecr.io/MyImage:Taginstead ofMyImage
|
hey @yonzhan - can one of the assigned reviewers check this out? Bumping @howang-ms since it shows you're a code owner |
| az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \\ | ||
| --container-type CustomContainer --environment MyEnvironment \\ | ||
| --cpu 0.5 --memory 1Gi --target-port 80 --image MyImage \\ | ||
| --cpu 0.5 --memory 1Gi --target-port 80 --image myregistry.azurecr.io/MyImage:Tag \\ |
There was a problem hiding this comment.
The --image supports not only azurecr.io image. I think it doesn't need to update the docs.
There was a problem hiding this comment.
Fair point. I guess to reclarify, can this be reworded that a private registry (or essentially something non-Dockerhub related) requires a fully qualified name (myregistry.domain/myimage:mytag)?
We had a support case get raised for confusion around that, so figured a bit of wording change may help there.
There was a problem hiding this comment.
bumping this @Greedygre - see my comment above. tldr, updating this for a small verbatim change about fully qualified image names in some cases
This PR is to update the
helpinfo foraz containerapp sessionpool createwhen using a container type of "CustomContainer". For the help docs in this PR, it may not be clear to users that--imageexpects the fully qualified image name.Currently in the docs,
--imageis shown as accepting a value ofMyImage, which may imply just literally the image name only.Since through some testing (and external reports) it expects the fully qualified name (myregistry.something.com/image:tag), this PR is to reflect that
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
az containerapp sessionpool create(full command that is wanting to be updated)
az containerapp sessionpool create -n mysessionpool -g MyResourceGroup \ --container-type CustomContainer --environment MyEnvironment --image myregistry.azurecr.io/MyImage:Tag \ --cpu 0.5 --memory 1Gi --target-port 80 --registry-server myregistry.azurecr.io \ --registry-username myregistry --registry-password $REGISTRY_PASSWORD \ --location eastasiaFrom: Microsoft Learn | az containerapp sessionpool create
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.