kudo

Documentation

Index

• type Client
  • func NewClient(namespace, kubeConfigPath string) (*Client, error)
  • func NewClientFromK8s(client versioned.Interface) *Client
  • func (c *Client) GetInstance(name, namespace string) (*v1alpha1.Instance, error)
  • func (c *Client) GetOperatorVersion(name, namespace string) (*v1alpha1.OperatorVersion, error)
  • func (c *Client) InstallInstanceObjToCluster(obj *v1alpha1.Instance, namespace string) (*v1alpha1.Instance, error)
  • func (c *Client) InstallOperatorObjToCluster(obj *v1alpha1.Operator, namespace string) (*v1alpha1.Operator, error)
  • func (c *Client) InstallOperatorVersionObjToCluster(obj *v1alpha1.OperatorVersion, namespace string) (*v1alpha1.OperatorVersion, error)
  • func (c *Client) InstanceExistsInCluster(operatorName, namespace, version, instanceName string) (bool, error)
  • func (c *Client) ListInstances(namespace string) ([]string, error)
  • func (c *Client) OperatorExistsInCluster(name, namespace string) bool
  • func (c *Client) OperatorVersionsInstalled(operatorName, namespace string) ([]string, error)
  • func (c *Client) UpdateInstance(instanceName, namespace string, operatorVersionName *string, ...) error
  • func (c *Client) ValidateServerForOperator(operator *v1alpha1.Operator) error

Types

type Client

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

Client is a KUDO Client providing access to a clientset

func NewClient

func NewClient(namespace, kubeConfigPath string) (*Client, error)

NewClient creates new KUDO Client

func NewClientFromK8s

func NewClientFromK8s(client versioned.Interface) *Client

NewClientFromK8s creates KUDO client from kubernetes client interface

func (*Client) GetInstance

func (c *Client) GetInstance(name, namespace string) (*v1alpha1.Instance, error)

GetInstance queries kubernetes api for instance of given name in given namespace returns error for error conditions. Instance not found is not considered an error and will result in 'nil, nil'

func (*Client) GetOperatorVersion

func (c *Client) GetOperatorVersion(name, namespace string) (*v1alpha1.OperatorVersion, error)

GetOperatorVersion queries kubernetes api for operatorversion of given name in given namespace returns error for all other errors that not found, not found is treated as result being 'nil, nil'

func (*Client) InstallInstanceObjToCluster

func (c *Client) InstallInstanceObjToCluster(obj *v1alpha1.Instance, namespace string) (*v1alpha1.Instance, error)

InstallInstanceObjToCluster expects a valid Instance obj to install

func (*Client) InstallOperatorObjToCluster

func (c *Client) InstallOperatorObjToCluster(obj *v1alpha1.Operator, namespace string) (*v1alpha1.Operator, error)

InstallOperatorObjToCluster expects a valid Operator obj to install

func (*Client) InstallOperatorVersionObjToCluster

func (c *Client) InstallOperatorVersionObjToCluster(obj *v1alpha1.OperatorVersion, namespace string) (*v1alpha1.OperatorVersion, error)

InstallOperatorVersionObjToCluster expects a valid Operator obj to install

func (*Client) InstanceExistsInCluster

func (c *Client) InstanceExistsInCluster(operatorName, namespace, version, instanceName string) (bool, error)

InstanceExistsInCluster checks if any OperatorVersion object matches to the given Operator name in the cluster. An Instance has two identifiers:

1. Spec.OperatorVersion.Name spec: operatorVersion: name: kafka-2.11-2.4.0
2. LabelSelector metadata: creationTimestamp: "2019-02-28T14:39:20Z" generation: 1 labels: controller-tools.k8s.io: "1.0" kudo.dev/operator: kafka

This function also just returns true if the Instance matches a specific OperatorVersion of an Operator

func (*Client) ListInstances

func (c *Client) ListInstances(namespace string) ([]string, error)

ListInstances lists all instances of given operator installed in the cluster in a given ns

func (*Client) OperatorExistsInCluster

func (c *Client) OperatorExistsInCluster(name, namespace string) bool

OperatorExistsInCluster checks if a given Operator object is installed on the current k8s cluster

func (*Client) OperatorVersionsInstalled

func (c *Client) OperatorVersionsInstalled(operatorName, namespace string) ([]string, error)

OperatorVersionsInstalled lists all the versions of given operator installed in the cluster in given ns

func (*Client) UpdateInstance

func (c *Client) UpdateInstance(instanceName, namespace string, operatorVersionName *string, parameters map[string]string) error

UpdateInstance updates operatorversion on instance

func (*Client) ValidateServerForOperator

func (c *Client) ValidateServerForOperator(operator *v1alpha1.Operator) error

ValidateServerForOperator validates that the k8s server version and kudo version are valid for operator error message will provide detail of failure, otherwise nil