GCP-Using the Assessment App

Lucidity Disk Assessment is an automated Disk metrics collection tool developed for GCP. It helps in a quick Assessment of the GCP Disks, delivering insights on :

Prerequisites

The following are the minimum requirements for running the GCP Assessment Tool.

1. OS: Windows 10 and above

         Linux Ubuntu 20.04 and above

2. The user or service account should be present in the respective organization where the Assessment will occur.

Getting Started

1. The Lucidity Assessment app can be downloaded from the Lucidity dashboard by navigating to the Assessment page from the bottom left corner.

2. Choose the version corresponding to your host machine OS.

   

3. Install and run the downloaded application.  

4. Choose Google Cloud as the cloud provider.

   

5. Two methods are available to grant the necessary permissions and run the Assessment app.

Using OAuth 2.0 (recommended)

1. It is the easiest, fastest and most efficient way to run the Assessment tool and collect the storage metrics. This method uses OAuth 2.0 with Auth Code grant type for authentication and authorization.

   

2. Enter the Organization ID on which you wish to run the Assessment.

3. You may choose to run the Assessment on either all the available projects under this organization or you can manually enter a few select projects.

4. Please enter a company name to help easily identify the generated Assessment report.

5. Please keep the ‘Send Assessment report automatically’ flag checked in order to automatically upload the generated Assessment report to Lucidity. If you wish to send the report manually (via email), you can uncheck this flag.

Note

The maximum file size that can be uploaded automatically via the app is 100 MB. If the size of the zip file that has been generated is greater than 100 MB, please reach out to us, and we will share a secure S3 location where the file can be uploaded.  

6. In order to run the Assessment on the selected subscriptions, the Assessment tool needs a few select permissions. You can review these permissions by clicking on the ‘Check Permission Policy’ link.

   

7. Once you have reviewed the permissions, click on ‘Initiate Assessment’ to begin the Assessment process.

8. The Assessment app will download the necessary dependencies. Once the dependencies are downloaded, the app will begin the process of authenticating the user.

   

   

9. The app will then begin fetching the VM details for the project(s).

   

10. Depending on the number of projects and number of instances within each project, the Assessment process can take a few hours. You can check the progress by clicking on the ‘Check Progress’  button.

    

11. Once the Assessment is completed, the Google ops agent, required to collect the vm details, will be uninstalled.

    

12. Once all the VMs have been processed, the Assessment report will be uploaded to Lucidity. In case the flag to upload the report automatically was left unchecked, then you may upload the file through the app. The insights from the Assessment will be made available on the Lucidity Assessment Dashboard once the report has been processed.  

Using Service Account File Authentication

1. Create the Service Account User

   1. Login to console and search for Service account in the search bar.

   2. Go and click on create service account

      

   3. Enter the service account name and continue

      

   4. We will not assign any roles here, you can click on DONE.

   5. A Service account has been created

   6. Now open that service account. Click on that newly created account.  

      

   7. Create a new key by clicking on the key tab and add a new key.

      

   8. A new key will be saved in your local computer, this key will be used for authentication, please save the path of this key file. It is required for running the Assessment.

13. Create lucidity Assessment role with required permissions

    1. Go to the organization directory and click on the role.

       

    2. Click on create role.

       

    3. Create the role and provide the required permissions as mentioned above.

       

    4. Your role has been created.

14. Attach the role to the user at organization level.

    1. Click on create assignment.

       

    2. Provide the service account that was created earlier and assign the role that was created in the earlier step.

       

    3. Click on done. You have assigned and created the new service account with lucidity req roles for running Assessment.

15. Proceed  with the steps mentioned on the Assessment app to complete the GCP Assessment. Once  the Assessment report is successfully generated, please share the same with us.