katibclient

Documentation

Index

• type Client
  • func NewClient(options client.Options) (Client, error)
  • func NewWithGivenClient(c client.Client) Client
• type KatibClient
  • func (k *KatibClient) CreateRuntimeObject(object client.Object) error
  • func (k *KatibClient) DeleteRuntimeObject(object client.Object) error
  • func (k *KatibClient) GetClient() client.Client
  • func (k *KatibClient) GetConfigMap(name string, namespace ...string) (map[string]string, error)
  • func (k *KatibClient) GetExperiment(name string, namespace ...string) (*experimentsv1beta1.Experiment, error)
  • func (k *KatibClient) GetExperimentList(namespace ...string) (*experimentsv1beta1.ExperimentList, error)
  • func (k *KatibClient) GetNamespaceList() (*apiv1.NamespaceList, error)
  • func (k *KatibClient) GetSuggestion(name string, namespace ...string) (*suggestionsv1beta1.Suggestion, error)
  • func (k *KatibClient) GetTrial(name string, namespace ...string) (*trialsv1beta1.Trial, error)
  • func (k *KatibClient) GetTrialList(name string, namespace ...string) (*trialsv1beta1.TrialList, error)
  • func (k *KatibClient) GetTrialTemplates(namespace ...string) (*apiv1.ConfigMapList, error)
  • func (k *KatibClient) InjectClient(c client.Client)
  • func (k *KatibClient) UpdateRuntimeObject(object client.Object) error

Types

type Client

type Client interface {
	InjectClient(c client.Client)
	GetClient() client.Client
	GetExperimentList(namespace ...string) (*experimentsv1beta1.ExperimentList, error)
	GetExperiment(name string, namespace ...string) (*experimentsv1beta1.Experiment, error)
	GetConfigMap(name string, namespace ...string) (map[string]string, error)
	GetTrial(name string, namespace ...string) (*trialsv1beta1.Trial, error)
	GetTrialList(name string, namespace ...string) (*trialsv1beta1.TrialList, error)
	GetTrialTemplates(namespace ...string) (*apiv1.ConfigMapList, error)
	GetSuggestion(name string, namespace ...string) (*suggestionsv1beta1.Suggestion, error)
	GetNamespaceList() (*apiv1.NamespaceList, error)
	CreateRuntimeObject(object client.Object) error
	DeleteRuntimeObject(object client.Object) error
	UpdateRuntimeObject(object client.Object) error
}

func NewClient

func NewClient(options client.Options) (Client, error)

func NewWithGivenClient

func NewWithGivenClient(c client.Client) Client

type KatibClient

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

func (*KatibClient) CreateRuntimeObject

func (k *KatibClient) CreateRuntimeObject(object client.Object) error

CreateRuntimeObject creates the given runtime object in Kubernetes cluster.

func (*KatibClient) DeleteRuntimeObject

func (k *KatibClient) DeleteRuntimeObject(object client.Object) error

DeleteRuntimeObject deletes the given runtime object in Kubernetes cluster.

func (*KatibClient) GetClient

func (k *KatibClient) GetClient() client.Client

func (*KatibClient) GetConfigMap

func (k *KatibClient) GetConfigMap(name string, namespace ...string) (map[string]string, error)

GetConfigMap returns the configmap for the given name and namespace.

func (*KatibClient) GetExperiment

func (k *KatibClient) GetExperiment(name string, namespace ...string) (*experimentsv1beta1.Experiment, error)

func (*KatibClient) GetExperimentList

func (k *KatibClient) GetExperimentList(namespace ...string) (*experimentsv1beta1.ExperimentList, error)

func (*KatibClient) GetNamespaceList

func (k *KatibClient) GetNamespaceList() (*apiv1.NamespaceList, error)

func (*KatibClient) GetSuggestion

func (k *KatibClient) GetSuggestion(name string, namespace ...string) (
	*suggestionsv1beta1.Suggestion, error)

GetSuggestion returns the Suggestion CR for the given name and namespace

func (*KatibClient) GetTrial

func (k *KatibClient) GetTrial(name string, namespace ...string) (*trialsv1beta1.Trial, error)

GetTrial returns the Trial for the given name and namespace

func (*KatibClient) GetTrialList

func (k *KatibClient) GetTrialList(name string, namespace ...string) (*trialsv1beta1.TrialList, error)

func (*KatibClient) GetTrialTemplates

func (k *KatibClient) GetTrialTemplates(namespace ...string) (*apiv1.ConfigMapList, error)

GetTrialTemplates returns all trial templates from the given namespace

func (*KatibClient) InjectClient

func (k *KatibClient) InjectClient(c client.Client)

func (*KatibClient) UpdateRuntimeObject

func (k *KatibClient) UpdateRuntimeObject(object client.Object) error

UpdateRuntimeObject updates the given runtime object in Kubernetes cluster.