state

package

v0.7.1 Latest Latest Go to latest Published: Aug 31, 2019 License: Apache-2.0 Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/summerwind/whitebox-controller

Links

Open Source Insights

Documentation ¶

Index ¶

func Pack(v interface{}, state *State) error
func ResourceKey(gvk schema.GroupVersionKind) string
func Unpack(state *State, v interface{}) error
type Event
- func (e *Event) Validate() error
type State
- func New(object *unstructured.Unstructured, ...) *State
- func (s *State) Copy() *State
- func (s *State) Diff(ns *State) ([]*unstructured.Unstructured, []*unstructured.Unstructured, ...)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Pack ¶

func Pack(v interface{}, state *State) error

Pack parses v and stores the state the value to the state.

func ResourceKey ¶

func ResourceKey(gvk schema.GroupVersionKind) string

func Unpack ¶

func Unpack(state *State, v interface{}) error

Unpack parses the state and stores the value pointed to by v.

Types ¶

type Event ¶

type Event struct {
	Type    string `json:"type"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}

Event represents an event of Kubernetes.

func (*Event) Validate ¶

func (e *Event) Validate() error

Validate validates the content of event.

type State ¶

type State struct {
	Object       *unstructured.Unstructured              `json:"object"`
	Dependents   map[string][]*unstructured.Unstructured `json:"dependents,omitempty"`
	References   map[string][]*unstructured.Unstructured `json:"references,omitempty"`
	Events       []Event                                 `json:"events,omitempty"`
	Requeue      bool                                    `json:"requeue,omitempty"`
	RequeueAfter int                                     `json:"requeueAfter,omitempty"`
}

State is passed to and received from handler.

func New ¶

func New(object *unstructured.Unstructured, deps, refs map[string][]*unstructured.Unstructured) *State

NewState returns a new state with specified object.

func (*State) Copy ¶

func (s *State) Copy() *State

Copy returns a copy of current state.

func (*State) Diff ¶

func (s *State) Diff(ns *State) ([]*unstructured.Unstructured, []*unstructured.Unstructured, []*unstructured.Unstructured)

Diff compares two states and returns lists of modified objects.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL