From 11d3aea6fc7148e1e3bc29e242b95b375a057417 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 9 Jul 2020 08:12:59 -0700 Subject: [PATCH] [DOCS] Clarify subscription requirements (#58958) --- .../licensing/get-trial-status.asciidoc | 16 ++++++------- docs/reference/licensing/start-trial.asciidoc | 24 +++++++++---------- .../licensing/update-license.asciidoc | 2 +- docs/reference/setup/restart-cluster.asciidoc | 3 +-- .../authentication/realm-chains.asciidoc | 5 ++-- .../en/security/fips-140-compliance.asciidoc | 17 ++++++------- 6 files changed, 32 insertions(+), 35 deletions(-) diff --git a/docs/reference/licensing/get-trial-status.asciidoc b/docs/reference/licensing/get-trial-status.asciidoc index b411f17b9e3c9..8517c313a92e3 100644 --- a/docs/reference/licensing/get-trial-status.asciidoc +++ b/docs/reference/licensing/get-trial-status.asciidoc @@ -6,7 +6,7 @@ Get trial status ++++ -This API enables you to check the status of your trial license. +Enables you to check the status of your trial. [float] ==== Request @@ -16,16 +16,14 @@ This API enables you to check the status of your trial license. [float] ==== Description -If you want to try the features that are included in a platinum license, you can -start a 30-day trial. +If you want to try all the subscription features, you can start a 30-day trial. -NOTE: You are allowed to initiate a trial license only if your cluster has not -already activated a trial license for the current major product version. For -example, if you have already activated a trial for v6.0, you cannot start a new -trial until v7.0. You can, however, contact `info@elastic.co` to request an -extended trial license. +NOTE: You are allowed to initiate a trial only if your cluster has not +already activated a trial for the current major product version. For example, if +you have already activated a trial for v6.0, you cannot start a new trial until +v7.0. You can, however, request an extended trial at {extendtrial}. -For more information about the different types of licenses, see +For more information about features and subscriptions, see https://www.elastic.co/subscriptions. ==== Authorization diff --git a/docs/reference/licensing/start-trial.asciidoc b/docs/reference/licensing/start-trial.asciidoc index 62123d2ab4253..4401feb3062b0 100644 --- a/docs/reference/licensing/start-trial.asciidoc +++ b/docs/reference/licensing/start-trial.asciidoc @@ -6,7 +6,7 @@ Start trial ++++ -This API starts a 30-day trial license. +Starts a 30-day trial. [float] ==== Request @@ -16,19 +16,17 @@ This API starts a 30-day trial license. [float] ==== Description -The `start trial` API enables you to upgrade from a basic license to a 30-day -trial license, which gives access to the platinum features. +The `start trial` API enables you to start a 30-day trial, which gives access to +all subscription features. -NOTE: You are allowed to initiate a trial license only if your cluster has not -already activated a trial license for the current major product version. For -example, if you have already activated a trial for v6.0, you cannot start a new -trial until v7.0. You can, however, contact `info@elastic.co` to request an -extended trial license. +NOTE: You are allowed to initiate a trial only if your cluster has not already +activated a trial for the current major product version. For example, if you +have already activated a trial for v6.0, you cannot start a new trial until v7.0. +You can, however, request an extended trial at {extendtrial}. -To check the status of your trial license, use the following API: -<>. +To check the status of your trial, use <>. -For more information about the different types of licenses, see +For more information about features and subscriptions, see https://www.elastic.co/subscriptions. ==== Authorization @@ -40,8 +38,8 @@ For more information, see [float] ==== Examples -The following example starts a 30-day trial license. The acknowledge -parameter is required as you are initiating a license that will expire. +The following example starts a 30-day trial. The acknowledge parameter is +required as you are initiating a license that will expire. [source,console] ------------------------------------------------------------ diff --git a/docs/reference/licensing/update-license.asciidoc b/docs/reference/licensing/update-license.asciidoc index ec5d2b930656e..bd20f09aa17a4 100644 --- a/docs/reference/licensing/update-license.asciidoc +++ b/docs/reference/licensing/update-license.asciidoc @@ -21,7 +21,7 @@ Updates the license for your {es} cluster. If {es} {security-features} are enabled, you need `manage` cluster privileges to install the license. -If {es} {security-features} are enabled and you are installing a gold or platinum +If {es} {security-features} are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. See <>. diff --git a/docs/reference/setup/restart-cluster.asciidoc b/docs/reference/setup/restart-cluster.asciidoc index bafbec62a142e..7f1a8f7b87d4a 100644 --- a/docs/reference/setup/restart-cluster.asciidoc +++ b/docs/reference/setup/restart-cluster.asciidoc @@ -34,8 +34,7 @@ include::{es-repo-dir}/upgrade/synced-flush.asciidoc[] . *Temporarily stop the tasks associated with active {ml} jobs and {dfeeds}.* (Optional) + -- -{ml-cap} features require a platinum license or higher. For more information about Elastic -license levels, see https://www.elastic.co/subscriptions[the subscription page]. +{ml-cap} features require specific {subscriptions}[subscriptions]. You have two options to handle {ml} jobs and {dfeeds} when you shut down a cluster: diff --git a/x-pack/docs/en/security/authentication/realm-chains.asciidoc b/x-pack/docs/en/security/authentication/realm-chains.asciidoc index 86f10957a1ce0..5620920910f2b 100644 --- a/x-pack/docs/en/security/authentication/realm-chains.asciidoc +++ b/x-pack/docs/en/security/authentication/realm-chains.asciidoc @@ -93,5 +93,6 @@ realms, authentication fails. See <> for more details. -NOTE: Delegated authorization requires a -https://www.elastic.co/subscriptions[Platinum or Trial license]. +NOTE: Delegated authorization requires that you have a +{subscriptions}[subscription] that includes custom authentication and +authorization realms. diff --git a/x-pack/docs/en/security/fips-140-compliance.asciidoc b/x-pack/docs/en/security/fips-140-compliance.asciidoc index 6fd0e743d2089..726aceec731ff 100644 --- a/x-pack/docs/en/security/fips-140-compliance.asciidoc +++ b/x-pack/docs/en/security/fips-140-compliance.asciidoc @@ -21,23 +21,24 @@ For {es}, adherence to FIPS 140-2 is ensured by [float] === Upgrade considerations -If you plan to upgrade your existing Cluster to a version that can be run in +If you plan to upgrade your existing cluster to a version that can be run in a FIPS 140-2 enabled JVM, the suggested approach is to first perform a rolling upgrade to the new version in your existing JVM and perform all necessary configuration changes in preparation for running in fips mode. You can then perform a rolling restart of the nodes, this time starting each node in the FIPS -140-2 JVM. This will allow {es} to take care of a couple of things automatically for you: +140-2 JVM. This enables {es} to take care of a couple of things automatically for you: -- <> will be upgraded to the latest format version as +- <> will be upgraded to the latest format version as previous format versions cannot be loaded in a FIPS 140-2 JVM. - Self-generated trial licenses will be upgraded to the latest format that is compliant with FIPS 140-2. -If you are on a appropriate license level (platinum) you can elect to perform -a rolling upgrade while at the same time running each upgraded node in a -FIPS 140-2 JVM. In this case, you would need to also regenerate your -`elasticsearch.keystore` and migrate all secure settings to it, in addition to the -necessary configuration changes outlined below, before starting each node. +If you have a {subscriptions}[subscription] that supports FIPS 140-2 mode, you +can elect to perform a rolling upgrade while at the same time running each +upgraded node in a FIPS 140-2 JVM. In this case, you would need to also +regenerate your `elasticsearch.keystore` and migrate all secure settings to it, +in addition to the necessary configuration changes outlined below, before +starting each node. [float] === Configuring {es} for FIPS 140-2