Update the cluster stack command to be cluster-stack instead of hyp-cluster-stack (#219)

* Append UUID to resource name prefix to ensure uniqueness .

---

Tested with unit tests and manual testing

* Update the cluster stack  command to be `cluster-stack` instead of `hyp-cluster-stack`

* Fix

Author: nargokul

src/sagemaker/hyperpod/cli/commands/cluster_stack.py

@@ -39,25 +39,25 @@ def parse_status_list(ctx, param, value):
         raise click.BadParameter(f"Invalid list format. Use: \"['STATUS1', 'STATUS2']\". Error: {e}")
 
 
-@click.command("hyp-cluster-stack")
+@click.command("cluster-stack")
 @click.argument("config-file", required=True)
 @click.argument("stack-name", required=True)
 @click.option("--region", help="AWS region")
 @click.option("--debug", is_flag=True, help="Enable debug logging")
 def create_cluster_stack(config_file, region, debug):
     """Create a new HyperPod cluster stack using the provided configuration.
-    
+
     Creates a CloudFormation stack for a HyperPod cluster using settings from a YAML configuration file.
     The stack will provision all necessary AWS resources for the cluster.
-    
+
     .. dropdown:: Usage Examples
        :open:
 
        .. code-block:: bash
 
           # Create cluster stack with config file
           hyp create hyp-cluster cluster-config.yaml my-stack-name --region us-west-2
-          
+
           # Create with debug logging
           hyp create hyp-cluster cluster-config.yaml my-stack-name --debug
     """
@@ -131,24 +131,24 @@ def create_cluster_stack_helper(config_file: str, region: Optional[str] = None,
             logger.exception("Detailed error information:")
         raise click.ClickException(str(e))
 
-@click.command("hyp-cluster-stack")
+@click.command("cluster-stack")
 @click.argument("stack-name", required=True)
 @click.option("--region", help="AWS region")
 @click.option("--debug", is_flag=True, help="Enable debug logging")
 def describe_cluster_stack(stack_name: str, debug: bool, region: str) -> None:
     """Describe the status of a HyperPod cluster stack.
-    
+
     Shows detailed information about a CloudFormation stack including its current status,
     resources, and configuration parameters.
-    
+
     .. dropdown:: Usage Examples
        :open:
 
        .. code-block:: bash
 
           # Describe a cluster stack
           hyp describe hyp-cluster my-stack-name
-          
+
           # Describe with specific region
           hyp describe hyp-cluster my-stack-name --region us-west-2
     """
@@ -206,26 +206,26 @@ def describe_cluster_stack(stack_name: str, debug: bool, region: str) -> None:
 
         raise click.ClickException(str(e))
 
-@click.command("hyp-cluster-stack")
+@click.command("cluster-stack")
 @click.option("--region", help="AWS region")
 @click.option("--debug", is_flag=True, help="Enable debug logging")
 @click.option("--status", 
               callback=parse_status_list,
               help="Filter by stack status. Format: \"['CREATE_COMPLETE', 'UPDATE_COMPLETE']\"")
 def list_cluster_stacks(region, debug, status):
     """List all HyperPod cluster stacks.
-    
+
     Displays a summary of all CloudFormation stacks related to HyperPod clusters
     in the specified region or default region.
-    
+
     .. dropdown:: Usage Examples
        :open:
 
        .. code-block:: bash
 
           # List all cluster stacks
           hyp list hyp-cluster
-          
+
           # List stacks in specific region
           hyp list hyp-cluster --region us-east-1
     """
@@ -276,15 +276,15 @@ def list_cluster_stacks(region, debug, status):
 
         raise click.ClickException(str(e))
 
-@click.command("hyp-cluster-stack")
+@click.command("cluster-stack")
 @click.argument("stack-name", required=True)
 @click.option("--debug", is_flag=True, help="Enable debug logging")
 def delete(stack_name: str, debug: bool) -> None:
     """Delete a HyperPod cluster stack.
-    
+
     Removes the specified CloudFormation stack and all associated AWS resources.
     This operation cannot be undone.
-    
+
     .. dropdown:: Usage Examples
        :open:
 
@@ -298,7 +298,7 @@ def delete(stack_name: str, debug: bool) -> None:
     logger.info(f"Deleting stack: {stack_name}")
     logger.info("This feature is not yet implemented.")
 
-@click.command("hyp-cluster")
+@click.command("cluster")
 @click.option("--cluster-name", required=True, help="The name of the cluster to update")
 @click.option("--instance-groups", help="Instance Groups JSON string")
 @click.option("--instance-groups-to-delete", help="Instance Groups to delete JSON string")
@@ -313,18 +313,18 @@ def update_cluster(
             node_recovery: Optional[str],
             debug: bool) -> None:
     """Update an existing HyperPod cluster configuration.
-    
+
     Modifies cluster settings such as instance groups and node recovery policies.
     At least one update parameter must be provided.
-    
+
     .. dropdown:: Usage Examples
        :open:
 
        .. code-block:: bash
 
           # Update cluster with new instance groups
           hyp update hyp-cluster --cluster-name my-cluster --instance-groups '{"group1": {...}}'
-          
+
           # Update node recovery setting
           hyp update hyp-cluster --cluster-name my-cluster --node-recovery Automatic
     """

src/sagemaker/hyperpod/cli/constants/init_constants.py

@@ -34,7 +34,7 @@
     #     'template': KUBERNETES_PYTORCH_JOB_TEMPLATE,
     #     'type': "jinja"
     # },
-    "hyp-cluster-stack": {
+    "cluster-stack": {
         "schema_pkg": "hyperpod_cluster_stack_template",
         "schema_type": CFN,
         'template': CLOUDFORMATION_CLUSTER_CREATION_TEMPLATE,
@@ -66,7 +66,7 @@
 
 Example:
 ```bash
-hyp init hyp-cluster-stack
+hyp init cluster-stack
 ```
 
 This creates the following files in your current directory:
@@ -81,23 +81,23 @@
 You can specify a target directory for initialization:
 
 ```bash
-hyp init hyp-cluster-stack <directory>
+hyp init cluster-stack <directory>
 cd <directory>
 ```
 
 ### Edge Cases
 
 **Re-initializing the same template:**
 ```
-hyp init hyp-cluster-stack
-⚠️ config.yaml already initialized as 'hyp-cluster-stack'.
+hyp init cluster-stack
+⚠️ config.yaml already initialized as 'cluster-stack'.
 Overwrite? [y/N]:
 ```
 
 **Initializing with a different template:**
 ```
 hyp init hyp-custom-endpoint
-⚠️ Directory already initialized as 'hyp-cluster-stack'.
+⚠️ Directory already initialized as 'cluster-stack'.
 ⚠️ It is highly unrecommended to initiate this directory with a different template.
 ⚠️ Recommended path is create a new folder and then init with 'hyp-custom-endpoint'.
 If you insist, re-init as 'hyp-custom-endpoint' instead? [y/N]:
@@ -154,7 +154,7 @@
 
 1. Initialize a new endpoint configuration:
    ```bash
-   hyp init hyp-cluster-stack
+   hyp init cluster-stack
    ```
 
 2. Configure required parameters:
@@ -176,7 +176,7 @@
 
 5. Check the status of your cluster stack:
    ```bash
-   hyp list hyp-cluster-stack
+   hyp list cluster-stack
    ```
 """
 

test/unit_tests/cli/test_cluster_stack.py

@@ -317,7 +317,7 @@ def test_create_cluster_stack_helper_success(self, mock_file, mock_exists, mock_
             # Setup mocks
             mock_exists.return_value = True
             mock_yaml_load.return_value = {
-                'template': 'hyp-cluster-stack',
+                'template': 'cluster-stack',
                 'version': '1.0',
                 'eks_cluster_name': 'test-cluster',
                 'namespace': 'test-namespace'
@@ -375,7 +375,7 @@ def test_create_cluster_stack_helper_filters_template_fields(self, mock_file, mo
             # Setup mocks
             mock_exists.return_value = True
             mock_yaml_load.return_value = {
-                'template': 'hyp-cluster-stack',
+                'template': 'cluster-stack',
                 'namespace': 'test-namespace',
                 'version': '1.0',
                 'eks_cluster_name': 'test-cluster',
@@ -409,7 +409,7 @@ def test_create_cluster_stack_helper_filters_none_values(self, mock_file, mock_e
         # Setup mocks
         mock_exists.return_value = True
         mock_yaml_load.return_value = {
-            'template': 'hyp-cluster-stack',
+            'template': 'cluster-stack',
             'eks_cluster_name': 'test-cluster',
             'optional_field': None,
             'required_field': 'value'
@@ -430,7 +430,7 @@ def test_create_cluster_stack_helper_filters_none_values(self, mock_file, mock_e
             call_args = mock_cluster_stack.call_args[1]
             assert 'optional_field' not in call_args
             assert 'required_field' in call_args
-    
+
     @patch('sagemaker.hyperpod.cli.commands.cluster_stack.HpClusterStack')
     @patch('yaml.safe_load')
     @patch('os.path.exists')
@@ -440,42 +440,42 @@ def test_create_cluster_stack_helper_appends_uuid_to_resource_name_prefix(self,
         # Mock template methods
         mock_get_template.return_value = '{"Parameters": {}}'
         mock_read_text.return_value = 'Parameters: {}'
-        
+
         # Setup mocks
         mock_exists.return_value = True
         original_prefix = 'hyperpod-cli-integ-test'
         mock_yaml_load.return_value = {
-            'template': 'hyp-cluster-stack',
+            'template': 'cluster-stack',
             'resource_name_prefix': original_prefix,
             'version': '1.0'
         }
-        
+
         # Mock the stack instance and its create method to avoid AWS calls
         mock_stack_instance = Mock()
         mock_stack_instance.create.return_value = {'StackId': 'test-stack-id'}
         mock_cluster_stack.return_value = mock_stack_instance
-        
+
         with patch('sagemaker.hyperpod.cli.commands.cluster_stack.logger') as mock_logger:
             from sagemaker.hyperpod.cli.commands.cluster_stack import create_cluster_stack_helper
-            
+
             # Execute
             create_cluster_stack_helper('config.yaml', 'us-west-2', False)
-            
+
             # Verify UUID was appended to resource_name_prefix
             call_args = mock_cluster_stack.call_args[1]
             modified_prefix = call_args['resource_name_prefix']
-            
+
             # Check that the prefix starts with the original value
             assert modified_prefix.startswith(original_prefix + '-'), f"Expected prefix to start with '{original_prefix}-', got '{modified_prefix}'"
-            
+
             # Check that exactly 4 characters were appended (plus the dash)
             assert len(modified_prefix) == len(original_prefix) + 5, f"Expected length {len(original_prefix) + 5}, got {len(modified_prefix)}"
-            
+
             # Check that the appended part is alphanumeric (UUID format)
             uuid_part = modified_prefix[len(original_prefix) + 1:]
             assert len(uuid_part) == 4, f"UUID part should be 4 characters, got {len(uuid_part)}"
             assert uuid_part.replace('-', '').isalnum(), f"UUID part should be alphanumeric, got '{uuid_part}'"
-    
+
     @patch('sagemaker.hyperpod.cli.commands.cluster_stack.HpClusterStack')
     @patch('yaml.safe_load')
     @patch('os.path.exists')
@@ -485,26 +485,26 @@ def test_create_cluster_stack_helper_handles_empty_resource_name_prefix(self, mo
         # Mock template methods
         mock_get_template.return_value = '{"Parameters": {}}'
         mock_read_text.return_value = 'Parameters: {}'
-        
+
         # Setup mocks
         mock_exists.return_value = True
         mock_yaml_load.return_value = {
-            'template': 'hyp-cluster-stack',
+            'template': 'cluster-stack',
             'resource_name_prefix': '',
             'version': '1.0'
         }
-        
+
         # Mock the stack instance and its create method to avoid AWS calls
         mock_stack_instance = Mock()
         mock_stack_instance.create.return_value = {'StackId': 'test-stack-id'}
         mock_cluster_stack.return_value = mock_stack_instance
-        
+
         with patch('sagemaker.hyperpod.cli.commands.cluster_stack.logger') as mock_logger:
             from sagemaker.hyperpod.cli.commands.cluster_stack import create_cluster_stack_helper
-            
+
             # Execute
             create_cluster_stack_helper('config.yaml', 'us-west-2', False)
-            
+
             # Verify empty prefix is not modified
             call_args = mock_cluster_stack.call_args[1]
             assert call_args['resource_name_prefix'] == ''