Skip to content

Latest commit

 

History

History
184 lines (155 loc) · 5.87 KB

global.md

File metadata and controls

184 lines (155 loc) · 5.87 KB

Global Config

All keys from the Common Config are valid in addition to the keys documented here.

deployTargetMap

Map of deployment targets. Supported deployment target types are:

  • com.boxboat.jenkins.library.deployTarget.KubernetesDeployTarget
  • com.boxboat.jenkins.library.gcloud.GCloudGKEDeployTarget
deployTargetMap:
  dev01: !!com.boxboat.jenkins.library.deployTarget.KubernetesDeployTarget
    # kubernetes context to use
    contextName: boxboat
    # credential ID with kube config
    credential: kubeconfig-dev
  gke: !!com.boxboat.jenkins.library.gcloud.GCloudGKEDeployTarget
    # gCloudAccountMap key to reference
    gCloudAccountKey: default
    # GKE cluster name
    name: kube-cluster-name
    # Google Cloud project name
    project: gcloud-project
    # specify either region or zone, not both; use region for regional clusters
    region: us-central1
    # specify either region or zone, not both; use zone for zonal clusters
    zone: us-central1-a

environmentMap

Map of environments. Environments reference a deployment target. This way, underlying deployment targets can be switched out.

environmentMap:
  dev:
    # deployTargetMap key to reference
    deployTargetKey: dev01

gCloudAccountMap

Map of Google Cloud accounts for use with GCloudGKEDeployTarget and GCloudRegistry

gCloudAccountMap:
  default:
    # name of the service account
    account: [email protected]
    # secret file credential with the service account JSON key
    keyFileCredential: gcloud-key-file-credential

git

Stores the git configuration. To select an alternate config, set a repo-specific gitAlternateKey

git:
  # repository where build versions are written to
  buildVersionsUrl: [email protected]:boxboat/build-versions.git
  # SSH key credential for git service account
  credential: git
  # email that Jenkins commits as
  email: [email protected]
  # regex to convert a git remote to friendly path
  # first capture group is the friendly path
  remotePathRegex: github\.com[:\/]boxboat\/(.*)\.git$
  # string to convert a friendly path to a git remote
  # {{ path }} is replaced with the git path
  remoteUrlReplace: [email protected]:boxboat/{{ path }}.git
  # string to display a Git branch URL
  # {{ path }} is replaced with the git path
  # {{ branch }} is replaced with the git branch
  branchUrlReplace: https://github.com/boxboat/{{ path }}/tree/{{ branch }}
  # string to display a Git commit URL
  # {{ path }} is replaced with the git path
  # {{ hash }} is replaced with the git commit hash
  commitUrlReplace: https://github.com/boxboat/{{ path }}/commit/{{ hash }}
  # alternate git configurations
  # buildVersionsUrl, credential, and email are not allowed
  # in alternate git configurations
  gitAlternateMap:
    gitlab:
      remotePathRegex: gitlab\.com[:\/]boxboat\/(.*)\.git$
      remoteUrlReplace: [email protected]:boxboat/{{ path }}.git
      branchUrlReplace: https://gitlab.com/boxboat/{{ path }}/tree/{{ branch }}
      commitUrlReplace: https://gitlab.com/boxboat/{{ path }}/commit/{{ hash }}

notifyTargetMap

Map of notification targets. Supported notification target types are:

  • com.boxboat.jenkins.library.notify.SlackWebHookNotifyTarget
    • For use with the Slack Incoming Webhooks App
    • Jenkins Credential referenced in credential is a Secret Text credential with the full webhook URL
  • com.boxboat.jenkins.library.notify.SlackJenkinsAppNotifyTarget 
notifyTargetMap:
  default: !!com.boxboat.jenkins.library.notify.SlackWebHookNotifyTarget
    credential: slack-webhook-url
  jenkins-success: !!com.boxboat.jenkins.library.notify.SlackJenkinsAppNotifyTarget
    channel: "#jenkins-success"
  jenkins-failure: !!com.boxboat.jenkins.library.notify.SlackJenkinsAppNotifyTarget
    channel: "#jenkins-failure"

registryMap

Map of Docker registries. Supported registry types are:

Supported deployment target types are:

  • com.boxboat.jenkins.library.docker.Registry (the default)
  • com.boxboat.jenkins.library.gcloud.GCloudRegistry
registryMap:
  default:
    scheme: https
    host: dtr.boxboat.com
    credential: registry
    # string to display a registry image URL
    # {{ path }} is replaced with the image path
    # {{ tag }} is replaced with the image tag
    imageUrlReplace: https://dtr.boxboat.com/repositories/{{ path }}/{{ tag }}/linux/amd64/layers
  gcr: !!com.boxboat.jenkins.library.gcloud.GCloudRegistry
    scheme: https
    host: gcr.io
    # Google Cloud project
    namespace: gcloud-project
    # gCloudAccountMap key to reference
    gCloudAccountKey: default

vaultMap

Map of Hashicorp Vault endpoints. Either (roleIdCredential and secretIdCredential) or (tokenCredential) are required.

vaultMap:
  default:
    # vault KV version
    kvVersion: 1
    # secret text credential ID with roleId
    roleIdCredential: vault-role-id
    # secret text credential ID with secretId
    secretIdCredential: vault-secret-id
    # secret text credential ID
    tokenCredential: vault-token
    # full URL to vault
    url: http://localhost:8200

repo

Repository configurations that are applied globally to all repositories.

repo:
  common:
    vaultKey: default
  promote:
    promotionMap:
      prod:
        event: commit/master
        promoteToEvent: tag/release
  deploy:
    deploymentMap:
      dev:
        environmentKey: dev
        event: commit/master
        trigger: true