kudo

Documentation

Index

• type Client
  • func NewKudoClient() (*Client, error)
  • func (c *Client) AnyFrameworkVersionExistsInCluster(framework string) bool
  • func (c *Client) AnyInstanceExistsInCluster(name, version string) bool
  • func (c *Client) CRDsInstalled() error
  • func (c *Client) FrameworkExistsInCluster(name string) bool
  • func (c *Client) FrameworkVersionInClusterOutOfSync(framework, mostRecentVersion string) bool
  • func (c *Client) InstallFrameworkObjToCluster(obj *v1alpha1.Framework) (*v1alpha1.Framework, error)
  • func (c *Client) InstallFrameworkVersionObjToCluster(obj *v1alpha1.FrameworkVersion) (*v1alpha1.FrameworkVersion, error)
  • func (c *Client) InstallInstanceObjToCluster(obj *v1alpha1.Instance) (*v1alpha1.Instance, error)

Types

type Client

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

Client is a KUDO Client providing access to a clientset

func NewKudoClient

func NewKudoClient() (*Client, error)

NewKudoClient creates new KUDO Client

func (*Client) AnyFrameworkVersionExistsInCluster

func (c *Client) AnyFrameworkVersionExistsInCluster(framework string) bool

AnyFrameworkVersionExistsInCluster checks if any FrameworkVersion object matches to the given Framework name in the cluster

func (*Client) AnyInstanceExistsInCluster

func (c *Client) AnyInstanceExistsInCluster(name, version string) bool

AnyInstanceExistsInCluster checks if any FrameworkVersion object matches to the given Framework name in the cluster. An Instance has two identifiers:

1. Spec.FrameworkVersion.Name spec: frameworkVersion: 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" framework: kafka

This function also just returns true if the Instance matches a specific FrameworkVersion of a Framework

func (*Client) CRDsInstalled

func (c *Client) CRDsInstalled() error

CRDsInstalled checks for essential CRDs of KUDO to be installed

func (*Client) FrameworkExistsInCluster

func (c *Client) FrameworkExistsInCluster(name string) bool

FrameworkExistsInCluster checks if a given Framework object is installed on the current k8s cluster

func (*Client) FrameworkVersionInClusterOutOfSync

func (c *Client) FrameworkVersionInClusterOutOfSync(framework, mostRecentVersion string) bool

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

func (*Client) InstallFrameworkObjToCluster

func (c *Client) InstallFrameworkObjToCluster(obj *v1alpha1.Framework) (*v1alpha1.Framework, error)

InstallFrameworkObjToCluster expects a valid Framework obj to install

func (*Client) InstallFrameworkVersionObjToCluster

func (c *Client) InstallFrameworkVersionObjToCluster(obj *v1alpha1.FrameworkVersion) (*v1alpha1.FrameworkVersion, error)

InstallFrameworkVersionObjToCluster expects a valid Framework obj to install

func (*Client) InstallInstanceObjToCluster

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

InstallInstanceObjToCluster expects a valid Instance obj to install