This topic describes how to create a new archive instance and connect it to an active instance. The archive instance is used in the smart archiving solution to offload archive items from the active instance.
Hybrid Smart Archiving is supported on the Self-hosted platform with E+ from version 7.117.14.
Prerequisite
Active Artifactory Instance
Contact your Account Manager to purchase JFrog E+ Hybrid subscription for JFrog Smart Archive instance.
Follow these steps to create and associate an archive instance with an active instance:
Important
Upon successful purchase, you will receive an email from JFrog with the subject line Activate Your JFrog Hybrid Subscription.
Click Go to MyJFrog in the received email.
Log in to MyJFrog Your Customer Portal with your registered credentials.
Navigate to Topology Page
In the My JFrog Dashboard, click Topology.
In the Topology page, click Configure Now.
Configure Archive under Available Smart Archiving Instance (X)
Note
No changes are allowed to the instance configuration once configured.
Contact JFrog support for any changes.
Scroll down in the Configure JPDs page where you can view Available Smart Archiving Instance (x) section and add JPDs:
Note
All fields are mandatory.
In the Archive Name field, enter name of the archive instance.
Note
We recommend to give a meaningful name.
The naming convention and criteria for Archive Name must be as follows:
unique
3 - 32 characters long
start with a letter
only lowercase characters or numbers
From the Provider list, select the cloud provider.
From the Region list, select the region.
Enter Password and Validate Password.
Note
The password criteria must be as follows:
8 - 32 characters long
at least one uppercase and one lowercase character
at least one number
at least one special character
Click Update.
Note
After you enter all required information, the dialog will display an All Set indicator.
The Topology tab now shows an indicator at the top that the JPDs are being added and the environment is being updated.
This process may take a few minutes. When the configuration completes:
a tree structure is shown with the archive instance status as Active.
upon successful Smart Archiving JPD creation, you will receive an email from JFrog with the subject line Your New JFrog Instance Is Ready.
View Configured Archive Instances
JPD Name: The name of the active instance.
Type: Indicates the type of JPD.
Provider: Indicates the type of Cloud provider.
Region: Indicates the region of the deployed instance.
Status: Indicates the status of the instance.
Active: The archive instance is available to bind with the active instance.
Note
To complete the setup for a Smart Archive instance, you must bind it to an active instance.
Bind Archive Instance
You can bind archive instance via UI or API
Bind Archive Instance via UI
Create Pairing Token: Generate the Pairing Token to connect the Active and Archive instances.
Perform the following steps on the Archive Instance to create a Pairing Token:
From the Administration, click User Management | Access Tokens | Pairing Token.
From the Generate Pairing Token, click Cold Storage.
Click Generate.
This displays the token window, which includes the token's expiration (in seconds, set by default to 300 seconds = 5 minutes), the token ID, and the actual token, which you can copy by clicking Copy.
Establish Trust Between Active and Archive Instances
Perform the following steps on the Active Instance:
From the Administration module, click Topology | Deployment Bindings.
Click the Archive tab. In the top right corner, click + Add Binding, and select Archive from the dropdown list.
In the Create Binding modal, do the following:
From the Source JPD (Live Instance), select the Active instance.
From the Target JPD (Cold Instance), select the Archive instance.
Click Apply.
The Summary displays the target and source you selected.
Click Create.
Check the Binding Results.
Bind Archive Instance via API
Create Pairing Token: Generate the Pairing Token to connect the Active and Archive instances.
On the Archive instance, execute the following POST request.
curl -u admin:password -X POST https://<archive_instance>/artifactory/api/v1/service_trust/pairing/artifactory-cold
This generates the pairing token. For example:
{ "pairing_token":"IiwiYWxnIjoiUlMyNTYiLCJraWQiOiJaWkhkQzBzenlqd2d..."}Establish Trust Between Active and Archive Instances
On the Active Instance, use the generated pairing token to execute the following PUT request.
curl -u admin:password -X PUT -H "Content-Type: application/json "-d '{"pairing_token" : "IiwiYWxnIjoiUlMyNTYiLCJraWQiOiJaWkhkQzBzenlqd2d..."}' https://<active_instance>/artifactory/api/v1/service_trust/pairing/artifactory-coldIf the two instances are paired successfully, the request returns the following status:
Trust with service artifactory-cold was established successfully