APIの管理

# config/local.yaml
auth:
    jwtPrivateKey: |
        PRIVATE KEY HERE
    jwtPublicKey: |
        PUBLIC KEY HERE
    jwtQueueServicePublicKey: |
        QUEUE SVC PUBLIC KEY HERE
    cookiePassword: 975452d6554228b581bf34197bcb4e0a08622e24
    encryptionPassword: 5c6d9edc3a951cda763f650235cfc41a3fc23fe8
    https: false
    whitelist:
        - github:batman
        - github:robin
    admins:
        - github:batman

# config/local.yaml
multiBuildCluster:
    enabled: true

# config/local.yaml
build:
    environment: CLUSTER-ENV-IN-JSON-FORMAT
    externalJoin: true

# config/local.yaml
bookends:
  default: 
    setup:
      - scm
      - my-custom-bookend
    teardown:
      - screwdriver-artifact-bookend
      - screwdriver-cache-bookend
  clusterA:
    setup: ...
    teardown: ...
  clusterB:
    setup: ...
    teardown: ...

# config/local.yaml
httpd:
    port: 443
    host: 0.0.0.0
    uri: https://localhost
    tls:
        key: |
            PRIVATE KEY HERE
        cert: |
            YOUR CERT HERE

# config/local.yaml
ecosystem:
    # 外部からルーティング可能なUI用URL
    ui: https://cd.screwdriver.cd
    # 外部からルーティング可能なArtifact Store用URL
    store: https://store.screwdriver.cd
    # 内部でルーティング可能な、キューsvcのFQDNS
    queue: http://sdqueuesvc.screwdriver.svc.cluster.local

# config/local.yaml
datastore:
    plugin: sequelize
    sequelize:
        dialect: TYPE-OF-SERVER
        storage: STORAGE-LOCATION
        database: DATABASE-NAME
        username: DATABASE-USERNAME
        password: DATABASE-PASSWORD
        host: NETWORK-HOST
        port: NETWORK-PORT
        readOnly: DATASTORE-READONLY-INSTANCE

# config/local.yaml
executor:
    plugin: k8s
    k8s:
        options:
            kubernetes:
                # kubernetes クラスタのホストかIP
                host: YOUR-KUBERNETES-HOST
                token: JWT-FOR-AUTHENTICATING-KUBERNETES-REQUEST
                jobsNamespace: default
            launchVersion: stable

# config/local.yaml
executor:
    plugin: k8s-vm
    k8s-vm:
        options:
            kubernetes:
                host: YOUR-KUBERNETES-HOST
                token: JWT-FOR-AUTHENTICATING-KUBERNETES-REQUEST
            launchVersion: stable

# config/local.yaml
executor:
    plugin: jenkins
    jenkins:
        options:
            jenkins:
                host: jenkins.default
                port: 8080
                username: screwdriver
                password: YOUR-PASSWORD
            launchVersion: stable

# config/local.yaml
executor:
    plugin: docker
    docker:
        options:
            docker:
                socketPath: /var/lib/docker.sock
            launchVersion: stable

# config/local.yaml
executor:
    plugin: queue
    queue: ''

# config/local.yaml
executor:
    plugin: nomad
    nomad:
        options:
            nomad:
                host: http://192.168.30.30:4646
            resources:
                cpu:
                    high: 600
                memory:
                    high: 4096
            launchVersion:  latest
            prefix:  'sd-build-'

# config/local.yaml
notifications:
    email:
        username: your-username # オプション SMTP username
        password: your-password # オプション SMTP password
        host: smtp.yourhost.com
        port: 25
        from: example@email.com

# config/local.yaml
notifications:
    slack:
        defaultWorkspace: your-workspace
        workspaces:
            your-workspace:
                token: 'YOUR-SLACK-BOT-TOKEN-HERE'
            secondary-workspace:
                token: 'ANOTHER-SLACK-BOT-TOKEN-HERE'

# config/local.yaml
notifications:
    email:
        host: smtp.yourhost.com
        port: 25
        from: example@email.com
    your-notification:
        foo: bar
        abc: 123

# config/local.yaml
notifications:
    your-notification:
        config:
            foo: bar
            abc: 123
        scopedPackage: '@scope/screwdriver-notifications-your-notification'

#config/local.yaml
notifications:
    options:
      throwValidationErr: false # デフォルト: true, バリデーションに失敗したときにエラーを出すかどうかの真偽値値
    slack:
        defaultWorkspace: your-workspace
        workspaces:
            your-workspace:
                token: 'YOUR-SLACK-BOT-TOKEN-HERE'
            secondary-workspace:
                token: 'ANOTHER-SLACK-BOT-TOKEN-HERE'
    email:
        host: smtp.yourhost.com
        port: 25
        from: example@email.com

# config/local.yaml
scms:
    github:
        plugin: github
        config:
            oauthClientId: YOU-PROBABLY-WANT-SOMETHING-HERE # OAuth Client ID (アプリケーションキー) (https://developer.github.com/v3/oauth/)
            oauthClientSecret: AGAIN-SOMETHING-HERE-IS-USEFUL # OAuth Client Secret (アプリケーションsecret)
            secret: SUPER-SECRET-SIGNING-THING # webhooks署名用のパスワード(secret)
            gheHost: github.screwdriver.cd # [Optional] GitHub Enterpriseの場合のGHEホスト
            username: sd-buildbot # [Optional] checkoutするユーザネーム
            email: dev-null@screwdriver.cd # [Optional] checkoutするユーザのEmailアドレス
            https: false # [Optional] Screwdriver APIがHTTPSで動作しているか、デフォルトはfalse
            commentUserToken: A_BOT_GITHUB_PERSONAL_ACCESS_TOKEN # [Optional] GitHubのPRにコメントを書き込むためのトークン、"public_repo"のスコープが必要
            privateRepo: false # [Optional] プライベートレポジトリの read/write権限
            autoDeployKeyGeneration: false # [Optional] trueにすると、deploy keyの公開鍵と秘密鍵を自動で生成し、それぞれをビルドパイプラインとチェックアウト用の Github のリポジトリに追加します。
    ...

# config/local.yaml
scms:
    ...
    # 下記はread-only SCMの例
    gitlab:
        plugin: gitlab
        config:
            oauthClientId: YOU-PROBABLY-WANT-SOMETHING-HERE # OAuth Client ID (アプリケーションキー)
            oauthClientSecret: AGAIN-SOMETHING-HERE-IS-USEFUL # OAuth Client Secret (アプリケーションsecret)
            gitlabHost: gitlab.screwdriver.cd # [Optional] GitLab enterpriseのホスト名
            commentUserToken: A_BOT_GITLAB_PERSONAL_ACCESS_TOKEN # [Optional] GitLabのPRにコメントを書き込むためのトークン
            https: false # [Optional] Screwdriver APIがHTTPSで動作しているか、デフォルトはfalse
            readOnly: # [Optional] read-only SCMのための設定
                enabled: true # trueに設定するとread-onlyモードが有効
                username: sd-buildbot # Headlessのユーザー名
                accessToken: GITLAB-TOKEN # リポジトリへのread-onlyアクセスとwebhooksの追加が可能なHeadless GitLabトークン
                cloneType: https # [Optional] sshまたはhttpsを設定、デフォルトはhttps

# config/local.yaml
scms:
    bitbucket:
        plugin: bitbucket
        config:
            oauthClientId: YOUR-APP-KEY # OAuth Client ID (アプリケーションキー)
            oauthClientSecret: YOUR-APP-SECRET # OAuth Client Secret (アプリケーションsecret)
            https: true # [Optional] Screwdriver APIがHTTPSで動作しているか、デフォルトはfalse
            username: sd-buildbot # [Optional] checkoutするユーザネーム
            email: dev-null@screwdriver.cd # [Optional] checkoutするユーザのEmailアドレス

# config/local.yaml
webhooks:
  username: SCM_USERNAME
  ignoreCommitsBy:
    __name: IGNORE_COMMITS_BY
    __format: json
  restrictPR: RESTRICT_PR

# config/local.yaml
rateLimit:
    enabled: true
    # リクエスト回数を1分間で最大60回に制限する
    limit: 60
    duration: 60000

# config/local.yaml
# environment release information
release:
    mode: stable
    cookieName: release
    cookieValue: stable
    cookieTimeout: 2 # in minutes
    headerName: release
    headerValue: stable

# config/local.yaml
redisLock:
  # Redisロックを有効にするには、trueを設定します。
  enabled: true
  options:
    # ロック取得までの最大リトライ回数
    retryCount: 200
    # 予想されるクロックドリフト
    driftFactor: 0.01
    # 再試行するまでの時間（ミリ秒)
    retryDelay: 500
    # 再試行回数にランダムに追加される最大時間（ミリ秒)
    retryJitter: 200
    # Redisインスタンスの設定
    redisConnection:
        host: "127.0.0.1"
        port: 6379
        options:
            password: '123'
            tls: false
        database: 0
        prefix: ""

# config/local.yaml
log:
  audit:
    # APIの呼び出し毎に Audit ログを出力するようにする場合はtrueにしてください
    enabled: false
    # 対象となるトークンのスコープ(pipeline, build, temporal, admin, guest, user)
    scope: []

# local.yaml
---
  ...
bookends:
  default:
    setup:
      - my-custom-bookend
      - scm

# partial Kubernetes configuration
  ...
spec:
  replicas: 1
  template:
    spec:
      containers:
      - name: screwdriver-api
        # The image name is the one you specified when built
        # The tag name is the tag you specified when built
        image: my_extended_docker_image_name:tag_name