v1alpha1

Documentation

Overview

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

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type Auth
  • func (in *Auth) DeepCopy() *Auth
  • func (in *Auth) DeepCopyInto(out *Auth)
• type BasicAuth
  • func (in *BasicAuth) DeepCopy() *BasicAuth
  • func (in *BasicAuth) DeepCopyInto(out *BasicAuth)
• type DeploymentManagerConfig
  • func (in *DeploymentManagerConfig) DeepCopy() *DeploymentManagerConfig
  • func (in *DeploymentManagerConfig) DeepCopyInto(out *DeploymentManagerConfig)
• type GcpPluginSpec
  • func (in *GcpPluginSpec) DeepCopy() *GcpPluginSpec
  • func (in *GcpPluginSpec) DeepCopyInto(out *GcpPluginSpec)
  • func (p *GcpPluginSpec) GetCreatePipelinePersistentStorage() bool
  • func (p *GcpPluginSpec) GetEnableWorkloadIdentity() bool
  • func (s *GcpPluginSpec) IsValid() (bool, string)
• type IAP
  • func (in *IAP) DeepCopy() *IAP
  • func (in *IAP) DeepCopyInto(out *IAP)
• type KfGcpPlugin
  • func (in *KfGcpPlugin) DeepCopy() *KfGcpPlugin
  • func (in *KfGcpPlugin) DeepCopyInto(out *KfGcpPlugin)
  • func (in *KfGcpPlugin) DeepCopyObject() runtime.Object

Variables

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

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

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

Functions

func Resource

func Resource(resource string) schema.GroupResource

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

Types

type Auth

type Auth struct {
	BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
	IAP       *IAP       `json:"iap,omitempty"`
}

func (*Auth) DeepCopy

func (in *Auth) DeepCopy() *Auth

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

func (*Auth) DeepCopyInto

func (in *Auth) DeepCopyInto(out *Auth)

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

type BasicAuth

type BasicAuth struct {
	Username string                `json:"username,omitempty"`
	Password *kfdeftypes.SecretRef `json:"password,omitempty"`
}

func (*BasicAuth) DeepCopy

func (in *BasicAuth) DeepCopy() *BasicAuth

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

func (*BasicAuth) DeepCopyInto

func (in *BasicAuth) DeepCopyInto(out *BasicAuth)

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

type DeploymentManagerConfig

type DeploymentManagerConfig struct {
	RepoRef *kfdeftypes.RepoRef `json:"repoRef,omitempty"`
}

func (*DeploymentManagerConfig) DeepCopy

func (in *DeploymentManagerConfig) DeepCopy() *DeploymentManagerConfig

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

func (*DeploymentManagerConfig) DeepCopyInto

func (in *DeploymentManagerConfig) DeepCopyInto(out *DeploymentManagerConfig)

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

type GcpPluginSpec

type GcpPluginSpec struct {
	Auth *Auth `json:"auth,omitempty"`

	// SAClientId if supplied grant this service account cluster admin access
	// TODO(jlewi): Might want to make it a list
	SAClientId string `json:"username,omitempty"`

	// CreatePipelinePersistentStorage indicates whether to create storage.
	// Use a pointer so we can distinguish unset values.
	CreatePipelinePersistentStorage *bool `json:"createPipelinePersistentStorage,omitempty"`

	// EnableWorkloadIdentity indicates whether to enable workload identity.
	// Use a pointer so we can distinguish unset values.
	EnableWorkloadIdentity *bool `json:"enableWorkloadIdentity,omitempty"`

	// DeploymentManagerConfig provides location of the deployment manager configs.
	DeploymentManagerConfig *DeploymentManagerConfig `json:"deploymentManagerConfig,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"`
	DeleteStorage   bool   `json:"deleteStorage,omitempty"`
}

GcpPlugin defines the extra data provided by the GCP Plugin in KfDef

func (*GcpPluginSpec) DeepCopy

func (in *GcpPluginSpec) DeepCopy() *GcpPluginSpec

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

func (*GcpPluginSpec) DeepCopyInto

func (in *GcpPluginSpec) DeepCopyInto(out *GcpPluginSpec)

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

func (*GcpPluginSpec) GetCreatePipelinePersistentStorage

func (p *GcpPluginSpec) GetCreatePipelinePersistentStorage() bool

func (*GcpPluginSpec) GetEnableWorkloadIdentity

func (p *GcpPluginSpec) GetEnableWorkloadIdentity() bool

func (*GcpPluginSpec) IsValid

func (s *GcpPluginSpec) IsValid() (bool, string)

IsValid returns true if the spec is a valid and complete spec. If false it will also return a string providing a message about why its invalid.

type IAP

type IAP struct {
	OAuthClientId     string                `json:"oAuthClientId,omitempty"`
	OAuthClientSecret *kfdeftypes.SecretRef `json:"oAuthClientSecret,omitempty"`
}

func (*IAP) DeepCopy

func (in *IAP) DeepCopy() *IAP

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

func (*IAP) DeepCopyInto

func (in *IAP) DeepCopyInto(out *IAP)

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

type KfGcpPlugin

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

	Spec GcpPluginSpec `json:"spec,omitempty"`
}

+k8s:openapi-gen=true Placeholder for the plugin API.

func (*KfGcpPlugin) DeepCopy

func (in *KfGcpPlugin) DeepCopy() *KfGcpPlugin

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

func (*KfGcpPlugin) DeepCopyInto

func (in *KfGcpPlugin) DeepCopyInto(out *KfGcpPlugin)

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

func (*KfGcpPlugin) DeepCopyObject

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

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