Watcher Docs: Added license management topic. Closes elastic/elasticsearch#706.
Original commit: elastic/x-pack-elasticsearch@477d14ecd3
This commit is contained in:
debadair
parent
e1dde82724
commit
aeffd696ff
|
|
@ -27,6 +27,8 @@ include::example-watches.asciidoc[]
|
|||
|
||||
include::reference.asciidoc[]
|
||||
|
||||
include::managing-watcher-licenses.asciidoc[]
|
||||
|
||||
include::troubleshooting.asciidoc[]
|
||||
|
||||
include::release-notes.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,96 @@
|
|||
[[license-management]]
|
||||
== Managing Your License
|
||||
|
||||
When you initially install Watcher, a 30 day trial license is installed that allows access to all
|
||||
features. At the end of the trial period, you can https://www.elastic.co/subscriptions/watcher[purchase a subscription] to keep using the full functionality of Watcher along with Shield and Marvel.
|
||||
|
||||
IMPORTANT: When your license expires, your watches will still be triggered but no actions will
|
||||
be performed. You will not be able to get existing watches or add new ones, but you can still
|
||||
delete watches.
|
||||
|
||||
[float]
|
||||
[[installing-license]]
|
||||
=== Updating Your License
|
||||
|
||||
You can update your license at runtime without shutting down your nodes. License updates take
|
||||
effect immediately. The license is provided as a _JSON_ file that you install with the `license`
|
||||
API.
|
||||
|
||||
NOTE: If Shield is enabled, you need cluster admin privileges to install the license.
|
||||
|
||||
To update your license:
|
||||
|
||||
. Send a request to the `license` API and specify the file that contains your new license:
|
||||
+
|
||||
[source,shell]
|
||||
-----------------------------------------------------------------------
|
||||
curl -XPUT -u admin 'http://<host>:<port>/_license' -d @license.json
|
||||
-----------------------------------------------------------------------
|
||||
+
|
||||
Where:
|
||||
+
|
||||
* `<host>` is the hostname of the Elasticsearch node (`localhost` if executing locally)
|
||||
* `<port>` is the http port (defaults to `9200`)
|
||||
* `license.json` is the license JSON file
|
||||
|
||||
. If the license you are installing does not support all of the features available with your
|
||||
previous license, you will be notified in the response. To complete the license installation,
|
||||
you must resubmit the license update request and set the `acknowledge` parameter to `true` to
|
||||
indicate that you are aware of the changes.
|
||||
+
|
||||
[source,shell]
|
||||
-----------------------------------------------------------------------
|
||||
curl -XPUT -u admin 'http://<host>:<port>/_license?acknowledge=true' -d @license.json
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
[float]
|
||||
[[listing-licenses]]
|
||||
=== Viewing the Installed License
|
||||
|
||||
You can also use the `license` API to retrieve the currently installed license:
|
||||
|
||||
[source,shell]
|
||||
-----------------------------------------------------
|
||||
curl -XGET -u admin:password 'http://<host>:<port>/_license'
|
||||
{
|
||||
"license" : {
|
||||
"status" : "active",
|
||||
"uid" : "0a98411f-73f4-4c67-954c-724874ed5488",
|
||||
"type" : "trial",
|
||||
"issue_date" : "2015-10-13T18:18:20.709Z",
|
||||
"issue_date_in_millis" : 1444760300709,
|
||||
"expiry_date" : "2015-11-12T18:18:20.709Z",
|
||||
"expiry_date_in_millis" : 1447352300709,
|
||||
"max_nodes" : 1000,
|
||||
"issued_to" : "elasticsearch",
|
||||
"issuer" : "elasticsearch"
|
||||
}
|
||||
}
|
||||
--------------------------------------------
|
||||
|
||||
NOTE: If Shield is enabled, you need cluster admin privileges to retrieve the license.
|
||||
|
||||
[float]
|
||||
[[license-expiration]]
|
||||
=== License Expiration
|
||||
|
||||
License expiration should never be a surprise. Warnings are displayed on startup and written to
|
||||
the Elasticsearch log starting 30 days from the expiration date. These error messages tell
|
||||
you when the license expires and what features will be disabled if you fail to update it:
|
||||
|
||||
[source,sh]
|
||||
--------------------------------------------
|
||||
# License will expire on [Thursday, November 12, 2015]. If you have a new license, please update it.
|
||||
# Otherwise, please reach out to your support contact.
|
||||
#
|
||||
# Commercial plugins operate with reduced functionality on license expiration:
|
||||
# - marvel
|
||||
# - The agent will stop collecting cluster and indices metrics
|
||||
# - shield
|
||||
# - Cluster health, cluster stats and indices stats operations are blocked
|
||||
# - All data operations (read and write) continue to work
|
||||
# - watcher
|
||||
# - PUT / GET watch APIs are disabled, DELETE watch API continues to work
|
||||
# - Watches execute and write to the history
|
||||
# - The actions of the watches don't execute
|
||||
--------------------------------------------
|
||||
Loading…
Reference in New Issue