kubectl

package

v0.3.11 Latest Latest Go to latest Published: Feb 14, 2024 License: AGPL-3.0 Imports: 22 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

Package kubectl implements helper functions for managing kubernetes resources in e2e tests

This section is empty.

This section is empty.

This section is empty.

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

Client holds the state to access kubernetes

func NewForConfig(_ context.Context, config *rest.Config) (*Client, error)

NewForConfig returns a new Client using a rest.Config

func NewFromKubeconfig(ctx context.Context, kubeconfig string) (*Client, error)

NewFromKubeconfig returns a new Client using the kubeconfig pointed by the path provided

func (c *Client) Apply(ctx context.Context, yaml string) error

Apply creates resources in a kubernetes cluster from a YAML manifest

func (c *Client) ForwardPodPort(
	ctx context.Context,
	namespace string,
	pod string,
	port uint,
	opts ...PortForwardOption,
) (uint, error)

ForwardPodPort opens a local port for forwards requests to a pod's port. Returns the local port used for listening

type PortForwardOption func(portForwardConfig) portForwardConfig

PortForwardOption defines a configuration option for port forwarding

func WithLocalPort(port uint) PortForwardOption

WithLocalPort sets the local port to listen for request. Defaults to 0 (random local port)

func WithOutputStreams(stdout io.Writer, stderr io.Writer) PortForwardOption

WithOutputStreams sets the output streams for the port forwarder. Default to nil