-
Notifications
You must be signed in to change notification settings - Fork 170
/
default.yaml
434 lines (418 loc) · 13.6 KB
/
default.yaml
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
---
auth:
# A private key used for signing jwt tokens
# Easily generate one by running
# $ openssl genrsa -out jwt.pem 2048
jwtPrivateKey: |
-----BEGIN RSA PRIVATE KEY-----
YOUR-KEY-HERE
-----END RSA PRIVATE KEY-----
# The public key used for verifying the signature
# Generate one by running
# $ openssl rsa -in jwt.pem -pubout -out jwt.pub
jwtPublicKey: |
-----BEGIN PUBLIC KEY-----
YOUR-KEY-HERE
-----END PUBLIC KEY-----
jwtQueueServicePublicKey: |
-----BEGIN PUBLIC KEY-----
YOUR-KEY-HERE
-----END PUBLIC KEY-----
# A password used for encrypting session data.
# **Needs to be minimum 32 characters**
cookiePassword: WOW-ANOTHER-INSECURE-PASSWORD!!!
# A password used for encrypting stored pipeline secrets and user Oauth token.
# **Needs to be minimum 32 characters**
encryptionPassword: WOW-ANOTHER-MORE-INSECURE-PASSWORD!!!
# A password used for hashing user/pipeline access tokens.
# **Needs to be minimum 32 characters**
hashingPassword: WOW-ANOTHER-MORE-INSECURE-PASSWORD!!!
# A flag to set if the server is running over https.
# Used as a flag for the OAuth flow
https: false
# A flag to set if you want guests to browse your pipelines
allowGuestAccess: false
# Deprecated. Instead, use allowList which is more secure.
# List of users able to authenticate against the system
# if empty, it allows everyone
# Values should follow '{scmDisplayName:scmUsername}' format
# Ex: ['github:john', 'bitbucket:john']
whitelist: []
# list of users able to authenticate against the system
# if empty, it allows everyone
# Values should follow '{scmDisplayName:scmUsername:scmUserId}' format
# Ex: ['github:john:12345', 'bitbucket:john:{98fsa1ba-0b91-4e3c-95ee-55899e933b0}']
allowList: []
# Deprecated. Instead, use sdAdmins which is more secure.
# List of users who should be given screwdriver admin privileges
# Values should follow '{scmDisplayName:scmUsername}' format
# Ex: ['github:john', 'bitbucket:john']
admins: []
# List of users who should be given screwdriver admin privileges
# Values should follow '{scmDisplayName:scmUsername:scmUserId}' format
# Ex: ['github:john:12345', 'bitbucket:john:{98fsa1ba-0b91-4e3c-95ee-55899e933b0}']
sdAdmins: []
# When set to true
# - grant admin privileges to the users listed in 'sdAdmins'
# - only authenticate the users listed in 'allowList'
# When set to false, performs
# - grant admin privileges to the users listed in 'admins'
# - only authenticate the users listed in 'whitelist'
authCheckById: true
# Default session timeout (in minutes)
sessionTimeout: 120
# SameSite Cookie Option
sameSite: Strict
# cookie path to access the cookie, set to '/'
path: /
shutdown:
terminationGracePeriod: TERMINATION_GRACE_PERIOD
httpd:
# Port to listen on
port: 80
# Host to listen on (set to localhost to only accept connections from this machine)
host: 0.0.0.0
# Externally routable URI (usually your load balancer or CNAME)
uri: http://localhost:80
# SSL Support
tls: false
# If you want SSL, you can easily add it by replacing `tls: false` with an object that
# provides the options required by `tls.createServer`
# https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener
# key: |
# PRIVATE KEY HERE
# cert: |
# YOUR CERT HERE
datastore:
plugin: sequelize
ddlSyncEnabled: "true"
sequelize:
# Type of server to talk to
dialect: sqlite
# More arguments here:
# http://docs.sequelizejs.com/en/latest/api/sequelize/
ssl: false
pool: {}
retry: {}
buildMetricsEnabled: "false"
# readOnly datastore config
# readOnly: {}
executor:
# Default executor
plugin: k8s
k8s:
enabled: true
options:
kubernetes:
# The host or IP of the kubernetes cluster
host: kubernetes.default
# The jwt token used for authenticating kubernetes requests
# Loaded from /var/run/secrets/kubernetes.io/serviceaccount/token by default
# Resources for build pod
resources:
# Number of cpu cores
cpu:
micro: "0.5"
low: 2
high: 6
# Memory in GB
memory:
micro: 1
low: 2
high: 12
# Default build timeout for all builds in this cluster (in minutes)
buildTimeout: 90
# Default max build timeout (in minutes)
maxBuildTimeout: 120
# k8s node selectors for appropriate pod scheduling
nodeSelectors: {}
preferredNodeSelectors: {}
# support for kata-containers-as-a-runtimeclass
runtimeClass: ""
# Launcher image to use
launchImage: screwdrivercd/launcher
# Container tags to use
launchVersion: stable
# nomad:
# enabled: true
# options:
# nomad:
# # The host or IP of the nomad cluster
# host: nomad.default/v1/jobs
# resources:
# cpu:
# high: 200
# memory:
# high: 2000
# # Container tags to use
# launchVersion: stable
docker:
enabled: true
options:
# Dockerode configuration https://github.com/apocas/dockerode#getting-started
docker: {}
# Container tags to use
launchVersion: stable
k8s-vm:
enabled: true
options:
# Configuration of Docker
kubernetes:
# The host or IP of the kubernetes cluster
host: kubernetes.default
# The jwt token used for authenticating kubernetes requests
# Loaded from /var/run/secrets/kubernetes.io/serviceaccount/token by default
# Resources for build pod
resources:
# Number of cpu cores
cpu:
micro: 1
low: 2
high: 6
# Memory in GB
memory:
micro: 1
low: 2
high: 12
# Default build timeout for all builds in this cluster (in minutes)
buildTimeout: 90
# Default max build timeout (in minutes)
maxBuildTimeout: 120
# k8s node selectors for appropriate pod scheduling
nodeSelectors: {}
preferredNodeSelectors: {}
# Launcher image to use
launchImage: screwdrivercd/launcher
# Launcher container tag to use
launchVersion: stable
# jenkins:
# options:
# # Configuration of Jenkins
# jenkins:
# host: jenkins.default
# port: 8080
# username: screwdriver
# password: "WOW-AN-EVEN-MORE-INSECURE-PASSWORD!!!!"
# # Default build timeout (in minutes)
# buildTimeout: 90
# # Default max build timeout (in minutes)
# maxBuildTimeout: 120
queue:
enabled: true
options:
# redis or redisCluster(beta)
connectionType: redis
# Configuration of the redis instance containing resque
redisConnection:
host: "127.0.0.1"
port: 9999
options:
password: "THIS-IS-A-PASSWORD"
tls: false
database: 0
redisClusterConnection:
hosts: []
options:
password: a-secure-password
tls: false
slotsRefreshTimeout: 1000
queueWebhook:
# Enabled events from webhook queue or not
enabled: false
scms: {}
# github:
# plugin: github
# config:
# # The client id used for OAuth with github. Look up GitHub OAuth for details
# # https://developer.github.com/v3/oauth/
# oauthClientId: YOU-PROBABLY-WANT-SOMETHING-HERE
# # The client secret used for OAuth with github
# oauthClientSecret: AGAIN-SOMETHING-HERE-IS-USEFUL
# # You can also configure for use with GitHub enterprise
# # gheHost: github.screwdriver.cd
# # The username and email used for checkout with github
# username: sd-buildbot
# email: [email protected]
# # Token for writing PR comments in Github, needs public_repo scope
# commentUserToken: A-BOT-GITHUB-PERSONAL-ACCESS-TOKEN
# # Secret to add to GitHub webhooks so that we can validate them
# secret: SUPER-SECRET-SIGNING-THING
# # Whether it supports private repo: boolean value.
# # If true, it will ask for read and write access to public and private repos
# # https://developer.github.com/v3/oauth/#scopes
# privateRepo: false
# bitbucket:
# plugin: bitbucket
# config:
# oauthClientId: YOUR-BITBUCKET-OAUTH-CLIENT-ID
# oauthClientSecret: YOUR-BITBUCKET-OAUTH-CLIENT-SECRET
# # The username and email used for checkout with bitbucket
# username: sd-buildbot
# email: [email protected]
# gitlab:
# plugin: gitlab
# config:
# oauthClientId: YOUR-GITLAB-OAUTH-CLIENT-ID
# oauthClientSecret: YOUR-GITLAB-OAUTH-CLIENT-SECRET
# # If you have on-premise gitlab, you can specify that here
# # gitlabHost: mygitlab.com
# # gitlabProtocol: https
# # The username and email used for checkout with gitlab
# username: sd-buildbot
# # email: [email protected]
# # read-only scm config, default false
# readOnly:
# # set true to enable read-only scm mode
# enabled: false
# # headless username
# username: headless-user
# # headless access token
# accessToken: headlesstoken
# # SCM clone type (https or ssh)
# cloneType: https
webhooks:
# Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
username: sd-buildbot
# Ignore commits made by these users
ignoreCommitsBy: []
# Restrict PR: all, none, branch, or fork
restrictPR: none
# Chain PR: true or false
chainPR: false
# Upper limit on incoming uploads to builds
maxBytes: 1048576 # 1MB
coverage:
default: "false"
plugin: sonar
sonar:
sdApiUrl: https://api.screwdriver.cd
sonarHost: https://sonar.screwdriver.cd
adminToken: your-sonar-admin-token
sdUiUrl: https://cd.screwdriver.cd
sonarEnterprise: false
sonarGitAppName: "Screwdriver Sonar PR Checks"
multiBuildCluster:
# Enabled multi build cluster feature or not
enabled: false
unzipArtifacts:
# Enabled unzip artifacts feature or not
enabled: false
bookends:
# Plugins for build setup
default:
setup:
- scm
- screwdriver-cache-bookend
teardown:
- screwdriver-artifact-bookend
- screwdriver-coverage-bookend
- screwdriver-cache-bookend
notifications:
options:
# Throw error when validation fails (default true); otherwise show warning
throwValidationErr: true
# # Email notification when a build finishes
# email:
# host: email-host
# port: email-port
# from: email-address-to-send-from
# username: optional-username
# password: optional-password
# # Slack notification when build finishes
# slack:
# # default workspace key
# defaultWorkspace: workspace1
# # Objects with slack token
# workspaces:
# # These keys are used in notification setting on screwdriver.yaml
# # ex)
# # settings:
# # slack:
# # channels:
# # - test-channel-1
# # - workspace1:test-channel-2
# # - workspace2:test-channel-1
# workspace1:
# token: your-slack-bot-token1
# workspace2:
# token: your-slack-bot-token2
ecosystem:
# Externally routable URL for the User Interface
ui: https://cd.screwdriver.cd
# Externally routable URL for the Artifact Store
store: https://store.screwdriver.cd
# Externally routable URL for the Queue Service
queue: https://queue.screwdriver.cd
# Badge service (needs to add a status and color)
badges: https://img.shields.io/badge/{{subject}}-{{status}}-{{color}}.svg
# Default registry to pull build containers from. Uses Docker Hub if nothing/empty string is provided
dockerRegistry: ""
# Extra origins allowed to do CORS to API
allowCors: []
# build cache strategies: s3, disk, with s3 as default option to store cache
cache:
strategy: "s3"
path: "/"
compress: false
md5check: false
max_size_mb: 0
max_go_threads: 10000
# environment release information
release:
mode: stable
cookieName: release
cookieValue: stable
cookieTimeout: 2 # in minutes
headerName: release
headerValue: stable
# Logging preferences
log:
audit:
# set true to enable audit logs for all API calls
enabled: false
# add target scope tokens(pipeline, build, temporal, admin, guest, user)
scope: []
# default cluster environment variables to inject into builds
build:
environment:
SD_VERSION: 4
artifacts:
# max artifact download size (in GB)
maxDownloadSize: 2
rateLimit:
# set true to enable rate limiting on auth token
enabled: false
# max request limit on auth token per duration, default: 300 (1 rps)
limit: 300
# limit duration in milliseconds, default: 300000 (5 mins)
duration: 300000
redisLock:
# set true to enable redis lock
enabled: false
options:
# maximum retry limit to obtain lock
retryCount: 200
# the expected clock drift
driftFactor: 0.01
# the time in milliseconds between retry attempts
retryDelay: 500
# the maximum time in milliseconds randomly added to retries
retryJitter: 200
# the maximum time in milliseconds living of a key that has a timeout
ttl: 20000
# redis or redisCluster(beta)
connectionType: redis
# Configuration of the redis instance
redisConnection:
host: "127.0.0.1"
port: 9999
options:
password: "THIS-IS-A-PASSWORD"
tls: false
database: 0
redisClusterConnection:
hosts: []
options:
password: "THIS-IS-A-PASSWORD"
tls: false
slotsRefreshTimeout: 1000