Weaveworks GitOps Tools Extension provides an intuitive way to manage, troubleshoot and operate your Kubernetes environment following the GitOps operating model. GitOps accelerates your development lifecycle and simplifies your continuous delivery pipelines. The extension is built on Flux (a CNCF open source project). To learn more about the Flux GitOps toolkit, visit fluxcd.io
Use this extension to visualize, configure and debug Flux objects (sources and workloads) needed for GitOps workflows. For example, with this extension you can create a Flux
GitRepository source object that tracks a Git repository containing Kubernetes manifests for your application. Then add a
Kustomization workload object that periodically applies (reconciles) the manifests from the repository to your cluster. Now your Kubernetes changes are managed through git!
Your feedback is very important to us! Please help us by submitting issues for bugs, enhancements and share with us how you are using the extension.
This extension is under active development with rolling beta release cycle and stable releases. Breaking changes remain a possibility.
There are a few requirements before installing and using the extension:
- Install the
kubectl command-line tool
- You must have a working cluster selected in the
kubectl config. A
kind or Docker Desktop cluster is an easy way to get started. More information about kubeconfigs is available here
flux tool is required and can be installed from this extension
- Additional dependencies for Weave GitOps Enterprise and Azure users
Once you have satisfied these requirements you can find and install GitOps Tools in the Extension Marketplace by searching for "fluxcd" or "gitops".
- Configure, visualize and manage Flux resources
- Tree views for Clusters, Sources, and Workloads
- Select clusters and examine installed GitOps Toolkit components
- Enable and Disable GitOps (install/uninstall Flux) on clusters
- Create, view and edit sources (git, OCI, Helm and Bucket), and workloads (Kustomization and HelmRelease)
- Reconcile sources and workloads on demand
- Pause and resume scheduled reconciliation
- Create GitRepository and Kustomization objects from folders opened in vscode
- Clone GitRepository source to user machine and open them in the editor
- Preview sources, workloads and other objects information with tooltips
- Open remote resources as
.yaml files in the editor
- Trace Kubernetes objects created by workloads
- Watch Flux controller logs and
flux CLI commands for diagnostics
- Documentation links for Flux and Weave GitOps embedded in the extension
Tree Views and Resources
(Clusters, Sources and Workflows tree views;
Kustomization tooltip and
HelmRepository YAML view)
Configure GitOps View
(Configure GitOps view is used to create sources and workloads)
(Right clicking in the Explorer view to create Flux objects from folders)
You can access GitOps tools check, CLI dependendency versions, Clusters, Sources and Workloads views Focus, Refresh and other commands by typing
View -> Command Palette... menu prompt:
The extension uses several CLI commands that must be installed and available in your system
You will need the
kubectl CLI tool to use this extension.
flux is also required but can be installed by the extension:
For users running clusters in Azure including AKS and Arc clusters, the
az command line tool is also required.
|The kubectl command line tool lets you control Kubernetes clusters.
|Flux is a set of continuous and progressive delivery solutions for Kubernetes.
||Install Flux CLI
|Git is a free and open source distributed version control system.
|Weave GitOps Enterprise (WGE) CLI (required for Templates feature)
||Install WGE CLI
|Azure CLI. (only if using the extension to create or register Azure clusters)
|Docker is an open platform for developing, shipping, and running applications.
If the extension needs one of the core Kubernetes tools and they are missing, it will prompt you to install them.
The GitOps Tools Extension depends on the Kubernetes Tools extension, which will be installed automatically if you don't already have it.
- Make sure you have successfully authenticated on your
az CLI and have access to the correct subscription for your AKS or ARC cluster.
- The easiest way to get your AKS or Arc cluster visible by the GitOps and Kubernetes Extensions, is to use the
az CLI to merge the kubeconfig for accessing your cluster onto the default
kubectl config. Use
get-credentials as shown in the official CLI documentation. In order to enable GitOps in a cluster you will likely need the
Weave GitOps Enterprise (WGE) Templates
WGE users can access GitOpsTemplates directly from this extensions. Templates are provided by cluster administrators (Platform Teams) and can be used to quickly create cluster and configure applications with GitOps.
Templates are an opt-in feature that must be enabled in setting:
After that they can be seen in a new 'Templates' view. Right-click a template to use it:
There are no clusters showing in my Clusters pane
We rely on the Kubernetes extension to discover and connect to clusters. If you are having issues accessing or viewing your cluster, follow the documentation provided by the Kubernetes extension.
Confirm that your configuration context shows in a terminal running
kubectl config get-contexts
Data and Telemetry
The GitOps Tools Extension for Visual Studio Code collects usage data and sends it to Weaveworks to help improve our products and services. Read our privacy statement to learn more. This extension respects the
VSCodium user can search and install from the VSCodium Open-VSX extension registry.
- Download the latest
vsix artifact version from our Releases page.
code --install-extension gitops-tools-$VERSION.vsix