Setting up the Cloud Code plugin

The Cloud Code for IntelliJ plugin adds support for Google Cloud development to the JetBrains family of IDEs, including IntelliJ (both Community and Ultimate editions), GoLand, PyCharm, WebStorm (and others).

Prerequisites

The following tools are expected to be installed and setup on your system and available on the PATH of your machine:

  • JetBrains IDE version 2020.3+

    Your IDE should be a JetBrains IDE such as one of the following:

    • IntelliJ Ultimate or Community
    • PyCharm Professional or Community
    • WebStorm
    • GoLand
  • Docker for building and pushing your container images.

  • Configured Kubernetes cluster which can either be a cluster for local development, such as minikube or Docker Kubernetes cluster, or a remote cluster, such as Google Kubernetes Engine cluster. A minikube cluster is recommended for local development; minikube can be managed automatically by Cloud Code.

  • Google Cloud project with billing enabled if you're using Google Cloud. Projects allow you to collect all of the related resources for a single application in one place as well as manage APIs, enable Google Cloud services, add and remove collaborators, and manage permissions for Google Cloud resources.

Installing the Cloud Code plugin

Direct installation

  1. Launch your IDE.
  2. Once you have your IDE open, refresh this page.

    You can now install the Cloud Code plugin directly by clicking the button below:

    The button launches an installation dialog within your open IDE.

    If you do not have your IDE open, you are directed to the JetBrains Marketplace instead, where you can download the Cloud Code plugin version most compatible with your IDE.

  3. Click OK in the installation dialog to set up Cloud Code.

Manual installation

  1. Launch your IDE.
  2. From your IDE's plugins marketplace (File > Settings > Plugins or for Mac OS X, IntelliJ IDEA > Preferences > Plugins), search for the Cloud Code plugin and then install it.
  3. If prompted, restart your IDE to activate the plugin.

After the plugin is installed, you can start creating your own application or import an existing one.

Managed dependencies

By default, Cloud Code installs some required command-line dependencies automatically, such as:

  • kubectl for working with Kubernetes clusters and managing Kubernetes deployments.
  • skaffold to support continuous development on a Kubernetes cluster, smart image building and tagging, and an array of supported deployment and build types.
  • minikube to support local development.
  • Cloud SDK to support managing resources on Google Cloud.

Custom versions of dependencies

To use custom versions of dependencies, opt out of dependency management as follows:

  1. Specify the relevant Cloud Code settings in your IDE by opening File > Settings > Tools > Cloud Code > Dependencies or, for Mac OS X, IntelliJ IDEA > Preferences > Tools > Cloud Code > Dependencies, and configuring the Deployment Tools section.

  2. Install the relevant dependencies on your PATH:

Getting support

To submit feedback or report an issue in your IntelliJ IDE, go to Tools > Cloud Code > Help / About > Submit feedback or report an issue to report an issue on GitHub, or ask a question on Stack Overflow.

You can also join the #cloud-code channel, which is part of the Google Cloud Slack community.