Deploy a Kubernetes app with Cloud Code for IntelliJ

This page shows you how to get started with Cloud Code.

In this quickstart, you'll set up a new Kubernetes application using a starter Hello World template, run your app on a cluster of your choosing, kickstart continuous rebuilding to iteratively develop your app, debug your running code, and sit back and view logs streaming from your live application.

Before you begin

  1. If you'd like to use Google Cloud, you'll need to create or select a Google Cloud project and enable billing on your project.

    Alternatively, you can use a cluster hosted on any other cloud platform or a local Kubernetes cluster with tools such as minikube and Docker Desktop.

  2. Install Git so that Cloud Code can perform Git operations, like cloning a sample.

  3. Install the Cloud Code plugin if you haven't already.

Creating an application

To create a new application using an existing sample:

  1. In your IDE, open File > New Project and select Cloud Code: Kubernetes.

  2. Select a Hello World template from the list of starter applications. List of templates available: Python, Go, NodeJS, Java hello world and guestbook applications

  3. Pick a name for your project.

    After you click Finish, Cloud Code clones your chosen template and opens your newly created project for use.

    For Java templates, you're prompted to import required Maven projects to sync your pom.xml. Click Add as Maven project and then click Import Changes.

Choosing a cluster

In order to develop your application, you'll need an associated Kubernetes cluster (hosted either locally with minikube or using a cloud platform, like a Google Kubernetes Engine cluster).

Local cluster

If you don't already have a cluster to use for this quickstart, you can choose to run your application with a Cloud Code-managed local minikube cluster. Cloud Code starts a minikube cluster to run your application and stops the cluster when deployment stops. If a minikube cluster is already running, Cloud Code reuses the existing minikube cluster for deployment.

You can choose to use this Cloud Code-managed minikube cluster in the next step, developing your application, by setting it as your deployment preference.

Cloud platform-based cluster

If you already have a cluster configured to work with Kubernetes tools (like kubectl) that you can use for this quickstart, Cloud Code deploys to it automatically. You can move on to developing your application where you can confirm your preferred cluster is set as your current context.

If you don't, you can create one using your cloud platform-specific instructions. For GKE, you can follow the Creating a cluster guide.

Developing your application

To initiate development of your application on Kubernetes:

  1. If you're running on a cluster hosted on a cloud platform, ensure you have defined where your container images are stored for Develop on Kubernetes.

    If you're logged into Google Cloud in your IDE and you have a default project defined, Cloud Code automatically uses your default container image repository ({project_id} where {project_id} references your default project).

  2. Ensure your preferred Kubernetes context is set. This can be specified in your Develop on Kubernetes configuration (accessible through Run > Edit Configurations > Develop on Kubernetes), on the Run tab and in the Deployment preferences section.

    You can choose to deploy to a current context (default), locally to a minikube cluster, or to another available context.

    By default, your Kubernetes application will run in On-demand mode with On demand selected. If preferred, you can select the On file save option instead.

  3. Choose the Develop on Kubernetes run target from the Run/Debug configuration selector in the Navigation bar.

    Kubernetes deployment run configurations

    This ensures any code changes to be automatically built, pushed, and deployed to a new version of your application.

  4. To start the development cycle on your Kubernetes cluster, click the run action for Develop on Kubernetes.

  5. In the output window, on the Logs tab, view incoming application logs.

    After the deployment has started, you'll see the list of forwarded ports for the deployed application.

  6. When the deployment is successful, you're notified that new service URLs are available. Click the Service URLs tab to view the URL(s), then click the URL link to open your browser with your running application.

    Viewing port-forwarded services in the Service URLs tab

    Alternatively, you can open the Event Log and then click the link to open your browser with your running application.

    The Deployed Resources pane shows what you deployed during the development session.

Debugging your application

Cloud Code supports applying changes while debugging.

To debug your application:

  1. Click the debug action Debug action icon for Develop on Kubernetes to start the development cycle in debug mode on your Kubernetes cluster.

    Starting the Kubernetes cluster development cycle in debug mode

  2. Cloud Code will attach a debug session. When successful, the Debug Tool window opens, confirming connection (on the Console tab).

    You can now debug against your live Kubernetes cluster.

  3. Click the gutter at the executable line of the code where you want to add a breakpoint.

    Red filled circles denote active breakpoints, while red-outlined hollow circles signify disabled breakpoints.

  4. When you send a new request to your application, it will pause at that desired line.

    Kubernetes debugger session

  5. To end the debugging session, click the stop icon on the Develop on Kubernetes run configuration.

Viewing logs

In addition to seeing a live stream of the logs from running pods in the terminal output as you're developing and running your application, you can view logs from a specific pod by navigating to the Kubernetes Explorer.

To view logs from a specific pod, follow these steps:

  1. Navigate to the Kubernetes Explorer. It can be accessed either from the side panel on the right or using Tools > Cloud Code > Kubernetes > View Cluster Explorer.

    Kubernetes Explorer panel open using the tab on the right side taskbar

  2. Select the pod you'd like to see logs from.

  3. Right-click the pod and then select Stream Logs. Alternatively, you can stream logs for individual containers running in pods.

    This outputs logs to the Kubernetes Explorer Console.

    Streaming logs from a pod using its right-click menu to output logs into the Kubernetes Explorer Console

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

  1. Go to the Projects page in the Google Cloud console:

    Go to the Projects page

  2. Select the project you created for this Quickstart and click the trash can icon next to delete it.

    This shuts down the project and schedules it for deletion.

What's next