You can access Google Cloud products and services from your code using Cloud APIs. These Cloud APIs expose a simple JSON REST interface that you can call via client libraries.
This document describes how to browse available APIs, enable Cloud APIs and add Cloud Client Libraries to your project, and set up authentication depending on your development needs.
Browsing Cloud APIs
To explore all available Google Cloud APIs in your IDE, follow these steps:
- Select Tools > Cloud Code > Add Cloud Libraries and Manage Cloud APIs.
- Expand the Google Cloud APIs explorer tree to view all available APIs. The explorer groups Cloud APIs by category. You can also look for a specific API using the Search APIs search bar.
- Click an API to view more details, such as its status, language-specific installation instructions for its corresponding client libraries, and relevant documentation.
Enabling Cloud APIs
To quickly enable Cloud APIs for a project using the API details, follow these steps:
- In the Cloud API details view, choose a Google Cloud project that you'd like to enable the Cloud API for.
- Click the Enable API button.
Once the API has been enabled you'll see a message confirming this change.
Adding the Cloud Client Libraries
To add libraries to your project in IntelliJ, follow these steps:
For Java Maven projects
- Select Tools > Cloud Code > Cloud APIs.
- Select your preferred library type from the choice of Google Cloud Client Library (recommended) or Java Spring Google Cloud Library.
- In the Module drop-down menu, select the module that you want to add the library to.
- Click Add Maven Dependency to add BOM and client library to your project.
The Manage Google Cloud APIs dialog displays the supported libraries.
For all other projects
- Select Tools > Cloud Code > Add Cloud Libraries and Manage Cloud APIs.
- Install the API using the installation instructions listed on the API details page for your preferred language.
The Add Google Cloud Libraries dialog displays the supported libraries.
Setting up authentication
After you've enabled the required APIs and added the necessary client libraries, you need to configure your application in order for it to be successfully authenticated. Your configuration depends on your type of development and the platform you're running on.
Once you complete the relevant authentication steps, your application can authenticate and is ready to be deployed.
Local development
minikube
- Ensure that you have Application Default Credentials (ADC) set by running
gcloud auth application-default login
. This lets minikube find your ADC to authenticate with.
minikube
- Ensure that you have Application Default Credentials (ADC) set by running
gcloud auth application-default login
. This lets minikube find your ADC to authenticate with. - Start minikube with
minikube start --addons gcp-auth
. This mounts your ADC in your pods. For a detailed minikube auth guide for Google Cloud, refer to the minikube gcp-auth docs.
Local Kubernetes cluster
- Ensure that you have Application Default Credentials (ADC) set by running
gcloud auth application-default login
. - Mount your local
gcloud
directory in your Kubernetes pods by editing the deployment manifests, so that the Google Cloud client libraries can find your credentials. Kubernetes pod configuration example:apiVersion: v1 kind: Pod metadata: name: my-app labels: name: my-app spec: containers: - name: my-app image: gcr.io/google-containers/busybox ports: - containerPort: 8080 volumeMounts: - mountPath: /root/.config/gcloud name: gcloud-volume volumes: - name: gcloud-volume hostPath: path: /path/to/home/.config/gcloud
Cloud Run
- Ensure that you have Application Default Credentials (ADC) set by
running
gcloud auth application-default login
. This lets the Cloud Run local simulated environment find your ADC to authenticate with.
Remote development
Google Kubernetes Engine
- Configure your GKE cluster and application with Workload Identity to authenticate Google Cloud services on GKE. This associates your Kubernetes service account with your Google service account.
- If the Google Cloud service you're trying to access requires additional
roles, grant them for the Google service account you're using to develop
your app.
For a list of IAM role types and predefined roles you can grant to identities, see the Understanding roles guide. For steps to grant the roles, see Granting, changing, and revoking access to resources. - Configure your Kubernetes Deployment to reference the Kubernetes service
account by setting the
.spec.serviceAccountName
field in your Kubernetes Deployment YAML file.
If you're working on an app created from a Cloud Code template, this file is located under the kubernetes-manifests folder.
Cloud Run
- To create a new unique service account for deploying your Cloud Run application, on the Service Accounts page, select the project that your secret is stored in.
- Click Create service account.
- In the Create service account dialog, enter a descriptive name for the service account.
- Change the Service account ID to a unique, recognizable value and then click Create.
- If the Google Cloud service you're trying to access requires additional roles, grant them, click Continue, and then click Done.
- To add your service account to your deploy configuration,
navigate to your Cloud Run: Deploy run configuration,
expand the Advanced revision settings section, and then
specify your service account in the Service Account field.
Cloud Run
- Configure your GKE cluster and application with Workload Identity to authenticate Google Cloud services on GKE. This associates your Kubernetes service account with your Google service account.
- If the Google Cloud service you're trying to access requires additional
roles, grant them for the Google service account you're using to develop
your app.
The Understanding roles guide describes IAM role types and lists available predefined roles you can grant to identities. - To add your Kubernetes service account to your deploy configuration,
navigate to your Cloud Run: Deploy run configuration,
expand the Advanced revision settings section, and then
specify your Kubernetes service account in the Service
Account field.
Remote development with Secret Manager enabled
If you're developing remotely, using a service account for authentication, and your application uses secrets, you need to complete a few more steps to assign your Google service account the role required to access a particular Secret Manager secret:
Open the Secret Manager panel and select the secret you want to access in your code.
Switch to the Permissions tab and then configure your secret's permissions by clicking edit Edit Permission. The Secret Manager configuration page for the secret opens in your web browser.
In Google Cloud console, click Show Info Panel and then click Add principal.
Assign your service account the Secret Manager Secret Accessor role.
Your service account has permission to access this secret.