kubernetes

Documentation

Overview

Package kubernetes provides a client for the Kubernetes runtime including creating, starting, stopping, and retrieving container information.

Index

• Constants
• func IsAvailable() bool
• type Client
  • func NewClient(_ context.Context) (*Client, error)
  • func NewClientWithConfig(clientset kubernetes.Interface, config *rest.Config) *Client
  • func NewClientWithConfigAndPlatformDetector(clientset kubernetes.Interface, config *rest.Config, ...) *Client
  • func (c *Client) AttachToWorkload(ctx context.Context, workloadName string) (io.WriteCloser, io.ReadCloser, error)
  • func (c *Client) DeployWorkload(ctx context.Context, image string, containerName string, command []string, ...) (int, error)
  • func (c *Client) GetWorkloadInfo(ctx context.Context, workloadName string) (runtime.ContainerInfo, error)
  • func (c *Client) GetWorkloadLogs(ctx context.Context, workloadName string, follow bool) (string, error)
  • func (c *Client) IsRunning(ctx context.Context) error
  • func (c *Client) IsWorkloadRunning(ctx context.Context, workloadName string) (bool, error)
  • func (c *Client) ListWorkloads(ctx context.Context) ([]runtime.ContainerInfo, error)
  • func (c *Client) RemoveWorkload(ctx context.Context, workloadName string) error
  • func (*Client) StopWorkload(_ context.Context, _ string) error
• type DefaultPlatformDetector
  • func (d *DefaultPlatformDetector) DetectPlatform(config *rest.Config) (Platform, error)
• type Platform
  • func (p Platform) String() string
• type PlatformDetector
  • func NewDefaultPlatformDetector() PlatformDetector

Constants

const RuntimeName = "kubernetes"

RuntimeName is the name identifier for the Kubernetes runtime

const (
	// UnknownStatus represents an unknown container status
	UnknownStatus = "unknown"
)

Constants for container status

Functions

func IsAvailable

func IsAvailable() bool

IsAvailable checks if kubernetes is available

Types

type Client

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

Client implements the Deployer interface for container operations

func NewClient

func NewClient(_ context.Context) (*Client, error)

NewClient creates a new container client

func NewClientWithConfig

func NewClientWithConfig(clientset kubernetes.Interface, config *rest.Config) *Client

NewClientWithConfig creates a new container client with a provided config This is primarily used for testing with fake clients

func NewClientWithConfigAndPlatformDetector

func NewClientWithConfigAndPlatformDetector(
	clientset kubernetes.Interface,
	config *rest.Config,
	platformDetector PlatformDetector,
) *Client

NewClientWithConfigAndPlatformDetector creates a new container client with a provided config and platform detector This is primarily used for testing with fake clients and mock platform detectors

func (*Client) AttachToWorkload

func (c *Client) AttachToWorkload(ctx context.Context, workloadName string) (io.WriteCloser, io.ReadCloser, error)

AttachToWorkload implements runtime.Runtime.

func (*Client) DeployWorkload

func (c *Client) DeployWorkload(ctx context.Context,
	image string,
	containerName string,
	command []string,
	envVars map[string]string,
	containerLabels map[string]string,
	_ *permissions.Profile,
	transportType string,
	options *runtime.DeployWorkloadOptions,
	_ bool,
) (int, error)

DeployWorkload implements runtime.Runtime.

func (*Client) GetWorkloadInfo

func (c *Client) GetWorkloadInfo(ctx context.Context, workloadName string) (runtime.ContainerInfo, error)

GetWorkloadInfo implements runtime.Runtime.

func (*Client) GetWorkloadLogs

func (c *Client) GetWorkloadLogs(ctx context.Context, workloadName string, follow bool) (string, error)

GetWorkloadLogs implements runtime.Runtime.

func (*Client) IsRunning

func (c *Client) IsRunning(ctx context.Context) error

IsRunning checks the health of the container runtime. This is used to verify that the runtime is operational and can manage workloads.

func (*Client) IsWorkloadRunning

func (c *Client) IsWorkloadRunning(ctx context.Context, workloadName string) (bool, error)

IsWorkloadRunning implements runtime.Runtime.

func (*Client) ListWorkloads

func (c *Client) ListWorkloads(ctx context.Context) ([]runtime.ContainerInfo, error)

ListWorkloads implements runtime.Runtime.

func (*Client) RemoveWorkload

func (c *Client) RemoveWorkload(ctx context.Context, workloadName string) error

RemoveWorkload implements runtime.Runtime.

func (*Client) StopWorkload

func (*Client) StopWorkload(_ context.Context, _ string) error

StopWorkload implements runtime.Runtime.

type DefaultPlatformDetector

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

DefaultPlatformDetector implements PlatformDetector using the existing OpenShift detection logic

func (*DefaultPlatformDetector) DetectPlatform

func (d *DefaultPlatformDetector) DetectPlatform(config *rest.Config) (Platform, error)

DetectPlatform implements the PlatformDetector interface

type Platform

type Platform int

Platform represents the Kubernetes platform type

const (
	// PlatformKubernetes represents standard Kubernetes
	PlatformKubernetes Platform = iota
	// PlatformOpenShift represents OpenShift
	PlatformOpenShift
)

func (Platform) String

func (p Platform) String() string

String returns the string representation of the Platform

type PlatformDetector

type PlatformDetector interface {
	DetectPlatform(config *rest.Config) (Platform, error)
}

PlatformDetector defines the interface for detecting the Kubernetes platform type

func NewDefaultPlatformDetector

func NewDefaultPlatformDetector() PlatformDetector

NewDefaultPlatformDetector creates a new DefaultPlatformDetector