networkpolicies

Documentation

Overview

Package networkpolicies contains the client for working with Kubernetes NetworkPolicies.

Index

• func ConditionDeleted(ctx context.Context, _ *v1.NetworkPolicy, apiErr error) (bool, error)
• func WithConditionReporter(ctx context.Context, reporter ConditionReporter) context.Context
• type Client
  • func NewClient(kclient cv1.NetworkPoliciesGetter) Client
• type ClientExtension
• type ConditionFuncE
• type ConditionReporter
• type Merger
• type Mutator
• type Predicate
• type ResourceInfo
  • func NewResourceInfo() *ResourceInfo
  • func (*ResourceInfo) FriendlyName() string
  • func (*ResourceInfo) GroupVersionKind(context.Context) schema.GroupVersionKind
  • func (*ResourceInfo) GroupVersionResource(context.Context) schema.GroupVersionResource
  • func (*ResourceInfo) Namespaced() bool

Functions

func ConditionDeleted

func ConditionDeleted(ctx context.Context, _ *v1.NetworkPolicy, apiErr error) (bool, error)

ConditionDeleted is a ConditionFuncE that succeeds if the error returned by the cluster was a not found error.

func WithConditionReporter

func WithConditionReporter(ctx context.Context, reporter ConditionReporter) context.Context

WithConditionReporter adds a callback to condition waits.

Types

type Client

type Client interface {
	Create(ctx context.Context, namespace string, obj *v1.NetworkPolicy) (*v1.NetworkPolicy, error)
	Transform(ctx context.Context, namespace string, name string, transformer Mutator) (*v1.NetworkPolicy, error)
	Get(ctx context.Context, namespace string, name string) (*v1.NetworkPolicy, error)
	Delete(ctx context.Context, namespace string, name string) error
	List(ctx context.Context, namespace string) ([]v1.NetworkPolicy, error)
	Upsert(ctx context.Context, namespace string, newObj *v1.NetworkPolicy, merge Merger) (*v1.NetworkPolicy, error)
	WaitFor(ctx context.Context, namespace string, name string, interval time.Duration, condition Predicate) (*v1.NetworkPolicy, error)

	// Utility functions
	WaitForDeletion(ctx context.Context, namespace string, name string, interval time.Duration) (*v1.NetworkPolicy, error)

	// ClientExtension can be used by the developer to extend the client.
	ClientExtension
}

Client is the interface for interacting with v1.NetworkPolicy types as NetworkPolicy CF style objects.

func NewClient

func NewClient(kclient cv1.NetworkPoliciesGetter) Client

NewClient creates a new service client.

type ClientExtension

type ClientExtension interface {
}

ClientExtension holds additional functions that should be exposed by client.

type ConditionFuncE

type ConditionFuncE func(ctx context.Context, instance *v1.NetworkPolicy, apiErr error) (done bool, err error)

ConditionFuncE is a callback used by waitForE. Done should be set to true once the condition succeeds and shouldn't be called anymore. The error will be passed back to the user.

This function MAY retrieve a nil instance and an apiErr. It's up to the function to decide how to handle the apiErr.

type ConditionReporter

type ConditionReporter func(message string)

ConditionReporter reports on changes to conditions while waiting.

type Merger

type Merger func(newObj, oldObj *v1.NetworkPolicy) *v1.NetworkPolicy

Merger is a type to merge an existing value with a new one.

type Mutator

type Mutator func(*v1.NetworkPolicy) error

Mutator is a function that changes v1.NetworkPolicy.

type Predicate

type Predicate func(*v1.NetworkPolicy) bool

Predicate is a boolean function for a v1.NetworkPolicy.

type ResourceInfo

type ResourceInfo struct{}

func NewResourceInfo

func NewResourceInfo() *ResourceInfo

NewResourceInfo returns a new instance of ResourceInfo

func (*ResourceInfo) FriendlyName

func (*ResourceInfo) FriendlyName() string

FriendlyName gets the user-facing name of the resource.

func (*ResourceInfo) GroupVersionKind

func (*ResourceInfo) GroupVersionKind(context.Context) schema.GroupVersionKind

GroupVersionKind gets the GVK struct for the resource.

func (*ResourceInfo) GroupVersionResource

func (*ResourceInfo) GroupVersionResource(context.Context) schema.GroupVersionResource

GroupVersionResource gets the GVR struct for the resource.

func (*ResourceInfo) Namespaced

func (*ResourceInfo) Namespaced() bool

Namespaced returns true if the type belongs in a namespace.