v1beta1

Documentation

Overview

Package v1beta1 is the v1beta1 version of the API. +groupName=viewer.kubeflow.org

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type TensorboardSpec
  • func (in *TensorboardSpec) DeepCopy() *TensorboardSpec
  • func (in *TensorboardSpec) DeepCopyInto(out *TensorboardSpec)
• type Viewer
  • func (in *Viewer) DeepCopy() *Viewer
  • func (in *Viewer) DeepCopyInto(out *Viewer)
  • func (in *Viewer) DeepCopyObject() runtime.Object
• type ViewerList
  • func (in *ViewerList) DeepCopy() *ViewerList
  • func (in *ViewerList) DeepCopyInto(out *ViewerList)
  • func (in *ViewerList) DeepCopyObject() runtime.Object
• type ViewerSpec
  • func (in *ViewerSpec) DeepCopy() *ViewerSpec
  • func (in *ViewerSpec) DeepCopyInto(out *ViewerSpec)
• type ViewerType

Variables

var (
	// SchemeBuilder is a runtime scheme builder for adding viewer types to the
	// scheme.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a method for adding viewer type schemes to any passed in
	// runtime scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: viewer.GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type TensorboardSpec

type TensorboardSpec struct {
	// LogDir is the location of the log directory to be read by tensorboard, i.e.,
	// ---log_dir.
	LogDir          string `json:"logDir"`
	TensorflowImage string `json:"tensorflowImage"`
}

TensorboardSpec contains fields specific to launching a tensorboard instance.

func (*TensorboardSpec) DeepCopy

func (in *TensorboardSpec) DeepCopy() *TensorboardSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TensorboardSpec.

func (*TensorboardSpec) DeepCopyInto

func (in *TensorboardSpec) DeepCopyInto(out *TensorboardSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Viewer

type Viewer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec contains specifications that pertain to how the viewer is launched and
	// managed by its controller.
	Spec ViewerSpec `json:"spec"`
}

Viewer is a specification for a Viewer resource.

func (*Viewer) DeepCopy

func (in *Viewer) DeepCopy() *Viewer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Viewer.

func (*Viewer) DeepCopyInto

func (in *Viewer) DeepCopyInto(out *Viewer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Viewer) DeepCopyObject

func (in *Viewer) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ViewerList

type ViewerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	// Items is a list of viewers.
	Items []Viewer `json:"items"`
}

ViewerList is a list of Viewer resources.

func (*ViewerList) DeepCopy

func (in *ViewerList) DeepCopy() *ViewerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ViewerList.

func (*ViewerList) DeepCopyInto

func (in *ViewerList) DeepCopyInto(out *ViewerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ViewerList) DeepCopyObject

func (in *ViewerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ViewerSpec

type ViewerSpec struct {
	// Type is the type of the viewer.
	Type ViewerType `json:"type"`
	// TensorboardSpec is only checked if the Type is ViewerTypeTensorboard.
	TensorboardSpec TensorboardSpec `json:"tensorboardSpec,omitempty"`
	// PodTemplateSpec is the template spec used to launch the viewer.
	PodTemplateSpec v1.PodTemplateSpec `json:"podTemplateSpec"`
}

ViewerSpec is the spec for a Viewer resource.

func (*ViewerSpec) DeepCopy

func (in *ViewerSpec) DeepCopy() *ViewerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ViewerSpec.

func (*ViewerSpec) DeepCopyInto

func (in *ViewerSpec) DeepCopyInto(out *ViewerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ViewerType

type ViewerType string

ViewerType is the underlying type of the view. Currently, only Tensorboard is explicitly supported by the Viewer CRD.

const (
	// ViewerTypeTensorboard is the ViewerType constant used to indicate that the
	// underlying type is Tensorboard. An instance named `instance123` will serve
	// under /tensorboard/instance123.
	ViewerTypeTensorboard ViewerType = "tensorboard"
)