Create GCP Compute Engine plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

GCP Compute Engine plugin configuration parameters

Table 1. EC-GCP-ComputeEngine plugin configuration parameters
Parameter Description

Configuration name

Required. The name for the created configuration.

Description

The description for the configuration.

Project ID

The Project ID of the project in GCP under which instances are provisioned. If not provided, it is taken from the key. If the key is not provided, this field is mandatory.

Zone

Required. The zone name. For example, us-east1-b.

Authorization type

The authorization type. You can provide either a JSON key file or use the instance metadata to authenticate API calls. If using the instance metadata, a service account should be assigned to the instance.

Check connection resource

Select the resource to run the test connection step on.

This resource should have a proper service account authorized, applicable to the instance metadata authorization type only.

Credential

The service account key, in JSON format. For example:

{ "type": "service_account", "project_id": "PROJECT ID", "private_key_id": "PRIVATE KEY ID", "private_key": "-----BEGIN PRIVATE KEY-----PRIVATE KEY CONTENT-----END PRIVATE KEY-----\n", "client_email": "SERVICE ACCOUNT NAME@PROJECT ID.iam.gserviceaccount.com", "client_id": "CLIENT ID", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/ACCOUNT ID" }

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.