Skip to content

Latest commit

 

History

History
114 lines (92 loc) · 7.36 KB

config_doc.md

File metadata and controls

114 lines (92 loc) · 7.36 KB
Raw

JIRA adapter configuration

Configuration example

jira {
  client = {
    retry = {
      maxAttempts = 5
      retryDelay = 5000
    }
    rateLimit = {
      total = -1
      get = 20
    }
  }
  fetch = {
    include = [
      {
        type = ".*"
      },
    ]
    exclude = [
      {
        type = "Webhook"
        criteria = {
          name = "name.*"
        }
      }
    ]
  }
  deploy = {
    defaultMissingUserFallback = "##DEPLOYER##"
  }
}

Configuration options

Name Default when undefined Description
client {} (no overrides) Configuration relating to the client used to interact with JIRA
fetch {} (no overrides) Configuration relating to the endpoints that will be queried during fetch
masking {} (mask nothing) Configuration to mask sensitive data from the NaCls
deploy {} (mask nothing) Configuration for elements deployment

Deploy configuration options

Name Default when undefined Description
defaultMissingUserFallback No fallback Configure replacement for missing users during deploy, can be user email for Jira Cloud, or username for Jira DC, or ##DEPLOYER## to fallback to deployer's user

Client configuration options

Name Default when undefined Description
retry {} (no overrides) Configuration for retrying on errors
rateLimit {} (no overrides) Limits on the number of concurrent requests of different types
[maxRequestsPerMinute] unlimited Limits on the number of requests per minute
[delayPerRequestMS] 0 Delay waited between each request in milliseconds
[useBottleneck] true Flag indicating usage of Bottleneck package for rate limiting
usePrivateAPI true Whether to use Jira Private API when fetching and deploying changes
timeout {} (no overrides) Configuration for setting request timeouts

Client timeout configuration options

Name Default when undefined Description
[maxDuration] 0 (unlimited) Set a timeout (in milliseconds) on requests
[retryOnTimeout] true Whether to retry requests that returned a timeout response
[lastRetryNoTimeout] true Whether to disable the timeout duration on the last retry (if we assume the service will eventually return a response)

Client retry options

Name Default when undefined Description
maxAttempts 5 The number of attempts to make for each request
retryDelay 5000 (5 seconds) The time (milliseconds) to wait between attempts

Rate limit configuration options

Name Default when undefined Description
get 20 Max number of concurrent get requests
total -1 (unlimited) Shared limit for all concurrent requests

Fetch configuration options

Name Default when undefined Description
include [{ type = ".*" }] List of entries to determine what instances to include in the fetch
exclude [] List of entries to determine what instances to exclude in the fetch
fallbackToInternalId false Whether to add the internal ids to the instance name when the name is not unique among the instances of that type

Masking configuration options

Name Default when undefined Description
automationHeaders [] List of regexes of header keys in Automations to mask their values
secretRegexps [] List of regexes of strings to mask all across the workspace

Fetch entry options

Name Default when undefined Description
type "" A regex of the Salto type name to include in the entry
criteria A List of criteria to filter specific instance of certain types

Fetch entry criteria

Name Default when undefined Description
name .* A regex used to filter instances by matching the regex to their name value
type .* A regex used to filter field instances by matching the regex to their type value