Documentation
¶
Index ¶
- Variables
- func ColouredName(key ObjectKey, color *color.Color) string
- func Name(key ObjectKey) string
- func PatchObject(actual, expected runtime.Object) (runtime.Object, error)
- func WaitForDeletion(ctx context.Context, client Client, object Object) error
- type Client
- type CreateOption
- type DeleteOption
- type GetOption
- type InNamespace
- type ListOption
- type MatchingLabels
- type Object
- type ObjectKey
- type ObjectList
- type Patch
- type PatchOption
- type PropagationPolicy
- type UpdateOption
Constants ¶
This section is empty.
Variables ¶
View Source
var RawPatch = ctrlclient.RawPatch
Functions ¶
func ColouredName ¶ added in v0.0.2
func ColouredName(key ObjectKey, color *color.Color) string
func PatchObject ¶
func PatchObject(actual, expected runtime.Object) (runtime.Object, error)
func WaitForDeletion ¶ added in v0.2.8
func WaitForDeletion(ctx context.Context, client Client, object Object) error
Types ¶
type Client ¶
type Client interface {
// Get retrieves an obj for the given object key from the Kubernetes Cluster.
// obj must be a struct pointer so that obj can be updated with the response
// returned by the Server.
Get(ctx context.Context, key ObjectKey, obj Object, opts ...GetOption) error
// List retrieves list of objects for a given namespace and list options. On a
// successful call, Items field in the list will be populated with the
// result returned from the server.
List(ctx context.Context, list ObjectList, opts ...ListOption) error
// Create saves the object obj in the Kubernetes cluster. obj must be a
// struct pointer so that obj can be updated with the content returned by the Server.
Create(ctx context.Context, obj Object, opts ...CreateOption) error
// Update updates the given obj in the Kubernetes cluster. obj must be a
// struct pointer so that obj can be updated with the content returned by the Server.
Update(ctx context.Context, obj Object, opts ...UpdateOption) error
// Delete deletes the given obj from Kubernetes cluster.
Delete(ctx context.Context, obj Object, opts ...DeleteOption) error
// Patch patches the given obj in the Kubernetes cluster. obj must be a
// struct pointer so that obj can be updated with the content returned by the Server.
Patch(ctx context.Context, obj Object, patch Patch, opts ...PatchOption) error
// IsObjectNamespaced returns true if the GroupVersionKind of the object is namespaced.
IsObjectNamespaced(obj runtime.Object) (bool, error)
// RESTMapper returns the rest this client is using.
RESTMapper() meta.RESTMapper
}
type CreateOption ¶ added in v0.2.8
type CreateOption = ctrlclient.CreateOption
type DeleteOption ¶ added in v0.2.8
type DeleteOption = ctrlclient.DeleteOption
type InNamespace ¶ added in v0.2.8
type InNamespace = ctrlclient.InNamespace
type ListOption ¶ added in v0.2.8
type ListOption = ctrlclient.ListOption
type MatchingLabels ¶ added in v0.2.8
type MatchingLabels = ctrlclient.MatchingLabels
type ObjectList ¶ added in v0.2.8
type ObjectList = ctrlclient.ObjectList
type PatchOption ¶ added in v0.2.8
type PatchOption = ctrlclient.PatchOption
type PropagationPolicy ¶ added in v0.2.8
type PropagationPolicy = ctrlclient.PropagationPolicy
type UpdateOption ¶ added in v0.2.8
type UpdateOption = ctrlclient.UpdateOption
Click to show internal directories.
Click to hide internal directories.