kube

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, config Config) (*Client, error)
  • func (c Client) GetCRDDetails(ctx context.Context, namespace string, name string) (*unstructured.Unstructured, error)
  • func (c Client) GetDeploymentDetails(ctx context.Context, namespace string, name string) (Deployment, error)
  • func (c Client) GetJobProcessor(j *job.Job) (*job.Processor, error)
  • func (c Client) GetPodDetails(ctx context.Context, namespace string, labelSelectors map[string]string, ...) ([]Pod, error)
  • func (c Client) RunJob(ctx context.Context, namespace, name string, image string, cmd []string, ...) (*batchv1.Job, error)
  • func (c Client) StreamLogs(ctx context.Context, namespace string, filter map[string]string) (<-chan LogChunk, error)
• type Config
  • func DefaultClientConfig() Config
  • func (conf *Config) RESTConfig(ctx context.Context) (*rest.Config, error)
  • func (conf *Config) Sanitise() error
  • func (conf *Config) StreamingConfig(ctx context.Context) (*rest.Config, error)
• type Deployment
• type FlinkDeploymentStatus
• type HelmConfig
• type LogChunk
• type LogOptions
• type Pod

Variables

var (
	ErrJobExecutionFailed = errors.ErrInternal.WithMsgf("job execution failed")
	ErrJobCreationFailed  = errors.ErrInternal.WithMsgf("job creation failed")
	ErrJobNotFound        = errors.ErrNotFound.WithMsgf("job not found")
)

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, config Config) (*Client, error)

func (Client) GetCRDDetails

func (c Client) GetCRDDetails(ctx context.Context, namespace string, name string) (*unstructured.Unstructured, error)

func (Client) GetDeploymentDetails

func (c Client) GetDeploymentDetails(ctx context.Context, namespace string, name string) (Deployment, error)

func (Client) GetJobProcessor

func (c Client) GetJobProcessor(j *job.Job) (*job.Processor, error)

func (Client) GetPodDetails

func (c Client) GetPodDetails(ctx context.Context, namespace string, labelSelectors map[string]string, allow func(pod corev1.Pod) bool) ([]Pod, error)

func (Client) RunJob

func (c Client) RunJob(ctx context.Context, namespace, name string, image string, cmd []string, retries int32, wait bool) (*batchv1.Job, error)

func (Client) StreamLogs

func (c Client) StreamLogs(ctx context.Context, namespace string, filter map[string]string) (<-chan LogChunk, error)

type Config

type Config struct {
	// Host - The hostname (in form of URI) of Kubernetes master.
	Host string `json:"host"`

	Timeout time.Duration `json:"timeout" default:"100ms"`

	// Token - Token to authenticate with static oauth2 access token
	Token string `json:"token"`

	// Insecure - Whether server should be accessed without verifying the TLS certificate.
	Insecure bool `json:"insecure" default:"false"`

	// ClientKey - PEM-encoded client key for TLS authentication.
	ClientKey string `json:"client_key"`

	// ClientCertificate - PEM-encoded client certificate for TLS authentication.
	ClientCertificate string `json:"client_certificate"`

	// ClusterCACertificate - PEM-encoded root certificates bundle for TLS authentication.
	ClusterCACertificate string `json:"cluster_ca_certificate"`

	// ProviderType indicates which provider that hos k8s: gke, eks, etc...
	// If it is `gke`, entropy will fetch auth from the default source
	// left it empty if token or client key will be used
	ProviderType string `json:"provider_type"`

	// Namespace defines where the resources that depend on this kube resource deployed to
	// namespace is optional, if it is being defined, it will force all resources that depend
	// on this kube resource to be deployed to the defined namespace
	Namespace string `json:"namespace"`

	HelmConfig HelmConfig `json:"helm_config"`

	// Maximum burst for throttle.
	Burst int `json:"burst" default:"10"`

	// QPS indicates the maximum QPS to the master from this client.
	QPS float32 `json:"qps" default:"5"`
}

func DefaultClientConfig

func DefaultClientConfig() Config

func (*Config) RESTConfig

func (conf *Config) RESTConfig(ctx context.Context) (*rest.Config, error)

func (*Config) Sanitise

func (conf *Config) Sanitise() error

func (*Config) StreamingConfig

func (conf *Config) StreamingConfig(ctx context.Context) (*rest.Config, error)

type Deployment

type Deployment struct {
	Name                string              `json:"name"`
	Paused              bool                `json:"paused"`
	ReadyReplicas       int                 `json:"ready_replicas"`
	AvailableReplicas   int                 `json:"available_replicas"`
	UnavailableReplicas int                 `json:"unavailable_replicas"`
	Conditions          []map[string]string `json:"conditions"`
}

type FlinkDeploymentStatus

type FlinkDeploymentStatus struct {
	State          string `json:"state"`
	JMDeployStatus string `json:"jm_deploy_status"`
	JobStatus      string `json:"job_status"`
	Reconciliation string `json:"reconciliation"`
}

type HelmConfig

type HelmConfig struct {
	MaxHistory int `json:"max_history" default:"256"`
}

type LogChunk

type LogChunk struct {
	Data   []byte
	Labels map[string]string
}

type LogOptions

type LogOptions struct {
	App          string `mapstructure:"app"`
	Pod          string `mapstructure:"pod"`
	Container    string `mapstructure:"container"`
	Follow       string `mapstructure:"follow"`
	Previous     string `mapstructure:"previous"`
	SinceSeconds string `mapstructure:"since_seconds"`
	Timestamps   string `mapstructure:"timestamps"`
	TailLines    string `mapstructure:"tail_lines"`
}

type Pod

type Pod struct {
	Name       string   `json:"name"`
	Containers []string `json:"containers"`
	Status     string   `json:"status"`
}