Documentation ¶
Overview ¶
Package configmaps contains the client for working with Kubernetes ConfigMaps.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client interface { Create(ctx context.Context, namespace string, obj *v1.ConfigMap) (*v1.ConfigMap, error) Transform(ctx context.Context, namespace string, name string, transformer Mutator) (*v1.ConfigMap, error) Get(ctx context.Context, namespace string, name string) (*v1.ConfigMap, error) Delete(ctx context.Context, namespace string, name string) error List(ctx context.Context, namespace string) ([]v1.ConfigMap, error) Upsert(ctx context.Context, namespace string, newObj *v1.ConfigMap, merge Merger) (*v1.ConfigMap, error) WaitFor(ctx context.Context, namespace string, name string, interval time.Duration, condition Predicate) (*v1.ConfigMap, error) // Utility functions WaitForDeletion(ctx context.Context, namespace string, name string, interval time.Duration) (*v1.ConfigMap, error) // ClientExtension can be used by the developer to extend the client. ClientExtension }
Client is the interface for interacting with v1.ConfigMap types as ConfigMap CF style objects.
func NewClient ¶
func NewClient(kclient cv1.ConfigMapsGetter) Client
NewClient creates a new configmap client.
type ClientExtension ¶
type ClientExtension interface { }
ClientExtension holds additional functions that should be exposed by client.
type ConditionFuncE ¶
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 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.