k8s

Documentation

Overview

Package k8s provides functionalities to interact with the Kubernetes API server

Index

• Constants
• func FetchBastionIpAddress(clusterName, namespace, kubeConfigPath string) (string, error)
• func FetchWorkloadConfig(clusterName, clusterNamespace, mgmtKubeConfigPath string) (string, error)
• func GetNodeAddresses(ctx context.Context, kubeconfigPath string, names, labels []string) ([]string, error)
• type Client
  • func New(kubeconfig string, clusterContextOptions ...string) (*Client, error)
  • func (k8sc *Client) Search(ctx context.Context, params SearchParams) ([]SearchResult, error)
• type Config
  • func LoadKubeCfg(kubeConfigPath string) (Config, error)
• type Container
  • func GetContainers(podItem unstructured.Unstructured) ([]Container, error)
• type ContainerLogsImpl
  • func NewContainerLogger(namespace, podName string, container corev1.Container) ContainerLogsImpl
  • func (c ContainerLogsImpl) Fetch(ctx context.Context, restApi rest.Interface) (io.ReadCloser, error)
  • func (c ContainerLogsImpl) Write(reader io.ReadCloser, rootDir string) error
• type KubeConfig
  • func (kcfg *KubeConfig) GetClusterName() (string, error)
  • func (kcfg *KubeConfig) GetCurrentContext() string
• type ObjectWriter
  • func (w ObjectWriter) Write(result SearchResult) (string, error)
• type ResultWriter
  • func NewResultWriter(workdir, what string, restApi rest.Interface) (*ResultWriter, error)
  • func (w *ResultWriter) GetResultDir() string
  • func (w *ResultWriter) Write(ctx context.Context, searchResults []SearchResult) error
• type SearchParams
  • func NewSearchParams(p *starlarkstruct.Struct) SearchParams
  • func (sp SearchParams) ContainsContainer(container string) bool
  • func (sp SearchParams) ContainsGroup(group string) bool
  • func (sp SearchParams) ContainsKind(kind string) bool
  • func (sp SearchParams) ContainsName(name string) bool
  • func (sp SearchParams) ContainsVersion(version string) bool
• type SearchResult
  • func (sr SearchResult) ToStarlarkValue() *starlarkstruct.Struct

Constants

const BaseDirname = "kubecapture"

const (
	LegacyGroupName = "core"
)

Functions

func FetchBastionIpAddress

func FetchBastionIpAddress(clusterName, namespace, kubeConfigPath string) (string, error)

func FetchWorkloadConfig

func FetchWorkloadConfig(clusterName, clusterNamespace, mgmtKubeConfigPath string) (string, error)

FetchWorkloadConfig...

func GetNodeAddresses

func GetNodeAddresses(ctx context.Context, kubeconfigPath string, names, labels []string) ([]string, error)

Types

type Client

type Client struct {
	Client      dynamic.Interface
	Disco       discovery.DiscoveryInterface
	CoreRest    rest.Interface
	Mapper      meta.RESTMapper
	JsonPrinter printers.JSONPrinter
}

Client prepares and exposes a dynamic, discovery, and Rest clients

func New

func New(kubeconfig string, clusterContextOptions ...string) (*Client, error)

New returns a *Client built with the kubecontext file path and an optional (at most one) K8s CLI context name.

func (*Client) Search

func (k8sc *Client) Search(ctx context.Context, params SearchParams) ([]SearchResult, error)

type Config

type Config interface {
	GetClusterName() (string, error)
	GetCurrentContext() string
}

func LoadKubeCfg

func LoadKubeCfg(kubeConfigPath string) (Config, error)

type Container

type Container interface {
	Fetch(context.Context, rest.Interface) (io.ReadCloser, error)
	Write(io.ReadCloser, string) error
}

func GetContainers

func GetContainers(podItem unstructured.Unstructured) ([]Container, error)

type ContainerLogsImpl

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

func NewContainerLogger

func NewContainerLogger(namespace, podName string, container corev1.Container) ContainerLogsImpl

func (ContainerLogsImpl) Fetch

func (c ContainerLogsImpl) Fetch(ctx context.Context, restApi rest.Interface) (io.ReadCloser, error)

func (ContainerLogsImpl) Write

func (c ContainerLogsImpl) Write(reader io.ReadCloser, rootDir string) error

type KubeConfig

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

func (*KubeConfig) GetClusterName

func (kcfg *KubeConfig) GetClusterName() (string, error)

func (*KubeConfig) GetCurrentContext

func (kcfg *KubeConfig) GetCurrentContext() string

type ObjectWriter

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

func (ObjectWriter) Write

func (w ObjectWriter) Write(result SearchResult) (string, error)

type ResultWriter

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

func NewResultWriter

func NewResultWriter(workdir, what string, restApi rest.Interface) (*ResultWriter, error)

func (*ResultWriter) GetResultDir

func (w *ResultWriter) GetResultDir() string

func (*ResultWriter) Write

func (w *ResultWriter) Write(ctx context.Context, searchResults []SearchResult) error

type SearchParams

type SearchParams struct {
	Groups     []string
	Categories []string
	Kinds      []string
	Namespaces []string
	Versions   []string
	Names      []string
	Labels     []string
	Containers []string
}

func NewSearchParams

func NewSearchParams(p *starlarkstruct.Struct) SearchParams

TODO: Change this to accept a string dictionary instead

func (SearchParams) ContainsContainer

func (sp SearchParams) ContainsContainer(container string) bool

func (SearchParams) ContainsGroup

func (sp SearchParams) ContainsGroup(group string) bool

func (SearchParams) ContainsKind

func (sp SearchParams) ContainsKind(kind string) bool

func (SearchParams) ContainsName

func (sp SearchParams) ContainsName(name string) bool

func (SearchParams) ContainsVersion

func (sp SearchParams) ContainsVersion(version string) bool

type SearchResult

type SearchResult struct {
	ListKind             string
	ResourceName         string
	ResourceKind         string
	GroupVersionResource schema.GroupVersionResource
	List                 *unstructured.UnstructuredList
	Namespaced           bool
	Namespace            string
}

SearchResult is the object representation of the kubernetes objects returned by querying the API server

func (SearchResult) ToStarlarkValue

func (sr SearchResult) ToStarlarkValue() *starlarkstruct.Struct

ToStarlarkValue converts the SearchResult object to a starlark dictionary