custom-environment-variables.yaml

# All values in this document are the ENVIRONMENT variable names that can override the defaults
# from `default.yaml`
---
auth:
    # A private key uses for signing jwt tokens
    # Easily generate one by running
    # $ openssl genrsa -out jwt.pem 2048
    jwtPrivateKey: SECRET_JWT_PRIVATE_KEY
    # The public key used for verifying the signature
    # Generate one by running
    # $ openssl rsa -in jwt.pem -pubout -out jwt.pub
    jwtPublicKey: SECRET_JWT_PUBLIC_KEY
    # A password used for encrypting session data.
    # **Needs to be minimum 32 characters**
    cookiePassword: SECRET_COOKIE_PASSWORD
    # A password used for encrypting stored secrets.
    # **Needs to be minimum 32 characters**
    encryptionPassword: SECRET_PASSWORD
    # A flag to set if the server is running over https.
    # Used as a flag for the OAuth flow
    https: IS_HTTPS
    whitelist:
        __name: SECRET_WHITELIST
        __format: json
    admins:
        __name: SECRET_ADMINS
        __format: json

httpd:
    # Port to listen on
    port: PORT
    # Host to listen on (set to 0.0.0.0 to accept all connections)
    host: HOST
    # Externally routable URI (usually your load balancer or CNAME)
    uri: URI
    # TLS configuration (key, cert, etc.)
    # https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener
    tls:
        __name: HTTPD_TLS
        __format: json

datastore:
    plugin: DATASTORE_PLUGIN
    sequelize:
        # Type of server to talk to
        dialect: DATASTORE_SEQUELIZE_DIALECT
        # Database name
        database: DATASTORE_SEQUELIZE_DATABASE
        # Username/Password
        username: DATASTORE_SEQUELIZE_USERNAME
        password: DATASTORE_SEQUELIZE_PASSWORD
        # Storage location for sqlite
        storage: DATASTORE_SEQUELIZE_STORAGE
        # Network settings
        host: DATASTORE_SEQUELIZE_HOST
        port: DATASTORE_SEQUELIZE_PORT
        # Prefix to the table names
        prefix: DATASTORE_SEQUELIZE_PREFIX
        # Configure SSL/TLS connection settings
        ssl:
          __name: DATASTORE_SEQUELIZE_SSL
          __format: json

executor:
    plugin: EXECUTOR_PLUGIN
    # The NPM module object(s) for the executor plugin(s)
    k8s:
      enabled: EXECUTOR_K8S_ENABLED
      options:
        kubernetes:
            # The host or IP of the kubernetes cluster
            host: K8S_HOST
            # The jwt token used for authenticating kubernetes requests
            token: K8S_TOKEN
            jobsNamespace: K8S_JOBS_NAMESPACE
        # Launcher container tag to use
        launchVersion: LAUNCH_VERSION
        # Prefix to the pod
        prefix: EXECUTOR_PREFIX
    docker:
      enabled: EXECUTOR_DOCKER_ENABLED
      options:
        # Configuration of Docker
        docker:
            __name: EXECUTOR_DOCKER_DOCKER
            __format: json
        # Launcher container tag to use
        launchVersion: LAUNCH_VERSION
        # Prefix to the container
        prefix: EXECUTOR_PREFIX
    k8s-vm:
      enabled: EXECUTOR_K8SVM_ENABLED
      options:
        # Configuration of Docker
        kubernetes:
            # The host or IP of the kubernetes cluster
            host: K8S_HOST
            # The jwt token used for authenticating kubernetes requests
            token: K8S_TOKEN
            jobsNamespace: K8S_JOBS_NAMESPACE
            baseImage: K8S_BASE_IMAGE
        # Launcher container tag to use
        launchVersion: LAUNCH_VERSION
        # Prefix to the container
        prefix: EXECUTOR_PREFIX
    jenkins:
      enabled: EXECUTOR_JENKINS_ENABLED
      options:
        jenkins:
            host: EXECUTOR_JENKINS_HOST
            port: EXECUTOR_JENKINS_PORT
            username: EXECUTOR_JENKINS_USERNAME
            # Jenkins password/token used for authenticating jenkins requests
            password: EXECUTOR_JENKINS_PASSWORD
            # Node labels of Jenkins slaves
            nodeLabel: EXECUTOR_JENKINS_NODE_LABEL
        docker:
            # The path to the docker-compose command
            composeCommand: EXECUTOR_JENKINS_DOCKER_COMPOSE_COMMAND
            # Prefix to the container
            prefix: EXECUTOR_JENKINS_DOCKER_PREFIX
            # Launcher container tag to use
            launchVersion: EXECUTOR_JENKINS_LAUNCH_VERSION
            # Memory limit (docker run `--memory` option)
            memory: EXECUTOR_JENKINS_DOCKER_MEMORY
            # Memory limit include swap (docker run `--memory-swap` option)
            memoryLimit: EXECUTOR_JENKINS_DOCKER_MEMORY_LIMIT
        # The command to start build
        buildScript: EXECUTOR_JENKINS_BUILD_SCRIPT
        # The command to clean up build system
        cleanupScript: EXECUTOR_JENKINS_CLEANUP_SCRIPT
        # Time (seconds) to destroy the job
        cleanupTimeLimit: EXECUTOR_JENKINS_CLEANUP_TIME_LIMIT
        # Interval to detect the stopped job (seconds)
        cleanupWatchInterval: EXECUTOR_JENKINS_CLEANUP_WATCH_INTERVAL
    queue:
        enabled: EXECUTOR_QUEUE_ENABLED
        options:
          # Configuration of the redis instance containing resque
            redisConnection:
                host: QUEUE_REDIS_HOST
                port: QUEUE_REDIS_PORT
                options:
                    password: QUEUE_REDIS_PASSWORD
                    tls: QUEUE_REDIS_TLS_ENABLED
                database: QUEUE_REDIS_DATABASE

scms:
    __name: SCM_SETTINGS
    __format: json
    # 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: SECRET_OAUTH_CLIENT_ID
    #         # The client secret used for OAuth with github
    #         oauthClientSecret: SECRET_OAUTH_CLIENT_SECRET
    #         # You can also configure for use with GitHub enterprise
    #         gheHost: SCM_GITHUB_GHE_HOST
    #         # The username and email used for checkout with github
    #         username: SCM_USERNAME
    #         email: SCM_EMAIL
    #         # Secret to add to GitHub webhooks so that we can validate them
    #         secret: WEBHOOK_GITHUB_SECRET
    #         # 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: SCM_PRIVATE_REPO_SUPPORT
    # bitbucket:
    #     plugin: bitbucket
    #     config:
    #         # The client id used for OAuth with bitbucket. Look up Bitbucket OAuth for details
    #         # https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html
    #         oauthClientId: SECRET_OAUTH_CLIENT_ID
    #         # The client secret used for OAuth with bitbucket
    #         oauthClientSecret: SECRET_OAUTH_CLIENT_SECRET
    #         # The username and email used for checkout with bitbucket
    #         username: SCM_USERNAME
    #         email: SCM_EMAIL
    # gitlab:
    #     plugin: gitlab
    #     config:
    #         # The client id used for OAuth with gitlab. Look up Gitlab OAuth for details
    #         # https://docs.gitlab.com/ee/integration/oauth_provider.html
    #         oauthClientId: SECRET_OAUTH_CLIENT_ID
    #         # The client secret used for OAuth with bitbucket
    #         oauthClientSecret: SECRET_OAUTH_CLIENT_SECRET
    #         # The username and email used for checkout with gitlab
    #         username: SCM_USERNAME
    #         email: SCM_EMAIL
    #         # if you have on-premise gitlab, you can specify that here
    #         gitlabHost: SCM_GITLAB_HOST
    #         gitlabProtocol: SCM_GITLAB_PROTOCOL
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: SCM_USERNAME
    # Ignore commits made by these users
    ignoreCommitsBy:
        __name: IGNORE_COMMITS_BY
        __format: json

bookends:
    # List of module names, or objects { name, config } for instantiation to use in sd-setup
    setup:
        __name: BOOKENDS_SETUP
        __format: json
    # List of module names, or objects { name, config } for instantiation to use in sd-teardown
    teardown:
        __name: BOOKENDS_TEARDOWN
        __format: json

notifications:
    __name: NOTIFICATIONS
    __format: json

ecosystem:
    # URL for the User Interface
    ui: ECOSYSTEM_UI
    # Externally routable URL for the Artifact Store
    store: ECOSYSTEM_STORE
    # Badge service (needs to add a status and color)
    badges: ECOSYSTEM_BADGES
    # Default registry to pull build containers from
    dockerRegistry: ECOSYSTEM_DOCKER_REGISTRY
    # Array of extra origins allowed to do CORS to API
    allowCors:
        __name: ECOSYSTEM_ALLOW_CORS
        __format: json