Repository navigation
Conversation
hyp list cluster-stack and HpClusterStack.list() return all CloudFormation stacks in the account and Region, but the help text, output header, and documentation described them as HyperPod-only. Clarify the behavior in the CLI help, SDK docstring, output header, README, Read the Docs, and example notebooks. Also fix the invalid `hyp list hyp-cluster` usage example and add regression tests covering mixed HyperPod and unrelated stacks plus help/behavior consistency. Refs aws#348
This branch was successfully deployed
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
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.
What's changing and why?
hyp list cluster-stackandHpClusterStack.list()return every CloudFormation stack in the account and Region, not only HyperPod-related stacks. The CLI help text, output header, and documentation incorrectly described the results as HyperPod-only (see #348).This PR implements the minimal short-term fix suggested in the issue:
HyperPod Cluster StackstoCloudFormation Stackshyp list hyp-cluster→hyp list cluster-stackTag-based filtering is intentionally not included:
ListStacksdoes not return stack tagsExisting behavior is unchanged:
--region,--status, pagination, and the default exclusion ofDELETE_COMPLETEstacks all work as before.Before/After UX
Before:
Help text claimed: "List all HyperPod cluster stacks."
After:
Help text now says: "List CloudFormation stacks in the current AWS account and Region." and explicitly notes that results are not filtered to HyperPod stacks.
How was this change tested?
tox -e unit(Python 3.11.15): 1249 passed, 19 warnings, coverage 80.11%pytest test/unit_tests/cli/test_cluster_stack.py test/unit_tests/cluster_management/test_hp_cluster_stack.py→ 64 passed
region_nameandStackStatusFilterare still passed through to CloudFormationgit diff --check, notebook JSON validation, and a scopedgit-secretsscan of the changed files passedNot run in this environment:
Are unit tests added?
Yes.
test_list_cluster_stacks_includes_unrelated_cloudformation_stacksverifies that non-HyperPod stacks are returned and displayed.test_list_cluster_stacks_help_describes_all_stacksverifies that the help text no longer claims HyperPod-only results.Are integration tests added?
No. This change only updates user-facing text, documentation, and unit tests; it does not change AWS API calls or filtering behavior.
Refs #348