hp: update documentation #115 - #226
Open
HPSLU wants to merge 2 commits into
Open
Conversation
ryanraaschCDC
requested changes
Jul 24, 2026
| **Common Causes** | ||
|
|
||
| - Do not assume that setting | ||
| `AZURE_KEYVAULT_NAME=CFA-Predict` |
Collaborator
There was a problem hiding this comment.
we don't want to show this value. we can refer them here: https://github.com/cdcent/cfa-cloudops-example
|
|
||
| **Best Practice** | ||
|
|
||
| Use the explicit keyvault argument. Initialize the client by explicitly specifying the Key Vault name. |
Collaborator
There was a problem hiding this comment.
change keyvault to Key Vault
|
|
||
| `from cloudops import CloudClient` | ||
|
|
||
| `cc = CloudClient(keyvault="CFA-Predict")` |
Collaborator
There was a problem hiding this comment.
remove the key vault
|
|
||
| This is the preferred approach because it avoids ambiguity about whether environment variables are being read correctly. | ||
|
|
||
| Additionally: |
Collaborator
There was a problem hiding this comment.
This "Additionally" seems out of place. I feel like a troubleshooting will just walk through common scenarios one after the other
|
|
||
| **Common Causes** | ||
|
|
||
| The Azure Batch pool odes not exit or contains no available compute nodes. |
Collaborator
There was a problem hiding this comment.
change odes to nodes
|
|
||
| Before creating a job: | ||
| - Verify the pool exists. | ||
| - Verify the pool is active. |
Collaborator
There was a problem hiding this comment.
users don't need to verify the pool is active or container compute nodes. The biggest things are that the pool exists and the job is not marked complete
|
|
||
| | **Issue** | **Most Likely Cause** | **Recommended Action** | | ||
| | ------------------------------------------ | ---------------------------------- | ----------------------------------------- | | ||
| | 1. `CloudClient()` initialization fails with Azure Batch account error | Cloudops could not resolve Azure Batch configuration from the environment | Use `CloudClient(keyvault="CFA-Predict")` | |
| | **Issue** | **Most Likely Cause** | **Recommended Action** | | ||
| | ------------------------------------------ | ---------------------------------- | ----------------------------------------- | | ||
| | 1. `CloudClient()` initialization fails with Azure Batch account error | Cloudops could not resolve Azure Batch configuration from the environment | Use `CloudClient(keyvault="CFA-Predict")` | | ||
| | 2. Container image push fails | Placeholder or invalid Azure Container Registry name | Use your assigned ACR name, such as `cfprdbatchcr` if assigned | |
HPSLU
commented
Aug 5, 2026
HPSLU
left a comment
HPSLU
left a comment
Collaborator
Author
There was a problem hiding this comment.
contents of this file added to https://github.com/CDCgov/cfa-cloudops/blob/main/docs/troubleshooting.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
created new troubleshooting documentation for CFA-cloudops.