Licenses

3 minute readAutomation

The license defines the usage to which your organization is entitled. See license types and license entitlements for further information about your license.

Managing licenses

Viewing licenses

You can view all license information known to the CloudBees CD/RO server from the license list: from the main menu, select Administration ConfigurationsLicenses.

A single license is typically displayed. The license defines the usage to which your organization is entitled. For explanations of the various CloudBees CD/RO license types, see License types below.

Viewing license usage statistics

To view license usage statistics: from the main menu, select Dev Ops Essentials Platform Home PageCloudResources.

Importing a license

You should have received a license (as a block of text) from CloudBees. If you have not received a license, contact support or your sales representative.

To import a license:

  1. Open the Licenses page: from the main menu, select Administration ConfigurationsLicenses.

  2. Use a text editor to open the license file.

  3. Select Import on the upper right-hand side of the Licenses page.

    The Import License dialog box appears.

  4. Copy and paste the license file text into the Contents field.

  5. Select OK.

Your license information now appears on the Licenses page.

Deleting a license

To delete a license, select Actions icon at far right for the license that you want to delete and then select Delete.

License types

Server license

A server license allows you to use only the built-in database. It is packaged with the server and is automatically installed if no other license is present. It restricts you to running only two concurrent steps.

Enterprise license

An enterprise license allows you to use an external (alternate) database. You must apply an enterprise license key when you want to configure an alternate database. Restriction and entitlements vary based on your license.

SDA license

An SDA license allows you to access CloudBees Analytics dashboards. If installed along with a server or enterprise license, you also have access to entitlements those licenses provide.

Entitlement categories

Registered host license

Registered hosts are dedicated hosts on which a procedure or step can always run. This license controls the number of unique registered host names. The maxRegisteredHosts license file property value sets the maximum number of hosts that can be recorded in the database. Whether those hosts are in the default-zone, behind a gateway, or are proxied hosts, they all count towards this total.

The localhost host name and the 127.0.0.1 IP address represent the local agent installed on the CloudBees CD/RO server machine. These are part of the total count for hosts in use with a registered host license.

If multiple steps are running concurrently on the same host, the host name still counts once only toward the license limit. All resources pointing to a single host count as one host.

When a license expires, running jobs are allowed to complete, but no new jobs can be launched.

Registered user license

This license allows registered users to be created up to the license limit.

License content

License list

The following information appears in the License section and applies to all types of licenses.

Column NameDescription

Company

Name of the company or organization to which the license is granted. If this is not your organization, contact CloudBees Customer Support.

Feature

Type of license. For example, Server.

Expiration

Last day when this license is valid. After your license expires (and after any grace period), running jobs will complete, but no new jobs can be launched.

Grace Period (Days)

Number of days that you may continue using CloudBees CD/RO after the expiration date. (However, you are warned frequently during the grace period that your license has expired.)

Actions

Button that you use to view license details of a particular license in the list or to delete a license.

Current usage

This section lists the particular entitlement categories included in the license along with the current usage for each.

Field Name

Description

Maximum Concurrent Steps

The maximum number of steps that can run at one time. This entitlement appears on the initial Server license that comes with the installer.

Concurrent Steps in Use

The number of steps currently running.

Maximum Registered Hosts

Number of registered hosts on which a procedure or step can always run. This entitlement appears when the license on the CloudBees CD/RO server is based on registered hosts.

Registered Hosts In Use

Number of registered hosts where steps are currently running.

Maximum Registered Users

Maximum number of registered users who can use CloudBees CD/RO at a time.

Registered Users In Use

Number of registered users currently using CloudBees CD/RO.