Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure Resource naming convention improvements #518

Open
jlester-msft opened this issue Oct 21, 2022 · 3 comments
Open

Azure Resource naming convention improvements #518

jlester-msft opened this issue Oct 21, 2022 · 3 comments
Labels
tobegroomed Add this label while creating new issues to get issues prioritized on the backlog
Milestone

Comments

@jlester-msft
Copy link
Contributor

Problem:
Cromwell on Azure deployer is creating VM and Storage Account resources using a naming scheme of "prefix + random digits". While this helps to create unique entities, it becomes a maintenance hassle once the resources are created and being maintained over the lifetime of the Cromwell server. Try typing in your random storage account a few dozen times without carefully looking at it or copy/pasting it.

For example, the deployer takes a prefix and then adds a different random UUID suffix to that name. This means that the UUID used in the VM is different than the UUID used in the Storage Account. Which makes it basically impossible to ever memorize those resource names, so either you have to go to the Azure Portal to copy/paste the names or you have to create aliases you can use (i.e., environmental variables).

Solution:
It would be better if the deployer created resources using either just the user provided prefix. Or that prefix plus something sensible or a dictionary style generator. For example, if the prefix was set to 'genomics-pipeline' you might generate something like:
VM: genomics-pipeline-vm or genomics-pipeline-vm1 if that name wasn't available
SA: genomicspipeline or genomicspipelinesa or genomicspipelinesabrowncat

Similarly for pool resources, the name should be more comprehensible. Pool names should be 'prefix + full vm family name + perhaps managed identity name, etc. + some small subset of unique digits'. So rather than:
e575819cc52-D1_v2-UNZATQPZ44VEVK6QWJIDVROOMMSC26ZV-5CGYD5BFMSNKG
You would ideally want something like:
wdltest-standard_d1_v2-wdltest.azurecr.io-5CGYD5BFMSNKG
or
wdltest-standard_d1_v2-ConfigA-5CGYD5BFMSNKG
wdltest-standard_d1_v2-ConfigB-QWJIDVROOMMS

@olesya13 olesya13 added this to the next milestone Oct 21, 2022
@BMurri
Copy link
Collaborator

BMurri commented Mar 1, 2023

@ngambani
Copy link

ngambani commented Feb 1, 2024

@BMurri is this an active issue? or already addressed?

@BMurri
Copy link
Collaborator

BMurri commented Feb 2, 2024

This has not been addressed and it is a pain point.

@ngambani ngambani added the tobegroomed Add this label while creating new issues to get issues prioritized on the backlog label Feb 15, 2024
@BMurri BMurri modified the milestones: next, CoA Backlog Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tobegroomed Add this label while creating new issues to get issues prioritized on the backlog
Projects
None yet
Development

No branches or pull requests

4 participants