- Print
- DarkLight
AWS Cloud Based Lab Onboarding
Overview:
This document provides a comprehensive guide to the end-to-end process of onboarding an AWS based lab scenario using the CloudLabs portal. Within this document, you will learn how to create a CloudFormation template, a CloudLabs template, set up a CloudLabs On Demand Lab (ODL), manage users, and troubleshoot basic issues.
AWS based labs are effective when you want to provide a hands-on learning experience to your users or students on AWS Cloud. These labs are particularly useful for learning about AWS, like using AWS Identity and Access Management (IAM) for identity and access management to users, deploying resources such as S3 Buckets, EC2 Instances and many more. To set up a lab successfully, follow the instructions listed below.
In this document you will be going through with the below topics:
Prerequisites - replace link
Information used to onboard a AWS based lab - replace link
Setup Template on CloudLabs - replace link
Setup ODL on CloudLabs- replace link
Launch the lab - replace link
Common Issues & Resolutions - replace link
Prerequisites
Before you begin onboarding an AWS based lab through CloudLabs, ensure you have the following prerequisites:
Admin access to CloudLabs Admin Portal (If access is unavailable, kindly reach out to your point of contact or CloudLabs Support).
An active subscription in CloudLabs Admin Portal. Refer How to Onboard AWS Accounts to CloudLabs- replace link Portal document.
Lab Guide/Reference documents containing necessary instructions, often provided through GitHub which are in GitMarkdown format.
Information used to onboard an AWS lab
To onboard an AWS based lab to CloudLabs, use the below details:
Subscription Types: To onboard a AWS based lab, you should firstly determine what type of access the participants would require and post that you need to select the Subscription type from one of the types below that CloudLabs offers. It is highly recommended that you apply access and policy constraints for the chosen subscription type.
Dedicated Subscription : One of the AWS Organization Member account will be given to the one user.
Dedicated Tenant: When a access to the Organization root account is needed.
Once you are ready to Onboard the labs on CloudLabs Admin Portal, you need to follow the instructions mentioned below:
Let’s begin with the Onboarding Process:
Setup Template on CloudLabs
The first step in the onboarding process is to create an CFT template through CloudLabs
You can follow the detailed guide mentioned here to login to the CloudLabs Admin Portal
Follow the below mentioned guide to Add Template in CloudLabs.
Add template in CloudLabs - replace link
You have successfully onboarded the template into CloudLabs.
Setup ODL on CloudLabs
Now, you need to create the ODL and map the template which you have created in the previous step to it. Also, the ODL must be created and managed only by the admins and not users.
Note: One template can be mapped with multiple ODLs.
To create ODL from CloudLabs Admin Portal follow instructions mentioned in the below guide:
Create ODL in CloudLabs - replace link
You have successfully onboarded the On-Demand Lab (ODL) into CloudLabs.
Note:
a) Once you have tested the lab configurations from the ODL you created, it is recommended to create another ODL for production labs.
b) For information on how to invite users, manage users, extend lab duration and much more, refer Manage Access documentation.
Launch the lab
From the On Demand Labs Page (1), choose your ODL (2) and click on the Users icon (3) to register into the environment.
Click on + Add User and enter your details, then click on Submit.
Now you have successfully registered yourself as a user.
Within the Users page, you will find an instance registered under your name, indicated by its status being in the Approved state (1). Proceed by clicking the Launch (2) button.
Now you will be navigated to a different browser tab where you will be able to view the page as shown in the screenshot below. On this page, click on the Launch Lab button.
Upon clicking the Launch Lab button, the deployment process will initiate, leading you to the screen illustrated in the provided screenshot below:
After the instance is successfully deployed,On the CloudLabs environment page you will be able to see the login credentials like in below provided screenshot:
You can also activate the lab at bulk using Bit.ly URL by following the below steps.
From the On Demand Labs Page, choose your ODL (1) and note down the ODL ID. Click on the Elipses icon (2) and select Manage Activation Codes (3) to create an activation code.
Click on + ADD ACTIVATION CODE
Provide the below values for the Activation Code properties.
Name: The Activation code should always follow the naming convention ACTIVATE<-ODL-ID->. For instance, if your ODL ID is 38407, then the Activation Code will be ACTIVATE38407.
Customer: Provide your company or customer name.
City: Provide your city name.
Country: Select your country from the dropdown.
Expiry Date: Select an expiry date for the Activation code, post which the Activation code will be invalid.
Finally, click Submit to save details.
Copy the Bit.ly URL and share it with the users.
Users can activate their labs by following the below steps:
Navigate to the Bit.ly URL.
Provide the required details.
Click on Submit.
Common Issues and Resolutions
1.If you are creating files for IAM Policies and adding it in CloudLabs, make sure the URLs of files are publicly accessible.
Make sure you are adding the URLs of IAM Policy and UsagePolicy files in its respective fields.
While creating the ODL, make sure you map the ODL with correct template to avoid conflict in labs.
Ensure you are following the Syntax correctly while creating the IAM Policies to avoid deployment failures.