isabella232 / vscode-gardener-tools

Gardener tools for VSCode

Gardener Tools for VSCode

This Visual Studio Code Kubernetes Tools extension allows you to work with your gardener projects, shoots, plants and seeds.

Features

• List
  • gardener projects
  • shoot clusters
  • plant clusters
  • seed clusters [*]
  • backup bucket resources [*]
  • backup entry resources [*]
• Right click on landscape, shoot, plant or seed cluster to Save Kubeconfig / Merge into Kubeconfig
• Right click on landscape or shoot to Show In Dashboard
• Right click on landscape to Create Project in gardener dashboard
• Right click on shoots list to Create Shoot in gardener dashboard
• Gardenctl integration
  • Right click on shoot or seed to get a Shell to a node [*]
  • Right click on landscape, project, shoot or seed to Target with gardenctl [*]
  • Right click on landscape, project, shoot or seed to List with gardenctl gardens, projects, seeds, shoots or issues. [*]
  • Right click on landscape to Register / Unregister for the operator shift with gardenctl [*]

[*] Gardener operator only

Requirements

• You have installed the Kubernetes Tools extension from the marketplace
• Kubeconfig to (virtual) garden cluster
• For gardener operators: Gardenctl for Shell, Target or List command

Install

1. Install this extension from the Visual Studio Marketplace
2. Configure the extension. See Extension Settings section below.
3. In the Sidebar, click on the Kubernetes icon. There should be an entry Gardener under the Clouds section.

Install from VSIX

• Download .vsix file from latest release asset
• In VSCode, open the command palette: View -> Command Palette... -> type in Extensions: Install from VSIX...
• Choose .vsix file downloaded in first step

Extension Settings

This extension contributes the following settings:

• vscode-gardener-tools.vscode-light-theme: should match your configured theme style. Default: true
• vscode-gardener-tools.landscapes: Required configuration for garden landscapes
• vscode-gardener-tools.landscapes[].name: Name of the garden cluster
• vscode-gardener-tools.landscapes[].gardenName: Optional name of the corresponding (gardenctl) garden. Default: Name of the landscape
• vscode-gardener-tools.landscapes[].kubeconfigPath: Path to the kubeconfig of the garden cluster.
  • How to get the kubeconfig as regular project member: In the gardener dashboard, go to the Members section of your project and create a new service account. Afterwards you can download the kubeconfig of the service account.
• vscode-gardener-tools.landscapes[].dashboardUrl: Gardener dashboard URL,
• vscode-gardener-tools.landscapes[].projects[]: Optional projects filter. List of projects (names) to be shown. You need to have access to these projects.

Example config settings.json:

    "vscode-gardener-tools": {
      "vscode-light-theme": false,
      "landscapes": [
        {
          "name": "landscape-dev",
          "gardenName": "virtual-dev",
          "kubeconfigPath": "/kubeconfigpath/cluster-dev-virtual-garden/kubeconfig.yaml",
          "dashboardUrl": "https://dashboard.garden.dev.example.com",
          "projects": ["garden", "myproject"]
        },
        {
          "name": "landscape-canary",
          "kubeconfigPath": "/kubeconfigpath/cluster-canary-virtual-garden/kubeconfig.yaml",
          "dashboardUrl": "https://dashboard.garden.canary.example.com"
        },
      ]
    }

To change the Gardener Kubernetes Tools settings:

• On Windows/Linux - File > Preferences > Settings
• On macOS - Code > Preferences > Settings

Then search for Gardener Kubernetes Tools or navigate to User Settings > Extensions > Gardener Kubernetes Tools

Known Issues

No Projects are Listed

No projects are listed and you also see the entry No permission to list projects. Specify the projects in the extension configuration.

Reason: Most likely you have downloaded the kubeconfig of a service account in the Members section of your project in the gardener dashboard. This account does not have the permission to list projects.

Solution: Specify the list of projects that you want to see (and have access to) by setting the projects property of your landscape in the Extension Settings.