v1alpha1

Documentation

Overview

Package v1alpha1 contains Preview +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/jenkins-x-plugins/jx-preview/pkg/apis/preview +k8s:defaulter-gen=TypeMeta +groupName=preview.jenkins.io

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type Command
  • func (in *Command) DeepCopy() *Command
  • func (in *Command) DeepCopyInto(out *Command)
• type EnvVar
  • func (in *EnvVar) DeepCopy() *EnvVar
  • func (in *EnvVar) DeepCopyInto(out *EnvVar)
• type Preview
  • func (in *Preview) DeepCopy() *Preview
  • func (in *Preview) DeepCopyInto(out *Preview)
  • func (in *Preview) DeepCopyObject() runtime.Object
• type PreviewList
  • func (in *PreviewList) DeepCopy() *PreviewList
  • func (in *PreviewList) DeepCopyInto(out *PreviewList)
  • func (in *PreviewList) DeepCopyObject() runtime.Object
• type PreviewSource
  • func (in *PreviewSource) DeepCopy() *PreviewSource
  • func (in *PreviewSource) DeepCopyInto(out *PreviewSource)
• type PreviewSpec
  • func (in *PreviewSpec) DeepCopy() *PreviewSpec
  • func (in *PreviewSpec) DeepCopyInto(out *PreviewSpec)
• type PullRequest
  • func (in *PullRequest) DeepCopy() *PullRequest
  • func (in *PullRequest) DeepCopyInto(out *PullRequest)
• type Resources
  • func (in *Resources) DeepCopy() *Resources
  • func (in *Resources) DeepCopyInto(out *Resources)
• type UserSpec
  • func (in *UserSpec) DeepCopy() *UserSpec
  • func (in *UserSpec) DeepCopyInto(out *UserSpec)

Variables

var (
	// SchemeBuilder collects functions that add things to a scheme.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: preview.GroupName, Version: "v1alpha1"}

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 Command

type Command struct {
	Command string   `json:"command,omitempty" protobuf:"bytes,1,opt,name=command"`
	Args    []string `json:"args,omitempty" protobuf:"bytes,2,opt,name=args"`
	Path    string   `json:"path,omitempty" protobuf:"bytes,3,opt,name=path"`
	Env     []EnvVar `json:"env,omitempty" protobuf:"bytes,4,opt,name=env"`
}

Command the CLI command for deleting the preview

func (*Command) DeepCopy

func (in *Command) DeepCopy() *Command

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

func (*Command) DeepCopyInto

func (in *Command) DeepCopyInto(out *Command)

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

type EnvVar

type EnvVar struct {
	Name  string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`
	Value string `json:"value,omitempty" protobuf:"bytes,2,opt,name=value"`
}

EnvVar the environment variable name and vlaue

func (*EnvVar) DeepCopy

func (in *EnvVar) DeepCopy() *EnvVar

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

func (*EnvVar) DeepCopyInto

func (in *EnvVar) DeepCopyInto(out *EnvVar)

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

type Preview

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

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

Preview contains the definition of a preview environment

func (*Preview) DeepCopy

func (in *Preview) DeepCopy() *Preview

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

func (*Preview) DeepCopyInto

func (in *Preview) DeepCopyInto(out *Preview)

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

func (*Preview) DeepCopyObject

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

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

type PreviewList

type PreviewList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Preview `json:"items"`
}

PreviewList represents a list of pipeline options

func (*PreviewList) DeepCopy

func (in *PreviewList) DeepCopy() *PreviewList

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

func (*PreviewList) DeepCopyInto

func (in *PreviewList) DeepCopyInto(out *PreviewList)

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

func (*PreviewList) DeepCopyObject

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

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

type PreviewSource

type PreviewSource struct {
	// URL the git URL of the source
	URL string `json:"url,omitempty" protobuf:"bytes,1,opt,name=url"`

	// CloneURL the git URL to clone the source which should include user and password
	// so that the garbage collection jobs can properly clone the repository
	CloneURL string `json:"cloneURL,omitempty" protobuf:"bytes,2,opt,name=cloneURL"`

	// Ref the git reference (sha / branch / tag) to clone the source
	Ref string `json:"ref,omitempty" protobuf:"bytes,3,opt,name=ref"`

	// Path the location of the helmfile.yaml file (defaults to charts/preview/helmfile.yaml)
	Path string `json:"path,omitempty" protobuf:"bytes,4,opt,name=path"`
}

PreviewSource the location of the preview

func (*PreviewSource) DeepCopy

func (in *PreviewSource) DeepCopy() *PreviewSource

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

func (*PreviewSource) DeepCopyInto

func (in *PreviewSource) DeepCopyInto(out *PreviewSource)

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

type PreviewSpec

type PreviewSpec struct {
	// Source the source of the pull request
	Source PreviewSource `json:"source,omitempty" protobuf:"bytes,1,opt,name=source"`

	// PullRequest the pull request which triggered it
	PullRequest PullRequest `json:"pullRequest,omitempty" protobuf:"bytes,2,opt,name=pullRequest"`

	// Resources information about the deployed resources
	Resources Resources `json:"resources,omitempty" protobuf:"bytes,3,opt,name=resources"`

	// DestroyCommand the command to destroy the preview
	DestroyCommand Command `json:"destroyCommand,omitempty" protobuf:"bytes,4,opt,name=destroyCommand"`
}

PreviewSpec the spec of a pipeline request

func (*PreviewSpec) DeepCopy

func (in *PreviewSpec) DeepCopy() *PreviewSpec

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

func (*PreviewSpec) DeepCopyInto

func (in *PreviewSpec) DeepCopyInto(out *PreviewSpec)

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

type PullRequest

type PullRequest struct {
	Number      int      `json:"number,omitempty" protobuf:"bytes,1,opt,name=number"`
	Owner       string   `json:"owner,omitempty" protobuf:"bytes,2,opt,name=owner"`
	Repository  string   `json:"repository,omitempty" protobuf:"bytes,3,opt,name=repository"`
	URL         string   `json:"url,omitempty" protobuf:"bytes,4,opt,name=url"`
	User        UserSpec `json:"user,omitempty" protobuf:"bytes,5,opt,name=user"`
	Title       string   `json:"title,omitempty" protobuf:"bytes,6,opt,name=title"`
	Description string   `json:"description,omitempty" protobuf:"bytes,7,opt,name=description"`
}

PullRequest the pull request information which triggered the preview

func (*PullRequest) DeepCopy

func (in *PullRequest) DeepCopy() *PullRequest

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

func (*PullRequest) DeepCopyInto

func (in *PullRequest) DeepCopyInto(out *PullRequest)

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

type Resources

type Resources struct {
	// Name the name of the preview if different from the repository name
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`

	// URL the URL to test out the preview if applicable
	URL string `json:"url,omitempty" protobuf:"bytes,2,opt,name=url"`

	// Namespace the optional namespace unique for the pull request to deploy into
	Namespace string `json:"namespace,omitempty" protobuf:"bytes,3,opt,name=namespace"`
}

Resources represents details of the preview application

func (*Resources) DeepCopy

func (in *Resources) DeepCopy() *Resources

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

func (*Resources) DeepCopyInto

func (in *Resources) DeepCopyInto(out *Resources)

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

type UserSpec

type UserSpec struct {
	Username string `json:"username,omitempty" protobuf:"bytes,1,opt,name=username"`
	Name     string `json:"name,omitempty" protobuf:"bytes,2,opt,name=name"`
	LinkURL  string `json:"linkUrl,omitempty" protobuf:"bytes,3,opt,name=linkUrl"`
	ImageURL string `json:"imageUrl,omitempty" protobuf:"bytes,4,opt,name=imageUrl"`
}

UserSpec is the user details

func (*UserSpec) DeepCopy

func (in *UserSpec) DeepCopy() *UserSpec

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

func (*UserSpec) DeepCopyInto

func (in *UserSpec) DeepCopyInto(out *UserSpec)

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