client

package

v1.3.2 Latest Latest Go to latest Published: Aug 23, 2022 License: MIT Imports: 8 Imported by: 0

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

This section is empty.

View Source

var ErrAPIGroup = errors.New("api group error")

ErrAPIGroup is returned when a kubernetes api call fails.

View Source

var ErrMissingResource = errors.New("resource not found")

ErrMissingResource is returned when the resource is not found.

This section is empty.

type Client struct {
	kubernetes.Interface

	Error error
	// contains filtered or unexported fields
}

Client is used to interact with the kubernetes API.

func NewClient(configures ...ConfigureFunc) *Client

NewClient creates `Client` from a kubernetes client.

func (client *Client) AppsV1() *appsv1.AppsV1

AppsV1 is used to interact with features provided by the apps group.

func (client *Client) BatchV1() *batchv1.BatchV1

BatchV1 is used to interact with features provided by the batch group.

func (client *Client) BatchV1Beta1() *batchv1beta1.BatchV1Beta1

BatchV1Beta1 is used to interact with features provided by the batch group.

func (client *Client) CoreV1() *corev1.CoreV1

CoreV1 is used to interact with features provided by the core group.

func (client *Client) GetAPIGroup(resource string) (string, error)

GetAPIGroup returns the GroupVersion (batch/v1, batch/v1beta1, etc) for the given resource.

type ConfigureFunc = func(client *Client)

ConfigureFunc is used for configuring `Client` settings.

func WithExport(shouldExport bool) ConfigureFunc

WithExport flags the client to include `export` statements in the output.

func WithKubeClient(kubeClient kubernetes.Interface) ConfigureFunc

WithKubeClient sets the underlying kubernetes API client.

func WithNamespace(namespace string) ConfigureFunc

WithNamespace sets the namespace to use when interacting with the Kubernetes API.