Add support for custom VM images in Guacamole user resources by stuartleeks · Pull Request #2634 · microsoft/AzureTRE

stuartleeks · 2022-09-22T07:50:08Z

Resolves #2568

What is being addressed

Extend existing Guacamole user resource templates to simplify using custom VM images.

After these changes, images can be specified by either publisher + offer + sku + version or by image name.

Part of these changes includes optionally specifying an image gallery associated with a TRE (via RP_BUNDLE_VALUES - see templates/workspace_services/guacamole/user_resources/README.md).
When specifying an image by name, the image will be referenced from this image gallery.

This allows a reasonable amount of flexibility:

users can have no image gallery associated with the TRE and reference images with publisher + offer + sku + version
users can have a single image gallery referenced by multiple TREs and specify images from it
users can have separate image galleries per TRE (e.g. for testing new images/templates in a DEV environment before pushing to production)

How is this addressed

Describe the changes made, and if appropriate, why they are addressed this way
Note any pending work (with links to the issues that will address them)
Update documentation
Update CHANGELOG.md if needed

Progress:

Test conditional logic to set source_image_id or source_image_reference depending on VM image list in bundle
Add new porter param value for specifying the image gallery id
Add image gallery id as option on TRE Core deployment and pass through to resource processor env vars
Update linuxvm/windowsvm user resource bundles to take image gallery id parameter and use this for image IDs
Update importreviewvm user resource bundle to take image gallery id parameter and use this for image IDs
Add README to user resource bundles explaining how to set image options (including custom images)

github-actions · 2022-09-26T18:24:15Z

Unit Test Results

0 tests - 5 0 ✔️ - 4 0s ⏱️ - 2h 33m 31s
0 suites - 1 0 💤 ±0
0 files - 1 0 ❌ - 1

Results for commit f948d3f. ± Comparison against base commit d94d123.

♻️ This comment has been updated with latest results.

martinpeck

I'm going to hit "pause" on my review.

I'm finding it hard-going because the formatting changes mean I have to eye-ball each change to see if something other than formatting has changed.

I don't doubt any of the linting/formatting changes are "wrong".

marrobi

Happy with the approach.

My only concern is we area adding an option to the image choice menu for existing templates that will not work out of the box. We have people taking these templates and using them "as is" for evaluation purposes. Having the custom image option will undoubtedly mean issues are created given it will fail.

I think we need a template that uses marketplace images only that users can take for evaluation purposes.

stuartleeks · 2022-09-29T14:10:15Z

My only concern is we area adding an option to the image choice menu for existing templates that will not work out of the box. We have people taking these templates and using them "as is" for evaluation purposes. Having the custom image option will undoubtedly mean issues are created given it will fail.

Cool! By the time I publish this PR, the custom image will be removed from the template and just be in the README 😄

stuartleeks · 2022-10-04T07:14:20Z

/test-extended

github-actions · 2022-10-04T07:14:35Z

🤖 pr-bot 🤖

🏃 Running extended tests: https://github.com/microsoft/AzureTRE/actions/runs/3180136755 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-04T09:18:47Z

/test-extended

re-running to see if this was a transient error: https://github.com/microsoft/AzureTRE/actions/runs/3180136755/jobs/5184186720#step:4:537

github-actions · 2022-10-04T09:19:02Z

🤖 pr-bot 🤖

🏃 Running extended tests: https://github.com/microsoft/AzureTRE/actions/runs/3180910653 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-05T14:15:10Z

/test

github-actions · 2022-10-05T14:15:26Z

🤖 pr-bot 🤖

🏃 Running tests: https://github.com/microsoft/AzureTRE/actions/runs/3190428204 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-05T15:49:14Z

/test-destroy-env

stuartleeks · 2022-10-06T07:39:59Z

/test

github-actions · 2022-10-06T07:40:20Z

🤖 pr-bot 🤖

🏃 Running tests: https://github.com/microsoft/AzureTRE/actions/runs/3195382152 (with refid 500167c0)

(in response to this comment from @stuartleeks)

Enable specifying source_image_reference or source_image_name In the case of source_image_name, use image_gallery_id bundle param

stuartleeks · 2022-10-06T12:51:49Z

/test

github-actions · 2022-10-06T12:52:06Z

🤖 pr-bot 🤖

🏃 Running tests: https://github.com/microsoft/AzureTRE/actions/runs/3197316231 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-06T13:33:59Z

/test-extended

github-actions · 2022-10-06T13:34:19Z

🤖 pr-bot 🤖

🏃 Running extended tests: https://github.com/microsoft/AzureTRE/actions/runs/3197596409 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-06T15:50:26Z

/test

github-actions · 2022-10-06T15:50:43Z

🤖 pr-bot 🤖

🏃 Running tests: https://github.com/microsoft/AzureTRE/actions/runs/3198592454 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-06T17:31:49Z

/test-extended

github-actions · 2022-10-06T17:32:06Z

🤖 pr-bot 🤖

🏃 Running extended tests: https://github.com/microsoft/AzureTRE/actions/runs/3199210135 (with refid 500167c0)

(in response to this comment from @stuartleeks)

stuartleeks · 2022-10-07T04:43:15Z

/test-force-approve

Test already ran successfully - updates since then are to CHANGELOG

github-actions · 2022-10-07T04:43:27Z

🤖 pr-bot 🤖

✅ Marking tests as complete (for commit f948d3f)

(in response to this comment from @stuartleeks)

stuartleeks changed the title ~~sl/vm custom image~~ Add support for custom VM images in Guacamole user resources Sep 22, 2022

stuartleeks mentioned this pull request Sep 22, 2022

Guacamole User Resource Templates should support custom images #2568

Closed

stuartleeks force-pushed the sl/vm-custom-image branch from b5e8461 to c111989 Compare September 26, 2022 18:20

martinpeck reviewed Sep 27, 2022

View reviewed changes

Comment thread devops/scripts/load_env.sh Outdated

Comment thread devops/scripts/load_terraform_env.sh Outdated

Comment thread resource_processor/resources/commands.py Outdated

Comment thread resource_processor/resources/commands.py Outdated

stuartleeks force-pushed the sl/vm-custom-image branch 2 times, most recently from dc16556 to 02bd33e Compare September 29, 2022 09:17

marrobi reviewed Sep 29, 2022

View reviewed changes

stuartleeks force-pushed the sl/vm-custom-image branch 2 times, most recently from 4a88cb3 to 706fca4 Compare October 3, 2022 18:45

stuartleeks marked this pull request as ready for review October 4, 2022 07:13

stuartleeks mentioned this pull request Oct 5, 2022

Update env var file loading #2703

Merged

stuartleeks force-pushed the sl/vm-custom-image branch 2 times, most recently from 9cba616 to 58ba00c Compare October 5, 2022 12:25

tanya-borisova reviewed Oct 5, 2022

View reviewed changes

stuartleeks force-pushed the sl/vm-custom-image branch from a1521d0 to 8c0b0f8 Compare October 5, 2022 13:07

tanya-borisova reviewed Oct 5, 2022

View reviewed changes

Comment thread ...ates/workspace_services/guacamole/user_resources/guacamole-azure-import-reviewvm/porter.yaml Outdated

Comment thread templates/workspace_services/guacamole/user_resources/guacamole-azure-windowsvm/porter.yaml Outdated

tanya-borisova approved these changes Oct 5, 2022

View reviewed changes

stuartleeks force-pushed the sl/vm-custom-image branch 2 times, most recently from 466dea7 to 3e476cf Compare October 6, 2022 07:38

stuartleeks added 16 commits October 6, 2022 07:57

Update RP to load RP_BUNDLE_ vars and use in bundle params

7f983cb

Update RP deployment to take RP_BUNDLE values

35a3b7d

Add session ID to start/end log messages

6502a84

Update linuxvm/windowsvm templates

ad74d61

Enable specifying source_image_reference or source_image_name In the case of source_image_name, use image_gallery_id bundle param

Add README for guacamole user resources

ecde09f

Move vm specs to porter.yaml

68f68a8

Handle not setting source_image_name or reference to null when not used

1eba49f

Comment out custom image sections

ce82956

terraform fmt

0b1d092

Clean up old JSON file

10af989

Update README for porter.yaml approach

dc207d7

Remove custom images from template schemas

542aded

fix broken sentence

a097ec9

PR feedback - porter.yaml

cc7b378

bump core version

001aadf

bump RP version

3d3cc6c

stuartleeks force-pushed the sl/vm-custom-image branch from bbccf05 to 001aadf Compare October 6, 2022 12:06

Update CHANGELOG

f948d3f

stuartleeks merged commit 04ef899 into microsoft:main Oct 7, 2022

stuartleeks deleted the sl/vm-custom-image branch October 7, 2022 04:44

Conversation

stuartleeks commented Sep 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Resolves #2568

What is being addressed

How is this addressed

Uh oh!

github-actions Bot commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Results

Uh oh!

martinpeck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marrobi left a comment

Choose a reason for hiding this comment

Uh oh!

stuartleeks commented Sep 29, 2022

Uh oh!

stuartleeks commented Oct 4, 2022

Uh oh!

github-actions Bot commented Oct 4, 2022

Uh oh!

stuartleeks commented Oct 4, 2022

Uh oh!

github-actions Bot commented Oct 4, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartleeks commented Oct 5, 2022

Uh oh!

github-actions Bot commented Oct 5, 2022

Uh oh!

stuartleeks commented Oct 5, 2022

Uh oh!

Uh oh!

Uh oh!

stuartleeks commented Oct 6, 2022

Uh oh!

github-actions Bot commented Oct 6, 2022

Uh oh!

stuartleeks commented Oct 6, 2022

Uh oh!

github-actions Bot commented Oct 6, 2022

Uh oh!

stuartleeks commented Oct 6, 2022

Uh oh!

github-actions Bot commented Oct 6, 2022

Uh oh!

stuartleeks commented Oct 6, 2022

Uh oh!

github-actions Bot commented Oct 6, 2022

Uh oh!

stuartleeks commented Oct 6, 2022

Uh oh!

github-actions Bot commented Oct 6, 2022

Uh oh!

stuartleeks commented Oct 7, 2022

Uh oh!

github-actions Bot commented Oct 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

stuartleeks commented Sep 22, 2022 •

edited

Loading

github-actions Bot commented Sep 26, 2022 •

edited

Loading