Skip to content

Commit 8bad730

Browse files
authored
Merge pull request #108267 from nicolehaugen/AzLabAcceleratedSetup
Added accelerated setup guides for lab accounts and labs
2 parents 6073a27 + 61ecf04 commit 8bad730

File tree

5 files changed

+268
-0
lines changed

5 files changed

+268
-0
lines changed

articles/lab-services/classroom-labs/TOC.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
items:
3131
- name: Administrator guide
3232
href: administrator-guide.md
33+
- name: Accelerated lab account set up guide
34+
href: account-setup-guide.md
35+
- name: Accelerated lab set up guide
36+
href: setup-guide.md
3337
- name: Classroom labs - class types
3438
items:
3539
- name: Class types overview
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title: Accelerated lab account setup guide for Azure Lab Services
3+
description: This guide helps administrators quickly set up a lab account for use within their school.
4+
services: lab-services
5+
documentationcenter: na
6+
author: spelluru
7+
manager:
8+
editor: ''
9+
10+
ms.service: lab-services
11+
ms.workload: na
12+
ms.tgt_pltfrm: na
13+
ms.devlang: na
14+
ms.topic: article
15+
ms.date: 3/18/2020
16+
ms.author: spelluru
17+
18+
---
19+
20+
# Lab account setup guide
21+
22+
The first step that needs to be completed by administrators is to set up a lab account within your Azure subscription. A lab account is a container for your classroom labs and only takes a few minutes to set up.
23+
24+
## Understand your school's lab account requirements
25+
26+
To understand how to configure your lab account based on your school's needs, you should consider the following questions:
27+
28+
**Do I have access to an Azure subscription?**
29+
30+
To create a lab account, you will need access to an Azure subscription that is configured for your school; your school may have one or more subscriptions. A subscription is used to manage billing and security for all your Azure resources\services that are used within it, including Lab Accounts. If you don't have a subscription, you should contact your account specialist to help with setting this up.
31+
32+
**How many lab accounts need to be created?**
33+
34+
To get started quickly, a reasonable approach is to create a single lab account and then later create additional Lab Accounts as needed. For example, you may eventually evolve to having one lab account per department.
35+
36+
**Who should be owners and contributors of the lab account?**
37+
38+
Your administrators are typically the owners\contributors for a lab account since they are responsible for managing the policies that apply to all the labs contained within the lab account. The person that creates the lab account is automatically an owner. You can add additional owners\contributors (typically from the AAD tenant associated with your subscription) to help manage a lab account by assigning either the Owner\Contributor role at the lab account level.
39+
40+
**Who will be allowed to create\manage labs?**
41+
42+
You may choose to have your administrators and\or faculty members create and manage labs; these users (typically from the AAD tenant associated with your subscription) are assigned to the Lab Creator role within the lab account.
43+
44+
**Do you want to give lab creators the ability to save images that can be shared across labs?**
45+
46+
A Shared Image Gallery is a repository that you can use for saving and sharing images. The benefit of this is that if you have several classes that need the same images, lab creators can create the image once and share it across labs. However, to get started, it's perfectly reasonable to start without a Shared Image Gallery; and, you can always choose to add one later.
47+
48+
If you answered 'Yes' to this question, then you will need to create and\or attach a Shared Image Gallery to your lab account. If you answered, 'I don't know', then you can postpone this decision until later.
49+
50+
When you have a Shared Image Gallery attached to your lab account
51+
52+
**Which images in the Azure Marketplace will your classroom labs use?**
53+
54+
The Azure Marketplace provides hundreds of images that you can enable so that lab creators can use the image for creating their lab. Some images may include everything that a lab already needs. In other cases, you may use an image as a starting point and then the lab creator may customize it by installing additional applications, tools, etc.
55+
56+
If you don't know which images you will need to use, you can always come back to this later to enable them. Also, the best way to see which images are available is to first create a lab account – this will give you access so that you can review the list of available images and their contents. More information is provided below.
57+
58+
**Do the lab's virtual machines (VMs) need to have access to other Azure or on-prem resources?**
59+
60+
When you set up a lab account, you also have the option to peer with a virtual network (VNet). To decide whether you need to peer with a VNet, consider the following questions:
61+
62+
- **Do you need to provide access to a licensing server?**
63+
64+
If you plan to use Azure Marketplace images, the cost of the OS license is bundled into the pricing for Lab Services, so you do *not* need to provide licenses for the OS itself. However, for additional software\applications that are installed, you will need to provide a license as appropriate.
65+
66+
- **Do the lab VMs need access to other on-prem resources, such as a file share, database, etc.?**
67+
68+
A VNet needs to be created to provide access to on-prem resources, typically using a site-to-site Virtual Network Gateway. If you don't have a VNet configured, additional time will need to be invested for this. More information on how to set this up is provided below.
69+
70+
- **Do the lab VMs need access to other Azure resources that are located within a VNet?**
71+
72+
If you need access to Azure resources that are *not* secured within a VNet, then you can access these resources via the public internet without doing any peering.
73+
74+
If you answered 'Yes' to one or more questions, then you will need to peer the lab account to a VNet. If you answered, 'I don't know', then you can postpone this decision until later since you can always choose to peer a VNet after creating the lab account.
75+
76+
## Set up your lab account
77+
78+
Once you understand the requirements for your lab account, you are ready to set it up. Follow the links in this section to see how to set up your lab account:
79+
80+
1. **Create your lab account**
81+
82+
Refer to the tutorial on [creating a lab account](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-lab-account#create-a-lab-account) for instructions.
83+
84+
When creating a lab account, you may find it helpful to familiarize yourself with the Azure resources involved; refer to the following list for more information and guidance on creating these resources:
85+
86+
- [Subscription](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#subscription)
87+
- [Resource Group](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#resource-group)
88+
- [Lab Account](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#lab-account)
89+
- [Classroom Lab](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#classroom-lab)
90+
- [Selecting a Region\Location](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#regions-or-locations)
91+
- [Naming Guidance for Resources](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#naming)
92+
93+
2. **Add users to the Lab Creator role**
94+
95+
Refer to the tutorial on [adding users to the Lab Creator role](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-lab-account#add-a-user-to-the-lab-creator-role) for instructions.
96+
97+
Also, for more information on the different roles that can be assigned to users that will manage lab lab accounts and labs, see the [guide on managing identity](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#manage-identity).
98+
99+
3. **Connect to a peer VNet**
100+
101+
Refer to the how-to guide on [connecting your lab's network with a peer VNet](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-connect-peer-virtual-network) for instructions.
102+
103+
You may also need to refer to instructions on [configuring the lab VMs address range](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-configure-lab-accounts#specify-an-address-range-for-vms-in-the-lab).
104+
105+
4. **Enable and review images**
106+
107+
Refer to the how-to guide on [enabling Marketplace images for lab creators](https://docs.microsoft.com/azure/lab-services/classroom-labs/specify-marketplace-images) for instructions.
108+
109+
To review contents of each Marketplace image, click on the image name. For example, refer to the following screenshot which shows the details for the Ubuntu Data Science VM image:
110+
111+
![Review Marketplace images](../media/setup-guide/review-marketplace-images.png)
112+
113+
If you have a Shared Image Gallery attached to your lab account and you want to enable custom images to be shared by lab creators, you will need to complete similar steps as shown in the following screenshot:
114+
115+
![Enabling custom images in Shared Image Gallery](../media/setup-guide/enable-sig-custom-images.png)
116+
117+
## Next steps
118+
119+
See the following articles:
120+
121+
- [Manage lab accounts](how-to-manage-lab-accounts.md)
122+
123+
- [Classroom lab setup guide](setup-guide.md)
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
title: Accelerated classroom lab setup guide for Azure Lab Services
3+
description: This guide helps lab creators quickly set up a lab account for use within their school.
4+
services: lab-services
5+
documentationcenter: na
6+
author: spelluru
7+
manager:
8+
editor: ''
9+
10+
ms.service: lab-services
11+
ms.workload: na
12+
ms.tgt_pltfrm: na
13+
ms.devlang: na
14+
ms.topic: article
15+
ms.date: 3/18/2020
16+
ms.author: spelluru
17+
18+
---
19+
20+
# Classroom lab setup guide
21+
22+
The process for publishing a lab to your students can take up to several hours depending on the number of virtual machines (VMs) that will be created in your lab. You should give yourself at least a day to set up a lab to ensure that it's working properly and to allow enough time to publish students' VMs.
23+
24+
## Understand your class's lab requirements
25+
26+
Before you set up a new lab, you should consider the following questions:
27+
28+
**What software requirements does the class have?**
29+
30+
Based on your class's learning objectives, you should decide which OS, applications, tools, etc. need to be installed on the lab's VMs. To set up lab VMs, you have three options:
31+
32+
- **Use an Azure Marketplace image** – The Marketplace provides hundreds of images that you can use when creating a lab. For some classes, a marketplace image may already contain everything that you need for your class.
33+
34+
- **Create a new custom image** - You may create your own custom image by using a marketplace image as a starting point and customizing it by installing additional software, making configuration changes, etc.
35+
36+
- **Use an existing custom image** - You may reuse existing custom images that you previously created or that were created by other administrators or faculty at your school; this requires your administrators to have configured a Shared Image Gallery which is a repository for saving custom images.
37+
38+
> [!NOTE]
39+
> Your administrators are responsible for enabling Marketplace and custom images so that you can use them; you will need to coordinate with your IT department to ensure that images that you need are enabled. Custom images that you create are automatically enabled for use within labs that you own.
40+
41+
**What hardware requirements does the class have?**
42+
43+
There are a variety of compute sizes that you can choose from that includes:
44+
45+
- Nested virtualization sizes so that you can give access to students to a VM that is capable of hosting multiple nested VMs; for example, this compute size is often used for Networking courses.
46+
47+
- GPU sizes so that your students can use computer-intensive types of applications, such as for Artificial Intelligence and Machine Learning.
48+
49+
Refer to the guide on [VM sizing](https://docs.microsoft.com/azure/lab-services/classroom-labs/administrator-guide#vm-sizing) to see the complete list of available compute sizes.
50+
51+
> [!NOTE]
52+
> Depending on the region you select for your lab, you may see fewer compute sizes available since this varies by region. If you need to create a lab using a large number of GPU VMs, you should coordinate with your account specialist to submit a request to ensure that the number VMs are available within your region. Our general recommendation is to select the smallest compute size that is closest to your needs. With Lab Services, you can easily set up a new lab with a different compute capacity later if needed.
53+
54+
**What dependencies does the class have on external Azure or network resources?**
55+
56+
If your lab VMs need to use external resources, such as a database, file share, licensing server, etc. you will need to coordinate with your administrators to ensure that your lab has access to these resources.
57+
58+
For access to Azure resources that are *not* secured by a virtual network, then you can access these resources via the public internet without any additional configuration by your administrators.
59+
60+
> [!NOTE]
61+
> You should consider whether you can reduce your lab's dependencies to external resources by providing the resource directly on the VM. For example, to eliminate the need to read data from an external database, you could install the database directly on the VM.
62+
63+
**How will costs be controlled?**
64+
65+
Lab Services uses a pay-as-you go pricing model which means that you only pay for the time that a lab VM is running. To control costs, you have three options that are typically used in conjunction with one another:
66+
67+
- **Schedule** - A schedule allows you to automatically control when your labs' VMs are started and shut down.
68+
- **Quota** - The quota controls the number of hours that students will have access to a VM outside of the scheduled hours. If the quota is reached while a student is using it, the VM is automatically shut down and the student is not able to restart the VM unless the quota is increased.
69+
- **Auto-shutdown** - When enabled, the auto-shutdown setting causes Windows VMs to automatically shut down after a certain length of time once a student has disconnected from their RDP session. By default, this setting is disabled.
70+
71+
> [!NOTE]
72+
> This setting currently only exists for Windows.
73+
74+
**How will students connect to their VM?**
75+
76+
For RDP to Windows VMs, we recommend students use [Microsoft Remote Desktop client](https://docs.microsoft.com/windows-server/remote/remote-desktop-services/clients/remote-desktop-clients). Remote Desktop client supports Macs, Chromebooks, and Windows.
77+
78+
For Linux VMs, students may use either SSH or RDP. To connect using RDP, you are responsible for installing and configuring the necessary RDP and GUI packages. More details on this is provided below.
79+
80+
## Set up your lab
81+
82+
Once you understand the requirements for your class's lab, you are ready to set it up. Follow the links in this section to see how to set up your lab.
83+
84+
1. **Create a lab**
85+
86+
Refer to the tutorial on [creating a classroom lab](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-classroom-lab#create-a-classroom-lab) for instructions.
87+
88+
> [!NOTE]
89+
> If your class requires nested virtualization, refer to steps in the how-to guide that shows [enabling nested virtualization](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-enable-nested-virtualization-template-vm).
90+
91+
1. **Customize images and publish lab VMs**
92+
93+
To customize images and publish VMs in your lab, you connect to a special VM called the template VM; refer to steps to the following guides:
94+
- [Create and manage a template VM](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-classroom-lab#publish-the-template-vm)
95+
- [Use a Shared Image Gallery](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-use-shared-image-gallery)
96+
97+
> [!NOTE]
98+
> If you are using Windows, you should also refer to instructions in the how-to guide for [preparing a Windows template VM](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-prepare-windows-template). These instructions include steps for setting up OneDrive and Office for your students to use.
99+
100+
1. **Manage VM pool and capacity**
101+
102+
You can easily scale up or down VM capacity as needed by your class. Keep in mind that increasing the VM capacity may take several hours since this involves setting up new VMs. Refer to steps in the how-to guide for [setting up and managing a VM pool](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-set-virtual-machine-passwords).
103+
104+
1. **Add and manage lab users**
105+
106+
To add users to your lab, refer to steps in the following tutorials:
107+
- [Add users to the lab](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-classroom-lab#add-users-to-the-lab)
108+
- [Send invitations to users](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-classroom-lab#send-invitation-emails-to-users)
109+
110+
Also, refer to the following article for information on the types of accounts that students can use:
111+
- [Student accounts](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-configure-student-usage#student-accounts)
112+
113+
1. **Set cost controls**
114+
115+
To control the costs of your lab, set schedules, quotas, and auto-shutdown; refer to instructions in the following tutorials:
116+
117+
- [Set a schedule](https://docs.microsoft.com/azure/lab-services/classroom-labs/tutorial-setup-classroom-lab#set-a-schedule-for-the-lab)
118+
> [!NOTE]
119+
> Depending on the type of OS you have installed, a VM may take several minutes to start. To ensure that a lab VM is ready for use during your scheduled hours, we recommend that you start VMs 30 minutes in advance to ensure that VMs are running and ready for use.
120+
121+
- [Set quotas for users](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-configure-student-usage#set-quotas-for-users) and [set additional quota for a specific user](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-configure-student-usage#set-additional-quota-for-a-specific-user)
122+
123+
- [Enable automatic shutdown on disconnect](https://docs.microsoft.com/azure/lab-services/classroom-labs/how-to-enable-shutdown-disconnect)
124+
125+
> [!NOTE]
126+
> Schedules, quotas, and automatic shutdown do *not* apply to the template VM. As a result, you must ensure that you shut down the template VM when it's not being used otherwise it will continue to incur costs. Also, by default, when you create a lab, the template VM is automatically started, so you'll want to make sure that you immediately finish setting up the lab and shutdown the template VM.
127+
128+
1. **Use dashboard**
129+
130+
Refer to the how-to guide on [using the lab's dashboard](https://docs.microsoft.com/azure/lab-services/classroom-labs/use-dashboard) for instructions.
131+
132+
> [!NOTE]
133+
> The estimated costs shown in the dashboard is the maximum cost that you can expect for students usage of the lab. For example, you will *not* be charged for unused quota hours by your students. The estimated costs do *not* reflect any charges for using the template VM or the Shared Image Gallery.
134+
135+
## Next steps
136+
137+
See the following articles:
138+
139+
- [Track usage of a classroom lab](tutorial-track-usage.md)
140+
141+
- [Access a classroom lab](tutorial-connect-virtual-machine-classroom-lab.md)
126 KB
Loading
275 KB
Loading

0 commit comments

Comments
 (0)