v1alpha1

package
v0.0.0-...-244201a Latest Latest
Warning

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

 Go to latest Published: May 2, 2019 License: Apache-2.0 Imports: 6 Imported by: 15

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io

Package v1alpha1 contains API Schema definitions for the devconsole v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=devconsole.openshift.io

Index

Constants

View Source 
const (
	// PhaseBuilding indicates the component is under build.
	PhaseBuilding string = "Building"
	// PhaseDeploying indicates the component is under deployment.
	PhaseDeploying string = "Deploying"
	// PhaseDeployed indicates the component is deployed.
	PhaseDeployed string = "Deployed"
)
View Source 
const (
	// Failed is the state of Connection when an attempt to reach a GitSource failed
	Failed ConnectionState = "failed"
	// OK is the state of Connection when an attempt to reach a GitSource was successful
	OK ConnectionState = "ok"

	// RepoNotReachable represents a failure reason when an attempt to reach the git repo failed.
	// This failure could be caused by either a wrong URL or insufficient permissions needed to access the repo.
	RepoNotReachable ConnectionFailureReason = "RepoNotReachable"
	// BranchNotFound represents a failure reason when the specified branch wasn't found in the repository
	BranchNotFound ConnectionFailureReason = "BranchNotFound"
	// BadCredentials represents a failure reason when an attempt to authenticate to the repo using the given secret failed
	BadCredentials ConnectionFailureReason = "BadCredentials"
	// ConnectionInternalFailure represents a failure reason caused by any internal failure
	ConnectionInternalFailure ConnectionFailureReason = "InternalFailure"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "devconsole.openshift.io", Version: "v1alpha1"}

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

Functions

func GetOpenAPIDefinitions 

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

func RegisterDefaults 

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

Types

type AnalysisFailureReason 

type AnalysisFailureReason string

AnalysisFailureReason represents the reason why the GitSource analysis (build type detection) failed 

const (
	// NotSupportedType represents the failure reason when no appropriate git implementation was found
	// for the given combination of repository and secret
	NotSupportedType AnalysisFailureReason = "NotSupportedType"
	// DetectionFailed represents the failure reason when the actual detection logic failed
	DetectionFailed AnalysisFailureReason = "DetectionFailed"
	// AnalysisInternalFailure represents a failure reason caused by any internal failure
	AnalysisInternalFailure AnalysisFailureReason = "InternalFailure"
)

type BuildEnvStats 

type BuildEnvStats struct {
	// SortedLanguages contains sorted languages detected in the GitSource where the first one is with the most used
	SortedLanguages []string `json:"sortedLanguages,omitempty"`

	// DetectedBuildTypes contains list of detected build types in the GitSource
	DetectedBuildTypes []DetectedBuildType `json:"detectedBuildTypes,omitempty"`
}

BuildEnvStatistics holds information about detected languages and build types in the GitSource

func (*BuildEnvStats) DeepCopy 

func (in *BuildEnvStats) DeepCopy() *BuildEnvStats

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

func (*BuildEnvStats) DeepCopyInto 

func (in *BuildEnvStats) DeepCopyInto(out *BuildEnvStats)

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

type Component 

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

	Spec ComponentSpec `json:"spec,omitempty"`

	Status ComponentStatus `json:"status,omitempty"`
}

Component is the Schema for the components API. +k8s:openapi-gen=true

func (*Component) DeepCopy 

func (in *Component) DeepCopy() *Component

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

func (*Component) DeepCopyInto 

func (in *Component) DeepCopyInto(out *Component)

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

func (*Component) DeepCopyObject 

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

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

func (*Component) GetAnnotationVcsRef 

func (c *Component) GetAnnotationVcsRef() string

GetAnnotationVcsRef retrieves the annotation vcs-red.

func (*Component) GetAnnotationVcsUri 

func (c *Component) GetAnnotationVcsUri() string

GetAnnotationVcsUri retrieves the annotation vcs-uri.

func (*Component) GetLabelComponent 

func (c *Component) GetLabelComponent() string

GetLabelComponent retrieves the label component.

func (*Component) GetLabelInstance 

func (c *Component) GetLabelInstance() string

GetLabelInstance retrieves the label instance. If not present, infer the instance by calling GetName().

func (*Component) GetLabelName 

func (c *Component) GetLabelName() string

GetLabelName retrieves the label name. If not present, infer the name by using the component spec buildtype value.

func (*Component) GetLabelPartOf 

func (c *Component) GetLabelPartOf() string

GetLabelPartOf retrieves the label part-of.

func (*Component) GetLabelVersion 

func (c *Component) GetLabelVersion() string

GetLabelVersion retrieves label version.

type ComponentList 

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

ComponentList contains a list of Component.

func (*ComponentList) DeepCopy 

func (in *ComponentList) DeepCopy() *ComponentList

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

func (*ComponentList) DeepCopyInto 

func (in *ComponentList) DeepCopyInto(out *ComponentList)

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

func (*ComponentList) DeepCopyObject 

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

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

type ComponentSpec 

type ComponentSpec struct {
	// BuildType is the container image used to build (nodejs, golang etc..).
	BuildType string `json:"buildType"`
	// GitSourceRef is the source code of your component. Currently, only public remote URLs are supported.
	GitSourceRef string `json:"gitSourceRef"`
	// The cluster port of the service for your deployed component. The same port also matches target port.
	Port int32 `json:"port,omitempty"`
	// If the service is exposed, create a route.
	Exposed bool `json:"exposed,omitempty"`
}

ComponentSpec defines the desired state of Component. +k8s:openapi-gen=true +kubebuilder:subresource:status

func (*ComponentSpec) DeepCopy 

func (in *ComponentSpec) DeepCopy() *ComponentSpec

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

func (*ComponentSpec) DeepCopyInto 

func (in *ComponentSpec) DeepCopyInto(out *ComponentSpec)

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

type ComponentStatus 

type ComponentStatus struct {
	// RevNumber indicates if the component has been updated.
	// It is linked to the ObjectMeta.ResourceVersion of the component.
	RevNumber string `json:"revNumber,omitempty"`
	// Phase indicates which phase the component build and deployment process is.
	Phase string `json:"phase,omitempty"`
}

ComponentStatus defines the observed state of Component. +k8s:openapi-gen=true

func (*ComponentStatus) DeepCopy 

func (in *ComponentStatus) DeepCopy() *ComponentStatus

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

func (*ComponentStatus) DeepCopyInto 

func (in *ComponentStatus) DeepCopyInto(out *ComponentStatus)

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

type Connection 

type Connection struct {
	// State is the result of the attempt to reach a GitSource. Can be either Failed or OK
	State ConnectionState `json:"state"`

	// Error has the error message if the attempt to reach a GitSource failed. Optional
	Error string `json:"error,omitempty"`

	// Reason represents the reason why the attempt to reach a GitSource failed. Optional
	Reason ConnectionFailureReason `json:"reason,omitempty"`
}

Connection holds information whether the last attempt to reach the git source was successful or not

func (*Connection) DeepCopy 

func (in *Connection) DeepCopy() *Connection

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

func (*Connection) DeepCopyInto 

func (in *Connection) DeepCopyInto(out *Connection)

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

type ConnectionFailureReason 

type ConnectionFailureReason string

ConnectionFailureReason represents the reason why the attempt to reach a GitSource failed

type ConnectionState 

type ConnectionState string

ConnectionState is the result of the attempt to reach a GitSource.

type DetectedBuildType 

type DetectedBuildType struct {
	// Language is a programing language the build type if used for
	Language string `json:"language,omitempty"`

	// Name is a name of the build type
	Name string `json:"name,omitempty"`

	// DetectedFiles contains a list of files detected in the GitSource that are used by the build type
	DetectedFiles []string `json:"detectedFiles,omitempty"`
}

DetectedBuildType holds information of the build type detected in a GitSource

func (*DetectedBuildType) DeepCopy 

func (in *DetectedBuildType) DeepCopy() *DetectedBuildType

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

func (*DetectedBuildType) DeepCopyInto 

func (in *DetectedBuildType) DeepCopyInto(out *DetectedBuildType)

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

type GitSource 

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

	Spec   GitSourceSpec   `json:"spec,omitempty"`
	Status GitSourceStatus `json:"status,omitempty"`
}

GitSource is the Schema for the gitsources API +k8s:openapi-gen=true

func (*GitSource) DeepCopy 

func (in *GitSource) DeepCopy() *GitSource

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

func (*GitSource) DeepCopyInto 

func (in *GitSource) DeepCopyInto(out *GitSource)

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

func (*GitSource) DeepCopyObject 

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

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

type GitSourceAnalysis 

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

	Spec   GitSourceAnalysisSpec   `json:"spec,omitempty"`
	Status GitSourceAnalysisStatus `json:"status,omitempty"`
}

GitSourceAnalysis is the Schema for the gitsourceanalyses API +k8s:openapi-gen=true

func (*GitSourceAnalysis) DeepCopy 

func (in *GitSourceAnalysis) DeepCopy() *GitSourceAnalysis

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

func (*GitSourceAnalysis) DeepCopyInto 

func (in *GitSourceAnalysis) DeepCopyInto(out *GitSourceAnalysis)

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

func (*GitSourceAnalysis) DeepCopyObject 

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

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

type GitSourceAnalysisList 

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

GitSourceAnalysisList contains a list of GitSourceAnalysis

func (*GitSourceAnalysisList) DeepCopy 

func (in *GitSourceAnalysisList) DeepCopy() *GitSourceAnalysisList

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

func (*GitSourceAnalysisList) DeepCopyInto 

func (in *GitSourceAnalysisList) DeepCopyInto(out *GitSourceAnalysisList)

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

func (*GitSourceAnalysisList) DeepCopyObject 

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

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

type GitSourceAnalysisSpec 

type GitSourceAnalysisSpec struct {

	// GitSourceRef refers to the GitSource to be analyzed
	GitSourceRef GitSourceRef `json:"gitSourceRef"`
}

GitSourceAnalysisSpec defines the desired state of GitSourceAnalysis

func (*GitSourceAnalysisSpec) DeepCopy 

func (in *GitSourceAnalysisSpec) DeepCopy() *GitSourceAnalysisSpec

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

func (*GitSourceAnalysisSpec) DeepCopyInto 

func (in *GitSourceAnalysisSpec) DeepCopyInto(out *GitSourceAnalysisSpec)

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

type GitSourceAnalysisStatus 

type GitSourceAnalysisStatus struct {

	// Analyzed says if the GitSource analysis is done or not
	Analyzed bool `json:"analyzed"`

	// BuildEnvStatistics holds information about detected languages and build types in the GitSource. Optional
	BuildEnvStatistics BuildEnvStats `json:"buildEnvStatistics,omitempty"`

	// Error contains an error message in case the build environment detection fails. Optional
	Error string `json:"error,omitempty"`

	// Reason represents the reason why the GitSource analysis (build type detection) failed. Optional
	Reason AnalysisFailureReason `json:"reason,omitempty"`
}

GitSourceAnalysisStatus defines the observed state of GitSourceAnalysis

func (*GitSourceAnalysisStatus) DeepCopy 

func (in *GitSourceAnalysisStatus) DeepCopy() *GitSourceAnalysisStatus

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

func (*GitSourceAnalysisStatus) DeepCopyInto 

func (in *GitSourceAnalysisStatus) DeepCopyInto(out *GitSourceAnalysisStatus)

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

type GitSourceList 

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

GitSourceList contains a list of GitSource

func (*GitSourceList) DeepCopy 

func (in *GitSourceList) DeepCopy() *GitSourceList

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

func (*GitSourceList) DeepCopyInto 

func (in *GitSourceList) DeepCopyInto(out *GitSourceList)

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

func (*GitSourceList) DeepCopyObject 

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

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

type GitSourceRef 

type GitSourceRef struct {
	// Name is the name of the GitSource within the same namespace that contains all necessary information of the git repo
	Name string `json:"name"`
}

GitSourceRef refers to the GitSource to be analyzed

func (*GitSourceRef) DeepCopy 

func (in *GitSourceRef) DeepCopy() *GitSourceRef

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

func (*GitSourceRef) DeepCopyInto 

func (in *GitSourceRef) DeepCopyInto(out *GitSourceRef)

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

type GitSourceSpec 

type GitSourceSpec struct {

	// URL of the git repo
	URL string `json:"url"`

	// Ref is a git reference. Optional. "master" is used by default.
	Ref string `json:"ref,omitempty"`

	// ContextDir is a path to subfolder in the repo. Optional.
	ContextDir string `json:"contextDir,omitempty"`

	// HttpProxy is optional.
	HttpProxy string `json:"httpProxy,omitempty"`

	// HttpsProxy is optional.
	HttpsProxy string `json:"httpsProxy,omitempty"`

	// NoProxy can be used to specify domains for which no proxying should be performed. Optional.
	NoProxy string `json:"noProxy,omitempty"`

	// SecretRef refers to the secret that contains credentials to access the git repo. Optional.
	SecretRef *SecretRef `json:"secretRef,omitempty"`

	// Flavor of the git provider like github, gitlab, bitbucket, generic, etc. Optional.
	Flavor string `json:"flavor,omitempty"`
}

GitSourceSpec defines the desired state of GitSource +k8s:openapi-gen=true

func (*GitSourceSpec) DeepCopy 

func (in *GitSourceSpec) DeepCopy() *GitSourceSpec

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

func (*GitSourceSpec) DeepCopyInto 

func (in *GitSourceSpec) DeepCopyInto(out *GitSourceSpec)

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

type GitSourceStatus 

type GitSourceStatus struct {

	// State represents current state of the GitSource, can be either initializing or ready
	State State `json:"state,omitempty"`

	// Connection holds information whether the last attempt to reach the git source was successful or not. Optional
	Connection Connection `json:"connection,omitempty"`
}

GitSourceStatus defines the observed state of GitSource +k8s:openapi-gen=true

func (*GitSourceStatus) DeepCopy 

func (in *GitSourceStatus) DeepCopy() *GitSourceStatus

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

func (*GitSourceStatus) DeepCopyInto 

func (in *GitSourceStatus) DeepCopyInto(out *GitSourceStatus)

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

type SecretRef 

type SecretRef struct {
	// Name is the name of the secret that contains credentials to access the git repo
	Name string `json:"name"`
}

SecretRef holds information about the secret that contains credentials to access the git repo

func (*SecretRef) DeepCopy 

func (in *SecretRef) DeepCopy() *SecretRef

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

func (*SecretRef) DeepCopyInto 

func (in *SecretRef) DeepCopyInto(out *SecretRef)

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

type State 

type State string

State represents current state of the GitSource, 

const Initializing State = "initializing"

Initializing represents a state of GitSource whose creation wasn't completed and is not ready to use 

const Ready State = "ready"

Ready represents a state of GitSource whose creation was completed and is ready to use

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.