apis

package

v3.0.0-...-c7e9b3a Latest Latest Go to latest Published: Feb 17, 2020 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jackskj/kfctl

Links

Open Source Insights

Documentation ¶

Overview ¶

Package apis contains Kubernetes API groups.

Index ¶

Variables
func AddToScheme(s *runtime.Scheme) error
func IsNotFound(e error) bool
func NewKfErrorWithMessage(e error, msg string) error
type KfError
- func (e *KfError) Error() string
type StatusCode

Constants ¶

This section is empty.

Variables ¶

View Source

var AddToSchemes runtime.SchemeBuilder

AddToSchemes may be used to add all resources defined in the project to a Scheme

Functions ¶

func AddToScheme ¶

func AddToScheme(s *runtime.Scheme) error

AddToScheme adds all Resources to the Scheme

func IsNotFound ¶

func IsNotFound(e error) bool

func NewKfErrorWithMessage ¶

func NewKfErrorWithMessage(e error, msg string) error

NewKfErrorWithMessage will propogate the error with the given message.

TODO(jlewi): Not sure this is the best way to propogate the error messages and turn them into KfErrors. There was a lot of code that was doing this but not asserting that the error was a KfError which was causing segmentation faults so I wrote this helper method.

Types ¶

type KfError ¶

type KfError struct {
	// Code is the HTTP response status code.
	Code    int    `json:"code"`
	Message string `json:"message,omitempty"`
}

KfError stands for Kubeflow error. This is the standard error interface for Kubeflow components.

func (*KfError) Error ¶

func (e *KfError) Error() string

type StatusCode ¶

type StatusCode int

const (
	OK               StatusCode = 200
	INVALID_ARGUMENT StatusCode = 400
	NOT_FOUND        StatusCode = 404
	INTERNAL_ERROR   StatusCode = 500
	UNKNOWN          StatusCode = 520
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
apps Package apis contains Kubernetes API groups.	Package apis contains Kubernetes API groups.
kfconfig 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/kfctl/v3/pkg/kfconfig +k8s:defaulter-gen=TypeMeta +groupName=kfconfig.apps.kubeflow.org	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/kfctl/v3/pkg/kfconfig +k8s:defaulter-gen=TypeMeta +groupName=kfconfig.apps.kubeflow.org
kfdef Package kfdef contains kfdef related types	Package kfdef contains kfdef related types
kfdef/v1 Package v1 contains API Schema definitions for the kfdef v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org	Package v1 contains API Schema definitions for the kfdef v1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubeflow/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org
kfdef/v1alpha1 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/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org	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/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org
kfdef/v1beta1 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/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org	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/kfctl/v3/pkg/apis/apps/kfdef +k8s:defaulter-gen=TypeMeta +groupName=kfdef.apps.kubeflow.org
kfupgrade Package kfupgrade contains kfupgrade related types	Package kfupgrade contains kfupgrade related types
kfupgrade/v1alpha1 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/kfctl/v3/pkg/apis/apps/kfupdate +k8s:defaulter-gen=TypeMeta +groupName=kfupdate.apps.kubeflow.org	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/kfctl/v3/pkg/apis/apps/kfupdate +k8s:defaulter-gen=TypeMeta +groupName=kfupdate.apps.kubeflow.org
plugins
plugins/aws
plugins/aws/v1alpha1 Package v1alpha1 contains API Schema definitions for the KfAwsPlugin v1alpha1.	Package v1alpha1 contains API Schema definitions for the KfAwsPlugin v1alpha1.
plugins/gcp
plugins/gcp/v1alpha1 Package v1alpha1 contains API Schema definitions for the KfGcpPlugin v1alpha1.	Package v1alpha1 contains API Schema definitions for the KfGcpPlugin v1alpha1.

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