Using the latest JFrog products?
JFrog Platform User Guide
JFrog Mission Control 3.x Documentation
To get the latest version, go to the JFrog Unified Platform
Obtaining a License Bucket
Once your licence bucket is created, you will receive an email with a link to a dedicated web page.
Contacting your JFrog representative to create a bucket
This page will display your personalized bucket license information needed when adding your bucket, including the Bucket Identifier, Signed URL and Key.
Adding a License Bucket
There are two ways to add your license bucket:
- The Onboarding Wizard
- The Admin Module
Step 4 of the Onboarding Wizard allows you to add your license buckets using an Offline Bucket File or Signed URL and Bucket Key.
Go to the Admin module > Licenses > Bucket Management, and click Add new bucket.
Enter a Name for your bucket, an Offline Bucket File or Signed URL, the Key you received from your JFrog representative, and click Add Bucket.
Matching the URL and Key
For more than one license bucket, make sure the URL and Key that you enter 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 Mission Control, you can attach licenses from it using JFrog CLI.
Viewing Bucket Information
A bucket report provides a variety of information on usage of licenses in the bucket. To view a bucket report, hover over a bucket and select View Report from the Actions drop down menu.
|The total number of licenses in this bucket.|
|The identifier of this license bucket.|
|The expiry date for this license bucket.|
Max. consumed licenses
|The maximum number of licenses that were ever in use concurrently during the validity period of this bucket.|
The additional buckets split from this original bucket.
|The services attached to this license bucket.|
Do you have enough or too many licenses in your bucket?
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 not used all the licenses in this bucket concurrently, you may be able to manage with fewer licenses.
- If you reached 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.
Splitting a License Bucket
A license bucket can be split into any number of separate buckets that can be applied to multiple environments as needed.
This is useful for isolated environments that have disconnected networks, and each require a separate Mission Control service. For example: separate environments for Development, Staging and Production. In this case you would split the bucket into additional sub-buckets that can be assigned to each Mission Control service that's within each one of the environments in your organization.
To Split a bucket, select "Split" from the action drop down list.
Add the new bucket name and the number of licenses to assign to it.
Once the new bucket is created, it will be added below the original bucket with the same name, appended by a dash and an ordered number.
- original bucket ID: 905539862
- new bucket ID: 905539862-1
The newly created licences bucket should be downloaded and uploaded to the Mission Control environment it is intended for.
To download the split license bucket, hover over the bucket and select Download Bucket and Copy Key from the from the Actions drop down menu.
Removing a License Bucket
To remove a license bucket, go to Admin > Licenses > Bucket Management, hover over a specific bucket and select Delete from the Actions drop down.
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.
Automating License Buckets with CLI
Using license buckets and JFrog CLI, you can easily automate, and therefore greatly simplify, managing licenses for a large number of Artifactory services.
Using Mission Control CLI
JFrog CLI is a compact and smart client that provides a simple interface to JFrog Mission Control (through its REST API). It 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.
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.
To attach a license bucket, hover over the bucket and select Attach License from the Actions drop down menu.
Split Licence Buckets
A split bucket is intended to be applied to Artifactory services in a separate Mission Control environment. When applying licenses, split licenses should not be used.
The Attach License page displays the available and used licenses within the selected license bucket, and the online Artifactory services managed by this Mission Control service.
You can attach as many licenses to an Artifactory cluster as needed.
Attaching additional licenses to your Artifactory cluster will allow you to dynamically scale it up on demand.
To set the number of licences you would like to attach to each service, select the green check icon and click on Attach licenses. You can set the licenses to all services in bulk by selecting the uppermost green checkbox.
The "# Licenses to Attach" column initially displays the minimum number of licenses the specific service requires. You can increase this number according to the number of available licenses in your bucket. However, you cannot attach less licenses than this default number.
Licenses can only be detached from the Artifactory service.
License Management for individual Artifactory or Artifactory Edge
To apply licenses to a single Artifactory instance use the following steps:
1. Add a new bucket
2. Select Edit service for an existing Artifactory or Edge service
3. In the credentials section, enter username/password and select Test Connectivity. If the connectivity test succeeds, the dropdown for bucket selection is enabled.
4. Choose the new bucket from the list and select Save.
Mission Control will determine the number of licenses the selected Artifactory/Edge instance requires and deploys that many licenses. If the existing licenses have better expiry than the selected bucket, then no action is taken.
Artifactory / Artifactory Edge licenses
Note: For Artifactory and Artifactory Edge services, buckets of both types are available for selection. This allows you to switch an Artifactory to Artifactory Edge or vice versa.