lib

Documentation

Index

• type Config
• type Kubepug
  • func NewKubepug(config Config) *Kubepug
  • func (k *Kubepug) GetDeprecated() (result *results.Result, err error)

Types

type Config

type Config struct {
	// K8sVersion defines what is the Kubernetes version that the validation should target.
	// Should be on the Kubernetes semver format: v1.24.5
	K8sVersion string
	// ForceDownload defines if the download should happen even if the swagger file already exists
	ForceDownload bool
	// SwaggerDir defines where the swagger file should be saved. If empty, a temporary directory will be created and used.
	SwaggerDir string
	// ShowDescription defines if the description of the API should be copied to the output result
	ShowDescription bool
	Input           string
	ConfigFlags     *genericclioptions.ConfigFlags
}

Config configuration object for Kubepug configurations for kubernetes and for kubepug functionality

type Kubepug

type Kubepug struct {
	Config Config
}

Kubepug defines a kubepug instance to be used

func NewKubepug

func NewKubepug(config Config) *Kubepug

NewKubepug returns a new kubepug library

func (*Kubepug) GetDeprecated

func (k *Kubepug) GetDeprecated() (result *results.Result, err error)

GetDeprecated returns the list of deprecated APIs