Google Cloud Native: Installation & Configuration

Installation

The Google Cloud Native provider is available as a package in all Pulumi languages:

• JavaScript/TypeScript: @pulumi/google-native
• Python: pulumi-google-native
• Go: github.com/pulumi/pulumi-google-native/sdk/go/google
• .NET: Pulumi.GoogleNative
• Java: com.pulumi/google-native

Authentication Methods

To provision resources with the Pulumi Google Cloud Native Provider, you need to have Google credentials.

Pulumi can authenticate to Google Cloud via several methods:

• Google Cloud CLI
• OpenID Connect (OIDC)
• Service account

Configuration

There are a few different ways you can configure your Google Cloud credentials to work with Pulumi.

Authenticate using the CLI

When developing locally, we recommend that you install the Google Cloud SDK and then authorize access with a user account. Next, Pulumi requires default application credentials to interact with your Google Cloud resources, so run auth application-default login command to obtain those credentials:

$ gcloud auth application-default login

To configure Pulumi to interact with your Google Cloud project, set it with the pulumi config command using the project’s ID:

$ pulumi config set google-native:project your-gcp-project-id

You may also set your Google Cloud Project via environment variable (listed in order of precedence):

• GOOGLE_PROJECT
• GOOGLE_CLOUD_PROJECT
• GCLOUD_PROJECT
• CLOUDSDK_CORE_PROJECT

$ export GOOGLE_PROJECT=your-gcp-project-id

Authenticate using a service account

If you are using Pulumi in an non-interactive setting (such as a CI/CD system) you will need to configure and use a service account instead.

Authenticate with dynamically generated credentials

In addition to configuring the Google Cloud Native provider locally, you also have the option to centralize your configurations using Pulumi ESC (Environments, Secrets, and Configuration). Using this service will enable you to run Pulumi CLI commands with dynamically generated credentials, removing the need to configure and manage your credentials locally.

To do this, you will need to complete the following steps:

Configure OIDC between Pulumi and GCP

Refer to the Configuring OpenID Connect for GCP Guide for the step-by-step process on how to do this. Once you have completed these steps, you can define and expose environment variables as shown below:

values:
  gcp:
    login:
      fn::open::gcp-login:
        project: <your-project-id>
        oidc:
          workloadPoolId: <your-pool-id>
          providerId: <your-provider-id>
          serviceAccount: <your-service-account>
  pulumiConfig:
    gcp:accessToken: ${gcp.login.accessToken}
  environmentVariables:
    GOOGLE_PROJECT: ${gcp.login.project}
    GOOGLE_REGION: <your-region>
    GOOGLE_ZONE: <your-zone>

To expose these values to Pulumi IaC, you will need to add any desired values underneath the pulumiConfig key. Further, if your workflow does not require the exposure of environment variables, you can also define those variables under the pulumiConfig block as shown below:

values:
  gcp:
    login:
      fn::open::gcp-login:
        project: <your-project-id>
        oidc:
          workloadPoolId: <your-pool-id>
          providerId: <your-provider-id>
          serviceAccount: <your-service-account>
  pulumiConfig:
    project:environment: 'dev'
    gcp:accessToken: ${gcp.login.accessToken}
    gcp:project: ${gcp.login.project}
    gcp:region: <your-region>
    gcp:zone: <your-zone>

This will ensure that those values are scoped only to your pulumi run.

Import your environment

The last step is to update your project’s stack settings file (Pulumi.<stack-name>.yaml) to import your ESC environment as shown below:

environment:
  - <your-environment-name>

Make sure to replace <your-environment-name> with the name of the ESC environment you created in the previous steps.

You can test that your configuration is working by running the pulumi preview command. This will validate that your GCP resources can be deployed using the dynamically generated credentials in your environment file.

To learn more about projecting environment variables in Pulumi ESC, refer to the relevant Pulumi ESC documentation.

Configuration options

Use pulumi config set google-native:<option> or pass options to the constructor of new Provider.