v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the KfAwsPlugin v1alpha1. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/kfctl/v3/pkg/apis/apps/plugins/aws +k8s:defaulter-gen=TypeMeta +groupName=aws.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 AwsPluginSpec
  • func (in *AwsPluginSpec) DeepCopy() *AwsPluginSpec
  • func (in *AwsPluginSpec) DeepCopyInto(out *AwsPluginSpec)
  • func (plugin *AwsPluginSpec) IsValid() (bool, string)
• type BasicAuth
  • func (in *BasicAuth) DeepCopy() *BasicAuth
  • func (in *BasicAuth) DeepCopyInto(out *BasicAuth)
• type Coginito
  • func (in *Coginito) DeepCopy() *Coginito
  • func (in *Coginito) DeepCopyInto(out *Coginito)
• type KfAwsPlugin
  • func (in *KfAwsPlugin) DeepCopy() *KfAwsPlugin
  • func (in *KfAwsPlugin) DeepCopyInto(out *KfAwsPlugin)
  • func (in *KfAwsPlugin) DeepCopyObject() runtime.Object
• type OIDC
  • func (in *OIDC) DeepCopy() *OIDC
  • func (in *OIDC) DeepCopyInto(out *OIDC)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "aws.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"`
	Oidc      *OIDC      `json:"oidc,omitempty"`
	Cognito   *Coginito  `json:"cognito,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 AwsPluginSpec

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

	Region string `json:"region,omitempty"`

	Roles []string `json:"roles,omitempty"`
}

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

func (*AwsPluginSpec) DeepCopy

func (in *AwsPluginSpec) DeepCopy() *AwsPluginSpec

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

func (*AwsPluginSpec) DeepCopyInto

func (in *AwsPluginSpec) DeepCopyInto(out *AwsPluginSpec)

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

func (*AwsPluginSpec) IsValid

func (plugin *AwsPluginSpec) 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 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 Coginito

type Coginito struct {
	CognitoAppClientId    string `json:"cognitoAppClientId,omitempty"`
	CognitoUserPoolArn    string `json:"cognitoUserPoolArn,omitempty"`
	CognitoUserPoolDomain string `json:"cognitoUserPoolDomain,omitempty"`
	CertArn               string `json:"certArn,omitempty"`
}

func (*Coginito) DeepCopy

func (in *Coginito) DeepCopy() *Coginito

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

func (*Coginito) DeepCopyInto

func (in *Coginito) DeepCopyInto(out *Coginito)

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

type KfAwsPlugin

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

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

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

func (*KfAwsPlugin) DeepCopy

func (in *KfAwsPlugin) DeepCopy() *KfAwsPlugin

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

func (*KfAwsPlugin) DeepCopyInto

func (in *KfAwsPlugin) DeepCopyInto(out *KfAwsPlugin)

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

func (*KfAwsPlugin) DeepCopyObject

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

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

type OIDC

type OIDC struct {
	OidcAuthorizationEndpoint string `json:"oidcAuthorizationEndpoint,omitempty"`
	OidcIssuer                string `json:"oidcIssuer,omitempty"`
	OidcTokenEndpoint         string `json:"oidcTokenEndpoint,omitempty"`
	OidcUserInfoEndpoint      string `json:"oidcUserInfoEndpoint,omitempty"`
	CertArn                   string `json:"certArn,omitempty"`
	OAuthClientId             string `json:"oAuthClientId,omitempty"`
	OAuthClientSecret         string `json:"oAuthClientSecret,omitempty"`
}

func (*OIDC) DeepCopy

func (in *OIDC) DeepCopy() *OIDC

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

func (*OIDC) DeepCopyInto

func (in *OIDC) DeepCopyInto(out *OIDC)

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