kubernetes

Documentation

Index

• Constants
• type ClusterMetadata
• type ClusterMetadataChecker
• type StorageProvisioner
• type Tunnel
  • func NewTunnel(client rest.Interface, c *rest.Config, kind TunnelKind, ...) *Tunnel
  • func NewTunnelForConfig(c *rest.Config, kind TunnelKind, namespace, target, remotePort string) (*Tunnel, error)
  • func (t *Tunnel) Close()
  • func (t *Tunnel) ForwardPort(ctx context.Context) error
  • func (t *Tunnel) IsValidTunnelKind() bool
• type TunnelKind

Constants

const (
	// K8sCloudMicrok8s is the name used for microk8s k8s clouds.
	K8sCloudMicrok8s = "microk8s"

	// K8sCloudGCE is the name used for GCE k8s clouds(GKE, CDK).
	K8sCloudGCE = "gce"

	// K8sCloudAzure is the name used for Azure k8s clouds(AKS, CDK).
	K8sCloudAzure = "azure"

	// K8sCloudEC2 is the name used for AWS k8s clouds(EKS, CDK).
	K8sCloudEC2 = "ec2"

	// K8sCloudOpenStack is the name used for openstack k8s clouds(CDK).
	K8sCloudOpenStack = "openstack"

	// K8sCloudMAAS is the name used for MAAS k8s clouds(CDK).
	K8sCloudMAAS = "maas"

	// K8sCloudLXD is the name used for LXD k8s clouds(Kubernetes Core).
	K8sCloudLXD = "lxd"

	// K8sCloudOther is the name used for any other k8s cloud is not listed above.
	K8sCloudOther = "other"

	// Microk8sRegion is the single microk8s cloud region.
	Microk8sRegion = "localhost"

	// MicroK8sClusterName is the cluster named used by microk8s.
	MicroK8sClusterName = "microk8s-cluster"
)

const (
	TunnelKindPods     = TunnelKind("pods")
	TunnelKindServices = TunnelKind("services")
)

const (
	// ForwardPortTimeout is the duration for waiting for a pod to be ready.
	ForwardPortTimeout time.Duration = time.Minute * 10
)

Types

type ClusterMetadata

type ClusterMetadata struct {
	WorkloadStorageClass *storagev1.StorageClass
	Cloud                string
	Regions              set.Strings
}

ClusterMetadata defines metadata about a cluster.

type ClusterMetadataChecker

type ClusterMetadataChecker interface {
	// GetClusterMetadata returns metadata about host cloud and storage for the cluster.
	GetClusterMetadata(ctx context.Context, storageClass string) (result *ClusterMetadata, err error)
}

ClusterMetadataChecker provides an API to query cluster metadata.

type StorageProvisioner

type StorageProvisioner struct {
	Name              string
	Provisioner       string
	Parameters        map[string]string
	Namespace         string
	Model             string
	ReclaimPolicy     string
	VolumeBindingMode string
	IsDefault         bool
}

StorageProvisioner defines the a storage provisioner available on a cluster.

type Tunnel

type Tunnel struct {
	Kind      TunnelKind
	LocalPort string
	Namespace string
	Out       io.Writer

	RemotePort string

	Target string
	// contains filtered or unexported fields
}

Tunnel represents an ssh like tunnel to a Kubernetes Pod or Service

func NewTunnel

func NewTunnel(
	client rest.Interface,
	c *rest.Config,
	kind TunnelKind,
	namespace,
	target,
	remotePort string) *Tunnel

NewTunnel constructs a new kubernetes tunnel for the provided information

func NewTunnelForConfig

func NewTunnelForConfig(
	c *rest.Config,
	kind TunnelKind,
	namespace,
	target,
	remotePort string) (*Tunnel, error)

NewTunnelForConfig constructs a new tunnel from the provided rest config

func (*Tunnel) Close

func (t *Tunnel) Close()

Close disconnects a tunnel connection

func (*Tunnel) ForwardPort

func (t *Tunnel) ForwardPort(ctx context.Context) error

func (*Tunnel) IsValidTunnelKind

func (t *Tunnel) IsValidTunnelKind() bool

IsValidTunnelKind tests that the tunnel kind supplied to this tunnel is valid

type TunnelKind

type TunnelKind string