client

Documentation

Index

• Constants
• func Apply(ctx context.Context, c client.Client, obj client.Object, ...) error
• func BuildConfigFromFlags(masterURL, kubeConfigPath string, options ...func(c *rest.Config)) (*rest.Config, error)
• func BuildConfigFromKubeConfig(kubeconfig []byte, options ...func(c *rest.Config)) (*rest.Config, error)
• func SetQPS(qps float32, burst int) func(c *rest.Config)
• func WithDryRun(dryRun bool) func(*ApplyOptions)
• func WithFieldManager(fieldManager string) func(*ApplyOptions)
• func WithForce(force bool) func(*ApplyOptions)
• type ApplyOptions

Constants

const (
	// DefaultQPS is the default QPS value.
	DefaultQPS = 50
	// DefaultBurst is the default Burst value.
	DefaultBurst = 100
)

Functions

func Apply

func Apply(ctx context.Context, c client.Client, obj client.Object, options ...func(*ApplyOptions)) error

Apply creates the given object or updates the existing object to the given one using apply patch.

func BuildConfigFromFlags

func BuildConfigFromFlags(masterURL, kubeConfigPath string, options ...func(c *rest.Config)) (*rest.Config, error)

BuildConfigFromFlags builds rest configs from a master url or a kube config filepath.

func BuildConfigFromKubeConfig

func BuildConfigFromKubeConfig(kubeconfig []byte, options ...func(c *rest.Config)) (*rest.Config, error)

BuildConfigFromKubeConfig builds rest configs from kube config data.

func SetQPS

func SetQPS(qps float32, burst int) func(c *rest.Config)

SetQPS sets the QPS and Burst.

func WithDryRun

func WithDryRun(dryRun bool) func(*ApplyOptions)

WithDryRun sets the DryRun option when creating or patching the object. The default value is `false`.

func WithFieldManager

func WithFieldManager(fieldManager string) func(*ApplyOptions)

WithFieldManager sets the FieldManager option when creating or patching the object. The default value is `controller-runtime`.

func WithForce

func WithForce(force bool) func(*ApplyOptions)

WithForce sets the Force option when patching the object. The default value is `true`.

Types

type ApplyOptions

type ApplyOptions struct {
	// contains filtered or unexported fields
}

ApplyOptions defines options needed to create or patch an object.