-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
pipeline_types.go
115 lines (95 loc) · 4.28 KB
/
pipeline_types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
Copyright 2018 The Knative Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1beta1
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// PipelineSpec defines the desired state of PipeLine.
type PipelineSpec struct {
Tasks []PipelineTask `json:"tasks"`
}
// PipelineStatus defines the observed state of Pipeline
type PipelineStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Pipeline describes a DAG of Tasks to execute. It expresses how outputs
// of tasks feed into inputs of subsequent tasks, and how parameters from
// a PipelineParams should be fed into each task. The DAG is constructed
// from the 'prev' and 'next' of each PipelineTask as well as Task dependencies.
// +k8s:openapi-gen=true
type Pipeline struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PipelineSpec `json:"spec,omitempty"`
Status PipelineStatus `json:"status,omitempty"`
}
// PipelineTask defines a task in a Pipeline, passing inputs from both
// PipelineParams and from the output of previous tasks.
type PipelineTask struct {
Name string `json:"name"`
TaskRef TaskRef `json:"taskRef"`
SourceBindings []SourceBinding `json:"sourceBindings,omitempty"`
ArtifactStoreBindings []ArtifactStoreBinding `json:"artifactStoreBindings,omitempty"`
Params []PipelineTaskParam `json:"params,omitempty"`
ParamBindings []PipelineTaskParamBinding `json:"paramBindings,omitempty"`
NextTasks []string `json:"nextTasks,omitempty"`
PrevTasks []string `json:"prevTasks,omitempty"`
}
// PipelineTaskParamBinding is used to bind the outputs of a Task to the inputs of another Task.
type PipelineTaskParamBinding struct {
InputName string `json:"inputName"`
TaskName string `json:"taskName"`
TaskOutputName string `json:"taskOutputName"`
}
// PipelineTaskParam is used to provide arbitrary string parameters to a Task.
type PipelineTaskParam struct {
Name string `json:"name"`
Value string `json:"value"`
}
// SourceBinding is used to bind a Source from a PipelineParams to a source required
// as an input for a task.
type SourceBinding struct {
// InputName is the string the Task will use to identify this source in its inputs.
InputName string `json:"inputName"`
// SourceKey is the string that the PipelineParams will use to identify this source.
SourceKey string `json:"sourceKey"`
}
// ArtifactStoreBinding is used to bind an ArtifactStore from a PipelineParams to
// artifacts that will be produced as output by a task.
type ArtifactStoreBinding struct {
// InputName is the string the Task will use to identify this source in its outputs.
StoreName string `json:"storeName"`
// StoreKey is the string that the PipelineParams will use to identify this artifact store.
StoreKey string `json:"storeKey"`
}
// TaskRef can be used to refer to a specific instance of a task.
// Copied from CrossVersionObjectReference: https://github.com/kubernetes/kubernetes/blob/169df7434155cbbc22f1532cba8e0a9588e29ad8/pkg/apis/autoscaling/types.go#L64
type TaskRef struct {
// Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name string `json:"name"`
// API version of the referent
APIVersion string `json:"apiVersion,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// PipelineList contains a list of Pipeline
type PipelineList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Pipeline `json:"items"`
}
func init() {
SchemeBuilder.Register(&Pipeline{}, &PipelineList{})
}