Skip to content

Latest commit

 

History

History
117 lines (87 loc) · 3.38 KB

gardener.md

File metadata and controls

117 lines (87 loc) · 3.38 KB
Raw

Configure Gardener store

Kubeswitch can search through multiple Gardener installations for kubeconfigs of Shoot clusters and Shooted /Managed Seeds. External Seeds (not managed) and Plants are currently not supported.

Search Semantics

Kubeconfig contexts names are searchable using Gardener semantics.

The prefix is the identity of the Gardener installation (k -n kube-system get cm cluster-identity in the Garden cluster). Optionally, a less technical name can be defined (see configuration).

Shoot

  • -shoot--/

In this example:

  • Landscape-identity: sap-landscape-dev
  • Project Name: core
  • Shoot Name: dm
  • Context Name: shoot--core--dm

Shoots

Seed

  • -seed-/

In this example:

  • Landscape-identity: sap-landscape-dev
  • Seed Name: az
  • Context Name: shoot--garden-az

Seeds

Garden cluster

  • -garden

garden

However, you can always define an alias for a context name to customize the search. For instance, if you are more used to calling your Gardener cluster "virtual-garden", define an alias like so:

switch alias dev-virtual-garden=sap-landscape-dev-garden/virtual-garden

Using switch dev-virtual-garden will directly switch to the virtual Garden cluster.

Preview functionality

The preview includes meta information depending on which kubeconfig is selected. This includes the Gardener landscape, the name of the Seed where the Shoot's control plane runs and the name of the Shoot. Please note: Using this preview will cause additional requests against the Gardener API server even though you might use a search index.

Preview

The preview can be turned off using the flag --show-preview false.

Configuration

You need to configure kubeswitch with a kubeconfig for each Gardener installation. It should have

  • permissions to list Shoots, Secrets and ManagedSeeds (limited to namespaces dependent on the configured paths)
  • the current-context set

Example configuration

cat ~/.kube/switch-config.yaml

kind: SwitchConfig
version: "v1alpha1"
refreshIndexAfter: 4h
kubeconfigStores:
- kind: gardener
  config:
    gardenerAPIKubeconfigPath: "/path/to/dev-(virtual)-garden-kubeconfig"
    landscapeName: "dev"
- kind: gardener
  config:
    gardenerAPIKubeconfigPath: "/path/to/canary-(virtual)-garden-kubeconfig"
    landscapeName: "canary"
- kind: gardener
  refreshIndexAfter: 6h
  config:
    gardenerAPIKubeconfigPath: "/path/to/live-(virtual)-garden-kubeconfig"
    landscapeName: "live"

Optional configuration

Optionally, a landscapeName can be configured that replaces the automatically detected landscape-identity of each gardener installation.

Per default, all namespaces are searched for Shoot clusters (equals path "/"). You can also define the namespaces in the paths field.

Please see the example below.

cat ~/.kube/switch-config.yaml

kind: SwitchConfig
version: "v1alpha1"
refreshIndexAfter: 4h
kubeconfigStores:
- kind: gardener
  paths:
  - "garden-my-shoot-ns"
  - "garden"
  config:
    gardenerAPIKubeconfigPath: "/path/to/dev-(virtual)-garden-kubeconfig"
    landscapeName: "dev"