Skip to main content

Google Cloud Platform Plugins

Google Cloud Platform Plugins

Available in PagerDuty Runbook Automation Commercial products.

Overview

Runbook Automation integrates with Google Cloud through a variety of plugins listed below.
By integrating Runbook Automation with Google Cloud, users can automate and provide self-service interfaces for operations of their infrastructure and applications.
These integrations allow operations teams to provide self-service mechanisms to users throughout the business, as well as setup event-driven automation for workflows with Google Cloud.

Plugin NamePlugin TypeDescription
Start VMWorkflow StepStart a Google Compute instance.
Stop VMWorkflow StepStop a Google Compute instance.
Restart VMWorkflow StepRestart a Google Compute instance.
Delete VMWorkflow StepDelete a Google Compute instance.
Restart SQL InstanceWorkflow StepRestart a Google Cloud SQL instance.
Capture VM SnapshotWorkflow StepCapture a snapshot of a Google Compute instance.
Update Autoscaling PolicyWorkflow StepUpdate an autoscaling policy of Google Compute instances.
Enable VPC Network PeeringWorkflow StepEnable VPC connections between networks using VPC peering.
Create ResourceWorkflow StepCreate a new Google Compute instance.
Configure VPC LogWorkflow StepEnable flow logs for GCP Compute instance.
Compute VM Node SourceNode SourceRetrieve Google Compute instances and populate them into the Node Inventory.
Compute VM Health CheckHealth CheckProvide health status on Compute instance based on whether the instance is running.
Start VMNode StepStart a Google Compute instance.
Stop VMNode StepStop a Google Compute instance.
Restart VMNode StepRestart a Google Compute instance.
Delete VMNode StepDelete a Google Compute instance.

Click to expand to see the full list of Runbook Automation plugins for Google Cloud.

Setup

GCP Service Account Keys

This section outlines how to retrieve the Service Account keys from Google Cloud. The background for these steps is covered in detail on Google's support site here: Creating and Managing Service Account Keys.

  1. Login to your Google Cloud Console at https://console.cloud.google.com
  2. Navigate to IAM & Admin > Service Accounts

    Service Accounts Menu

  3. Click the Create Service Account button to start the wizard

    Create Service Account

  4. Assign the account a Name and ID.
  5. When selecting Roles ensure the role(s) provide enough access to Runbook Automation to perform the desired tasks.
  6. Click Done
  7. Click on the newly created account and navigate to the Keys tab.
  8. Click Add Key > Create new key
  9. Choose JSON for Key Type and click Create
  10. Save the JSON file somewhere safe where it can be used in a future step.

Project ID

While in the Google Cloud Console, click on the project list in the upper left, next to Google Cloud:
GCP Project List

From the popup, copy the Project ID from the ID column:
GCP Project ID

Configure Google Cloud Plugin Suite in Runbook Automation

Authentication for the Google Cloud plugins can be configured for the entire system or for an individual project.
Credentials can be optionally be overwritten on a per-plugin basis, such as an individual Job Step.

Project Level Configuration

Use the following steps to configure authentication for the Google Cloud plugins for a specific project:

  1. In the specific project, click on Project Settings in the lower left.
  2. Click on Edit Configuration then click on Plugins.
    Plugin Suite Project Settings
  3. Click on +PluginGroup.
  4. Select GCP from the list.
  5. Click Select next to the Key File field.
  6. Click + Add or Upload a Key
  7. For the Key Type dropdown, choose the Private Key option.
  8. Click the Enter text dropdown and choose the Upload file option:
    GCP Upload File
  9. Click on Choose File and select the .json file saved from the prior section.
  10. Click Save to add this secret to Key Storage.
  11. Click Save to now use the saved secret from Key Storage.
  12. Enter the Project ID captured from the prior section into the Project ID field.
  13. Select the Zone to set the default zone used by the plugins.
    GCP Project Config
  14. Click Save for the plugin configuration.
  15. Click Save for the Project Settings.

System Level Configuration

Use the following steps to configure authentication for the Google Cloud plugins for the whole Runbook Automation system.

  1. Click on the System Menu (gear icon) in the upper right.
  2. Click on System Configuration.
  3. Navigate to the GCP section and click on the Pencil Icon in the upper right:
    Edit Plugin Suite Sysytem Level
  4. Click Select next to the Key File field.
  5. Click + Add or Upload a Key
  6. For the Key Type dropdown, choose the Private Key option.
  7. Click the Enter text dropdown and choose the Upload file option:
    GCP Upload File
  8. Click on Choose File and select the .json file saved from the prior section.
  9. Click Save to add this secret to Key Storage.
  10. Click Save to now use the saved secret from Key Storage.
  11. Enter the Project ID captured from the prior section into the Project ID field.
  12. Select the Zone to set the default zone used by the plugins:
    GCP System Config
  13. Click Save to commit these changes to the System Configuration.