kubernetes

Documentation

Index

• func CheckPodExists(client *k8s.Clientset, namespace string, labelSelector map[string]string, ...) (bool, string)
• func Client() (*k8s.Clientset, error)
• func DaprClient() (scheme.Interface, error)
• func Expiry() (*time.Time, error)
• func ExportTrustChain(outputDir string) error
• func GetDefaultConfiguration() v1alpha1.Configuration
• func GetKubeConfigClient() (*rest.Config, *k8s.Clientset, error)
• func Init(config InitConfiguration) error
• func IsMTLSEnabled() (bool, error)
• func ListPods(client *k8s.Clientset, namespace string, labelSelector map[string]string) (*core_v1.PodList, error)
• func ListPodsInterface(client k8s.Interface, labelSelector map[string]string) (*core_v1.PodList, error)
• func Logs(appID, podName, namespace string) error
• func PrintComponents(name, outputFormat string) error
• func PrintConfigurations(name, outputFormat string) error
• func Uninstall(namespace string, timeout uint) error
• func Upgrade(conf UpgradeConfig) error
• type ComponentsOutput
• type InitConfiguration
• type ListOutput
  • func List() ([]ListOutput, error)
• type PortForward
  • func NewPortForward(config *rest.Config, namespace, deployName string, host string, ...) (*PortForward, error)
  • func (pf *PortForward) GetStop() <-chan struct{}
  • func (pf *PortForward) Init() error
  • func (pf *PortForward) Stop()
• type RunConfig
• type RunOutput
  • func Run(config *RunConfig) (*RunOutput, error)
• type StatusClient
  • func NewStatusClient() (*StatusClient, error)
  • func (s *StatusClient) Status() ([]StatusOutput, error)
• type StatusOutput
• type UpgradeConfig

Functions

func CheckPodExists

func CheckPodExists(client *k8s.Clientset, namespace string, labelSelector map[string]string, deployName string) (bool, string)

CheckPodExists returns a boolean representing the pod's existence and the namespace that the given pod resides in, or empty if not present in the given namespace.

func Client

func Client() (*k8s.Clientset, error)

Client returns a new Kubernetes client.

func DaprClient

func DaprClient() (scheme.Interface, error)

DaprClient returns a new Kubernetes Dapr client.

func Expiry

func Expiry() (*time.Time, error)

Expiry returns the expiry time for the root cert.

func ExportTrustChain

func ExportTrustChain(outputDir string) error

ExportTrustChain takes the root cert, issuer cert and issuer key from a k8s cluster and saves them in a given directory.

func GetDefaultConfiguration

func GetDefaultConfiguration() v1alpha1.Configuration

func GetKubeConfigClient

func GetKubeConfigClient() (*rest.Config, *k8s.Clientset, error)

GetKubeConfigClient returns the kubeconfig and the client created from the kubeconfig.

func Init

func Init(config InitConfiguration) error

Init deploys the Dapr operator using the supplied runtime version.

func IsMTLSEnabled

func IsMTLSEnabled() (bool, error)

func ListPods

func ListPods(client *k8s.Clientset, namespace string, labelSelector map[string]string) (*core_v1.PodList, error)

func ListPodsInterface

func ListPodsInterface(client k8s.Interface, labelSelector map[string]string) (*core_v1.PodList, error)

func Logs

func Logs(appID, podName, namespace string) error

Logs fetches Dapr sidecar logs from Kubernetes.

func PrintComponents

func PrintComponents(name, outputFormat string) error

PrintComponents prints all Dapr components.

func PrintConfigurations

func PrintConfigurations(name, outputFormat string) error

PrintConfigurations prints all Dapr configurations.

func Uninstall

func Uninstall(namespace string, timeout uint) error

Uninstall removes Dapr from a Kubernetes cluster.

func Upgrade

func Upgrade(conf UpgradeConfig) error

Types

type ComponentsOutput

type ComponentsOutput struct {
	Name    string `csv:"Name"`
	Type    string `csv:"Type"`
	Version string `csv:"VERSION"`
	Scopes  string `csv:"SCOPES"`
	Created string `csv:"CREATED"`
	Age     string `csv:"AGE"`
}

ComponentsOutput represent a Dapr component.

type InitConfiguration

type InitConfiguration struct {
	Version    string
	Namespace  string
	EnableMTLS bool
	EnableHA   bool
	Args       []string
	Wait       bool
	Timeout    uint
}

type ListOutput

type ListOutput struct {
	AppID   string `csv:"APP ID"`
	AppPort string `csv:"APP PORT"`
	Age     string `csv:"AGE"`
	Created string `csv:"CREATED"`
}

ListOutput represents the application ID, application port and creation time.

func List

func List() ([]ListOutput, error)

List outputs all the applications.

type PortForward

type PortForward struct {
	Config     *rest.Config
	Method     string
	URL        *url.URL
	Host       string
	LocalPort  int
	RemotePort int
	EmitLogs   bool
	StopCh     chan struct{}
	ReadyCh    chan struct{}
}

PortForward provides a port-forward connection in a kubernetes cluster.

func NewPortForward

func NewPortForward(
	config *rest.Config,
	namespace, deployName string,
	host string, localPort, remotePort int,
	emitLogs bool,
) (*PortForward, error)

NewPortForward returns an instance of PortForward struct that can be used for establishing port-forwarding connection to a pod in kubernetes cluster, specified by namespace and deployName.

func (*PortForward) GetStop

func (pf *PortForward) GetStop() <-chan struct{}

GetStop returns StopCh for a PortForward instance. Receiving on StopCh will block until the port forwarding stops.

func (*PortForward) Init

func (pf *PortForward) Init() error

Init creates and runs a port-forward connection. This function blocks until connection is established. Note: Caller should call Stop() to finish the connection.

func (*PortForward) Stop

func (pf *PortForward) Stop()

Stop terminates port-forwarding connection.

type RunConfig

type RunConfig struct {
	AppID         string
	AppPort       int
	HTTPPort      int
	GRPCPort      int
	CodeDirectory string
	Arguments     []string
	Image         string
}

RunConfig represents the application configuration parameters.

type RunOutput

type RunOutput struct {
	Message string
}

RunOutput represents the run output.

func Run

func Run(config *RunConfig) (*RunOutput, error)

Run executes the application based on the run configuration.

type StatusClient

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

func NewStatusClient

func NewStatusClient() (*StatusClient, error)

Create a new k8s client for status commands.

func (*StatusClient) Status

func (s *StatusClient) Status() ([]StatusOutput, error)

List status for Dapr resources.

type StatusOutput

type StatusOutput struct {
	Name      string `csv:"NAME"`
	Namespace string `csv:"NAMESPACE"`
	Healthy   string `csv:"HEALTHY"`
	Status    string `csv:"STATUS"`
	Replicas  int    `csv:"REPLICAS"`
	Version   string `csv:"VERSION"`
	Age       string `csv:"AGE"`
	Created   string `csv:"CREATED"`
}

StatusOutput represents the status of a named Dapr resource.

type UpgradeConfig

type UpgradeConfig struct {
	RuntimeVersion string
	Args           []string
	Timeout        uint
}