Creating an extended integration for Google Cloud instance assets

Let Oomnitza be your single source of truth!

You'll get complete visibility of your assets as data from Google Cloud Platform (GCP) instances is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and GCP instances in minutes

• Configurable dashboards and list views of key asset information
• Configurable reports to share information about your assets with your colleagues and management
• Configurable workflows that you can easily create to automate tasks such as:
  • getting GCP instances
  • starting and resetting GCP instances
  • stopping GCP instances

Navigation

Authentication

Integrate GCP instances with Oomnitza

Creating custom mappings

 Creating a workflow

GCP get instance details

GCP reset instance

GCP start instance

GCP stop instance

 Additional instance operations

Authentication

Google Cloud's REST API uses OAuth2 based authentication. Instructions on how to setup a Google Workspace OAuth2 App and add your credentials to the Oomnitza vault can be found here: Adding Google (OAuth 2.0) credentials.

Please use the following scopes when working with this integration:

• https://www.googleapis.com/auth/compute.readonly
• https://www.googleapis.com/auth/compute 

For further information, refer to OAuth 2.0 Scopes for Google APIs.

Integrate GCP instances with Oomnitza

To configure the integration for GCP instances assets, complete the following steps:

1. In Oomnitza, click Configuration > Integrations.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for Assets.
4. Click NEW INTEGRATION.
5. In the New Asset Integration sidebar, click Google Cloud.
6. To integrate Oomnitza with the Google Cloud Instance Asset Load, click APPLY and then click NEXT twice.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as Google Cloud Instance Assets. This name will be displayed on the Integrations page once the setup is complete.
2. Select Cloud as the installation type.
3. Enter the Credentials that you created in Adding Google (OAuth 2.0) credentials.
4. From the Integration Preferences list, select Create & Update. 
5. Enter the name of the user of the integration.
6. Enter your Google Cloud instance Project ID. The Project ID is case sensitive, so please make sure you have the correct spelling with upper and lower case characters or else the integration will fail with a not authorized message.
7. Enter your Google Cloud instance Zone. You can only add one zone per integration. You can add more zones after the integration is created by following the steps in Adding more zones to your integration.
8. Click Next.

Creating custom mappings

Map the GCP instances fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping.
2. Create a custom mapping for the Project field. To create a custom mapping, complete the following steps:
   1. Select the down arrow on the Project field that you want to map.
   2. Select Add new Oomnitza assets field.
   3. Change the name of the field to GCP Project.
   4. Click CREATE. 
3. Create a custom mapping for the Zone field and name the new field GCP Zone.
4. Map the Instance Id to the Serial Number field in Oomnitza.
5. Assign a sync key to the Serial Number field.
6. Click NEXT. 

Custom mappings

Boot disk
Connector Sync Time
Creation Timestamp
Description
Hostname
Instance ID
Instance Name
Last Start Timestamp
Last Stop Timestamp
Machine Type
Project
VM Status
Zone

 Learn more about mapping

When you've completed mapping GCP instances fields to Oomnitza fields, click NEXT.   

Schedule

By default, data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see what information is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings.

 

Adding more zones to your integration

Once the integration is created, you can add more regions to your integration. To add another region, complete the following steps:

1. In Oomnitza, click Configuration > Integrations.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for Assets and select your integration.
4. Click the plus sign on the Google Cloud logo and repeat the steps to connect the integration.

Tip
To view the information that is collected about your mobile assets, click Assets. 

Creating a workflow

Creating asset workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create workflows with the API block by following the steps in Creating asset workflows with the API block. When creating the asset workflows with the API block for GCP instances, the following specific configuration is required:

To locate the available presets, enter Google Cloud in the Select Preset search field. Select your preset of choice and for every preset enter your correct GCP instances Credentials that you created in Adding Google (OAuth 2.0) credentials.

All of the following API presets assume that you have created standard field mappings in Creating custom mappings as follows:

• GCP Project field is mapped to the custom Oomnitza asset field gcp_project 
• GCP Zone field is mapped to the custom Oomnitza asset field gcp_zone 
• GCP Instance Id field is mapped to the Oomnitza asset field serial_number 

For information on the specific requirements for each preset, click one of the links below:

GCP get instance details

GCP reset instance

GCP start instance

GCP stop instance

Using the GCP get instance details preset

The GCP get instance details preset enables you to get CGP instance details. Use the Advanced Mode to configure the message payload. To do this, 

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the fields {gcp_project}, {gcp_zone} and {serial_number} are referenced in the URL path. It is assumed you mapped these Oomnitza fields to GCP fields when you created custom mappings.
3. Select the Response tab. You have the option to map the Response fields to an Oomnitza field. If you do not have an Oomnitza field that you can use, can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.

For further information, refer to the Google Cloud API Documentation: Method: instances. get.

Using the GCP reset instance preset

The GCP reset instance preset enables you to reset a GCP instance. Use the Advanced Mode to configure the message payload. To do this, 

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the fields {gcp_project}, {gcp_zone} and {serial_number} are referenced in the URL path. It is assumed you mapped these Oomnitza fields to GCP fields when you created custom mappings.
3. Select the Response tab. For troubleshooting purposes, you can map the Response field {{response}} to a custom long text Oomnitza field. Once you have the entire response, you can then map to individual JSON values to custom fields. To create a custom field, go to People>Customization in Oomnitza. For further information, see Creating Custom Fields in Oomnitza.

For further information, refer to the Google Cloud API Documentation: Method: instances. reset.

Using the GCP start instance preset

The GCP start instance preset enables you to start a GCP instance. Use the Advanced Mode to configure the message payload by following the steps in Using the GCP reset instance preset.

For further information, refer to the Google Cloud API Documentation: Method: instances. start.

Using the GCP stop instance preset 

The GCP stop instance preset enables you to stop a GCP instance. Use the Advanced Mode to configure the message payload by following the steps in Using the GCP reset instance preset. 

For further information, refer to the Google Cloud API Documentation: Method: instances. stop.

Additional instance operations

Check out the Google Cloud API Documentation on instances to create your own API presets or customize your existing API presets in Oomnitza.

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started for more information.

For further information see:
Creating an extended integration for Google Workspace Chrome OS device assets