forked from openshift/origin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
417 lines (326 loc) · 15.7 KB
/
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
package api
import (
"time"
kapi "github.com/GoogleCloudPlatform/kubernetes/pkg/api"
"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
)
const (
// BuildAnnotation is an annotation that identifies a Pod as being for a Build
BuildAnnotation = "openshift.io/build.name"
// BuildLabel is the key of a Pod label whose value is the Name of a Build which is run.
BuildLabel = "build"
)
// Build encapsulates the inputs needed to produce a new deployable image, as well as
// the status of the execution and a reference to the Pod which executed the build.
type Build struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// Parameters are all the inputs used to create the build pod.
Parameters BuildParameters `json:"parameters,omitempty"`
// Status is the current status of the build.
Status BuildStatus `json:"status,omitempty"`
// A human readable message indicating details about why the build has this status
Message string `json:"message,omitempty"`
// Cancelled describes if a cancelling event was triggered for the build.
Cancelled bool `json:"cancelled,omitempty"`
// StartTimestamp is a timestamp representing the server time when this Build started
// running in a Pod.
// It is represented in RFC3339 form and is in UTC.
StartTimestamp *util.Time `json:"startTimestamp,omitempty"`
// CompletionTimestamp is a timestamp representing the server time when this Build was
// finished, whether that build failed or succeeded. It reflects the time at which
// the Pod running the Build terminated.
// It is represented in RFC3339 form and is in UTC.
CompletionTimestamp *util.Time `json:"completionTimestamp,omitempty"`
// Duration contains time.Duration object describing build time.
Duration time.Duration `json:"duration,omitempty"`
// Config is an ObjectReference to the BuildConfig this Build is based on.
Config *kapi.ObjectReference `json:"config,omitempty"`
}
// BuildParameters encapsulates all the inputs necessary to represent a build.
type BuildParameters struct {
// Source describes the SCM in use.
Source BuildSource `json:"source,omitempty"`
// Revision is the information from the source for a specific repo snapshot.
// This is optional.
Revision *SourceRevision `json:"revision,omitempty"`
// Strategy defines how to perform a build.
Strategy BuildStrategy `json:"strategy"`
// Output describes the Docker image the Strategy should produce.
Output BuildOutput `json:"output,omitempty"`
// Compute resource requirements to execute the build
Resources kapi.ResourceRequirements `json:"resources,omitempty"`
}
// BuildStatus represents the status of a build at a point in time.
type BuildStatus string
// Valid values for BuildStatus.
const (
// BuildStatusNew is automatically assigned to a newly created build.
BuildStatusNew BuildStatus = "New"
// BuildStatusPending indicates that a pod name has been assigned and a build is
// about to start running.
BuildStatusPending BuildStatus = "Pending"
// BuildStatusRunning indicates that a pod has been created and a build is running.
BuildStatusRunning BuildStatus = "Running"
// BuildStatusComplete indicates that a build has been successful.
BuildStatusComplete BuildStatus = "Complete"
// BuildStatusFailed indicates that a build has executed and failed.
BuildStatusFailed BuildStatus = "Failed"
// BuildStatusError indicates that an error prevented the build from executing.
BuildStatusError BuildStatus = "Error"
// BuildStatusCancelled indicates that a running/pending build was stopped from executing.
BuildStatusCancelled BuildStatus = "Cancelled"
)
// BuildSourceType is the type of SCM used
type BuildSourceType string
// Valid values for BuildSourceType.
const (
//BuildSourceGit is a Git SCM
BuildSourceGit BuildSourceType = "Git"
)
// BuildSource is the SCM used for the build
type BuildSource struct {
Type BuildSourceType `json:"type,omitempty"`
Git *GitBuildSource `json:"git,omitempty"`
// Specify the sub-directory where the source code for the application exists.
// This allows to have buildable sources in directory other than root of
// repository.
ContextDir string `json:"contextDir,omitempty"`
// SourceSecretName is the name of a Secret that would be used for setting
// up the authentication for cloning private repository.
// The secret contains valid credentials for remote repository, where the
// data's key represent the authentication method to be used and value is
// the base64 encoded credentials. Supported auth methods are: ssh-privatekey.
SourceSecretName string
}
// SourceRevision is the revision or commit information from the source for the build
type SourceRevision struct {
Type BuildSourceType `json:"type,omitempty"`
Git *GitSourceRevision `json:"git,omitempty"`
}
// GitSourceRevision is the commit information from a git source for a build
type GitSourceRevision struct {
// Commit is the commit hash identifying a specific commit
Commit string `json:"commit,omitempty"`
// Author is the author of a specific commit
Author SourceControlUser `json:"author,omitempty"`
// Committer is the committer of a specific commit
Committer SourceControlUser `json:"committer,omitempty"`
// Message is the description of a specific commit
Message string `json:"message,omitempty"`
}
// GitBuildSource defines the parameters of a Git SCM
type GitBuildSource struct {
// URI points to the source that will be built. The structure of the source
// will depend on the type of build to run
URI string `json:"uri,omitempty"`
// Ref is the branch/tag/ref to build.
Ref string `json:"ref,omitempty"`
}
// SourceControlUser defines the identity of a user of source control
type SourceControlUser struct {
Name string `json:"name,omitempty"`
Email string `json:"email,omitempty"`
}
// BuildStrategy contains the details of how to perform a build.
type BuildStrategy struct {
// Type is the kind of build strategy.
Type BuildStrategyType `json:"type"`
// DockerStrategy holds the parameters to the Docker build strategy.
DockerStrategy *DockerBuildStrategy `json:"dockerStrategy,omitempty"`
// SourceStrategy holds the parameters to the STI build strategy.
SourceStrategy *SourceBuildStrategy `json:"stiStrategy,omitempty"`
// CustomStrategy holds the parameters to the Custom build strategy.
CustomStrategy *CustomBuildStrategy `json:"customStrategy,omitempty"`
}
// BuildStrategyType describes a particular way of performing a build.
type BuildStrategyType string
// Valid values for BuildStrategyType.
const (
// DockerBuildStrategyType performs builds using a Dockerfile.
DockerBuildStrategyType BuildStrategyType = "Docker"
// SourceBuildStrategyType performs builds build using Source To Images with a Git repository
// and a builder image.
SourceBuildStrategyType BuildStrategyType = "STI"
// CustomBuildStrategyType performs builds using the custom builder Docker image.
CustomBuildStrategyType BuildStrategyType = "Custom"
)
const (
// CustomBuildStrategyBaseImageKey is the environment variable that indicates the base image to be used when
// performing a custom build, if needed.
CustomBuildStrategyBaseImageKey = "OPENSHIFT_CUSTOM_BUILD_BASE_IMAGE"
)
// CustomBuildStrategy defines input parameters specific to Custom build.
type CustomBuildStrategy struct {
// Additional environment variables you want to pass into a builder container
Env []kapi.EnvVar `json:"env,omitempty"`
// ExposeDockerSocket will allow running Docker commands (and build Docker images) from
// inside the Docker container.
// TODO: Allow admins to enforce 'false' for this option
ExposeDockerSocket bool `json:"exposeDockerSocket,omitempty"`
// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which
// the docker image should be pulled
From *kapi.ObjectReference `json:"from,omitempty"`
// PullSecretName is the name of a Secret that would be used for setting up
// the authentication for pulling the Docker images from the private Docker
// registries
PullSecretName string `json:"pullSecretName,omitempty"`
}
// DockerBuildStrategy defines input parameters specific to Docker build.
type DockerBuildStrategy struct {
// NoCache if set to true indicates that the docker build must be executed with the
// --no-cache=true flag
NoCache bool `json:"noCache,omitempty"`
// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which
// the docker image should be pulled
// the resulting image will be used in the FROM line of the Dockerfile for this build.
From *kapi.ObjectReference `json:"from,omitempty"`
// PullSecretName is the name of a Secret that would be used for setting up
// the authentication for pulling the Docker images from the private Docker
// registries
PullSecretName string `json:"pullSecretName,omitempty"`
}
// SourceBuildStrategy defines input parameters specific to an STI build.
type SourceBuildStrategy struct {
// From is reference to an ImageStream, ImageStreamTag, or ImageStreamImage from which
// the docker image should be pulled
From *kapi.ObjectReference `json:"from,omitempty"`
// PullSecretName is the name of a Secret that would be used for setting up
// the authentication for pulling the Docker images from the private Docker
// registries
PullSecretName string `json:"pullSecretName,omitempty"`
// Additional environment variables you want to pass into a builder container
Env []kapi.EnvVar `json:"env,omitempty"`
// Scripts is the location of STI scripts
Scripts string `json:"scripts,omitempty"`
// Incremental flag forces the STI build to do incremental builds if true.
Incremental bool `json:"incremental,omitempty"`
}
// BuildOutput is input to a build strategy and describes the Docker image that the strategy
// should produce.
type BuildOutput struct {
// To defines an optional ImageStream to push the output of this build to. The namespace
// may be empty, in which case the named ImageStream will be retrieved from the namespace
// of the build. Kind must be set to 'ImageStream' and is the only supported value. If set,
// this field takes priority over DockerImageReference. This value will be used to look up
// a Docker image repository to push to. Failure to find the To will result in a build error.
To *kapi.ObjectReference `json:"to,omitempty"`
// PushSecretName is the name of a Secret that would be used for setting
// up the authentication for executing the Docker push to authentication
// enabled Docker Registry (or Docker Hub).
PushSecretName string `json:"pushSecretName,omitempty"`
// Tag is the "version name" that will be associated with the output image. This
// field is only used if the To field is set, and is ignored when DockerImageReference is used.
// This value represents a consistent name for a set of related changes (v1, 5.x, 5.5, dev, stable)
// and defaults to the preferred tag for "To" if not specified.
Tag string `json:"tag,omitempty"`
// DockerImageReference is the full name of an image ([registry/]name[:tag]), and will be the
// value sent to Docker push at the end of a build if the To field is not defined.
DockerImageReference string `json:"dockerImageReference,omitempty"`
}
// BuildConfigLabel is the key of a Build label whose value is the ID of a BuildConfig
// on which the Build is based.
const BuildConfigLabel = "buildconfig"
// BuildConfig is a template which can be used to create new builds.
type BuildConfig struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// Triggers determine how new Builds can be launched from a BuildConfig. If no triggers
// are defined, a new build can only occur as a result of an explicit client build creation.
Triggers []BuildTriggerPolicy `json:"triggers,omitempty"`
// LastVersion is used to inform about number of last triggered build.
LastVersion int `json:"lastVersion,omitempty"`
// Parameters holds all the input necessary to produce a new build. A build config may only
// define either the Output.To or Output.DockerImageReference fields, but not both.
Parameters BuildParameters `json:"parameters,omitempty"`
}
// WebHookTrigger is a trigger that gets invoked using a webhook type of post
type WebHookTrigger struct {
// Secret used to validate requests.
Secret string `json:"secret,omitempty"`
}
// ImageChangeTrigger allows builds to be triggered when an ImageStream changes
type ImageChangeTrigger struct {
// LastTriggeredImageID is used internally by the ImageChangeController to save last
// used image ID for build
LastTriggeredImageID string `json:"lastTriggeredImageID,omitempty"`
}
// BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.
type BuildTriggerPolicy struct {
// Type is the type of build trigger
Type BuildTriggerType `json:"type,omitempty"`
// GithubWebHook contains the parameters for a GitHub webhook type of trigger
GithubWebHook *WebHookTrigger `json:"github,omitempty"`
// GenericWebHook contains the parameters for a Generic webhook type of trigger
GenericWebHook *WebHookTrigger `json:"generic,omitempty"`
// ImageChange contains parameters for an ImageChange type of trigger
ImageChange *ImageChangeTrigger `json:"imageChange,omitempty"`
}
// BuildTriggerType refers to a specific BuildTriggerPolicy implementation.
type BuildTriggerType string
const (
// GithubWebHookBuildTriggerType represents a trigger that launches builds on
// GitHub webhook invocations
GithubWebHookBuildTriggerType BuildTriggerType = "github"
// GenericWebHookBuildTriggerType represents a trigger that launches builds on
// generic webhook invocations
GenericWebHookBuildTriggerType BuildTriggerType = "generic"
// ImageChangeBuildTriggerType represents a trigger that launches builds on
// availability of a new version of an image
ImageChangeBuildTriggerType BuildTriggerType = "imageChange"
)
// BuildList is a collection of Builds.
type BuildList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
Items []Build `json:"items"`
}
// BuildConfigList is a collection of BuildConfigs.
type BuildConfigList struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
Items []BuildConfig `json:"items"`
}
// GenericWebHookEvent is the payload expected for a generic webhook post
type GenericWebHookEvent struct {
// Type is the type of source repository
Type BuildSourceType `json:"type,omitempty"`
// Git is the git information if the Type is BuildSourceGit
Git *GitInfo `json:"git,omitempty"`
}
// GitInfo is the aggregated git information for a generic webhook post
type GitInfo struct {
GitBuildSource `json:",inline"`
GitSourceRevision `json:",inline"`
// Refs is a list of GitRefs for the provided repo - generally sent
// when used from a post-receive hook. This field is optional and is
// used when sending multiple refs
Refs []GitRefInfo `json:"refs,omitempty"`
}
// GitRefInfo is a single ref
type GitRefInfo struct {
GitBuildSource `json:",inline"`
GitSourceRevision `json:",inline"`
}
// BuildLog is the (unused) resource associated with the build log redirector
type BuildLog struct {
kapi.TypeMeta `json:",inline"`
kapi.ListMeta `json:"metadata,omitempty"`
}
// BuildRequest is the resource used to pass parameters to build generator
type BuildRequest struct {
kapi.TypeMeta `json:",inline"`
kapi.ObjectMeta `json:"metadata,omitempty"`
// Revision is the information from the source for a specific repo snapshot.
Revision *SourceRevision `json:"revision,omitempty"`
}
// BuildLogOptions is the REST options for a build log
type BuildLogOptions struct {
kapi.TypeMeta
// Follow if true indicates that the build log should be streamed until
// the build terminates.
Follow bool
// NoWait if true causes the call to return immediately even if the build
// is not available yet. Otherwise the server will wait until the build has started.
NoWait bool
}