clusterid

README

clusterid

A small Kubernetes cluster detection library.

Why?

The Tilt project interacts with many different types of local development clusters.

These clusters sometimes have machine-readable ways to determine what features they support, but more often they do not.

This library uses some simple heuristics to figure out what kind of cluster we're talking to, to figure out what features a cluster might support.

License

Copyright 2022 Windmill Engineering

Licensed under the Apache License, Version 2.0

Documentation

Index

• type Product
  • func ProductFromContext(c *clientcmdapi.Context, cl *clientcmdapi.Cluster) Product
  • func (p Product) DefaultClusterName() string
  • func (e Product) IsDevCluster() bool
  • func (p Product) String() string

Types

type Product

type Product string

Enum of possible values for cluster.product

Named in honor of the product component of the user-agent string, which we hope isn't foreshadowing.

const (
	ProductUnknown        Product = "unknown"
	ProductGKE            Product = "gke"
	ProductMinikube       Product = "minikube"
	ProductDockerDesktop  Product = "docker-desktop"
	ProductMicroK8s       Product = "microk8s"
	ProductCRC            Product = "crc"
	ProductKrucible       Product = "krucible"
	ProductKIND           Product = "kind"
	ProductK3D            Product = "k3d"
	ProductRancherDesktop Product = "rancher-desktop"
)

func ProductFromContext

func ProductFromContext(c *clientcmdapi.Context, cl *clientcmdapi.Cluster) Product

func (Product) DefaultClusterName

func (p Product) DefaultClusterName() string

func (Product) IsDevCluster

func (e Product) IsDevCluster() bool

func (Product) String

func (p Product) String() string