mlstacks
mlstacks copied to clipboard
Enable Custom Stack Name Specification
Currently, MLStacks generates an auto-generated, generic name for each stack, without offering the option for users to specify or set their stack names. This enhancement proposes changing the Terraform code and Python logic within MLStacks to allow for dynamic specification of stack names by the user, both in Terraform configurations and via the CLI.
Task Description
This task involves updating MLStacks to support user-defined stack names. It will require modifications to the Terraform recipes to accept a stack name as a variable and updates to the Python code to handle validation (e.g., ensuring no duplicate stack names) and to pass this variable correctly. Additionally, testing should be conducted to verify new functionality and helper/util functions related to stack name specification.
Expected Outcome
- Users can specify custom stack names when deploying MLStacks, enhancing usability and personalization.
- Terraform recipes are updated to accept and use a stack name specified by the user.
- Python code is modified to include validation for the stack name and to support passing the stack name as a variable.
- Comprehensive testing confirms that the new feature works as expected, including checks for duplicate stack names and proper integration with Terraform and the MLStacks CLI.
Steps to Implement
- Update Terraform recipes within MLStacks to include a variable for the stack name, allowing it to be dynamically specified by the user.
- Modify Python code in MLStacks to support the specification of stack names through the CLI, including adding validation to check for existing stacks with the same name.
- Ensure that the specified stack name is correctly passed to and used in Terraform deployments.
- Implement tests for the new functionality, including testing the validation logic, the successful passing of stack names to Terraform, and the correct operation of any new helper or utility functions.
- Update documentation to guide users on how to specify their stack names when using MLStacks.
Additional Context
Allowing users to specify stack names will significantly improve the flexibility and user experience of MLStacks, making stack management more intuitive and personalized.
Code of Conduct
- [ ] I agree to follow this project's Code of Conduct
Hello! I am looking for my first open source contribution and thought this could be a good one. I would like to work on this if possible.
Sure! Any questions about the technical side of this ticket @khh7?