Botframework-solutions: Add Azure Resource Tags to VA Assistant and VA Sill Arm Templates

[managedcoder]

User Story

As a developer or admin
I want to pass 2 resource tags (e.g. "Department" and "Bot") and their corresponding values to the deploy.ps1 scripts (or specify in Arm Template) for both the Assistant and Skill templates
so that developers and assistants can conditionally have resource tags associated with every resource that is created during deployment.

Note: It should be conditional since there is a limit of 50 tags per resource so need to make sure we don't blindly take up 2 tags when tags aren't requested.

Acceptance Criteria

List your requirements.

• [ ] ...
• [ ] ...
• [ ] ...

Resources

Provide any screenshots or conversation mockups to support your request.
Learn how to mock up bot conversations with .chat files.

Notes

Right now, developers and admins who are required to deploy to Resource Groups, due to permissions and policy where they work, have the various component of the VA Template solution thrown in with all the other resource in that Resource Group. In those cases, things are locked down to Resource Groups, that's how lots of shops work and those Resource Groups are shared with lots of other groups and projects and they get quite messy. In these cases, its super hard to determine what got created by the VA template and then tag things by hand and there is risk in missing components. Clean up in this scenario without tags is also hard since its not as simple as just delete the Resource Group that only contains the bot.

Here is a link to Resource Tags and mentions the 50 per resource limit which is why setting a tag should only be done if the tags are passed to deploy.ps1 or specified in Templates themselves.

https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-using-tags

[lauren-mills]

So if I understand correctly, you want the ARM template to tag all the resources it creates with those two tags, which can be overridden via the ARM template parameters, correct?

[managedcoder]

Correct. The reason for 2 parametric tags is one for an organizational tag (like “HR” or “Finance”) and the other would be for the bot itself (i.e. “Edgar HR Bot” which is separate from “Ava Helpdesk Bot” in the same company). These tags can be used for lots of things but two scenarios there will be particularly useful with are 1) cleaning up failed attempts of deploying a bot and 2) determining ongoing operating cost of bot. Regarding cleanup, there are lots and lots of reasons that perfectly correct deployment scripts fail as customers are initially deploying bot (they only have permission for some of the services that need to be deployed in a VA Template bot, etc.).

-Russ

From: lauren-mills [e-mail]
Sent: Monday, December 9, 2019 11:08 AM
To: microsoft/botframework-solutions [e-mail]
Cc: Russ Williams [e-mail]; Author [e-mail]
Subject: Re: [microsoft/botframework-solutions] Add Azure Resource Tags to VA Assistant and VA Sill Arm Templates (#2764)

So if I understand correctly, you want the ARM template to tag all the resources it creates with those two tags, which can be overridden via the ARM template parameters, correct?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fbotframework-solutions%2Fissues%2F2764%3Femail_source%3Dnotifications%26email_token%3DAEHSFYSNU4MQWX3U4JFINZDQXZUONA5CNFSM4JSMMHZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGJWXXA%23issuecomment-563309532&data=02%7C01%7Cruwill%40microsoft.com%7C291a32a57b404181835308d77cc1fa90%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115044884102931&sdata=BF6Pxi8OYtbNbCChyaszhFwtaOl46WVE2yuuFS5AslQ%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAEHSFYTJ6ATQP6WAHJ3ISMDQXZUONANCNFSM4JSMMHZQ&data=02%7C01%7Cruwill%40microsoft.com%7C291a32a57b404181835308d77cc1fa90%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115044884112924&sdata=2Uze21oTbb1UulibqHwqvqiofZ6A5svGTjfWrrMqeeY%3D&reserved=0.

[managedcoder]

Also, in case this did not come across in the ask, it would be nice if the tag name and the tag value were parametric so that I could pass in both rather than have the ARM templated hardcod the name of both. So it would look something like deploy.ps1 --tag1Name "Division" --tag1Value "Finance" --tag2Name "Bot" --tag2Value "Edgar Finance Bot"

[lauren-mills]

I was planning on adding them to the parameters file, so it doesn't clutter up the script itself. Does that work?

[managedcoder]

Yes, that works

From: lauren-mills [e-mail]
Sent: Monday, December 9, 2019 12:16 PM
To: microsoft/botframework-solutions [e-mail]
Cc: Russ Williams [e-mail]; Author [e-mail]
Subject: Re: [microsoft/botframework-solutions] Add Azure Resource Tags to VA Assistant and VA Sill Arm Templates (#2764)

I was planning on adding them to the parameters file, so it doesn't clutter up the script itself. Does that work?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fbotframework-solutions%2Fissues%2F2764%3Femail_source%3Dnotifications%26email_token%3DAEHSFYVFNQLCXYKTFT5GBR3QXZ4L7A5CNFSM4JSMMHZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGJ6EJA%23issuecomment-563339812&data=02%7C01%7Cruwill%40microsoft.com%7C3a7822804c9a4cfc39ff08d77ccb6c5d%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115085451038819&sdata=QG5nqkBy3VYZYlkuZ9nyAYiz%2BlY%2FAeu9ZZUiBA7q%2Bz4%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAEHSFYVN7JWM6TC34UT62QLQXZ4L7ANCNFSM4JSMMHZQ&data=02%7C01%7Cruwill%40microsoft.com%7C3a7822804c9a4cfc39ff08d77ccb6c5d%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115085451048778&sdata=3zj6qzadc%2BLfW52nR%2Brvh34uXYu%2FOFVTWIUZfGkOU6E%3D&reserved=0.

[lauren-mills]

Tried a couple of different ways, but I don't think it will let me conditionally add a tag based on a parameter. I can have a tag with a default name and value, that can then be overridden, but if I add one, there will be a tag on each of the resources regardless of if the user wants one. Thoughts?

[managedcoder]

Have you tried to default them to null? If you default to null (or set to null) then I don’t think it creates a tag but I have not look at this in a while so I could be off base.

From: lauren-mills [e-mail]
Sent: Monday, December 9, 2019 1:24 PM
To: microsoft/botframework-solutions [e-mail]
Cc: Russ Williams [e-mail]; Author [e-mail]
Subject: Re: [microsoft/botframework-solutions] Add Azure Resource Tags to VA Assistant and VA Sill Arm Templates (#2764)

Tried a couple of different ways, but I don't think it will let me conditionally add a tag based on a parameter. I can have a tag with a default name and value, that can then be overridden, but if I add one, there will be a tag on each of the resources regardless of if the user wants one. Thoughts?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fbotframework-solutions%2Fissues%2F2764%3Femail_source%3Dnotifications%26email_token%3DAEHSFYQ5BAQKOAX53TZNVZTQX2EMBA5CNFSM4JSMMHZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGKEZAI%23issuecomment-563367041&data=02%7C01%7Cruwill%40microsoft.com%7C76791b53df31424a9e3508d77cd4f6d3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115126429411512&sdata=yIeNLj3UL0cn8Q5l%2BAXNIhXMdCTzD6a1OO9DJ5258MM%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAEHSFYQDQWM6NKA4FSPLXDTQX2EMBANCNFSM4JSMMHZQ&data=02%7C01%7Cruwill%40microsoft.com%7C76791b53df31424a9e3508d77cd4f6d3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115126429411512&sdata=KwqGCP77RvvM%2F%2BkLxHDRGB0BuIVnQwGygDLqidx%2BfjM%3D&reserved=0.

[lauren-mills]

It fails validation for me when its null.

[managedcoder]

Ok, then what makes the most sense to me is a single tag that defaults to the concatenation of the bot name and value of teh “suffix” parameter from template.json file. If I wanted to put additional information like organizational division info I could still use that single tag and using something like a “namespace”, for example, something like “Finance.EdgarBot.DevTest” or I could simply search for all the ARM tag occurrences in the ARM template and add extra tags everywhere a tag exists in the finished work you do.

-Russ

From: lauren-mills [e-mail]
Sent: Monday, December 9, 2019 2:32 PM
To: microsoft/botframework-solutions [e-mail]
Cc: Russ Williams [e-mail]; Author [e-mail]
Subject: Re: [microsoft/botframework-solutions] Add Azure Resource Tags to VA Assistant and VA Sill Arm Templates (#2764)

It fails validation for me when its null.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fbotframework-solutions%2Fissues%2F2764%3Femail_source%3Dnotifications%26email_token%3DAEHSFYRMIQTYSVK5X4MW75DQX2MLNA5CNFSM4JSMMHZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEGKMDEQ%23issuecomment-563397010&data=02%7C01%7Cruwill%40microsoft.com%7Ce59c63d0ff9a4e17392308d77cde79ff%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115167281961445&sdata=Y9dE8rNGtU91JC%2F5vEeT6gm5XahBx38i%2BDJYNgHbpkM%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAEHSFYUFIEHFSJGXS3I6HITQX2MLNANCNFSM4JSMMHZQ&data=02%7C01%7Cruwill%40microsoft.com%7Ce59c63d0ff9a4e17392308d77cde79ff%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637115167281961445&sdata=v%2FgLX9MYsTUsCSUqLivkOj30TkYn70sX5kfw4BkA49c%3D&reserved=0.

[darrenj]

Merged