screwdriver (11) Versions 0.3.1 Follow0

Installs/Configures Screwdriver

Policyfile

Berkshelf

Knife

cookbook 'screwdriver', '= 0.3.1', :supermarket

cookbook 'screwdriver', '= 0.3.1'

knife supermarket install screwdriver

knife supermarket download screwdriver

README

Dependencies

Changelog

Quality 43%

screwdriver Cookbook

This cookbook sets up a Screwdriver CI/CD service by Docker Compose.

Requirements
Attributes
Usage
License and Authors

Requirements

platforms

Debian >= 9.0
Ubuntu >= 14.04
CentOS, RHEL >= 7.3

packages

none.

cookbooks

docker-grid
ssl_cert

Attributes

Key	Type	Description, example	Default
`['screwdriver']['with_ssl_cert_cookbook']`	Boolean	See `attributes/default.rb`	`false`
`['screwdriver']['ssl_cert']['ca_names']`	Array	Internal CA names that are imported by the ssl_cert cookbook.	`[]`
`['screwdriver']['ssl_cert']['common_name']`	String	Server common name for TLS	`node['fqdn']`
`['screwdriver']['jwt_private_key_vault_item']`	Hash	Optional, Sets a JWT private key from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['jwt_public_key_vault_item']`	Hash	Optional, Sets a JWT public key from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['cookie_password_vault_item']`	Hash	Optional, Sets a session cookie password from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['password_vault_item']`	Hash	Optional, Sets a password for secrets encryption from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['ui']['tls_setup_mode']`	String	`'reverseproxy'` only. Note: Add TLS support to UI docker container #377	`'reverseproxy'`
`['screwdriver']['api']['config']`	Hash	This hash object is expanded to a `/config/local.yaml` file in the API Docker container.	See `attributes/default.rb`
`['screwdriver']['api']['scms_vault_items']`	Hash	This hash contains Chef Vault item definitions of SCM's secrets.	See `attributes/default.rb`
`['screwdriver']['store']['config']`	Hash	This hash object is expanded to a `/config/local.yaml` file in the Store Docker container.	See `attributes/default.rb`
`['screwdriver']['docker-compose']['import_ca']`	Boolean	whether import internal CA certificates or not.	`false`
`['screwdriver']['docker-compose']['app_dir']`	String	Path string.	`"#{node['docker-grid']['compose']['app_dir']}/screwdriver"`
`['screwdriver']['docker-compose']['bin_dir']`	String	Path string.	`"#{node['screwdriver']['docker-compose']['app_dir']}/bin"`
`['screwdriver']['docker-compose']['config_dir']`	String	Path string.	`"#{node['screwdriver']['docker-compose']['app_dir']}/config"`
`['screwdriver']['docker-compose']['data_dir']`	String	Path string.	`"#{node['screwdriver']['docker-compose']['app_dir']}/data"`
`['screwdriver']['docker-compose']['etc_dir']`	String	Path string.	`"#{node['screwdriver']['docker-compose']['app_dir']}/etc"`
`['screwdriver']['docker-compose']['jwt_private_key_reset']`	Boolean	Only available if the JWT key pair is automatically generated by Chef.	`false`
`['screwdriver']['docker-compose']['jwt_private_key_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['jwt_private_key_vault_item']`. Optional, Sets a JWT private key from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['jwt_public_key_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['jwt_public_key_vault_item']`. Optional, Sets a JWT public key from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['cookie_password_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['cookie_password_vault_item']`. Optional, Sets a session cookie password from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['password_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['password_vault_item']`. Optional, Sets a password for secrets encryption from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['oauth_client_id_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['api']['scms_vault_items']`. Required, Sets a OAuth client ID for SCM from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['oauth_client_secret_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['api']['scms_vault_items']`. Required, Sets a OAuth secret for SCM from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['webhook_github_secret_vault_item']`	Hash	DEPRECATED: use `['screwdriver']['api']['scms_vault_items']`. Required for GitHub, Sets a secret for GitHub webhook from Chef Vault. See `attributes/default.rb`	`{}`
`['screwdriver']['docker-compose']['config']`	Hash	`docker-compose.yml` configurations.	See `attributes/default.rb`

Usage

Recipes

screwdriver::default

This recipe does nothing.

screwdriver::docker-compose

This recipe generates JWT key pair and a docker-compose.yml file for the Screwdriver CI/CD service.

Role Examples

roles/screwdriver.rb

name 'screwdriver'
description 'screwdriver'

ui_port     = '9000'
api_port    = '9001'
store_port  = '9002'

run_list(
  'role[docker]',
  'recipe[screwdriver::docker-compose]',
)

override_attributes(
  'screwdriver' => {
    'api' => {
      'config' => {
        'executor' => {
          'plugin' => 'docker',
          'docker' => {
            'options' => {
              'docker' => {
                'socketPath' => '/var/run/docker.sock',
              },
              'launchVersion' => 'stable',
            },
          },
        },
        'scms' => {
          'github.com' => {
            'plugin' => 'github',
            'config' => {
              # OAuth Callback URL: "http://#{node['fqdn']}:9001/v4/auth/login/web"
              'username' => 'ci-tool',
              'email' => 'citool@mail.example.com',
              'privateRepo' => false,
            },
          },
        },
      },
      'scms_vault_items' => {
        'github.com' => {
          'oauthClientId' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientId',  # real hash path: "/oauthClientId"
          },
          'oauthClientSecret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientSecret',  # real hash path: "/oauthClientSecret"
          },
          'secret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'secret',  # real hash path: "/secret"
          },
        },
      },
    },
    'docker-compose' => {
      'config' => {
        'services' => {
          'api' => {
            'ports' => [
              "#{api_port}:80",
            ],
            'environment' => {
              'NODE_TLS_REJECT_UNAUTHORIZED' => '0',  # for self-signed cetificates
              # The following variables will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_UI' => "http://#{node['fqdn']}:#{ui_port}",
              #'ECOSYSTEM_STORE' => "http://#{node['fqdn']}:#{store_port}",
            },
          },
          'ui' => {
            'ports' => [
              "#{ui_port}:80",
            ],
            'environment' => {
              # These variables will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_API' => "http://#{node['fqdn']}:#{api_port}",
              #'ECOSYSTEM_STORE' => "http://#{node['fqdn']}:#{store_port}",
            },
          },
          'store' => {
            'ports' => [
              "#{store_port}:80",
            ],
            'environment' => {
              # This variable will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_UI' => "http://#{node['fqdn']}:#{ui_port}",
            },
          },
        },
      },
    },
  },
)

roles/screwdriver-with-ssl.rb

name 'screwdriver-with-ssl'
description 'screwdriver with SSL'

cn = 'screwdriver.io.example.com'
ui_port     = '9000'
api_port    = '9001'
store_port  = '9002'

run_list(
  'role[docker]',
  'recipe[screwdriver::docker-compose]',
)

override_attributes(
  'ssl_cert' => {
    #'common_names' => [
    #  cn,  # screwdriver cookbook < 0.2.2
    #],
  },
  'screwdriver' => {
    'with_ssl_cert_cookbook' => true,
    'ssl_cert' => {
      'common_name' => cn,
    },
    'api' => {
      'config' => {
        'executor' => {
          'plugin' => 'docker',
          'docker' => {
            'options' => {
              'docker' => {
                'socketPath' => '/var/run/docker.sock',
              },
              'launchVersion' => 'stable',
            },
          },
        },
        'scms' => {
          'github.com' => {
            'plugin' => 'github',
            'config' => {
              # OAuth Callback URL: "http://#{node['fqdn']}:9001/v4/auth/login/web"
              'username' => 'ci-tool',
              'email' => 'citool@mail.example.com',
              'privateRepo' => false,
            },
          },
        },
      },
      'scms_vault_items' => {
        'github.com' => {
          'oauthClientId' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientId',  # real hash path: "/oauthClientId"
          },
          'oauthClientSecret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientSecret',  # real hash path: "/oauthClientSecret"
          },
          'secret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'secret',  # real hash path: "/secret"
          },
        },
      },
    },
    'docker-compose' => {
      'config' => {
        'services' => {
          'reverseproxy' => {
            'ports' => [
              "#{ui_port}:9000",
            ],
            'environment' => {
            },
          },
          'api' => {
            'ports' => [
              "#{api_port}:80",
            ],
            'environment' => {
              'NODE_TLS_REJECT_UNAUTHORIZED' => '0',  # for self-signed cetificates
              # The following variables will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_UI' => "http://#{node['fqdn']}:#{ui_port}",
              #'ECOSYSTEM_STORE' => "http://#{node['fqdn']}:#{store_port}",
            },
          },
          'ui' => {
            #'ports' => [
            #  "#{ui_port}:80",
            #],
            'environment' => {
              # These variables will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_API' => "http://#{node['fqdn']}:#{api_port}",
              #'ECOSYSTEM_STORE' => "http://#{node['fqdn']}:#{store_port}",
            },
          },
          'store' => {
            'ports' => [
              "#{store_port}:80",
            ],
            'environment' => {
              # These variables will be set by the screwdriver::docker-compose recipe automatically.
              #'ECOSYSTEM_UI' => "http://#{node['fqdn']}:#{ui_port}",
            },
          },
        },
      },
    },
  },
)

SSL server keys and certificates management by ssl_cert cookbook

create vault items.

$ ruby -rjson -e 'puts JSON.generate({"private" => File.read("screwdriver.io.example.com.prod.key")})' \
> > ~/tmp/screwdriver.io.example.com.prod.key.json

$ ruby -rjson -e 'puts JSON.generate({"public" => File.read("screwdriver.io.example.com.prod.crt")})' \
> > ~/tmp/screwdriver.io.example.com.prod.crt.json

$ cd $CHEF_REPO_PATH

$ knife vault create ssl_server_keys screwdriver.io.example.com.prod \
> --json ~/tmp/screwdriver.io.example.com.prod.key.json

$ knife vault create ssl_server_certs screwdriver.io.example.com.prod \
> --json ~/tmp/screwdriver.io.example.com.prod.crt.json

grant reference permission to the screwdriver host

$ knife vault update ssl_server_keys  screwdriver.io.example.com.prod -S 'name:screwdriver-host.example.com'
$ knife vault update ssl_server_certs screwdriver.io.example.com.prod -S 'name:screwdriver-host.example.com'

modify attributes

override_attributes(
  'ssl_cert' => {
    #'common_names' => [
    #  'screwdriver.io.example.com',  # screwdriver cookbook < 0.2.2
    #],
  },
  'screwdriver' => {
    'with_ssl_cert_cookbook' => true,
    'ssl_cert' => {
      'common_name' => 'screwdriver.io.example.com',
    },
    # ...
  },
)

JWT private and public keys management by Chef Vault

create vault items.

$ ruby -rjson -e 'puts JSON.generate({"private" => File.read("screwdriver_jwt_private.key")})' \
> > ~/sec/tmp/screwdriver_jwt_private.key.json

$ ruby -rjson -e 'puts JSON.generate({"public" => File.read("screwdriver_jwt_public.key")})' \
> > ~/sec/tmp/screwdriver_jwt_public.key.json

$ cd $CHEF_REPO_PATH

$ knife vault create screwdriver jwt_private_key \
> --json ~/sec/tmp/screwdriver_jwt_private.key.json

$ knife vault create screwdriver screwdriver_jwt_public \
> --json ~/sec/tmp/screwdriver_jwt_public.key.json

grant reference permission to the screwdriver host

$ knife vault update screwdriver jwt_private_key -S 'name:screwdriver-host.example.com'
$ knife vault update screwdriver jwt_public_key  -S 'name:screwdriver-host.example.com'

modify attributes

override_attributes(
  'screwdriver' => {
    # ...
    'jwt_private_key_vault_item' => {
      'vault' => 'screwdriver',
      'name' => 'jwt_private_key',
      'env_context' => false,
      'key' => 'private',
    },
    'jwt_public_key_vault_item' => {
      'vault' => 'screwdriver',
      'name' => 'jwt_public_key',
      'env_context' => false,
      'key' => 'public',
    },
    # ...
  },
)

create vault items.

# A password used for encrypting session data. Needs to be minimum 32 characters
$ cat ~/tmp/screwdriver_cookie_password.json
{"password":"********************************"}

$ cd $CHEF_REPO_PATH
$ knife vault create screwdriver cookie_password --json ~/sec/tmp/screwdriver_cookie_password.json

grant reference permission to the screwdriver host

$ knife vault update screwdriver cookie_password -S 'name:screwdriver-host.example.com'

modify attributes

override_attributes(
  'screwdriver' => {
    # ...
    'cookie_password_vault_item' => {
      'vault' => 'screwdriver',
      'name' => 'cookie_password',
      'env_context' => false,
      'key' => 'password',
    },
    # ...
  },
)

Secrets encryption password management by Chef Vault

create vault items.

# A password used for encrypting stored secrets. Needs to be minimum 32 characters
$ cat ~/tmp/screwdriver_password.json
{"password":"********************************"}

$ cd $CHEF_REPO_PATH
$ knife vault create screwdriver password --json ~/sec/tmp/screwdriver_password.json

grant reference permission to the screwdriver host

$ knife vault update screwdriver password -S 'name:screwdriver-host.example.com'

modify attributes

override_attributes(
  'screwdriver' => {
    # ...
    'password_vault_item' => {
      'vault' => 'screwdriver',
      'name' => 'password',
      'env_context' => false,
      'key' => 'password',
    },
    # ...
  },
)

OAuth client ID, secret and GitHub webhook secret management by Chef Vault

create vault items.

$ cat ~/sec/tmp/screwdriver_github_secrets.json
{
  "oauthClientId": "***************************************************************",
  "oauthClientSecret": "***************************************************************",
  "secret": "**************************"
}

$ cd $CHEF_REPO_PATH

$ knife vault create screwdriver github --json ~/sec/tmp/screwdriver_github_secrets.json

grant reference permission to the screwdriver host

$ knife vault update screwdriver github -S 'name:screwdriver-host.example.com'

modify attributes

override_attributes(
  'screwdriver' => {
    # ...
    'api' => {
      # ...
      'scms_vault_items' => {
        'github.com' => {
          'oauthClientId' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientId',  # real hash path: "/oauthClientId"
          },
          'oauthClientSecret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'oauthClientSecret',  # real hash path: "/oauthClientSecret"
          },
          'secret' => {
            'vault' => 'screwdriver',
            'name' => 'github',
            'env_context' => false,
            'key' => 'secret',  # real hash path: "/secret"
          },
        },
      },
    },
    # ...
  },
)

License and Authors

Author:: whitestar at osdn.jp

Copyright 2017, whitestar

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.

Dependent cookbooks

docker-grid >= 0.4.0

ssl_cert >= 0.4.1

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

screwdriver CHANGELOG

0.3.1

revises documents.

0.3.0

adds multiple SCM support.
refactoring.

0.2.2

improves server key pair deployment.

0.2.1

revises documents.
bug fix.

0.2.0

adds a reverse proxy service (Nginx) for the UI service SSL/TLS settings.
bug fix.

0.1.0

Initial release of screwdriver

Collaborator Number Metric

0.3.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric

0.3.1 passed this metric

License Metric

0.3.1 passed this metric

No Binaries Metric

0.3.1 passed this metric

Testing File Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

screwdriver (11) Versions 0.3.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.0 Follow0

screwdriver Cookbook

Contents

Requirements

platforms

packages

cookbooks

Attributes

Usage

Recipes

screwdriver::default

screwdriver::docker-compose

Role Examples

SSL server keys and certificates management by ssl_cert cookbook

JWT private and public keys management by Chef Vault

Cookie password management by Chef Vault

Secrets encryption password management by Chef Vault

OAuth client ID, secret and GitHub webhook secret management by Chef Vault

License and Authors

Dependent cookbooks

Contingent cookbooks

screwdriver CHANGELOG

0.3.1

0.3.0

0.2.2

0.2.1

0.2.0

0.1.0

Collaborator Number Metric 0.3.1 failed this metric Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric 0.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric 0.3.1 passed this metric

License Metric 0.3.1 passed this metric

No Binaries Metric 0.3.1 passed this metric

Testing File Metric 0.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric 0.3.1 failed this metric Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Details

Updated December 3, 2017 Created on September 2, 2017

Supported Platforms

License

screwdriver (11) Versions 0.3.1 Follow0

Collaborator Number Metric

0.3.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric

0.3.1 passed this metric

License Metric

0.3.1 passed this metric

No Binaries Metric

0.3.1 passed this metric

Testing File Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric

0.3.1 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number