k8sapi

Documentation

Index

• func DeploymentImpl(o Object) (*apps.Deployment, bool)
• func GetAppProto(ctx context.Context, aps AppProtocolStrategy, p *core.ServicePort) string
• func GetClusterID(ctx context.Context) (clusterID string, err error)
• func GetK8sInterface(ctx context.Context) kubernetes.Interface
• func GetPort(cn *core.Container, portName string) (*core.ContainerPort, error)
• func ObjErrorf(o Object, format string, args ...interface{}) error
• func PodImpl(o Object) (*core.Pod, bool)
• func ReplicaSetImpl(o Object) (*apps.ReplicaSet, bool)
• func ServiceImpl(o Object) (*core.Service, bool)
• func StatefulSetImpl(o Object) (*apps.StatefulSet, bool)
• func WithK8sInterface(ctx context.Context, ki kubernetes.Interface) context.Context
• type AppProtocolStrategy
  • func NewAppProtocolStrategy(s string) (AppProtocolStrategy, error)
  • func (aps *AppProtocolStrategy) EnvDecode(val string) (err error)
  • func (aps AppProtocolStrategy) MarshalYAML() (interface{}, error)
  • func (aps AppProtocolStrategy) String() string
  • func (aps *AppProtocolStrategy) UnmarshalYAML(node *yaml.Node) (err error)
• type Object
  • func GetPod(c context.Context, name, namespace string) (Object, error)
  • func GetService(c context.Context, name, namespace string) (Object, error)
  • func Pod(d *core.Pod) Object
  • func Pods(c context.Context, namespace string) ([]Object, error)
  • func Service(d *core.Service) Object
  • func Services(c context.Context, namespace string) ([]Object, error)
• type Workload
  • func Deployment(d *apps.Deployment) Workload
  • func Deployments(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)
  • func GetDeployment(c context.Context, name, namespace string) (Workload, error)
  • func GetReplicaSet(c context.Context, name, namespace string) (Workload, error)
  • func GetStatefulSet(c context.Context, name, namespace string) (Workload, error)
  • func GetWorkload(c context.Context, name, namespace, workloadKind string) (obj Workload, err error)
  • func ReplicaSet(d *apps.ReplicaSet) Workload
  • func ReplicaSets(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)
  • func StatefulSet(d *apps.StatefulSet) Workload
  • func StatefulSets(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)
  • func WrapWorkload(workload runtime.Object) (Workload, error)

Functions

func DeploymentImpl

func DeploymentImpl(o Object) (*apps.Deployment, bool)

DeploymentImpl casts the given Object as an *apps.Deployment and returns it together with a status flag indicating whether the cast was possible

func GetAppProto

func GetAppProto(ctx context.Context, aps AppProtocolStrategy, p *core.ServicePort) string

GetAppProto determines the application protocol of the given ServicePort. The given AppProtocolStrategy used if the port's appProtocol attribute is unset.

func GetClusterID

func GetClusterID(ctx context.Context) (clusterID string, err error)

GetClusterID returns the cluster ID for the given cluster. If there is an error, it still returns a usable ID along with the error.

func GetK8sInterface

func GetK8sInterface(ctx context.Context) kubernetes.Interface

func GetPort

func GetPort(cn *core.Container, portName string) (*core.ContainerPort, error)

GetPort finds a port with the given name and returns it.

func ObjErrorf

func ObjErrorf(o Object, format string, args ...interface{}) error

func PodImpl

func PodImpl(o Object) (*core.Pod, bool)

PodImpl casts the given Object as an *core.Pod and returns it together with a status flag indicating whether the cast was possible

func ReplicaSetImpl

func ReplicaSetImpl(o Object) (*apps.ReplicaSet, bool)

ReplicaSetImpl casts the given Object as an *apps.ReplicaSet and returns it together with a status flag indicating whether the cast was possible

func ServiceImpl

func ServiceImpl(o Object) (*core.Service, bool)

ServiceImpl casts the given Object as an *core.Service and returns it together with a status flag indicating whether the cast was possible

func StatefulSetImpl

func StatefulSetImpl(o Object) (*apps.StatefulSet, bool)

StatefulSetImpl casts the given Object as an *apps.StatefulSet and returns it together with a status flag indicating whether the cast was possible

func WithK8sInterface

func WithK8sInterface(ctx context.Context, ki kubernetes.Interface) context.Context

Types

type AppProtocolStrategy

type AppProtocolStrategy int

AppProtocolStrategy specifies how the application protocol for a service port is determined in case the service.spec.ports.appProtocol is not set.

const (
	// Http2Probe means never guess. Choose HTTP/1.1 or HTTP/2 by probing (this is the default behavior)
	Http2Probe AppProtocolStrategy = iota

	// PortName means trust educated guess based on port name when appProtocol is missing and perform a http2 probe
	// if no such guess can be made.
	PortName

	// Http means just assume HTTP/1.1
	Http

	// Http2 means just assume HTTP/2
	Http2
)

func NewAppProtocolStrategy

func NewAppProtocolStrategy(s string) (AppProtocolStrategy, error)

func (*AppProtocolStrategy) EnvDecode

func (aps *AppProtocolStrategy) EnvDecode(val string) (err error)

func (AppProtocolStrategy) MarshalYAML

func (aps AppProtocolStrategy) MarshalYAML() (interface{}, error)

func (AppProtocolStrategy) String

func (aps AppProtocolStrategy) String() string

func (*AppProtocolStrategy) UnmarshalYAML

func (aps *AppProtocolStrategy) UnmarshalYAML(node *yaml.Node) (err error)

type Object

type Object interface {
	runtime.Object
	meta.Object
	GetAnnotations() map[string]string
	GetKind() string
	Delete(context.Context) error
	Refresh(context.Context) error
	Update(context.Context) error
	Patch(context.Context, types.PatchType, []byte, ...string) error
}

func GetPod

func GetPod(c context.Context, name, namespace string) (Object, error)

func GetService

func GetService(c context.Context, name, namespace string) (Object, error)

func Pod

func Pod(d *core.Pod) Object

func Pods

func Pods(c context.Context, namespace string) ([]Object, error)

Pods returns all pods found in the given Namespace

func Service

func Service(d *core.Service) Object

func Services

func Services(c context.Context, namespace string) ([]Object, error)

Services returns all services found in the given Namespace

type Workload

type Workload interface {
	Object
	GetPodTemplate() *core.PodTemplateSpec
	Replicas() int
	Updated(int64) bool
}

func Deployment

func Deployment(d *apps.Deployment) Workload

func Deployments

func Deployments(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)

Deployments returns all deployments found in the given Namespace

func GetDeployment

func GetDeployment(c context.Context, name, namespace string) (Workload, error)

func GetReplicaSet

func GetReplicaSet(c context.Context, name, namespace string) (Workload, error)

func GetStatefulSet

func GetStatefulSet(c context.Context, name, namespace string) (Workload, error)

func GetWorkload

func GetWorkload(c context.Context, name, namespace, workloadKind string) (obj Workload, err error)

GetWorkload returns a workload for the given name, namespace, and workloadKind. The workloadKind is optional. A search is performed in the following order if it is empty:

1. Deployments
2. ReplicaSets
3. StatefulSets

The first match is returned.

func ReplicaSet

func ReplicaSet(d *apps.ReplicaSet) Workload

func ReplicaSets

func ReplicaSets(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)

ReplicaSets returns all replica sets found in the given Namespace

func StatefulSet

func StatefulSet(d *apps.StatefulSet) Workload

func StatefulSets

func StatefulSets(c context.Context, namespace string, labelSelector labels.Set) ([]Workload, error)

StatefulSets returns all stateful sets found in the given Namespace

func WrapWorkload

func WrapWorkload(workload runtime.Object) (Workload, error)