Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +k8s:openapi-gen=true Package v1alpha1 is the v1alpha1 version of the API. +groupName=project.jenkins-x.io
Index ¶
Constants ¶
const ( // APIVersion the api version APIVersion = "project.jenkins-x.io/v1alpha1" // KindSecretMapping the kind KindSecretMapping = "SecretMapping" // KindSourceConfig the kind KindSourceConfig = "SourceConfig" )
const (
// PipelineCatalogFileName default name of the kpt strategy file
PipelineCatalogFileName = "pipeline-catalog.yaml"
)
const (
// QuickstartsFileName default name of the source repository configuration
QuickstartsFileName = "quickstarts.yaml"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PipelineCatalog ¶
type PipelineCatalog struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata"` // Spec holds the desired state of the PipelineCatalog from the client // +optional Spec PipelineCatalogSpec `json:"spec"` }
PipelineCatalog represents a collection quickstart project
+k8s:openapi-gen=true
type PipelineCatalogList ¶
type PipelineCatalogList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []PipelineCatalog `json:"items"` }
PipelineCatalogList contains a list of Repositories
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type PipelineCatalogSource ¶
type PipelineCatalogSource struct { ID string `json:"id,omitempty" protobuf:"bytes,1,opt,name=id"` Label string `json:"label,omitempty" protobuf:"bytes,2,opt,name=label"` GitURL string `json:"gitUrl,omitempty" protobuf:"bytes,3,opt,name=gitUrl"` GitRef string `json:"gitRef,omitempty" protobuf:"bytes,4,opt,name=gitRef"` }
PipelineCatalogSource the source of a pipeline catalog
type PipelineCatalogSpec ¶
type PipelineCatalogSpec struct { // Repositories the repositories containing pipeline catalogs Repositories []PipelineCatalogSource `json:"repositories,omitempty"` }
PipelineCatalogSpec defines the desired state of PipelineCatalog.
type QuickstartImport ¶
type QuickstartImport struct { // File file name relative to the root directory to load File string `json:"file,omitempty"` Include []string `json:"includes,omitempty"` Excludes []string `json:"excludes,omitempty"` }
QuickstartImport imports quickstats from another folder (such as from the shared version stream)
func (*QuickstartImport) Matcher ¶
func (i *QuickstartImport) Matcher() (func(source *QuickstartSource) bool, error)
Matcher returns a matcher for the given import
type QuickstartSource ¶
type QuickstartSource struct { ID string Owner string Name string Version string Language string Framework string Tags []string DownloadZipURL string GitServer string GitKind string }
QuickstartSource the source of a quickstart
type Quickstarts ¶
type Quickstarts struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata"` // Spec holds the specified quicksatrt configuration // +optional Spec QuickstartsSpec `json:"spec"` }
Quickstarts represents a collection quickstart project
+k8s:openapi-gen=true
type QuickstartsList ¶
type QuickstartsList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []Quickstarts `json:"items"` }
QuickstartsList contains a list of Quickstarts
+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
type QuickstartsSpec ¶
type QuickstartsSpec struct { // Quickstarts custom quickstarts to include Quickstarts []QuickstartSource `json:"quickstarts,omitempty"` // DefaultOwner the default owner if not specfied DefaultOwner string `json:"defaultOwner,omitempty"` // Imports import quickstarts from the version stream Imports []QuickstartImport `json:"imports,omitempty"` }
QuickstartsSpec defines the desired state of Quickstarts.
func (*QuickstartsSpec) DefaultValues ¶
func (qs *QuickstartsSpec) DefaultValues(q *QuickstartSource)
DefaultValues defaults any missing values
func (*QuickstartsSpec) LoadImports ¶
func (qs *QuickstartsSpec) LoadImports(i *QuickstartImport, matcher func(source *QuickstartSource) bool, dir string) ([]QuickstartSource, error)
LoadImports loads the imported quickstarts