License Bucket Management
JFrog Mission Control uses License Bucket Management to manage large number of Artifactory services. You can obtain license buckets for Enterprise+, Artifactory Edge and Enterprise.
Getting a License Bucket
To use JFrog Mission Control license bucket management, you first need to set up the following components on your system:
- Obtaining the License Buckets
- Installing JFrog CLI
Obtaining a Bucket of Licenses
To obtain your bucket of licenses, please contact your JFrog representative who will create a bucket with the number of licenses you require and send them to you. All licenses in a bucket have exactly the same activation parameters. That means they will all have the same date of expiry.
You will receive an email message with a link to a dedicated web page. This page displays your personalized bucket license information required when you add your bucket . You should look out for a section similar to the below:
BUCKET LICENCE INFORMATION
During installation, you will be requested to specify the following bucket details.
Bucket identifier: <bucket_id>
Signed URL: <signed_URL>
Bucket unlock Key: <key>
You need to enter the Bucket Identifier, Signed URL and Key in JFrog Mission Control as described in the next section.
Installing JFrog CLI
JFrog CLI is a compact and smart client that provides a simple interface to JFrog Mission Control (through its REST API). JFrog CLI can be used by your automation environment for fully automated license management for all your Artifactory services through Mission Control. For details on downloading and installing JFrog CLI, please refer to the JFrog CLI documentation.
Adding a License Bucket
You can add license buckets in the following two locations in Mission Control:
- In the Mission Control Onboarding Wizard.
- In the Admin module under Licenses | Bucket Management.
To load a new bucket, click Add New Bucket.
You can give the bucket a logical name in the Name field. Enter the URL and Key you received from your JFrog representative and click Get Bucket.
Match the bucket identifier to the URL and key
If you have received more than one license bucket, make sure you enter a URL and Key that correspond to the same Bucket Identifier.
Bucket name and identifier are two different things
Don’t confuse the bucket Name with the Bucket Identifier. The bucket name is an arbitrary logical name you assign to the bucket. The identifier is a unique identifier assigned to the bucket by JFrog.
Once the license bucket has been loaded into JFrog Mission Control, you can attach licenses from it using JFrog CLI.
Using Mission Control CLI
While each Artifactory license can only activate one Artifactory service at a time, you are free to move any license around to different Artifactory services as long as the license remains valid. For example, you can temporarily attach a license from a bucket to an Artifactory service used for a specific development project. Once the project is complete and the Artifactory service is no longer needed, you can detach the license and return it to the bucket managed by Mission Control.
Attaching and Detaching Licenses
You can attach and detach licenses with the JFrog CLI.
attach-lic command extracts a license from the bucket specified and attaches it to the specified Artifactory service.
detach-lic command removes the specified license from the specified Artifactory service and returns it to the specified bucket in JFrog Mission Control.
A license always belongs to the same bucket
When you detach a license, it is always returned to the same bucket it was attached from.
Working with Artifactory HA
From version 5.0 of JFrog Artifactory, licensing for all cluster nodes in an Artifactory High Availability configuration are managed through the Cluster License Manager. When attaching or detaching licenses to an HA cluster, Mission Control will detect the Artifactory version and work accordingly with the Cluster License Manager if the version is 5.0 or above, or directly with each node for earlier versions of Artifactory.
Removing a License Bucket
You can view all loaded license buckets in the Admin module under Licenses | Bucket Management.
To remove a bucket, hover over it and select delete. Removing the bucket will not remove the licenses from the services.
Once the license bucket is removed, the services that were attached to it should be assigned to a new bucket.
Bucket Report / view bucket
A bucket report provides a variety of information on usage of licenses in the bucket. To view a bucket report, click the Bucket ID in the list of license buckets.
To detach a license key, right click on it and select "Detach".
|The identifier of this bucket|
Max. consumed licenses
|The maximum number of licenses that were ever in use concurrently during the validity period of this bucket|
Current licenses in use
The number of licenses currently in use
Current available licenses
|The number of licenses currently available|
|The total number of licenses in this bucket|
Do you have enough or too many licenses in your bucket?
The value of Max. Consumed Licenses shows you that highest number licenses you ever used during the validity period of this bucket. This is something to consider when you renew your JFrog Artifactory licenses. If you never used all the licenses in this bucket concurrently, you may be able to manage with fewer licenses. If you did reach the total number of licenses in this bucket, you may not be meeting the demand for Artifactory services in your organization and should consider purchasing more Artifactory licenses.
Updating Licenses Individually
The process of applying licenses has four steps:
Select Artifactory Services
Select the one or more service for which you want to add or update a license, and click "Continue" to move on to the next step
Paste license keys you want to apply to your Artifactory services.
Simply paste the licenses you want to add into the Add Licenses entry field and click "Add Licenses". Click "Continue" to move on to the next step.
Adding multiple licenses at once
You can add licenses one at a time, or paste several licenses, separated by an empty line, into the Add Licenses field and add them to the list at once.
Match Licenses to Services
In this step, you need to match up the Artifactory services you have selected with the licenses you have added.
First select an Artifactory service. This will enable the list of licenses.
Then, select the license you wish to apply to the selected service and click "Add".
The column on the right displays your matched selections.
To change services and licenses matches, click Delete to return the service and license of a matched set to their respective lists.
Once you have matched all of your Artifactory services with their licenses, click "Continue" to move on to the next step.
The Summary screen displays the Artifactory services that should be updated with the licenses you selected for them.
To apply the licenses click Execute All.
You can retry, but you cannot roll back.
If, for any reason, applying a license does not work in any of the Artifactory services, you can click the corresponding "Retry" button to try again.
However, once a licenses is applied, you cannot roll back to the previous licenses.