Install Tanzu Developer Tools for VS Code

This topic tells you how to install VMware Tanzu Developer Tools for Visual Studio Code (VS Code).

Prerequisites

Before installing the extension, you must have:

• VS Code
• kubectl
• Tilt v0.30.12 or later
• Tanzu CLI and plug-ins
• A cluster with the Tanzu Application Platform Full profile or Iterate profile

If you are an app developer, someone else in your organization might have already set up the Tanzu Application Platform environment.

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

Install

To install VMware Tanzu Developer Tools for VS Code:

1. Open Visual Studio Code.
2. Open the command palette.
3. In the search box enter Extension.
4. Click Extensions: Install Extensions.
5. The Extensions view opens on the left side of your screen. In the search box enter Tanzu.
6. Click Tanzu Developer Tools and then click Install.

Configure

To configure VMware Tanzu Developer Tools for VS Code:

1. Ensure that you are targeting the correct cluster. For more information, see the Kubernetes documentation.

2. Go to Code > Preferences > Settings > Extensions > Tanzu Developer Tools and set the following:

   • Confirm Apply Config: This controls whether the extension asks to confirm user input when applying a workload.
   • Confirm Debug Port: This controls whether the extension asks for the debug port when running Tanzu: Start Java Debug.
   • Confirm Local Port: This controls whether the extension asks for the local port when running Tanzu: Start Java Debug.
   • Confirm Delete: This controls whether the extension asks for confirmation when deleting a workload.
   • Enable Live Hover: This enables Live Hover. For more information, see Integrating Live Hover by using Spring Boot Tools. Restart VS Code for this change to take effect.
   • Source Image: The registry location for publishing local source code. For example, registry.io/yourapp-source. This must include both a registry and a project name. A source image registry location is optional when Local Source Proxy is configured.
   • Local Path: (Optional) The path on the local file system to a directory of source code to build. This is the current directory by default.
   • Namespace: (Optional) This is the namespace that workloads are deployed into. The namespace set in kubeconfig is the default.
   • Tracked Namespaces: (Optional) Comma-separated list of namespaces. Resources in these namespaces appear in the Tanzu Workloads panel and the Activity panel. If empty, the namespace in the current context is the default.
   • Wait Timeout: (Optional) This sets how long to wait for a workload to become ready.
   • Workload Type: (Optional) This distinguishes the workload type. Examples include web and server.

Uninstall

To uninstall VMware Tanzu Developer Tools for VS Code:

1. Go to Code > Preferences > Settings > Extensions.
2. Right-click the extension and then click Uninstall.

Next steps

Proceed to Getting started with Tanzu Developer Tools for Visual Studio Code.