A Visual Studio Code extension for interacting with Kubernetes clusters. This extension combines
the vs-kubernetes
extension by @brendandburns and the vs-helm
extension by @technosophos.
This extension assumes that you have a Dockerfile
in the root directory of
your project.
It also assumes that you have the following binaries on your PATH
:
kubectl
docker
git
helm
(optional)draft
(optional)
For kubectl
, helm
and draft
the binaries need not be on the system PATH, provided you tell the extension their locations using the appropriate vs-kubernetes -> vs-kubernetes.${tool}-path
configuration setting. See "Extension Settings" below.
The extension can install kubectl
, helm
and draft
for you if they are missing - choose Install dependencies when you see an error notification for the missing tool. This will set kubectl-path
, helm-path
and draft-path
entries in your configuration - the programs will not be installed on the system PATH, but this will be sufficient for them to work with the extension.
If you are working with Azure Container Services or Azure Kubernetes Services, then you can install and configure kubectl
using the Kubernetes: Add Existing Cluster
command.
If you plan to create managed clusters using Microsoft Azure (ACS or AKS), or to add clusters in those environments to your kubeconfig, then you will need Azure CLI 2.0.23 or above. You do not need Azure CLI if you do not use Azure, or to interact with Azure clusters that are already in your kubeconfig.
helm
support requires that you have Helm installed and configured.
To use the Helm: DryRun
command, your Kubernetes cluster must be running Tiller.
For setting up draft
you can provide a path to the binary via configuration (vs-kubernetes.draft-path
) if it is not on your PATH.
If you want to use the Kubernetes: Run
and Kubernetes: Debug
features
then you need to have correctly set the user and repository for your
images. You can do this via preferences in VS Code:
File > Preferences
And then add:
{
...
"vsdocker.imageUser": "<your-image-prefix-here>",
...
}
Where <your-image-prefix-here>
is something like docker.io/brendanburns
.
By default, the extension uses the active kubeconfig file -- that is, the file
to which the KUBECONFIG environment variable points, or the default kubeconfig
if no KUBECONFIG environment variable exists. If you want to swap kubeconfig
files, you can specify the file path in the vs-kubernetes.kubeconfig
setting in
your user or workspace settings.
If you are building and running the extension from source, see CONTRIBUTING.md for prerequisites for the development environment.
vs-kubernetes
supports a number of commands for interacting with Kubernetes; these are accessible via the command menu (Ctrl+Shift+P
) and may be bound to keys in the normal way.
Kubernetes: Load
- Load a resource from the Kubernetes API and create a new editor window.Kubernetes: Get
- Get the status for a specific resource.Kubernetes: Follow Logs
- Follow logs for a pod in an output window.Kubernetes: Show Logs
- Get logs for a pod in an output window.
Kubernetes: Explain
- Use thekubectl explain ...
tool to annotate Kubernetes API objectsKubernetes: Create
- Create an object using the current documentKubernetes: Delete
- Delete an object contained in the current document.Kubernetes: Apply
- Apply changes to an object contained in the current document.Kubernetes: Expose
- Expose the object in the current document as a service.
Kubernetes: Run
- Run the current application as a Kubernetes DeploymentKubernetes: Terminal
- Open an interactive terminal session in a pod of the Kubernetes DeploymentKubernetes: Exec
- Run a command in a pod of the Kubernetes DeploymentKubernetes: Debug (Launch)
- Run the current application as a Kubernetes Deployment and attach a debugging session to it (currently works only for Java/Node.js deployments). See Debug support on Kubernetes cluster for more details.Kubernetes: Debug (Attach)
- Attach a debugging session to an existing Kubernetes Deployment (currently works only for Java deployments). See Debug support on Kubernetes cluster for more details.Kubernetes: Remove Debug
- Remove the deployment and/or service created for aKubernetes Debug (Launch)
sessionKubernetes: Sync Working Copy to Cluster
- Checks out the version of the code that matches what is deployed in the cluster. (This relies on Docker image versions also being Git commit IDs, which the extension does if you use the Run command to build the container, but which typically doesn't work for containers/deployments done by other means.)
Kubernetes Add Existing Cluster
- Install and configure the Kubernetes command line tool (kubectl) from a cloud cluster, such as an Azure Container Service (ACS) or Azure Kubernetes Service (AKS) cluster
Kubernetes Open Dashboard
- Opens the Kubernetes Dashboard in your browser.
Helm is the package manager for Kubernetes and provides a way for you to define, install and upgrade applications using 'charts.' This extension provides a set of tools for creating and testing Helm charts:
- Syntax highlighting for YAML + Helm Templates
- Autocomplete for Helm, Sprig, and Go Tpl functions
- Help text (on hover) for Helm, Sprig, and Go Tpl functions
- Snippets for quickly scaffolding new charts and templates
- Commands for...
Helm: Lint
- Lint your chartHelm: Preview Template
- Open a preview window and preview how your template will renderHelm: Template
- Run your chart through the template engineHelm: DryRun
- Run a helm install --dry-run --debug on a remote cluster and get the resultsHelm: Version
- Get the Helm versionHelm: Dependency Update
- Update a chart's dependencies.Helm: Package
- Package the chart into a versioned chart archive file.
- Code lenses for:
- requirements.yaml (Add and update dependencies)
- Right-click on a chart .tgz file, and choose inspect chart to preview all configurable chart values.
Draft is a tool to simplify the process of developing a new Kubernetes application, by creating the necessary deployment components and by keeping code in the cluster in sync with the code on your computer.
Draft: Create
- Set up Draft in the current folder (prerequisite for syncing using Draft)Draft: Up
- Runs Draft to watch the current folder and keep the cluster in sync with it
NOTE: Draft itself is in 'draft' form and is not yet stable. So the extension support for Draft is strictly experimental - assumptions may break, and commands and behavior may change!
vs-kubernetes
- Parent for Kubernetes-related extension settingsvs-kubernetes.namespace
- The namespace to use for all commandsvs-kubernetes.kubectl-path
- File path to the kubectl binary. Note this is the binary file itself, not just the directory containing the file. On Windows, this must contain the.exe
extension.vs-kubernetes.helm-path
- File path to the helm binary. Note this is the binary file itself, not just the directory containing the file. On Windows, this must contain the.exe
extension.vs-kubernetes.draft-path
- File path to the draft binary. Note this is the binary file itself, not just the directory containing the file. On Windows, this must contain the.exe
extension (note current versions of Draft are not supported on Windows).vs-kubernetes.kubeconfig
- File path to the kubeconfig file you want to use. This overrides both the default kubeconfig and the KUBECONFIG environment variable.vs-kubernetes.autoCleanupOnDebugTerminate
- The flag to control whether to auto cleanup the created deployment and associated pod by the command "Kubernetes: Debug (Launch)". The cleanup action occurs when it failed to start debug session or debug session terminated. If not specified, the extension will prompt for whether to clean up or not. You might choose not to clean up if you wanted to view pod logs, etc.vs-kubernetes.outputFormat
- The output format that you prefer to view Kubernetes manifests in. One of "yaml" or "json". Defaults to "yaml".
vsdocker.imageUser
- Image prefix for docker images e.g. 'docker.io/brendanburns'
Kubernetes: Debug
command currently works only with Node.js and Java applications- For deeply nested Helm charts, template previews are generated against highest (umbrella) chart values (though for
Helm: Template
calls you can pick your chart)
See the change log.
This extension collects telemetry data to help us build a better experience for building applications with Kubernetes and VS Code. We only collect the following data:
- Which commands are executed
- For the
Create Cluster
andConfigure from Cluster
commands, the cluster type selected.
We do not collect any information about image names, paths, etc. The extension respects the telemetry.enableTelemetry
setting which you can learn more about in our FAQ.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
For technical information about contributing, see CONTRIBUTING.md.