kubernetes

Documentation

Index

• Variables
• func BytesToUtf8Lf(file []byte) (string, error)
• func GetClusterName(config *rest.Config) string
• func GetUnstructuredObjects(data []byte) ([]unstructured.Unstructured, error)
• func NewClient(logger logger.Logger, kubeconfigPaths ...string) (kubernetes.Interface, *rest.Config, error)
• func NewClientFromPathOrConfig(logger logger.Logger, kubeconfigOrPath string) (kubernetes.Interface, *rest.Config, error)
• func NewClientWithConfig(logger logger.Logger, kubeConfig []byte) (kubernetes.Interface, *rest.Config, error)
• type Client
  • func NewKubeClient(client kubernetes.Interface, config *rest.Config) *Client
  • func (c *Client) DeleteByGVK(ctx context.Context, namespace, name string, gvk schema.GroupVersionKind) (bool, error)
  • func (c *Client) ExecutePodf(ctx context.Context, namespace, pod, container string, command ...string) (string, string, error)
  • func (c *Client) FetchResources(ctx context.Context, resources ...unstructured.Unstructured) ([]unstructured.Unstructured, error)
  • func (c *Client) GetClientByGroupVersionKind(group, version, kind string) (dynamic.NamespaceableResourceInterface, error)
  • func (c *Client) GetClientByKind(kind string) (dynamic.NamespaceableResourceInterface, error)
  • func (c *Client) GetDynamicClient() (dynamic.Interface, error)
  • func (c *Client) GetPodLogs(ctx context.Context, namespace, podName, container string) (io.ReadCloser, error)
  • func (c *Client) GetRestMapper() (meta.RESTMapper, error)
  • func (c *Client) StreamLogsV2(ctx context.Context, namespace, name string, timeout time.Duration, ...) error
  • func (c *Client) WaitForContainerStart(ctx context.Context, namespace, name string, timeout time.Duration, ...) error
  • func (c *Client) WaitForPod(ctx context.Context, namespace, name string, timeout time.Duration, ...) error

Variables

var Nil = fake.NewSimpleClientset()

Functions

func BytesToUtf8Lf

func BytesToUtf8Lf(file []byte) (string, error)

func GetClusterName

func GetClusterName(config *rest.Config) string

ExecutePodf runs the specified shell command inside a container of the specified pod

func GetUnstructuredObjects

func GetUnstructuredObjects(data []byte) ([]unstructured.Unstructured, error)

func NewClient

func NewClient(logger logger.Logger, kubeconfigPaths ...string) (kubernetes.Interface, *rest.Config, error)

func NewClientFromPathOrConfig

func NewClientFromPathOrConfig(logger logger.Logger, kubeconfigOrPath string) (kubernetes.Interface, *rest.Config, error)

func NewClientWithConfig

func NewClientWithConfig(logger logger.Logger, kubeConfig []byte) (kubernetes.Interface, *rest.Config, error)

Types

type Client

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

func NewKubeClient

func NewKubeClient(client kubernetes.Interface, config *rest.Config) *Client

func (*Client) DeleteByGVK

func (c *Client) DeleteByGVK(ctx context.Context, namespace, name string, gvk schema.GroupVersionKind) (bool, error)

func (*Client) ExecutePodf

func (c *Client) ExecutePodf(
	ctx context.Context,
	namespace, pod, container string,
	command ...string,
) (string, string, error)

func (*Client) FetchResources

func (c *Client) FetchResources(
	ctx context.Context,
	resources ...unstructured.Unstructured,
) ([]unstructured.Unstructured, error)

func (*Client) GetClientByGroupVersionKind

func (c *Client) GetClientByGroupVersionKind(
	group, version, kind string,
) (dynamic.NamespaceableResourceInterface, error)

func (*Client) GetClientByKind

func (c *Client) GetClientByKind(kind string) (dynamic.NamespaceableResourceInterface, error)

WARN: "Kind" is not specific enough. A cluster can have various resources with the same Kind. example: helmchrats.helm.cattle.io & helmcharts.source.toolkit.fluxcd.io both have HelmChart as the kind.

Use GetClientByGroupVersionKind instead.

func (*Client) GetDynamicClient

func (c *Client) GetDynamicClient() (dynamic.Interface, error)

GetDynamicClient creates a new k8s client

func (*Client) GetPodLogs

func (c *Client) GetPodLogs(ctx context.Context, namespace, podName, container string) (io.ReadCloser, error)

func (*Client) GetRestMapper

func (c *Client) GetRestMapper() (meta.RESTMapper, error)

func (*Client) StreamLogsV2

func (c *Client) StreamLogsV2(
	ctx context.Context,
	namespace, name string,
	timeout time.Duration,
	containerNames ...string,
) error

func (*Client) WaitForContainerStart

func (c *Client) WaitForContainerStart(
	ctx context.Context,
	namespace, name string,
	timeout time.Duration,
	containerNames ...string,
) error

WaitForContainerStart waits for the specified containers to be started (or any container if no names are specified) - returns an error if the timeout is exceeded

func (*Client) WaitForPod

func (c *Client) WaitForPod(
	ctx context.Context,
	namespace, name string,
	timeout time.Duration,
	phases ...v1.PodPhase,
) error

WaitForPod waits for a pod to be in the specified phase, or returns an error if the timeout is exceeded