Configuration DSL

Overview

Mission Control comes with a comprehensive set of built-in configuration blocks that are intended as guides to make it easier for you to define configuration scripts using the allowed DSL.

Configuration blocks must be in service closures

Note that the script segments described on this page represent configuration blocks and cannot be used by themselves. Configuration blocksmustbe placed within aservice closurein order to create an executable script.

Artifactory Configuration Blocks

This section presents configuration blocks that can be used to configure different administrative features of Artifactory services. As with any configuration block, these must be placed within an Artifactoryservice closureas shown below.

Artifactory service closure

artifactory(''){  }

Page Contents

Property Sets

The parameters for apropertySetsconfiguration block are described below. For more details on these parameters, please refer toProperty Setsin theArtifactory User Guide.

propertySets block

propertySets { propertySet('property_set_name') { singleSelect('property_name') { defaultValue "value_1" value "value_1" value "value_2" } multiSelect('property_name_multi') { defaultValue "value_1" defaultValue "value_2" value "value_1" value "value_2" } anyValue('another_property_name') { defaultValue "value_1" value "value_1" } } }

property_set_name	一个标识符属性集。名称必须be unique in all Artifactory instances on which it is applied.
singleSelect parameters
property_name	A unique identifier for the single selection property within this property set.
defaultValue	A default value for the single selection property.
value	The selection options for this property
multiSelect parameters
property_name_multi	A unique identifier for the multiple selection property within this property set.
defaultValue	The default selected values for the multiple selection property.
value	The selection options for this property
anyValue parameters
another_property_name	A unique identifier for the free-text property within this property set.
defaultValue	A default value for the free-text property.
value	The selection options for this property

Repository Layout

The parameters for arepoLayoutconfiguration block are described below. For more details on these parameters, please refer toRepository Layoutsin theArtifactory User Guide.

repoLayout block

repoLayouts { repoLayout ('repo_layout_name') { folderIntegrationRevisionRegExp "SNAPSHOT" fileIntegrationRevisionRegExp "SNAPSHOT|(?:(?:[0-9]{8}.[0-9]{6})-(?:[0-9]+))" distinctiveDescriptorPathPattern true artifactPathPattern "[orgPath]/[module]/[baseRev](-[folderItegRev])/[module]-[baseRev](-[fileItegRev])(-[classifier]).[ext]" descriptorPathPattern "[orgPath]/[module]/[baseRev](-[folderItegRev])/[module]-[baseRev](-[fileItegRev])(-[classifier]).pom" } }

repo_layout_name	一个标识符为这个库布局。名称必须be unique in all Artifactory instances on which it is applied.
folderIntegrationRevisionRegExp	A regular expression for folder integration revision.
fileIntegrationRevisionRegExp	A regular expression for file integration revision.
distinctiveDescriptorPathPattern	A distinctive descriptor path pattern is used to recognize descriptor files.
artifactPathPattern	The typical structure in which all module artifacts are expected to be stored.
descriptorPathPattern	The pattern used to recognize descriptor files (such as`.pom`or`ivy.xml`files).

Proxies

The parameters for aproxiesconfiguration block are described below. For more details on these parameters, please refer toManaging Proxiesin theArtifactory User Guide.

proxies { proxy('proxy_key') { host 'proxy host' // mandatory port 8888 // mandatory username 'username' password 'password' defaultProxy false ntHost 'NT Host' ntDomain 'NT Domain' redirectedToHosts (['host1', 'host2', 'host3']) } }

proxy_key	The ID of the proxy. Must be unique within the Artifactory instance.
host	这个名字of the proxy host.
port	The proxy port number
username	The proxy username when authentication credentials are required.
password	The proxy password when authentication credentials are required.
defaultProxy	When true, this proxy will be the default proxy for new remote repositories and for internal HTTP requests.
ntHost	The computer name of the machine (the machine connecting to the NTLM proxy).
ntDomain	The proxy domain/realm name.
redirectedToHosts	An optional list of newline or comma separated host names to which this proxy may redirect requests.

LDAP Settings

The parameters for anldapconfiguration block are described below. For more details on these parameters, please refer toManaging Security with LDAPin theArtifactory User Guide.

ldap { settings('settings_name') { url 'ldap://myserver:myport/DC=sampledomain,DC=com' // mandatory userDnPattern 'uid={0},ou=People' emailAttribute 'mail' enabled true // default value - true autoCreateUser true // default value - true search { filter '(uid={0})' base 'OU=dev,DC=sampledomain,DC=com' searchSubTree true managerDn 'CN=admin,OU=ops,DC=sampledomain,DC=com' managerPassword 'password' } } }

settings_name	LDAP的ID设置。中必须是唯一的the Artifactory instance being configured.
url	Location of the LDAP server in the following format:`ldap://myserver:myport/dc=sampledomain,dc=com`.
userDnPattern	A DN pattern used to log users directly in to the LDAP database. This pattern is used to create a DN string for "direct" user authentication, and is relative to the base DN in the LDAP URL.
emailAttribute	An attribute that can be used to map a user's email to a user created automatically by Artifactory.
enabled	When true, these settings are enabled.
autoCreateUser	When true, Artifactory will automatically create new users for those who have logged in using LDAP, and assign them to the default groups.
filter	A filter expression used to search for the user DN that is used in LDAP authentication.
base	The Context name in which to search relative to the base DN in the LDAP URL. This is parameter is optional.
searchSubTree	When true, enables deep search through the sub-tree of the LDAP URL + Search Base.
managerDn	The full DN of a user with permissions that allow querying the LDAP server.
managerPassword	The password of the user binding to the LDAP server when using "search" authentication.

LDAP Groups

The parameters for anldap groupsconfiguration block are described below. For more details on these parameters, please refer toLDAP Groupsin theArtifactory User Guide.

ldap { groupSettings('static_group_settings_name') { settings // 'ldap settings ref' staticMapping { groupMemberAttribute 'uniqueMember' // mandatory groupNameAttribute 'cn' // mandatory descriptionAttribute 'description' // mandatory filter '(objectClass=groupOfNames)' // mandatory searchBase '' searchSubTree true } } groupSettings('dynamic_group_settings_name') { settings // 'ldap settings ref' dynamicMapping { groupMemberAttribute 'uniqueMember' // mandatory groupNameAttribute 'cn' // mandatory descriptionAttribute 'description' // mandatory filter '(objectClass=groupOfNames)' // mandatory searchBase '' searchSubTree true } } groupSettings('hierarchy_group_settings_name') { settings // 'ldap settings ref' hierarchyMapping { userDnGroupKey 'uniqueMember' // mandatory groupNameAttribute 'cn' // mandatory descriptionAttribute 'description' // mandatory filter '(objectClass=groupOfNames)' // mandatory } } }

static_group_settings_name	A logical name for astaticgroup mapping strategy.
dynamic_group_settings_name	A logical name for adynamicgroup mapping strategy.
hierarchy_group_settings_name	A logical name for ahierarchygroup mapping strategy.
settings	The LDAP settings reference.
groupMemberAttribute	The group membership attribute for this LDAP group.
groupNameAttribute	The group name attribute for this LDAP group.
descriptionAttribute	The description attribute for this LDAP group.
filter	A filter expression used to search for the user DN that is used in LDAP authentication.
searchBase	The Context name in which to search relative to the base DN in the LDAP URL.
searchSubTree	When true, enables deep search through the sub-tree of the LDAP URL + Search Base.

Security Settings

The configuration blocks for security settings related to users, groups and permissions are described below. For more details on these parameters, please refer toConfiguring Securityin theArtifactory User Guide.

security { users { conflictResolutionPolicy "OVERRIDE" // default user('name') { email 'login_1@www.si-fil.com' password 'passwd_1' admin false profileUpdatable false internalPasswordDisabled false groups (['groupA', 'groupB']) // values (['groupA', 'groupB']) are examples. Please set existing values from the instance } } groups { conflictResolutionPolicy "OVERRIDE" // default group('name') { description 'desc_1' autoJoin false } } permissions { conflictResolutionPolicy "OVERRIDE" // default permission('name') { includesPattern '**' excludesPattern '' anyLocal false anyRemote false anyDistribution false repositories (["local-rep1", "local-rep2"]) // values (["local-rep1", "local-rep2", ...]) are examples. Please set existing values from the instance users { userA (['manage', 'delete', 'deploy', 'annotate', 'read']) // value userA - is example. Please set existing user names from the instance } groups { groupsG1 (['manage', 'delete', 'deploy', 'annotate', 'read']) // value groupsG1 - is example. Please set existing group names from the instance } } } }

Users block	Creates or updatesusersin the instance
conflictResolutionPolicy	Default: OVERRIDE Specifies what to do if any setting in the users block of the configuration script conflicts with an existing value for the specified user. Currently, the only option available is the default OVERRIDE which means that values specified in the configuration script will override any existing values.
email	The user's email address.
password	The user's login password.
admin	When true, this user is an administrator with all the ensuing privileges
profileUpdatable	When true, this user can update his profile details (except for the password. Only an administrator can update the password).
internalPasswordDisabled	When true, disables the fallback of using an internal password when external authentication (such as LDAP) is enabled.
groups	Specifies the groups to which this user should belong

Groups block	Creates or updatesgroupsin the instance
conflictResolutionPolicy	Default: OVERRIDE Specifies what to do if any setting in the groups block of the configuration script conflicts with an existing value for the specified user. Currently, the only option available is the default OVERRIDE which means that values specified in the configuration script will override any existing values.
description	A free text description for the group.
autoJoin	When true, any new users defined in the system are automatically assigned to this group.

Permissions block	Creates or updatespermission targetsin the instance.
conflictResolutionPolicy	Default: OVERRIDE Specifies what to do if any setting in the permissions block of the configuration script conflicts with an existing value for the specified user. Currently, the only option available is the default OVERRIDE which means that values specified in the configuration script will override any existing values.
includesPattern/ excludesPattern	"Ant-like" expressions that specify repositories and paths to be included or excluded from the permission target
anyLocal	When true, all local repositories are included in the permission target.
anyRemote	When true, all remote repositories are included in the persmission target.
anyDistribution	When true, all distribution repositories are included in the permission target.
repositories	Specific repositories on which to apply the permission target.
users	The users on whom to apply the permission target and the corresponding permissions they are given.
groups	The groups on which to apply the permission target and the corresponding permissions they are given.

Repository Configuration Blocks

This section presents all the configuration blocks that may be used to configure Artifactory repositories.

Local Repository

The parameters for alocalRepositoryblock are described below. For more details on these parameters, please refer toCommon SettingsandLocal Repositoriesin theArtifactory User Guide.

localRepository block

localRepository (repository-key){描述“Public description" notes "Some internal notes" includesPattern "**/*" // default excludesPattern "" // default repoLayoutRef "maven-2-default" packageType "generic" // "maven" | "gradle" | "ivy" | "sbt" | "nuget" | "gems" | "npm" | "conan" | "helm" | // "bower" | "debian" | "pypi" | "docker" | "vagrant" | "gitlfs" | "yum" | "generic" debianTrivialLayout false checksumPolicyType "client-checksums" // default | "server-generated-checksums" handleReleases true // default handleSnapshots true // default maxUniqueSnapshots 0 // default snapshotVersionBehavior "unique" // "non-unique" | "deployer" suppressPomConsistencyChecks false // default blackedOut false // default propertySets // (["ps1", "ps2"]) archiveBrowsingEnabled false calculateYumMetadata false yumRootDepth 0 xrayIndex false blockXrayUnscannedArtifacts false xrayMinimumBlockedSeverity "" // "Minor" | "Major" | "Critical" enableFileListsIndexing false //default yumGroupFileNames "" dockerApiVersion "V2" // default maxUniqueTags 0 // default optionalIndexCompressionFormats "" // "bz2", "lzma", "xz" }

repository-key	The Repository Key is a mandatory identifier for the repository and must be unique within an Artifactory instance. It cannot begin with a number or contain spaces or special characters. For local repositories we recommend using a "-local" suffix (e.g. "libs-release-local").
description	A free text field that describes the content and purpose of the repository.
notes	A free text field to add additional notes about the repository. These are only visible to the Artifactory administrator and to Mission Control.
includesPattern and excludesPattern	These parameters provide a way to filter out specific repositories when trying to resolve the location of different artifacts.
repoLayoutRef	Sets the layout that the repository should use for storing and identifying modules. The layout should correspond to the value set in the packageType property.
packageType	The repository's package type.
debianTrivialLayout	Only valid if`packageType`is set to Debian. If true, the Debian repository will use the Trivial layout.
checksumPolicyType	Only valid if for Maven, Gradle, Ivy and SBT repositories. Determines how Artifactory behaves when a client checksum for a deployed resource is missing or conflicts with the locally calculated checksum.
handleReleases	If true, users will be able upload Release artifacts to this repository
handleSnapshots	If true, users will be able upload Snapshot artifacts to this repository
maxUniqueSnapshots	Specifies the maximum number of unique snapshots of the same artifact that should be stored. A value of 0 (default) indicates that there is no limit on the number of unique snapshots.
snapshotVersionBehavior	Artifactory supports centralized control of how snapshots are deployed into a repository, regardless of end user-specific settings. This can be used to guarantee a standardized format for deployed snapshots within your organization.
suppressPomConsistencyChecks	If true, Artifactory will reject a deployment in which the`groupId:artifactId:version`set in the path conflicts with the deployed path.
blackedOut	If true, Artifactory will ignores this repository when trying to resolve, download or deploy artifacts.
propertySets	Defines the property sets that will be available for artifacts stored in this repository.
archiveBrowsingEnabled	If true, allows uses to view archive file contents (e.g., Javadoc browsing, HTML files) directly from Artifactory.
calculateYumMetadata	Only valid for YUM repositories. If true, YUM metadata calculation will be automatically triggered for the events described inTriggering RPM Metadata Updates.
yumRootDepth	Only valid for YUM repositories. Informs Artifactory under which level of directory to search for RPMs and save the`repodata`directory.
xrayIndex	If true, this repository should be indexed by JFrog Xray connected to the Artifactory instance.
blockXrayUnscannedArtifacts	If true, artifacts that have not yet been scanned by the connected JFrog Xray will be blocked for download.
xrayMinimumBlockedSeverity	The minimum severity of an issue detected for an artifact to be blocked for download.
enableFileListsIndexing	For an RPM repository, this field specifies if the RPM file lists metadata file should be indexed by Artifactory or not.
dockerApiVersion
maxUniqueTags
optionalIndexCompressionFormats	Cannot be an empty string

Remote Repository

The parameters for a remoteRepositoryblock are described below. For more details on these parameters, please refer toCommon SettingsandRemote Repositoriesin theArtifactory User Guide.

remoteRepository block

remoteRepository (repository-key) {url http://host:port/some-repo" username "remote-repo-user" password "pass" proxy "proxy1" description "Public description" notes "Some internal notes" includesPattern "**/*" // default excludesPattern "" // default packageType "generic" // "maven" | "gradle" | "helm" | "ivy" | "sbt" | "nuget" | "gems" | "npm" | "bower" | "debian" | "pypi" | "docker" | "yum" | "vcs" | "p2" | "generic" remoteRepoChecksumPolicyType "generate-if-absent" // default | "fail" | "ignore-and-generate" | "pass-thru" handleReleases true // default handleSnapshots true // default maxUniqueSnapshots 0 // default suppressPomConsistencyChecks false // default offline false // default blackedOut false // default storeArtifactsLocally true // default socketTimeoutMillis 15000 localAddress "123.123.123.123" retrievalCachePeriodSecs 43200 // default failedRetrievalCachePeriodSecs 30 // default missedRetrievalCachePeriodSecs 7200 // default unusedArtifactsCleanupEnabled false // default unusedArtifactsCleanupPeriodHours 0 // default fetchJarsEagerly false // default fetchSourcesEagerly false // default shareConfiguration false // default synchronizeProperties false // default propertySets // (["ps1", "ps2"]) allowAnyHostAuth false // default enableCookieManagement false // default xrayIndex false blockXrayUnscannedArtifacts false xrayMinimumBlockedSeverity "" // "Minor" | "Major" | "Critical" enableFileListsIndexing false //default blockMismatchingMimeTypes false // default bowerRegistryUrl "https://registry.bower.io" //default bypassHeadRequests false // default clientTlsCertificate "" // default composerRegistryUrl "https://packagist.org" // default assumedOfflinePeriodSecs 300 // default hardFail false // default repoLayoutRef // "maven-2-default" vcsGitDownloadUrl "" // default vcsGitProvider "GITHUB" // default "BITBUCKET" | "OLDSTASH" | "STASH" | "ARTIFACTORY" | "CUSTOM" vcsTpe "GIT" // default }

repository-key	Please refer to the description for this parameter in aLocal Repositoryblock.
url	The URL for the remote repository. Currently only HTTP and HTTPS URLs are supported.
username	The username that should be used for HTTP authentication when accessing the remote proxy.
password	The password that should be used for HTTP authentication when accessing the remote proxy.
proxy	If the organization in which the Artifactory instance is hosted requires users to go through a proxy to access a remote repository, this parameter lets you select the correspondingProxy Key.
description	Please refer to the description for this parameter in aLocal Repositoryblock.
notes	Please refer to the description for this parameter in aLocal Repositoryblock.
includesPattern	Please refer to the description for this parameter in aLocal Repositoryblock.
excludesPattern	Please refer to the description for this parameter in aLocal Repositoryblock.
packageType	Please refer to the description for this parameter in aLocal Repositoryblock.
remoteRepoChecksumPolicyType	Specifies how the Artifactory instance should behave when a client checksum for a remote resource is missing or conflicts with the locally calculated checksum.
handleReleases	Please refer to the description for this parameter in aLocal Repositoryblock.
handleSnapshots	Please refer to the description for this parameter in aLocal Repositoryblock.
maxUniqueSnapshots	Please refer to the description for this parameter in aLocal Repositoryblock.
suppressPomConsistencyChecks	Please refer to the description for this parameter in aLocal Repositoryblock.
offline	If true, the repository will be considered offline and no attempts will be made to fetch artifacts from it.
blackedOut	Please refer to the description for this parameter in aLocal Repositoryblock.
storeArtifactsLocally	If true, artifacts from the repository will be cached locally. If not set, direct repository-to-client streaming is used.
socketTimeoutMillis	The time that the Artifactory instance should wait for both a socket and a connection before giving up on an attempt to retrieve an artifact from a remote repository.
localAddress	When working on multi-homed systems, this parameter lets you specify which specific interface (IP address) should be used to access the remote repository.
retrievalCachePeriodSecs	Defines how long before the Artifactory instance should check for a newer version of a requested artifact in a remote repository. A value of 0 means that Artifactory will always check for a newer version.
missedRetrievalCachePeriodSecs	If a remote repository is missing a requested artifact, Artifactory will return a "404 Not found" error. This response is cached for the period of time specified by this parameter. During that time, Artifactory will not issue new requests for the same artifact. A value of 0 means that the response is not cached and Artifactory will always issue a new request when demanded.
unusedArtifactsCleanupPeriodHours	Specifies how long an unused artifact will be stored in the Artifactory instance before it is removed. A value of 0 means that the artifact is stored indefinitely.
fetchJarsEagerly	If true, if a POM is requested, the Artifactory instance attempts to fetch the corresponding jar in the background. This will accelerate first access time to the jar when it is subsequently requested.
fetchSourcesEagerly	If true, if a binaries jar is requested, the Artifactory instance attempts to fetch the corresponding source jar in the background. This will accelerate first access time to the source jar when it is subsequently requested.
synchronizeProperties	Only valid forSmart Remote Repositories. If true, properties for artifacts that have been cached in the repository will be updated if they are modified in the artifact hosted at the remote Artifactory instance.
propertySets	Please refer to the description for this parameter in aLocal Repositoryblock.
allowAnyHostAuth	If true, allows using the repository credentials on any host to which the original request is redirected.
enableCookieManagement	If true, the repository will allow cookie management to work with servers that require them.
xrayIndex	Please refer to the description for this parameter in aLocal Repositoryblock.
blockXrayUnscannedArtifacts	Please refer to the description for this parameter in aLocal Repositoryblock.
xrayMinimumBlockedSeverity	Please refer to the description for this parameter in aLocal Repositoryblock.
enableFileListsIndexing	For an RPM repository, this field specifies if the RPM file lists metadata file should be indexed by Artifactory or not.
allowAnyHostAuth
bowerRegistryUrl
blockMismatchingMimeTypes
clientTlsCertificate
composerRegistryUrl
assumedOfflinePeriodSecs
byPassHeadRequests
hardFail
repoLayoutRef
vcsGitDownloadUrl
vcsGitProvider
vcsType

Virtual Repository

The parameters for a virtualRepositoryblock are described below. For more details on these parameters, please refer toCommon SettingsandVirtual Repositoriesin theArtifactory User Guide.

virtualRepository block

virtualRepository('repository-key') { repositories (["local-rep1", "local-rep2"]) // values (["local-rep1", "local-rep2", ...]) are examples. Please set existing values from the instance description "Public description" notes "Some internal notes" includesPattern "**/*" // default excludesPattern "" // default packageType "generic" // "maven" | "gradle" | "helm" | "ivy" | "sbt" | "nuget" | "gems" | "npm" | "bower" | "pypi" | "p2" | "generic" debianTrivialLayout false artifactoryRequestsCanRetrieveRemoteArtifacts false keyPair "keypair1" //value "keypair1" is example. Please set existing value from the instance pomRepositoryReferencesCleanupPolicy "discard_active_reference" // default | "discard_any_reference" | "nothing" defaultDeploymentRepo "local-rep1" forceMavenAuthentication false // default }

repository-key	Please refer to the description for this parameter in aLocal Repositoryblock.
repositories	The list of repositories that should be aggregated in this virtual repository.
description	Please refer to the description for this parameter in aLocal Repositoryblock.
notes	Please refer to the description for this parameter in aLocal Repositoryblock.
includesPattern	Please refer to the description for this parameter in aLocal Repositoryblock.
excludesPattern	Please refer to the description for this parameter in aLocal Repositoryblock.
packageType	Please refer to the description for this parameter in aLocal Repositoryblock.
debianTrivialLayout	Please refer to the description for this parameter in aLocal Repositoryblock.
artifactoryRequestsCanRetrieveRemoteArtifacts	If true, the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
keyPair	A named key-pair to use for automatically signing artifacts.
pomRepositoryReferencesCleanupPolicy	This setting gives you the ability to ensure Artifactory is the sole provider of Artifacts in your system by automatically cleaning up the POM file.
forceMavenAuthentication

Replication

A replication block is used for creating push/pull replication. This block should always be nested inside a repository block:localRepositoryfor push replication,remoteRepositoryfor pull replication or arepositoryblock for both.

replication block

localRepository("example") { replication() { cronExp "0 0/9 14 * * ?" socketTimeoutMillis 15000 username "remote-repo-user" password "pass" proxy //"proxy-ref" enableEventReplication true enabled true syncDeletes false syncProperties true clientTlsCertificate "" } }

REPLICATION_TARGET	Target local repository for push replication. There are two ways to provide a target repository: Target repository URL- the URL of the target local repository (String) Target Artifactory object- the service object the target repository belongs to. This appliesonlywhen creating a new repository. Mission control will select the repository about to be created on the target instancewithin the current configuration context(current configuration action). An instance object can be obtained from the context variables or by asking for user input of type ARTIFACTORY. For pull replication there is no need to set the target repository
cronExp	Define the replication task schedule using a validcronexpression
socketTimeoutMillis	The network timeout in milliseconds to use for remote operations
username	The HTTP authentication username
password	The HTTP authentication password
proxy	The key of a proxy configuration to use when communicating with the remote instance
enableEventReplication	When set, event-based push replication is enabled
enabled	When set to true, this replication will be enabled
syncDeletes	When set, items that were deleted remotely should also be deleted locally
syncProperties	When set, the task also synchronizes the properties of replicated artifacts
clientTlsCertificate	The SSL/TLS certificate used for authentication

Star Topology

Mission Control provides built-in configuration blocks that make it very easy to create replication relationships between different Artifactory services in a star topology. This is done using the following two key words to create push replication and pull replication configurations respectively:

starPush
starPull

In each case the DSL may include aReplicationblock through which you can configure the parameters governing the replication process.

Push Replication

下面的例子显示了如何创建一个明星托波尔ogy using push replication.

Star Topology with Push Replication

This example shows:

An Artifactory service named "Amsterdam" with two local repositories, "maven-local-1" and "maven-local-2"
The configuration block will create or update a push replication relationship between "maven-local-1" and "maven-local-2" in "Amsterdam" to the corresponding repositories in each of the Artifactory services named "Bangkok", "Cape Town" and "Denver".
If "maven-local-1" or "maven-local-2" do not already exist in any of the target Artifactory services, Mission Control will create them
The replication will be governed by the parameters specified (socketTimeoutMillis, enableEventReplication, etc.)

starPush replication block

artifactory('Amsterdam') { repository("maven-local-1", "maven-local-2") { starPush('Bangkok', 'Cape Town', 'Denver'){ socketTimeoutMillis 60000 enableEventReplication true cronExp '0 0/9 14 * * ?' syncDeletes false syncProperties false syncStatistics false } } }

Pull Replication

下面的例子显示了如何创建一个明星托波尔ogy using pull replication.

Star Topology with Pull Replication

This example shows:

An Artifactory service named "Amsterdam" with two repositories, "maven-local" and "maven-virtual"
The configuration block will create or update a pull replication relationship in corresponding repositories in each of the Artifactory services named "Bangkok", "Cape Town" and "Denver" to pull replicate from the "maven-local" and "maven-virtual" repositories in "Amsterdam" .
If "maven-local" or "maven-remote" don't exist in "Bangkok", "Cape Town" or "Denver", Mission Control will create them
The replication will be governed by the parameters specified (socketTimeoutMillis, enableEventReplication, etc.)

starPull replication block

artifactory('Amsterdam') { repository("maven-local", "maven-virtual") { starPull('Bangkok', 'Cape Town', 'Denver'){ socketTimeoutMillis 60000 enableEventReplication true cronExp '0 0/9 14 * * ?' syncDeletes false syncProperties false syncStatistics false } } }

Xray Configuration Blocks

This section presents configuration blocks that can be used to configure different administrative features of Xray services. As with any configuration block, these must be placed within an Xrayservice closureas shown below.

Artifactory service closure

xray(''){  }

Link to Artifactory - Binary Manager

The following is an example of a configuration block that adds an Artifactory service as a binary manager to an Xray service.

IfArtifactory-prod在任务控制已经注册为一个服务吗rol, the admin login credentials specified when registering will be provided to Xray when configuring it as the binary manager.

{ binaryManager('Artifactory-prod') }

IfArtifactory-prodis not registered as a service in Mission Control, you need to provide all properties of the service as follows:

{ binaryManager('Artifactory-prod') { url 'http://artifactory.com/artifactory' login 'login' password 'password' } }

In this case, Mission Control will create an Artifactory service with these properties and then configure the Xray service in the enclosingservice closurewith it as its binary manager.

Watches

Below is an example of awatchconfiguration block. For more details on these parameters, please refer toWatchesin theJFrog Xray User Guide.

{ watch('watch') { binaryManagerId 'binaryManagerId' targetType 'repository' description 'description' active true postActions { emails(['email1@email.com', 'email2@email.com']) slacks 'slacks' webhooks(['webhook1', 'webhook2']) failBuild true } filters { filter { type 'license_black' value 'value1' } filter { type 'regex' value 'value1' } } repoType 'repoType' severity 'severity' system true targetName 'targetName' temp true } }

Configuration DSL

Overview

Artifactory Configuration Blocks

Property Sets

property_set_name

property_name

defaultValue

value

property_name_multi

defaultValue

value

another_property_name

defaultValue

value

Repository Layout

repo_layout_name

folderIntegrationRevisionRegExp

fileIntegrationRevisionRegExp

distinctiveDescriptorPathPattern

artifactPathPattern

descriptorPathPattern

Proxies

proxy_key

host

port

username

password

defaultProxy

ntHost

ntDomain

redirectedToHosts

LDAP Settings

settings_name

url

userDnPattern

emailAttribute

enabled

autoCreateUser

filter

base

searchSubTree

managerDn

managerPassword

LDAP Groups

static_group_settings_name

dynamic_group_settings_name

hierarchy_group_settings_name

settings

groupMemberAttribute

groupNameAttribute

descriptionAttribute

filter

searchBase

searchSubTree

Security Settings

conflictResolutionPolicy

email

password

admin

profileUpdatable

internalPasswordDisabled

groups

conflictResolutionPolicy

description

autoJoin

conflictResolutionPolicy

includesPattern/excludesPattern

anyLocal

anyRemote

anyDistribution

repositories

users

groups

Repository Configuration Blocks

Local Repository

repository-key

description

notes

includesPattern and excludesPattern

repoLayoutRef

includesPattern/
excludesPattern