results

Documentation

Overview

Package results provide types and methods used to assemble the results of deprecated objects

Index

• type DeletedAPI
• type DeprecatedAPI
• type Item
  • func ListObjects(items []unstructured.Unstructured) (deprecatedItems []Item)
• type Result
• type ResultItem
  • func CreateItem(group, version, kind string, items []Item) ResultItem

Types

type DeletedAPI

type DeletedAPI struct {
	Group   string `json,yaml:"group,omitempty"`
	Kind    string `json,yaml:"kind,omitempty"`
	Version string `json,yaml:"version,omitempty"`
	// TODO: What is this boolean for? All APIs here aren't already marked as Deleted?
	Deleted bool   `json,yaml:"deleted,omitempty"`
	Items   []Item `json,yaml:"deleted_items,omitempty"`
}

DeletedAPI definition of an API

type DeprecatedAPI

type DeprecatedAPI struct {
	Description string `json,yaml:"description,omitempty"`
	Group       string `json,yaml:"group,omitempty"`
	Kind        string `json,yaml:"kind,omitempty"`
	Version     string `json,yaml:"version,omitempty"`
	// TODO: What is this boolean for? All APIs here aren't already marked as Deprecated?
	Deprecated bool   `json,yaml:"deprecated,omitempty"`
	Items      []Item `json,yaml:"deprecated_items,omitempty"`
}

DeprecatedAPI definition of an API

type Item

type Item struct {
	Scope      string `json,yaml:"scope,omitempty"`
	ObjectName string `json,yaml:"objectname,omitempty"`
	Namespace  string `json,yaml:"namespace,omitempty"`
	Location   string `json:"location,omitempty" yaml:"location,omitempty"`
}

Item definition of the Items inside a deprecated API

func ListObjects

func ListObjects(items []unstructured.Unstructured) (deprecatedItems []Item)

ListObjects is a generic function that receives unstructured Kubernetes objects and convert to deprecatedItem to be used later in the results

type Result

type Result struct {
	DeprecatedAPIs []ResultItem `json,yaml:"deprecated_apis,omitempty"`
	DeletedAPIs    []ResultItem `json,yaml:"deleted_apis,omitempty"`
}

Result to show final user

type ResultItem

type ResultItem struct {
	Group       string `json,yaml:"group,omitempty"`
	Kind        string `json,yaml:"kind,omitempty"`
	Version     string `json,yaml:"version,omitempty"`
	Description string `json,yaml:"description,omitempty"`
	Items       []Item `json,yaml:"deleted_items,omitempty"`
}

func CreateItem

func CreateItem(group, version, kind string, items []Item) ResultItem