Page History

Configuring the Cold Artifact Storage

To configure the Cold Artifact Storage, you must first configure a designated Artifactory instance as the Cold Artifactory, connect to it a storage provider (either cheap self-hosted storage or cloud storage provider, such as Amazon S3 Glacier), and then connect the Cold Artifactory instance to an existing Artifactory instance, also called Live Artifactory.

Prerequisites 

Before setting up Cold Artifact Storage, verify that the following prerequisites are in place:

• Two Artifactory instances

• Enterprise or Enterprise Plus licenses
• Unique license for each Artifactory instance

• Administrator access to both instances

Step 1: Configuring an Artifactory Instance as a Cold Instance

Anchor
step1 step1

Perform the following steps on the Artifactory instance that you are designating as the Cold instance:

1. Update the Artifactory System YAML file:
   Add the shared.jfrogColdStorage.coldInstanceEnabled property and set it as true to configure the instance as the Cold instance.
   

   Code Block
   language yml
   shared: jfrogColdStorage: coldInstanceEnabled: true

2. Configure the Archive Binary Provider: 

   Anchor
   binaryProvider binaryProvider

   
   When setting up the Cold instance, you will need to connect it to a binary storage provider. You can use one of the following storage options:

   • Self-hosted Storage: If you wish to use the local file system, see Configuring the Filesystem Binary Provider.

   • Amazon S3 Glacier Cloud Storage: If you wish to use Amazon S3 Glacier, follow these steps:

     Anchor
     amazonS3 amazonS3

     1. Open the  binarystore.xml configuration file located in the $JFROG_HOME/artifactory/var/etc/artifactory folder.

     2. Specify the s3-storage-v3-archive chain.

     3. Within the chain, define the standard Amazon S3 Binary Provider template as outlined in the section Amazon S3 Official SDK Template and configure the parameters as per your requirements.
        

        Example

        Code Block
        title s3-storage-v3-archive Template
        <config version="1"> <chain template="s3-storage-v3-archive"/> //Dedicated Cold Storage parameters <provider type="s3-storage-v3" id="s3-storage-v3"> //Based on s3-storage-v3 Template <bucketName>artifactory-ice-test-regular-bucket</bucketName> <path>artifactory-on-ice</path> <credential>creds</credential> <identity>ident</identity> <provider.id>aws-s3</provider.id> <region>eu-central-1</region> </provider> </config>

3. Restart the Cold Artifactory instance:
   After making the above changes, restart the Cold Artifactory instance for the changes to take effect. 

Step 2: Connecting Live Artifactory to Cold Artifactory 

Anchor
step2 step2

Perform the following steps on the Artifactory instance that you are designating as the Live instance. This could be either your existing or a new Artifactory instance:

1. Update the Artifactory System YAML file:
   Add the shared.jfrogColdStorage.coldInstanceUrl property and enter the Cold instance URL that the Live instance will connect with.
   

   Code Block
   shared: jfrogColdStorage: coldInstanceUrl: "https://<cold_instance_ip_address>/artifactory"

2. Restart the Live Artifactory Instance:
   After making the above changes, restart the Live Artifactory instance for the changes to take effect.

Step 3: Pairing the Live Instance with the Cold Instance

Anchor
step3 step3

For the Cold Artifactory instance to trust and receive requests from the Live Artifactory instance, the two instances must be paired. This is a one-way trust.

You can pair a Live Artifactory instance with a Cold Artifactory instance using either the UI or APIs.

Pairing using UI

For information about using the UI to pair Live and Cold Artifactory instances, see the section Pairing Tokens.

Pairing using API

Perform the following steps to pair the Live instance with the Cold instance using APIs:

1. On the Cold instance, execute the following POST request:

   Code Block
   curl -u admin:password -X POST https://<cold_instance_ip_address>/artifactory/api/v1/service_trust/pairing/artifactory-cold

   This generates the pairing token. For example:

   Code Block
   { "pairing_token":"IiwiYWxnIjoiUlMyNTYiLCJraWQiOiJaWkhkQzBzenlqd2d..." }

2. Next, on the Live instance, use the generated pairing token to execute the following PUT request. This sets up trust between the Live instance and the Cold instance:
   

   Code Block
   curl -u admin:password -X PUT -H "Content-Type: application/json" -d '{"pairing_token" : "IiwiYWxnIjoiUlMyNTYiLCJraWQiOiJaWkhkQzBzenlqd2d..."}' https://<live_instance_ip_address>/artifactory/api/v1/service_trust/pairing/artifactory-cold

   If the two instance are paired successfully, the request returns the following status: 
   

   Code Block
   Trust with service artifactory-cold was established successfully

Optimizing Cold Artifact Storage Performance

Cold Artifact Storage includes several properties that can be used to configure and optimize its performance. 

Live Artifactory Properties

The following properties can be configured in the Live Artifactory System YAML.

Cold Artifactory Properties

The following properties can be configured in the Cold Artifactory System YAML.