detector

README

Provider Detector

A library to identify the provider of a Kubernetes Cluster

Usage

Pass in a kubernetes.Interface and get a string back for the provider

Documentation

Index

• func DetectProvider(ctx context.Context, k8sClient kubernetes.Interface) (string, error)
• func ListRegisteredProviders() []string
• type ErrUnknownProvider
  • func (e ErrUnknownProvider) Error() string
• type IsProvider

Functions

func DetectProvider

func DetectProvider(ctx context.Context, k8sClient kubernetes.Interface) (string, error)

DetectProvider accepts a k8s interface and checks all registered providers for a match

func ListRegisteredProviders

func ListRegisteredProviders() []string

ListRegisteredProviders returns a list of the names of all providers

Types

type ErrUnknownProvider

type ErrUnknownProvider struct{}

func (ErrUnknownProvider) Error

func (e ErrUnknownProvider) Error() string

type IsProvider

type IsProvider func(ctx context.Context, k8sClient kubernetes.Interface) (bool, error)

IsProvider is the interface all providers need to implement