Contents x
    GCP VM + Cloud Based Lab Onboarding
    • 09 Jan 2025
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    GCP VM + Cloud Based Lab Onboarding

    • Updated on 09 Jan 2025
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Overview:​

    This document provides a detailed description on the onboarding processes for GCP VM + Cloud based lab scenarios on CloudLabs Admin portal. Here we can provide pre-configured tools inside the VM deployed on GCP with the help of user data scripts, which reduce time and manual efforts to install the required tools. On Demand Lab users will only be able to access the VM through its public ip/dns and can deploy other resources through the GCP Console. To set up a lab successfully follow the instructions listed below.

    In this document you will be going through with the below topics:

    Links to be replaced

    Prerequisites:​

    Before you begin onboarding a VM + Cloud based lab to CloudLabs Admin portal, ensure you have the following prerequisites:

    1. Admin access to CloudLabs Admin Portal (If access is unavailable, kindly reach out to your point of contact or CloudLabs Support.

    2. An active subscription in CloudLabs Admin portal.

    3. Lab Guide/Reference documents containing necessary instructions, often provided through GitHub which are in GitMarkdown format.

    Required type of Subscription to onboard a VM based lab:​

    To onboard a VM based lab to CloudLabs Admin portal, use the below details:

    • Subscription Type: Depending on the lab's needs and access constraints,

    • Dedicated Subscription explained below is an appropriate option for implementing a VM + Cloud based lab. If you are not providing access to GCP Organization level, you can choose this option where dedicated projects can be assigned to individual users to access the lab environment.

    Once you are ready with pre-requisites and Subscriptions to onboard the labs on CloudLabs Admin Portal, you need to follow the instructions mentioned below:

    Let’s begin with the Onboarding Process:

    Step 1: Setup Template on CloudLabs Admin portal​

    1. The first step in the onboarding process is to create a template on CloudLabs Admin portal.

    2. You can follow the detailed guide mentioned below to login to the CloudLabs Admin Portal.

    3. Once you have logged in to the CloudLabs Admin Portal, follow the below mentioned guide to Add Template in CloudLabs Admin portal.

    You have successfully onboarded the template into CloudLabs Admin portal.

    Step 2: Setup ODL on CloudLabs Admin portal​

    1. Now, you need to create the On Demand Lab and map the template which you have created in the previous step to it.

      Note: One template can be mapped with multiple On Demand Labs.

    2. To create ODL from CloudLabs Admin Portal follow instructions mentioned in the below guide:

    You have successfully onboarded the On-Demand Lab (ODL) to CloudLabs Admin portal.

    Launch the lab​

    1. From the On Demand Labs Page (1), choose your ODL (2) and click on the Users icon (3) to register into the environment.

    2. Click on + Add User and enter your details, then click on Submit.

    3. Now you have successfully registered yourself as a user.

    4. 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.

    5. 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.

    6. Upon clicking the Launch Lab button, the deployment process will initiate, leading you to the screen illustrated in the provided screenshot below:

    7. You can also activate the lab at bulk using Bit.ly URL by following the below steps.

    8. 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.

    1. Click on + ADD ACTIVATION CODE

    2. 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 1462, then the Activation Code will be ACTIVATE1462.

    • Customer: Provide your company/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.

    1. Copy the Bit.ly URL and share it with the users.

    2. Users can activate their labs by following the below steps:

      • Navigate to the Bit.ly URL.

      • Provide the required details.

      • Click on Submit.

    3. To find more information on ODL and Manging the lab click on the below link to access the guide. You can find information on how to invite users, manage users, extend lab duration and much more.

      Manage Access

    Common Issues & Resolutions​

    1. If you are creating your templates and adding it in CloudLabs Admin portal, make sure the URLs of Deployment Manager Template and parameter file are publically accessible. If you are providing URLs from Private repo/s3 bucket, you will be encountered with the error.

    2. While creating the ODL, make sure you map the ODL with correct template to avoid conflict in labs.

    3. If you are creating your own Deployment Manager templates, make sure you are following the Syntax correctly to avoid deployment failures.

    What's Next