Support "enterprise" license types by tvernum · Pull Request #49223 · elastic/elasticsearch

tvernum · 2019-11-18T05:30:56Z

This adds "enterprise" as an acceptable type for a license loaded
through the PUT _license API.

Internally an enterprise license is treated as having a "platinum"
operating mode.

The handling of License types was refactored to have a new explicit
"LicenseType" enum in addition to the existing "OperatingMode" enum.

Relates: #48510

This adds "enterprise" as an acceptable type for a license loaded through the PUT _license API. Internally an enterprise license is treated as having a "platinum" operating mode. The handling of License types was refactored to have a new explicit "LicenseType" enum in addition to the existing "OperatingMode" enum.

elasticmachine · 2019-11-18T05:30:59Z

Pinging @elastic/es-security (:Security/License)

tvernum · 2019-11-18T05:33:56Z

Notes:

This does not include support for reading the ECE license structure (which is labelled "enterprise" but is a different JSON format)
This maps to the "platinum" operating mode, so as currently implemented, it is not possible to tie any ES functionality to the enterprise license type.
This does not have a compatibility mode that would return "platinum" for older clients (but we will need to add one).

jkakavas

LGTM

jkakavas · 2019-11-19T14:13:23Z

...cense-tools/src/main/java/org/elasticsearch/license/licensor/tools/LicenseGeneratorTool.java

                    "Must specify either --license or --licenseFile");
        }
+        if (licenseSpec == null) {
+            throw new UserException(ExitCodes.DATA_ERROR, "Could parse license spec");


Suggested change

throw new UserException(ExitCodes.DATA_ERROR, "Could parse license spec");

throw new UserException(ExitCodes.DATA_ERROR, "Could not parse license spec");

jkakavas · 2019-11-19T14:15:42Z

x-pack/plugin/core/src/main/java/org/elasticsearch/license/License.java

-                case "cloud_internal":
-                case "internal": // bwc for 1.x subscription_type field
+                case PLATINUM:
+                case ENTERPRISE: // TODO Add an explicit platinum operating mode


Suggested change

case ENTERPRISE: // TODO Add an explicit platinum operating mode

case ENTERPRISE: // TODO Add an explicit enterprise operating mode

jkakavas · 2019-11-19T14:39:24Z

x-pack/plugin/core/src/main/java/org/elasticsearch/license/LicenseService.java

+
+    private static boolean licenseIsCompatible(License license, Version version) {
+        if (License.LicenseType.ENTERPRISE.getTypeName().equalsIgnoreCase(license.type())) {
+            return version.onOrAfter(Version.V_8_0_0);


IIRC the suggested approach is to use the targeted version here and set bwc_enabled to false in build.gradle until the backporting PR is merged

jkakavas · 2019-11-19T14:42:10Z

x-pack/plugin/core/src/main/java/org/elasticsearch/license/LicenseService.java

-        if (VALID_TRIAL_TYPES.contains(request.getType()) == false) {
+        License.LicenseType requestedType = License.LicenseType.parse(request.getType());
+        if (VALID_TRIAL_TYPES.contains(requestedType) == false) {
            throw new IllegalArgumentException("Cannot start trial of type [" + request.getType() + "]. Valid trial types are "


request.getType() to requestedType.getTypeName() ?

jkakavas · 2019-11-19T14:51:09Z

Do we really need LicenceType and OperatingMode nowadays? Should we merge those in a followup?

tvernum · 2019-11-20T03:24:07Z

Do we really need LicenceType and OperatingMode nowadays?

No, I don't think we do, but all this BWC stuff in licensing is getting a bit crazy. We ought to look at cleaning up a bunch of stuff for 8.0

This adds "enterprise" as an acceptable type for a license loaded through the PUT _license API. Internally an enterprise license is treated as having a "platinum" operating mode. The handling of License types was refactored to have a new explicit "LicenseType" enum in addition to the existing "OperatingMode" enum. Backport of: elastic#49223

six5532one · 2019-12-10T00:08:44Z

@tvernum I'm planning to add the changes to ECE to install the new "enterprise" stack license in ECE clusters with stack version >= 7.6 (https://github.com/elastic/cloud/issues/43639). I have a few questions to make sure we're on the same page.

You mentioned in a comment above:

This does not include support for reading the ECE license structure (which is labelled "enterprise" but is a different JSON format)

My understanding is the Elasticsearch API supports PUT requests with a payload like

{
                "license": {
                    "uid": "55ec27dc-b2d6-455c-b985-1e06fa77062a",
                    "type": "platinum",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1591574399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1590969600000
                }
            }

The ECE license bundles stack licenses with this format. Currently, ECE installs stack licenses by making a PUT request against the ES API with a payload that has the same structure as the JSON pasted above. My understanding is, in order for ECE to support the new "enterprise" stack license on v7.6+, it will continue to install stack licenses with the payload structure shown above, but the value of the "type" field will be "enterprise". According to my understanding, license update requests from ECE will not be using a different JSON format. I wanted to make sure there isn't a misunderstanding on my end.

For reference, here is a sample ECE license (which at some point will include an enterprise stack license in "cluster_licenses":

{
    "license": {
        "uid": "748f2afe-ec9c-4b93-a04f-0d3588e1ee68",
        "type": "enterprise",
        "issue_date_in_millis": 1559779200000,
        "start_date_in_millis": 1559779200000,
        "expiry_date_in_millis": 1591574399999,
        "max_instances": 100,
        "issued_to": "Elastic - INTERNAL",
        "issuer": "Shane Connelly",
        "signature": "redacted",
        "cluster_licenses": [
            {
                "license": {
                    "uid": "17641883-1229-4494-ac1c-66bd3ddb6b76",
                    "type": "standard",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1601510399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1559779200000
                }
            },
            {
                "license": {
                    "uid": "1ef5250f-5068-49fc-8a7b-86755a3635d3",
                    "type": "gold",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1601510399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1559779200000
                }
            },
            {
                "license": {
                    "uid": "6c3d2bb1-dee1-4946-b41c-0fdce75990e9",
                    "type": "platinum",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1601510399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1559779200000
                }
            },
            {
                "license": {
                    "uid": "05d83147-d2b2-43fe-8087-fecddf34ca85",
                    "type": "standard",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1591574399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1590969600000
                }
            },
            {
                "license": {
                    "uid": "55ec27dc-b2d6-455c-b985-1e06fa77062a",
                    "type": "gold",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1591574399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1590969600000
                }
            },
            {
                "license": {
                    "uid": "6080ab72-75e1-4d3f-911c-237928c8dfa6",
                    "type": "platinum",
                    "issue_date_in_millis": 1559779200000,
                    "expiry_date_in_millis": 1591574399999,
                    "max_nodes": 100,
                    "issued_to": "Elastic - INTERNAL",
                    "issuer": "Shane Connelly",
                    "signature": "redacted",
                    "start_date_in_millis": 1590969600000
                }
            }
        ]
    }
}```

six5532one · 2019-12-10T00:39:50Z

ECE currently makes a PUT /_xpack/license request. Should we migrate to PUT /_license instead? Do you know which ES versions support PUT /_license?

This adds "enterprise" as an acceptable type for a license loaded through the PUT _license API. Internally an enterprise license is treated as having a "platinum" operating mode. The handling of License types was refactored to have a new explicit "LicenseType" enum in addition to the existing "OperatingMode" enum. By default (in 7.x) the GET license API will return "platinum" when an enterprise license is active in order to be compatible with existing consumers of that API. A new "accept_enterprise" flag has been introduced to allow clients to opt-in to receive the correct "enterprise" type. Backport of: #49223

Relates: #4341, elastic/elasticsearch#49223, elastic/elasticsearch#50735 This commit adds support for Enterprise LicenseType, and adds max_resource_units to GetLicenseResponse.

Relates: #4341, elastic/elasticsearch#49223, elastic/elasticsearch#50735 This commit adds support for Enterprise LicenseType, and adds max_resource_units to GetLicenseResponse. Co-authored-by: Russ Cam <russ.cam@elastic.co>

Relates: #4341, elastic/elasticsearch#49223, elastic/elasticsearch#50735 This commit adds support for Enterprise LicenseType, and adds max_resource_units to GetLicenseResponse. (cherry picked from commit c737df6)

tvernum added >enhancement :Security/License License functionality for commercial features v8.0.0 v7.6.0 labels Nov 18, 2019

tvernum requested a review from jkakavas November 18, 2019 05:30

jkakavas approved these changes Nov 19, 2019

View reviewed changes

tvernum added 3 commits November 20, 2019 14:34

Merge branch 'master' into enterprise-license/accept-put

afb18ac

Address feedback

49d8862

Fix test

05bb5b4

tvernum merged commit 31512fb into elastic:master Nov 20, 2019

tvernum added the backport pending label Nov 20, 2019

tvernum mentioned this pull request Nov 22, 2019

Support "enterprise" license types #49474

Merged

pebrc mentioned this pull request Dec 1, 2019

7.6 support elastic/cloud-on-k8s#2197

Closed

2 tasks

peterschretlen mentioned this pull request Dec 9, 2019

Support 'enterprise' license type elastic/kibana#49474

Closed

tvernum removed the backport pending label Dec 12, 2019

tvernum mentioned this pull request Jan 8, 2020

Support 'enterprise' license type #48510

Closed

This was referenced Feb 3, 2020

[meta] 7.6 release elastic/elasticsearch-net#4340

Closed

[meta] 7.6 release elastic/elasticsearch-net#4341

Closed

russcam mentioned this pull request Feb 21, 2020

Support Enterprise license type elastic/elasticsearch-net#4406

Merged

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support "enterprise" license types#49223

Support "enterprise" license types#49223
tvernum merged 4 commits intoelastic:masterfrom
tvernum:enterprise-license/accept-put

tvernum commented Nov 18, 2019

Uh oh!

elasticmachine commented Nov 18, 2019

Uh oh!

tvernum commented Nov 18, 2019 •

edited

Loading

Uh oh!

jkakavas left a comment

Uh oh!

jkakavas Nov 19, 2019

Uh oh!

jkakavas Nov 19, 2019

Uh oh!

jkakavas Nov 19, 2019

Uh oh!

jkakavas Nov 19, 2019

Uh oh!

jkakavas commented Nov 19, 2019

Uh oh!

tvernum commented Nov 20, 2019 •

edited

Loading

Uh oh!

six5532one commented Dec 10, 2019 •

edited

Loading

Uh oh!

six5532one commented Dec 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	throw new UserException(ExitCodes.DATA_ERROR, "Could parse license spec");
	throw new UserException(ExitCodes.DATA_ERROR, "Could not parse license spec");

	case ENTERPRISE: // TODO Add an explicit platinum operating mode
	case ENTERPRISE: // TODO Add an explicit enterprise operating mode

Conversation

tvernum commented Nov 18, 2019

Uh oh!

elasticmachine commented Nov 18, 2019

Uh oh!

tvernum commented Nov 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jkakavas left a comment

Choose a reason for hiding this comment

Uh oh!

jkakavas Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

jkakavas Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

jkakavas Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

jkakavas Nov 19, 2019

Choose a reason for hiding this comment

Uh oh!

jkakavas commented Nov 19, 2019

Uh oh!

tvernum commented Nov 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

six5532one commented Dec 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

six5532one commented Dec 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tvernum commented Nov 18, 2019 •

edited

Loading

tvernum commented Nov 20, 2019 •

edited

Loading

six5532one commented Dec 10, 2019 •

edited

Loading