installation.md

Installing Tanzu Dev Tools for Visual Studio Code

This page explains how to install the VMware Tanzu Developer Tools extension for Visual Studio Code (VS Code).

On this page

• Prerequisites
• Installation
• Configuration
• Uninstallation
• What’s Next

Prerequisites

Note: The Tanzu Developer Tools extension currently only supports VS Code, Mac OS, and Java Applications.

Before installing the Tanzu Developer Tools IDE extension, you must have:

• VS Code

• The Kubernetes command-line tool. For more information, see the kubectl section of the Kubernetes Install Tools page.

• Tilt v0.24.0 or later.

  Note: Docker Desktop and local Kubernetes are not prerequisites for using Tanzu Developer Tools for VS Code.

• The Tanzu CLI and plug-ins. Follow the instructions on the Installing the Tanzu CLI page.

• A cluster with Tanzu Application Platform’s Iterate or Full profiles. Download these from Tanzu Network. For installation instructions, see Installing the Tanzu Application Platform.

Note: If you are an application developer, the Tanzu Application Platform environment may have been set up by someone else in your organization. Contact the respective group within your organization to determine if a Tanzu Application Platform environment already exists.

Installation

To install VMware Tanzu Developer Tools for Visual Studio Code:

1. Download Tanzu Developer Tools for Visual Studio Code from the Tanzu Network.

2. Open VS Code.

   Option 1:

   1. From the Command Palette (cmd + shift + P), run "Extensions: Install from VSIX...".

   2. Select the extension file tanzu-vscode-extension.vsix.

   

   Option 2:

   1. Select the Extensions tab:

   2. Select Install from VSIX… from the overflow menu.

   

3. The Tanzu Developer Tools extension will install the Debugger for Java, Language Support for Java(™) by Red Hat, and YAML extensions if they are not previously installed. The Tanzu Developer Tools extension depends on these additional extensions to function.

   Note: If the extensions do not automatically install, manually install the following extensions from the VS Code Marketplace:

   • Debugger for Java
   • Language Support for Java(™) by Red Hat
   • YAML

4. Ensure Language Support for Java is running in Standard Mode.

   This can be configured in the Settings menu Code -> Preferences -> Settings under Java > Server: Launch Mode:

   

   When the JDK and Language Support for Java are configured correctly, you see that the integrated development environment creates a directory "target" where the code is compiled.

Configuration

To configure the VMware Tanzu Developer Tools extension for Visual Studio Code:

1. Ensure that you are targeting the correct cluster. See Configure Access to Multiple Clusters in the Kubernetes documentation.

2. Select File -> Preferences -> Settings -> Extensions -> Tanzu and set the following:

   • Confirm Delete (required): Controls whether the extension should ask for confirmation when deleting a workload.
   • Source Image (required): Destination for an image containing the source code to be published. For example, your-registry.io/project/tanzu-java-web-app-source.
   • Local Path (optional): Path on the local file system to a directory of source code to build (defaults to current directory).
   • Namespace (optional): Namespace that workloads are deployed into (defaults to namespace set in kubeconfig).

Uninstallation

To uninstall the Tanzu Dev Tools extension:

1. Navigate to the extensions menu:
2. Right-click the Tanzu Dev Tools extension and select Uninstall.

What's Next

Proceed to the Getting Started page.