v1alpha1

package
v0.0.0-...-9ad3809 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the kfdef v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/kubeflow/bootstrap/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org

Index

Constants

This section is empty.

Variables

View Source
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "kfdef.apps.kubeflow.org", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is required by pkg/kfdef/...
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/kfdef/listers/...

Types

type AppConfig

type AppConfig struct {
	Registries []*RegistryConfig `json:"registries,omitempty"`
	Packages   []KsPackage       `json:"packages,omitempty"`
	Components []KsComponent     `json:"components,omitempty"`
	Parameters []KsParameter     `json:"parameters,omitempty"`
	// Parameters to apply when creating the ksonnet components
	ApplyParameters []KsParameter `json:"applyParameters,omitempty"`
}

func (*AppConfig) DeepCopy

func (in *AppConfig) DeepCopy() *AppConfig

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

func (*AppConfig) DeepCopyInto

func (in *AppConfig) DeepCopyInto(out *AppConfig)

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

type KfDef

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

	Spec   KfDefSpec   `json:"spec,omitempty"`
	Status KfDefStatus `json:"status,omitempty"`
}

KfDef is the Schema for the applications API +k8s:openapi-gen=true

func (*KfDef) DeepCopy

func (in *KfDef) DeepCopy() *KfDef

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

func (*KfDef) DeepCopyInto

func (in *KfDef) DeepCopyInto(out *KfDef)

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

func (*KfDef) DeepCopyObject

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

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

type KfDefCondition

type KfDefCondition struct {
	// Type of deployment condition.
	Type KfDefConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=KfDefConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
	// The last time this condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"`
	// Last time the condition transitioned from one status to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,7,opt,name=lastTransitionTime"`
	// The reason for the condition's last transition.
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
	// A human readable message indicating details about the transition.
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

func (*KfDefCondition) DeepCopy

func (in *KfDefCondition) DeepCopy() *KfDefCondition

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

func (*KfDefCondition) DeepCopyInto

func (in *KfDefCondition) DeepCopyInto(out *KfDefCondition)

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

type KfDefConditionType

type KfDefConditionType string

type KfDefList

type KfDefList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []KfDef `json:"items"`
}

KfDefList contains a list of KfDef

func (*KfDefList) DeepCopy

func (in *KfDefList) DeepCopy() *KfDefList

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

func (*KfDefList) DeepCopyInto

func (in *KfDefList) DeepCopyInto(out *KfDefList)

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

func (*KfDefList) DeepCopyObject

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

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

type KfDefSpec

type KfDefSpec struct {
	config.ComponentConfig `json:",inline"`
	AppDir                 string `json:"appdir,omitempty"`
	Version                string `json:"version,omitempty"`
	MountLocal             bool   `json:"mountLocal,omitempty"`
	Project                string `json:"project,omitempty"`
	Email                  string `json:"email,omitempty"`
	IpName                 string `json:"ipName,omitempty"`
	Hostname               string `json:"hostname,omitempty"`
	Zone                   string `json:"zone,omitempty"`
	UseBasicAuth           bool   `json:"useBasicAuth"`
	SkipInitProject        bool   `json:"skipInitProject,omitempty"`
	UseIstio               bool   `json:"useIstio"`
	EnableApplications     bool   `json:"enableApplications"`
	ServerVersion          string `json:"serverVersion,omitempty"`
	DeleteStorage          bool   `json:"deleteStorage,omitempty"`
	PackageManager         string `json:"packageManager,omitempty"`
	ManifestsRepo          string `json:"manifestsRepo,omitempty"`
}

KfDefSpec holds common attributes used by each platform

func (*KfDefSpec) DeepCopy

func (in *KfDefSpec) DeepCopy() *KfDefSpec

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

func (*KfDefSpec) DeepCopyInto

func (in *KfDefSpec) DeepCopyInto(out *KfDefSpec)

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

type KfDefStatus

type KfDefStatus struct {
	Conditions []KfDefCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,6,rep,name=conditions"`
}

KfDefStatus defines the observed state of KfDef

func (*KfDefStatus) DeepCopy

func (in *KfDefStatus) DeepCopy() *KfDefStatus

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

func (*KfDefStatus) DeepCopyInto

func (in *KfDefStatus) DeepCopyInto(out *KfDefStatus)

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

type KsComponent

type KsComponent struct {
	Name      string `json:"name,omitempty"`
	Prototype string `json:"prototype,omitempty"`
}

func (*KsComponent) DeepCopy

func (in *KsComponent) DeepCopy() *KsComponent

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

func (*KsComponent) DeepCopyInto

func (in *KsComponent) DeepCopyInto(out *KsComponent)

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

type KsLibrary

type KsLibrary struct {
	Name     string `json:"name"`
	Registry string `json:"registry"`
	Version  string `json:"version"`
}

func (*KsLibrary) DeepCopy

func (in *KsLibrary) DeepCopy() *KsLibrary

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

func (*KsLibrary) DeepCopyInto

func (in *KsLibrary) DeepCopyInto(out *KsLibrary)

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

type KsModule

type KsModule struct {
	Name       string         `json:"name"`
	Components []*KsComponent `json:"components,omitempty"`
	Modules    []*KsModule    `json:"modules,omitempty"`
}

func (*KsModule) DeepCopy

func (in *KsModule) DeepCopy() *KsModule

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

func (*KsModule) DeepCopyInto

func (in *KsModule) DeepCopyInto(out *KsModule)

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

type KsPackage

type KsPackage struct {
	Name string `json:"name,omitempty"`
	// Registry should be the name of the registry containing the package.
	Registry string `json:"registry,omitempty"`
}

func (*KsPackage) DeepCopy

func (in *KsPackage) DeepCopy() *KsPackage

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

func (*KsPackage) DeepCopyInto

func (in *KsPackage) DeepCopyInto(out *KsPackage)

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

type KsParameter

type KsParameter struct {
	// nested components are referenced as "a.b.c" where "a" or "b" may be a module name
	Component string `json:"component,omitempty"`
	Name      string `json:"name,omitempty"`
	Value     string `json:"value,omitempty"`
}

func (*KsParameter) DeepCopy

func (in *KsParameter) DeepCopy() *KsParameter

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

func (*KsParameter) DeepCopyInto

func (in *KsParameter) DeepCopyInto(out *KsParameter)

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

type KsRegistry

type KsRegistry struct {
	ApiVersion string
	Kind       string
	Libraries  map[string]LibrarySpec
}

KsRegistry corresponds to ksonnet.io/registry which is the registry.yaml file found in every registry.

func (*KsRegistry) DeepCopy

func (in *KsRegistry) DeepCopy() *KsRegistry

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

func (*KsRegistry) DeepCopyInto

func (in *KsRegistry) DeepCopyInto(out *KsRegistry)

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

type LibrarySpec

type LibrarySpec struct {
	Version string
	Path    string
}

func (*LibrarySpec) DeepCopy

func (in *LibrarySpec) DeepCopy() *LibrarySpec

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

func (*LibrarySpec) DeepCopyInto

func (in *LibrarySpec) DeepCopyInto(out *LibrarySpec)

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

type RegistriesConfigFile

type RegistriesConfigFile struct {
	// Registries provides information about known registries.
	Registries []*RegistryConfig
}

RegistriesConfigFile corresponds to a YAML file specifying information about known registries.

func (*RegistriesConfigFile) DeepCopy

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

func (*RegistriesConfigFile) DeepCopyInto

func (in *RegistriesConfigFile) DeepCopyInto(out *RegistriesConfigFile)

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

type Registry

type Registry struct {
	// Name is the user defined name of a registry.
	Name string `json:"-"`
	// Protocol is the registry protocol for this registry. Currently supported
	// values are `github`, `fs`, `helm`.
	Protocol string `json:"protocol"`
	// URI is the location of the registry.
	URI string `json:"uri"`
}

func (*Registry) DeepCopy

func (in *Registry) DeepCopy() *Registry

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

func (*Registry) DeepCopyInto

func (in *Registry) DeepCopyInto(out *Registry)

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

type RegistryConfig

type RegistryConfig struct {
	Name    string `json:"name,omitempty"`
	Repo    string `json:"repo,omitempty"`
	Version string `json:"version,omitempty"`
	Path    string `json:"path,omitempty"`
	RegUri  string `json:"reguri,omitempty"`
}

RegistryConfig is used for two purposes:

  1. used during image build, to configure registries that should be baked into the bootstrapper docker image. (See: https://github.com/kubeflow/kubeflow/blob/master/bootstrap/image_registries.yaml)
  2. used during app create rpc call, specifies a registry to be added to an app. required info for registry: Name, Repo, Version, Path Additionally if any of required fields is blank we will try to map with one of the registries baked into the Docker image using the name.

func GetDefaultRegistry

func GetDefaultRegistry() *RegistryConfig

GetDefaultRegistry return reference of a newly copied Default Registry

func (*RegistryConfig) DeepCopy

func (in *RegistryConfig) DeepCopy() *RegistryConfig

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

func (*RegistryConfig) DeepCopyInto

func (in *RegistryConfig) DeepCopyInto(out *RegistryConfig)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL