kudo

Documentation

Index

• type Client
  • func NewClient(namespace, kubeConfigPath string) (*Client, error)
  • func (c *Client) AnyOperatorVersionExistsInCluster(operator string, namespace string) bool
  • func (c *Client) CRDsInstalled(namespace string) 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(name, namespace, version, instanceName string) (bool, error)
  • func (c *Client) OperatorExistsInCluster(name, namespace string) bool
  • func (c *Client) OperatorVersionInClusterOutOfSync(operator, mostRecentVersion, namespace string) bool

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 (*Client) AnyOperatorVersionExistsInCluster

func (c *Client) AnyOperatorVersionExistsInCluster(operator string, namespace string) bool

AnyOperatorVersionExistsInCluster checks if any OperatorVersion object matches to the given Operator name in the cluster

func (*Client) CRDsInstalled

func (c *Client) CRDsInstalled(namespace string) error

CRDsInstalled checks for essential CRDs of KUDO to be installed

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(name, 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" operator: kafka

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

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) OperatorVersionInClusterOutOfSync

func (c *Client) OperatorVersionInClusterOutOfSync(operator, mostRecentVersion, namespace string) bool

OperatorVersionInClusterOutOfSync checks if any OperatorVersion object matches a given Operator name and if not it returns false. False means that for the given Operator the most recent official OperatorVersion is not installed in the cluster or an error occurred.