2 # Cookbook Name:: screwdriver
3 # Recipe:: docker-compose
5 # Copyright 2017, whitestar
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
20 doc_url = 'https://hub.docker.com/r/screwdrivercd/screwdriver/'
22 ::Chef::Recipe.send(:include, SSLCert::Helper)
24 #include_recipe 'platform_utils::kernel_user_namespace'
25 include_recipe 'docker-grid::compose'
32 'socketPath' => '/var/run/docker.sock',
34 'launchVersion' => 'stable',
39 app_dir = node['screwdriver']['docker-compose']['app_dir']
40 bin_dir = node['screwdriver']['docker-compose']['bin_dir']
41 config_dir = node['screwdriver']['docker-compose']['config_dir']
42 data_dir = node['screwdriver']['docker-compose']['data_dir']
43 etc_dir = node['screwdriver']['docker-compose']['etc_dir']
52 resources(directory: dir) rescue directory dir do
60 api_config_file = "#{config_dir}/api-local.yaml"
61 env_file = "#{app_dir}/.env"
62 config_file = "#{app_dir}/docker-compose.yml"
64 api_config_local = nil
65 if File.exist?(api_config_file)
67 api_config_local = YAML.load_file(api_config_file)
71 if File.exist?(env_file)
73 File.open(env_file) do |file|
74 file.each_line do |line|
75 env_local[$1] = $2 if line =~ /^([^=]*)=(.*)$/
81 config_srvs_local = nil
82 if File.exist?(config_file)
84 config_srvs_local = YAML.load_file(config_file)['services']
88 # We use plain Hash objects instead of Chef attribute objects for containg secrets (JWT key pair).
89 override_api_config = node['screwdriver']['api']['config'].to_hash
90 override_store_config = node['screwdriver']['store']['config'].to_hash
91 #override_api_config = node.override['screwdriver']['api']['config'] # NG
92 #override_store_config = node.override['screwdriver']['store']['config'] # NG
94 config_srvs = node['screwdriver']['docker-compose']['config']['services']
95 override_config_srvs = node.override['screwdriver']['docker-compose']['config']['services']
96 force_override_config_srvs = node.force_override['screwdriver']['docker-compose']['config']['services']
99 api_envs_org = config_srvs['api']['environment']
101 api_vols = config_srvs['api']['volumes'].to_a
103 api_port = '9001' # default
104 api_in_port = api_envs_org['PORT']
105 ports = config_srvs['api']['ports']
107 override_config_srvs['api']['ports'] = ["#{api_port}:#{api_in_port}"]
110 elms = port.split(':')
111 api_port = (elms.size == 2 ? elms[0] : elms[1]) if elms.last == api_in_port
115 override_api_config['executor'] = default_executor if override_api_config['executor'].empty?
118 'jwt_private_key_vault_item',
119 'jwt_public_key_vault_item',
120 'cookie_password_vault_item',
121 'password_vault_item',
123 # for backward compatibility.
124 if node['screwdriver'][vault_item].empty? && !node['screwdriver']['docker-compose'][vault_item].empty?
125 node.force_override['screwdriver'][vault_item] = node['screwdriver']['docker-compose'][vault_item].to_hash
129 jwt_private_key_reset = node['screwdriver']['docker-compose']['jwt_private_key_reset']
130 jwt_private_key = nil
132 jwt_private_key_vault_item = node['screwdriver']['jwt_private_key_vault_item']
133 jwt_public_key_vault_item = node['screwdriver']['jwt_public_key_vault_item']
135 if !jwt_private_key_vault_item.empty?
136 # 1. from Chef Vault (recommended).
137 jwt_private_key = get_vault_item_value(jwt_private_key_vault_item)
138 jwt_public_key = get_vault_item_value(jwt_public_key_vault_item)
139 log 'JWT key pair has been loaded from Chef Vault.'
141 # 2. from Chef attribute (NOT recommended).
142 jwt_private_key = api_envs_org['SECRET_JWT_PRIVATE_KEY']
143 jwt_public_key = api_envs_org['SECRET_JWT_PUBLIC_KEY']
144 if jwt_private_key.nil? || jwt_private_key.empty?
145 if !api_config_local.nil? && !api_config_local['auth']['jwtPrivateKey'].nil? && !jwt_private_key_reset
146 # 3. preserve it from the local config/api-local.yaml file.
147 jwt_private_key = api_config_local['auth']['jwtPrivateKey']
148 jwt_public_key = api_config_local['auth']['jwtPublicKey']
149 log 'JWT key pair is preserved from the local config/api-local.yaml file.'
150 # if !env_local.nil? && !env_local['SECRET_JWT_PRIVATE_KEY'].nil? && !jwt_private_key_reset
151 # # 3. preserve it from the local .env file.
152 # # Note: Docker env file format does not support backslash escaped string yet.
153 # eval "jwt_private_key = %Q(#{env_local['SECRET_JWT_PRIVATE_KEY']})"
154 # eval "jwt_public_key = %Q(#{env_local['SECRET_JWT_PUBLIC_KEY']})"
155 # log 'JWT key pair is preserved from the local .env file.'
159 rsa = OpenSSL::PKey::RSA.generate(2048)
160 jwt_private_key = rsa.export
161 jwt_public_key = rsa.public_key.export
162 log 'JWT key pair has been generated.'
167 override_api_config['auth']['jwtPrivateKey'] = jwt_private_key
168 override_api_config['auth']['jwtPublicKey'] = jwt_public_key
169 # Note: prevent Chef from logging JWT key attribute values. (=> template variables)
170 # However Docker env file format does not support multi-line value and backslash escaped string yet.
171 #api_envs['SECRET_JWT_PRIVATE_KEY'] = '${SECRET_JWT_PRIVATE_KEY}' # Useless
172 #api_envs['SECRET_JWT_PUBLIC_KEY'] = '${SECRET_JWT_PUBLIC_KEY}' # Useless
173 #api_envs['SECRET_JWT_PRIVATE_KEY'] = jwt_private_key # NG
174 #api_envs['SECRET_JWT_PUBLIC_KEY'] = jwt_public_key # NG
176 cookie_password = nil
177 cookie_password_vault_item = node['screwdriver']['cookie_password_vault_item']
178 unless cookie_password_vault_item.empty?
179 cookie_password = get_vault_item_value(cookie_password_vault_item)
180 api_envs['SECRET_COOKIE_PASSWORD'] = '${SECRET_COOKIE_PASSWORD}'
184 password_vault_item = node['screwdriver']['password_vault_item']
185 unless password_vault_item.empty?
186 password = get_vault_item_value(password_vault_item)
187 api_envs['SECRET_PASSWORD'] = '${SECRET_PASSWORD}'
190 node['screwdriver']['api']['scms_vault_items'].each {|scm, props|
191 props.each {|prop, vault_item|
192 unless vault_item.empty?
193 secret = get_vault_item_value(vault_item)
194 override_api_config['scms'][scm]['config'][prop] = secret
200 oauth_client_id = nil
201 oauth_client_id_vault_item = node['screwdriver']['docker-compose']['oauth_client_id_vault_item']
202 unless oauth_client_id_vault_item.empty?
203 oauth_client_id = get_vault_item_value(oauth_client_id_vault_item)
204 api_envs['SECRET_OAUTH_CLIENT_ID'] = '${SECRET_OAUTH_CLIENT_ID}'
207 oauth_client_secret = nil
208 oauth_client_secret_vault_item = node['screwdriver']['docker-compose']['oauth_client_secret_vault_item']
209 unless oauth_client_secret_vault_item.empty?
210 oauth_client_secret = get_vault_item_value(oauth_client_secret_vault_item)
211 api_envs['SECRET_OAUTH_CLIENT_SECRET'] = '${SECRET_OAUTH_CLIENT_SECRET}'
214 webhook_github_secret = nil
215 webhook_github_secret_vault_item = node['screwdriver']['docker-compose']['webhook_github_secret_vault_item']
216 unless webhook_github_secret_vault_item.empty?
217 webhook_github_secret = get_vault_item_value(webhook_github_secret_vault_item)
218 api_envs['WEBHOOK_GITHUB_SECRET'] = '${WEBHOOK_GITHUB_SECRET}'
223 db_username_vault_item = node['screwdriver']['db_username_vault_item']
224 unless db_username_vault_item.empty?
225 db_username = get_vault_item_value(db_username_vault_item)
226 api_envs['DATASTORE_SEQUELIZE_USERNAME'] = '${DB_USERNAME}'
230 db_password_vault_item = node['screwdriver']['db_password_vault_item']
231 unless db_password_vault_item.empty?
232 db_password = get_vault_item_value(db_password_vault_item)
233 api_envs['DATASTORE_SEQUELIZE_PASSWORD'] = '${DB_PASSWORD}'
236 db_root_password = nil
237 db_root_password_vault_item = node['screwdriver']['db_root_password_vault_item']
238 unless db_root_password_vault_item.empty?
239 db_root_password = get_vault_item_value(db_root_password_vault_item)
242 db_dialect = api_envs_org['DATASTORE_SEQUELIZE_DIALECT']
245 api_vols.push("#{data_dir}:/sd-data:rw")
246 api_envs['DATASTORE_SEQUELIZE_STORAGE'] = '/sd-data/storage.db'
247 when 'mysql', 'postgres'
248 override_config_srvs['api']['links'] = ['db']
249 api_envs['DATASTORE_SEQUELIZE_HOST'] = 'db'
253 if db_dialect != 'sqlite'
254 #db_envs_org = config_srvs['db']['environment']
256 db_vols = config_srvs['db']['volumes'].to_a
260 mysql_data_dir = "#{data_dir}/mysql"
261 resources(directory: mysql_data_dir) rescue directory mysql_data_dir do
268 db_vols.push("#{mysql_data_dir}:/var/lib/mysql:rw")
269 db_envs['MYSQL_DATABASE'] = api_envs_org['DATASTORE_SEQUELIZE_DATABASE']
270 db_envs['MYSQL_USER'] = '${DB_USERNAME}' unless db_username.nil?
271 db_envs['MYSQL_PASSWORD'] = '${DB_PASSWORD}' unless db_password.nil?
272 db_envs['MYSQL_ROOT_PASSWORD'] = '${DB_ROOT_PASSWORD}' unless db_root_password.nil?
274 pg_data_dir = "#{data_dir}/postgres"
275 resources(directory: pg_data_dir) rescue directory pg_data_dir do
282 db_vols.push("#{pg_data_dir}:/database:rw")
283 db_envs['POSTGRES_DB'] = api_envs_org['DATASTORE_SEQUELIZE_DATABASE']
284 db_envs['POSTGRES_USER'] = '${DB_USERNAME}' unless db_username.nil?
285 db_envs['POSTGRES_PASSWORD'] = '${DB_PASSWORD}' unless db_password.nil?
286 db_envs['PGDATA'] = '/database'
291 #ui_envs_org = config_srvs['ui']['environment']
293 ui_vols = config_srvs['ui']['volumes'].to_a
295 ui_port = '9000' # default
297 ports = config_srvs['ui']['ports']
299 override_config_srvs['ui']['ports'] = ["#{ui_port}:#{ui_in_port}"]
302 elms = port.split(':')
303 ui_port = (elms.size == 2 ? elms[0] : elms[1]) if elms.last == ui_in_port
308 store_backend = node['screwdriver']['store']['backend']
309 store_envs_org = config_srvs['store']['environment']
311 store_vols = config_srvs['store']['volumes'].to_a
313 store_port = '9002' # default
314 store_in_port = store_envs_org['PORT']
315 ports = config_srvs['store']['ports']
317 override_config_srvs['store']['ports'] = ["#{store_port}:#{store_in_port}"]
320 elms = port.split(':')
321 store_port = (elms.size == 2 ? elms[0] : elms[1]) if elms.last == store_in_port
325 s3_access_key_id = nil
326 s3_access_key_id_vault_item = node['screwdriver']['s3_access_key_id_vault_item']
327 unless s3_access_key_id_vault_item.empty?
328 s3_access_key_id = get_vault_item_value(s3_access_key_id_vault_item)
329 store_envs['S3_ACCESS_KEY_ID'] = '${S3_ACCESS_KEY_ID}'
332 s3_access_key_secret = nil
333 s3_access_key_secret_vault_item = node['screwdriver']['s3_access_key_secret_vault_item']
334 unless s3_access_key_secret_vault_item.empty?
335 s3_access_key_secret = get_vault_item_value(s3_access_key_secret_vault_item)
336 store_envs['S3_ACCESS_KEY_SECRET'] = '${S3_ACCESS_KEY_SECRET}'
339 # S3 compatible server
340 if !store_backend.nil? && !store_backend.empty?
341 override_config_srvs['store']['links'] = ['screwdriver.s3']
342 store_envs['STRATEGY'] = 's3'
343 store_envs['S3_BUCKET'] = 'screwdriver'
345 #s3_envs_org = config_srvs['screwdriver.s3']['environment']
347 s3_vols = config_srvs['screwdriver.s3']['volumes'].to_a
349 s3_port = '9010' # default
351 ports = config_srvs['screwdriver.s3']['ports']
355 store_envs['S3_REGION'] = 'us-east-1'
356 store_envs['S3_ENDPOINT'] = "http://s3:#{s3_in_port}/screwdriver" # for path style
357 store_envs['S3_SIG_VER'] = 'v4'
360 override_config_srvs['screwdriver.s3']['ports'] = ["#{s3_port}:#{s3_in_port}"]
363 elms = port.split(':')
364 s3_port = (elms.size == 2 ? elms[0] : elms[1]) if elms.last == s3_in_port
368 minio_data_dir = "#{data_dir}/minio"
369 resources(directory: minio_data_dir) rescue directory minio_data_dir do
376 s3_vols.push("#{minio_data_dir}:/export:rw")
377 s3_envs['MINIO_ACCESS_KEY'] = '${S3_ACCESS_KEY_ID}' unless s3_access_key_id.nil?
378 s3_envs['MINIO_SECRET_KEY'] = '${S3_ACCESS_KEY_SECRET}' unless s3_access_key_secret.nil?
382 override_store_config['auth']['jwtPublicKey'] = jwt_public_key
383 # Note: prevent Chef from logging JWT key attribute value. (=> template variables)
384 # However Docker env file format does not support multi-line value and backslash escaped string yet.
385 #store_envs['SECRET_JWT_PUBLIC_KEY'] = '${SECRET_JWT_PUBLIC_KEY}' # Useless
386 #store_envs['SECRET_JWT_PUBLIC_KEY'] = jwt_public_key # NG
388 api_uri = api_envs_org['URI']
389 store_uri = store_envs_org['URI']
390 ui_uri = api_uri.gsub(/:\d+/, ":#{ui_port}") # based on the API URI.
392 if node['screwdriver']['with_ssl_cert_cookbook']
393 cn = node['screwdriver']['ssl_cert']['common_name']
394 append_server_ssl_cn(cn)
395 include_recipe 'ssl_cert::server_key_pairs'
397 server_cert = server_cert_content(cn)
398 server_key = server_key_content(cn)
400 api_uri = api_uri.gsub('http://', 'https://')
401 store_uri = store_uri.gsub('http://', 'https://')
403 override_api_config['httpd']['tls'] = {} # for FalseClass by default.
404 override_api_config['httpd']['tls']['cert'] = server_cert
405 override_api_config['httpd']['tls']['key'] = server_key
406 api_envs['IS_HTTPS'] = 'true'
408 override_store_config['httpd']['tls'] = {} # for FalseClass by default.
409 override_store_config['httpd']['tls']['cert'] = server_cert
410 override_store_config['httpd']['tls']['key'] = server_key
412 # Note: Screwdriver UI image does not support TLS settings yet.
413 # https://github.com/screwdriver-cd/screwdriver/issues/377
415 if node['screwdriver']['ui']['tls_setup_mode'] == 'reverseproxy'
416 rproxy_in_port = '9000'
417 ports = config_srvs['reverseproxy']['ports']
419 override_config_srvs['reverseproxy']['ports'] = ["#{ui_port}:#{rproxy_in_port}"]
422 elms = port.split(':')
423 ui_port = (elms.size == 2 ? elms[0] : elms[1]) if elms.last == rproxy_in_port
426 ui_uri = api_uri.gsub(/:\d+/, ":#{ui_port}") # based on the API URI.
427 # do not expose UI service directly.
428 node.rm('screwdriver', 'docker-compose', 'config', 'services', 'ui', 'ports')
430 rproxy_vols = config_srvs['reverseproxy']['volumes'].to_a
431 rproxy_vols.push("#{etc_dir}/nginx/nginx.conf:/etc/nginx/nginx.conf:ro")
432 # Nginx parent process owner is root.
433 rproxy_vols.push("#{server_cert_path(cn)}:/root/server.crt:ro")
434 rproxy_vols.push("#{server_key_path(cn)}:/root/server.key:ro")
435 # reset vlumes array.
436 override_config_srvs['reverseproxy']['volumes'] = rproxy_vols
438 template "#{etc_dir}/nginx/nginx.conf" do
439 source 'opt/docker-compose/app/screwdriver/etc/nginx/nginx.conf'
446 node.rm('screwdriver', 'docker-compose', 'config', 'services', 'reverseproxy')
447 # TODO: in the future.
450 node.rm('screwdriver', 'docker-compose', 'config', 'services', 'reverseproxy')
454 api_envs['URI'] = api_uri
455 api_envs['ECOSYSTEM_STORE'] = store_uri
456 api_envs['ECOSYSTEM_UI'] = ui_uri
458 ui_envs['ECOSYSTEM_API'] = api_uri
459 ui_envs['ECOSYSTEM_STORE'] = store_uri
461 store_envs['URI'] = store_uri
462 store_envs['ECOSYSTEM_UI'] = ui_uri
465 if node['screwdriver']['docker-compose']['import_ca']
466 node['screwdriver']['ssl_cert']['ca_names'].each {|ca_name|
467 append_ca_name(ca_name)
468 ca_cert_vol = "#{ca_cert_path(ca_name)}:/usr/share/ca-certificates/#{ca_name}.crt:ro"
469 api_vols.push(ca_cert_vol)
470 #ui_vols.push(ca_cert_vol)
472 include_recipe 'ssl_cert::ca_certs'
474 import_ca_script = '/usr/local/bin/screwdriver_import_ca'
475 template "#{bin_dir}/screwdriver_import_ca" do
476 source 'opt/docker-compose/app/screwdriver/bin/screwdriver_import_ca'
482 import_ca_script_vol = "#{bin_dir}/screwdriver_import_ca:#{import_ca_script}:ro"
483 api_vols.push(import_ca_script_vol)
484 #ui_vols.push(import_ca_script_vol)
486 api_command = config_srvs['api']['command']
487 override_config_srvs['api']['command'] \
488 = "/bin/sh -c \"#{import_ca_script} && #{api_command}\""
495 local_yaml_file = "#{config_dir}/#{srv}-local.yaml"
500 srv_config = override_api_config
502 srv_vols = store_vols
503 srv_config = override_store_config
506 template local_yaml_file do
507 source "opt/docker-compose/app/screwdriver/config/#{srv}-local.yaml"
512 # prevent Chef from logging password attribute value.
518 srv_vols.push("#{local_yaml_file}:/config/local.yaml:ro")
521 # merge environment hash
522 force_override_config_srvs['api']['environment'] = api_envs unless api_envs.empty?
523 force_override_config_srvs['ui']['environment'] = ui_envs unless ui_envs.empty?
524 force_override_config_srvs['store']['environment'] = store_envs unless store_envs.empty?
525 if db_dialect != 'sqlite'
526 force_override_config_srvs['db']['environment'] = db_envs unless db_envs.empty?
528 if !store_backend.nil? && !store_backend.empty?
529 force_override_config_srvs['screwdriver.s3']['environment'] = s3_envs unless s3_envs.empty?
531 # reset vlumes array.
532 override_config_srvs['api']['volumes'] = api_vols unless api_vols.empty?
533 override_config_srvs['ui']['volumes'] = ui_vols unless ui_vols.empty?
534 override_config_srvs['store']['volumes'] = store_vols unless store_vols.empty?
535 if db_dialect != 'sqlite'
536 override_config_srvs['db']['volumes'] = db_vols unless db_vols.empty?
538 if !store_backend.nil? && !store_backend.empty?
539 override_config_srvs['screwdriver.s3']['volumes'] = s3_vols unless s3_vols.empty?
543 source 'opt/docker-compose/app/screwdriver/.env'
548 # prevent Chef from logging password attribute value.
551 cookie_password: cookie_password,
553 db_username: db_username,
554 db_password: db_password,
555 db_root_password: db_root_password,
556 s3_access_key_id: s3_access_key_id,
557 s3_access_key_secret: s3_access_key_secret,
559 # JWT keys setting -> /config/local.yaml
560 #jwt_private_key: jwt_private_key,
561 #jwt_public_key: jwt_public_key,
562 # SCM secrets setting -> /config/local.yaml
563 #oauth_client_id: oauth_client_id,
564 #oauth_client_secret: oauth_client_secret,
565 #webhook_github_secret: webhook_github_secret
569 template config_file do
570 source 'opt/docker-compose/app/screwdriver/docker-compose.yml'
576 log 'screwdriver docker-compose post install message' do
578 Note: You must execute the following command manually.
582 $ sudo docker-compose up -d
584 $ sudo docker-compose down