Quickstart for remote development

This page shows you how to get started quickly with Cloud Code using a remote development environment in Cloud Shell.

In this quickstart, you'll skip setup and clone a project into your remote development workspace with the click of a button, create a cluster, run a Kubernetes app on this cluster, debug your running code, view logs from your live application, and also, connect a terminal to your running container.

Before you begin

To access Cloud Shell, the remote development environment on Google Cloud you'll be using for this quickstart, you'll need to create a GCP project and enable billing.

You'll also need to have the following installed on your machine:

Launching Cloud Code

Once you have Visual Studio Code and the Remote - SSH extension installed, click the 'Open with Cloud Code' button below to open Visual Studio Code connected to a remote development environment in Cloud Shell. This environment has all the tools you need to develop Kubernetes applications.

On clicking the 'Open with Cloud Code' button, VS Code will launch and automatically clone a project into your remote development workspace. If you don't already have the prerequisites set up, you'll be prompted to install them at this point.

Choose your preferred language for the cloned project and click on the Open with Cloud Code button to start work in your remote development workplace:

Creating a Google Kubernetes Engine cluster

To create a GKE cluster, follow these steps:

  1. Navigate to the Google Kubernetes Engine explorer using the Cloud Code view Kubernetes Explorer icon, by clicking on its icon in the VS Code Activity bar on the left.
  2. Authenticate with the Cloud SDK by clicking on 'Click here to log in to Google Cloud SDK'.
  3. In the header of the Google Kubernetes Engine Explorer panel, click the '+' button(plus icon) (available on mouseover) to create a new GKE cluster.
  4. Ensure you're creating your cluster in your default project.
  5. Fill out fields in the Create Cluster wizard and click 'Create Cluster'.

    In this example, Project ID is set using the default Project ID button, zone is set as 'us-central1-a', and cluster name is defined as 'test'.

    Cluster creation takes a couple of minutes. Once created, your cluster will be listed under the GKE Explorer view Kubernetes Explorer icon.

    Creating a new cluster with the GKE explorer

Running your app

You can now run your application and view it live. Additionally, Cloud Code watches your filesystem for changes so that you can edit and rerun your app in near real-time.

To run your application, follow these steps:

  1. Use the Cloud Code status bar and select Run on Kubernetes.
  2. Confirm whether you'd like to use the current cluster context (or switch to a preferred one).
  3. Depending on the context chosen, you may be prompted to choose an image registry to push the images to.
  4. An output window will appear where you can track the progress of your running application. You'll also see a live stream of the logs from the running pods within the terminal output.
  5. Once successful, the output window will display an IP address. Ctrl/Cmd + click to use this linked address to access your application!

    Running the Hello World app

Troubleshooting tips

  1. If you're using a pre-existing cluster, run gcloud container clusters get-credentials ${CLUSTER} --zone=${ZONE} to get cluster credentials. This will also add your cluster to kubectl.

    Alternatively, you can navigate to the GKE Explorer (as a panel accessible through the Kubernetes explorer under the Cloud Code view Kubernetes Explorer icon). Right-click your preferred cluster and select 'Set as Active Cluster'.

Debugging your app

To debug your application, follow these steps:

  1. Use the Cloud Code status bar and select Debug on Kubernetes.
  2. If prompted, confirm whether you'd like to use the current cluster context (or switch to a preferred one).

    Cloud Code uses the 'cloudcode.kubernetes' configurations in your .vscode/launch.json file to run your application and attach a debugger session to it.

  3. Cloud Code then builds your containers, pushes them to the registry, applies Kubernetes configurations to the cluster, and returns the IP address you can use to browse your live application.

  4. Before your debugger session is attached, you'll be prompted to confirm or enter the directory in the remote container where the program you'd like to debug is found (or press ESC to skip debugging the container).

  5. Click in the editor margin of app.js to add a breakpoint.

    Red filled circles denote active breakpoints, while gray hollow circles signify disabled breakpoints. For finer breakpoint control, you can use the Breakpoints section in VS Code's Debug view.

    Breakpoints section in the left hand panel of Debug View that allows adding, removing, and disabling breakpoints

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

  6. (Optional) To inspect variables and stack info, use the Debug Sidebar.

    To interact with the debugging session, use the Debug Console in the bottom pane debugger.

    App paused at breakpoint and variables and call stack sections populated with values in scope

Viewing logs

While you can see a live stream of the logs from running pods within the terminal output from your running application, you can also view logs with the Log Viewer that comes with Cloud Code.

To view logs, follow these steps:

  1. Launch the Log Viewer by typing Cloud Code: View Logs using the Command Palette (accessible with Ctrl/Cmd+Shift+P or through the 'Manage' menu marked with a gear icon Manage icon).
  2. Search for the running app, in this case 'nodejs-hello-world', to view logs from using the deployment field in the Log Viewer search box.

    Viewing logs by setting the deployment field within the Log Viewer search box to 'nodejs-hello-world'.

Bonus: Opening a terminal in your container

Additionally, if you'd like to open a terminal in your container, follow these instructions:

  1. Navigate to the Kubernetes Explorer.
  2. Select the cluster and from the underlying Pods section, the pod you'd like to connect to.
  3. Under your specified pod, expand your Containers section and right-click the container in which you'd like to open a terminal.
  4. Select Get Terminal.

    This will launch a terminal; you now have access to a shell inside the running container!

    Opening a terminal for the specified pod

Cleaning up

Once you terminate your application, all Kubernetes resources deployed during the run will be deleted automatically.

However, to avoid incurring charges to your account for other resources used in this quickstart, be sure to delete the cluster and project you created.

If you're using Google Cloud and would like to delete just your cluster, you can do so by:

  • Using the Kubernetes explorer under the Cloud Code view Kubernetes Explorer icon, right click the cluster you'd like to delete from the Google Kubernetes Engine Explorer pane and select 'Delete cluster'.

To delete your project (and associated resources, including any clusters):

  • Go to the Projects page in the Cloud Console:

    Go to the Projects page

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

    This shuts down the project and schedules it for deletion.

What's next