JFrog Artifactory

Need help with other JFrog products?

JFrog Enterprise+
JFrog Mission Control
JFrog Xray
JFrog Distribution
JFrog Pipelines
JFrog Bintray
JFrog Access
JFrog CLI

Expand all   Collapse all

Versions Compared

Old Version 23

changes.mady.by.user Adi Atzmony

Saved on

compared with

New Version 24

changes.mady.by.user Rami Honig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Artifactory supports import and export of data at two levels:

At system level, Artifactory can export and import the whole Artifactory server: configuration, security information, stored data and metadata. The format used is identical to the System Backup format. This is useful when manually running backups and for migrating and restoring a complete Artifactory instance (as an alternative to using database level backup and restore).

At repository level, Artifactory can export and import data and metadata stored in a repository. This is useful when moving store data, including its metadata between repositories and for batch population of a repository.

Infopanel
iconfalse
titlePage Contents

Table of Contents
maxLevel4
minLevel2


 

System Import and Export

Note
titleExcluding builds from version 6.6 and above

From Artifactory version 6.6, you can exclude builds only using the System Export REST API. This is no longer available from the UI.

Info

Note: The System Import and Export feature is not available for Artifactory Cloud users.

To access import and export of your entire system, in the Admin module, select Import & Export | System

 

Tip
titleMaintaining security entities on system import

 From version 5.10, Artifactory maintains all security entities (users, groups, permissions and access tokens) when doing a system import. Previously, these entities would be removed along with existing configurations, repositories and artifacts.

 

Target Export Dir
The target directory for the exported files. You may browse your file system to select the directory
Exclude Content

Export: When set, repository binaries are excluded from the export.

Import: When set, binaries and metadata are excluded from the import. Only builds and configuration files are imported.

Exclude Metadata

When set, repository metadata are excluded from the import/export.
(Maven 2 metadata is unaffected by this setting)

Note
titleDocker repositories must have metadata

For Docker repositories to work they must have their metadata intact. Therefore, if you have Docker repositories, make sure that Exclude Metadata is not checked when doing a system export or import.

Exclude Builds
When set, all builds are excluded from the export
Create .m2 Compatible Export
When set, includes Maven 2 repository metadata and checksum files as part of the export
Create a Zip Archive (Slow and CPU Intensive!)
When set, creates and exports to a Zip archive
Output Verbose Log

When set, lowers the log level to "debug" and redirects the output from the standard log to the import-export log.

Info
titleMonitoring the log

You can monitor the log in the System Logs page.

 


The source/target of the import/export operations are folders (Zip archives are not recommended) on the Artifactory server itself.

You can use the built-in server-side browsing inside Artifactory to select server-side source/target folders:

Server side file browser

Info

Importing or exporting a large amount of data may be time consuming. During the import/export operation you can browse away from the page and sample the System Logs to monitor progress.

System Import and Export for an HA Cluster

When performing a system export and subsequent import for an HA cluster, you need to follow the procedure below to ensure that the cluster is able to correctly synchronize its nodes.

Expand
titleTarget Artifactory is running on version 5.7 and above

  • Perform a normal system export from the source cluster as described above 

  • In the target cluster, keep the primary node running, and perform a graceful shutdown of all secondary nodes

  • Perform normal system import to the target cluster (which now has only the primary node running) as described above

  • Perform a graceful shutdown of the primary node and then restart it

  • For each secondary node:

    • Delete the following folders

      • $ARTIFACTORY_HOME/access

      • $ARTIFACTORY_HOME/etc/security

      • $ARTIFACTORY_HOME/etc/ui

      • $ARTIFACTORY_HOME/etc/plugins

    • Copy the $ARTIFACTORY_HOME/etc/security/master.key from the primary node to the secondary node.

      Warning
      titleMaster Key

      Copying the $ARTIFACTORY_HOME/etc/security/master.key is a critical step in the import process.

    • Start up the secondary node

Expand
titleTarget Artifactory is running on version 5.6.x and below

  • Perform a normal system export from the source cluster as described above 

  • In the target cluster, keep the primary node running, and perform a graceful shutdown of all secondary nodes

  • Perform normal system import to the target cluster (which now has only the primary node running) as described above

  • Perform a graceful shutdown of the primary node and then restart it

  • Create the bootstrap bundle on the primary node 

  • For each secondary node:

    • Delete the following folders

      • $ARTIFACTORY_HOME/access

      • $ARTIFACTORY_HOME/etc/security

      • $ARTIFACTORY_HOME/etc/ui

      • $ARTIFACTORY_HOME/etc/plugins

    • Delete the $ARTIFACTORY_HOME/etc/db.properties file

    • Delete the $ARTIFACTORY_HOME/etc/binarystore.xml file

    • Copy the bootstrap bundle you created on the primary node, bootstrap.bundle.tar.gz, to the $ARTIFACTORY_HOME/etc folder on the secondary node.

      Warning
      titleBootstrap Bundle and db.properties

      This is a critical step in the import process. The bootstrap bundle must be installed in each secondary node before you start it up for it to operate correctly in the cluster.
      Note also, if the $ARTIFACTORY_HOME/etc folder in your secondary node already contains a db.properties file, it will prevent the bootstrap bundle from being properly extracted when you start up the secondary node causing the import to fail.

    • Start up the secondary node

Once you have completed the import, we recommend verifying that your HA cluster is up and running normally as described in Testing your HA Configuration. 

Repositories Import and Export

Info

Note: Importing repositories is supported for all users whereas exporting repositories is only available for non-SaaS users.

 


To access import and export of repositories, in the Admin tab, select Import & Export | Repositories

Export

When exporting, you need to specify the following parameters:

Source Local Repository
You can specify a single repository to export, or All Repositories
Export to Path
The export target directory on your server
Exclude Metadata
When set, repository metadata are excluded from the export.(Maven 2 metadata is unaffected by this setting)
Create .m2 Compatible Export
When set, includes Maven 2 repository metadata and checksum files as part of the export
Output Verbose Log

When set, lowers the log level to "debug" and redirects the output from the standard log to the import-export log.

Info
titleMonitoring the log

You can monitor the log in the System Logs page.

 


Import

You can import repositories from a server side folder, or by zipping a repository and uploading it to Artifactory.

When importing, you need to specify the following parameters:

Target Local Repository
You can specify a single repository to import, or All Repositories. The repository layout should be different depending on your selection. Please refer to Import Layout
Server Path for Import
The import source directory on your server
Exclude Metadata
When set, repository metadata are excluded from the import
Output Verbose Log

When set, lowers the log level to "debug" and redirects the output from the standard log to the import-export log.

Info
titleMonitoring the log

You can monitor the log in the System Logs page.

Note
titleDon't exclude metadata for Docker

To work with a Docker repository, it must have its metadata intact. Therefore, when importing to/exporting from a Docker repository make sure that Exclude Metadata is not checked.

Tip
titleImporting into a Remote Repository Cache

You can take advantage of remote repositories you have already downloaded to your local environment, and import them directly into a local repository.

For example, you can take your local Maven repository (usually located under ~/.m2) and upload it into Artifactory so that all the artifacts you have already downloaded are now available on the server.

 


Import Layout

An imported repository needs to be formatted using a Maven 2 repository layout.

When importing a single repository, the file structure within the import folder (or zip file) should be as follows:

Code Block
IMPORT_FOLDER/ZIP_FILE
|
|--LIB_DIR_1

When importing all repositories, the file structure within the import folder should be as follows:

Code Block
IMPORT_FOLDER/ZIP_FILE
|
|--REPOSITORY_NAME_DIR_1
| |
| |--LIB_DIR_1
Info

When importing all repositories, you need to ensure that the names of the directories representing the repositories in the archive match the names of the target repositories in Artifactory.