From acd051c288be1eb5b16123156fb2ecd5ed49ab9b Mon Sep 17 00:00:00 2001 From: uboness Date: Mon, 24 Aug 2015 14:40:16 +0200 Subject: [PATCH] [docs] Update docs for version 2.0.0-beta1 Original commit: elastic/x-pack-elasticsearch@02066482525a9cb3f3133b3a2c04be1c399a9514 --- watcher/docs/getting-started.asciidoc | 2 +- watcher/docs/index.asciidoc | 1 + watcher/docs/installing-watcher.asciidoc | 11 +++---- watcher/docs/reference/java.asciidoc | 6 ++-- watcher/docs/reference/rest/info.asciidoc | 4 +-- watcher/docs/release-notes.asciidoc | 37 ++++++++--------------- 6 files changed, 23 insertions(+), 38 deletions(-) diff --git a/watcher/docs/getting-started.asciidoc b/watcher/docs/getting-started.asciidoc index 30a36fd0821..ddae47e8b91 100644 --- a/watcher/docs/getting-started.asciidoc +++ b/watcher/docs/getting-started.asciidoc @@ -3,7 +3,7 @@ This getting started guide walks you through installing Watcher and creating your first watches, and introduces the building blocks you'll use to create custom watches. You can install Watcher -on nodes running Elasticsearch 1.5 or later. +on nodes running Elasticsearch {version}. To install and run Watcher: diff --git a/watcher/docs/index.asciidoc b/watcher/docs/index.asciidoc index 7b1d8900055..59f2a862ac7 100644 --- a/watcher/docs/index.asciidoc +++ b/watcher/docs/index.asciidoc @@ -7,6 +7,7 @@ :java-client-ref: http://www.elastic.co/guide/en/elasticsearch/client/java-api/current :blog-ref: https://www.elastic.co/blog/ :forum: https://discuss.elastic.co/c/watcher +:version: 2.0.0-beta1 include::introduction.asciidoc[] diff --git a/watcher/docs/installing-watcher.asciidoc b/watcher/docs/installing-watcher.asciidoc index 88a7b841c80..a5f5c57a581 100644 --- a/watcher/docs/installing-watcher.asciidoc +++ b/watcher/docs/installing-watcher.asciidoc @@ -12,7 +12,7 @@ options, and the installation process for RPM/DEB package installations. All you need to use Watcher is: * Java 7 or later -* Elasticsearch 1.5 or later +* Elasticsearch {version} * Elasticsearch License plugin For information about installing the latest Oracle JDK, see @@ -74,8 +74,8 @@ specify the location of the configuration files by setting `-Des.path.conf`. For [source,shell] ---------------------------------------------------------- cd /usr/share/elasticsearch -sudo bin/plugin -i elasticsearch/license/latest -Des.path.conf=/etc/elasticsearch -sudo bin/plugin -i elasticsearch/watcher/latest -Des.path.conf=/etc/elasticsearch +sudo bin/plugin -i license -Des.path.conf=/etc/elasticsearch +sudo bin/plugin -i watcher -Des.path.conf=/etc/elasticsearch ---------------------------------------------------------- [float] @@ -90,8 +90,6 @@ To install Watcher on a machine that doesn't have Internet access: . Manually download the License and Watcher binaries: ** https://download.elastic.co/elasticsearch/license/license-latest.zip[ https://download.elastic.co/elasticsearch/license/license-latest.zip] -** https://download.elastic.co/elasticsearch/watcher/watcher-latest.zip[ -https://download.elastic.co/elasticsearch/watcher/watcher-latest.zip] . Transfer the zip files to the offline machine. @@ -99,7 +97,6 @@ https://download.elastic.co/elasticsearch/watcher/watcher-latest.zip] + [source,shell] ---------------------------------------------------------- -bin/plugin -i license -u file:///path/to/file/license-latest.zip <1> -bin/plugin -i watcher -u file:///path/to/file/watcher-1.0.1.zip +bin/plugin -i watcher -u file:///path/to/file/watcher-{version}.zip <1> ---------------------------------------------------------- <1> Note that you must specify an absolute path to the zip file after the `file://` protocol. \ No newline at end of file diff --git a/watcher/docs/reference/java.asciidoc b/watcher/docs/reference/java.asciidoc index c632ebb9101..132ece95ae5 100644 --- a/watcher/docs/reference/java.asciidoc +++ b/watcher/docs/reference/java.asciidoc @@ -36,7 +36,7 @@ If you use Maven to manage dependencies, add the following to the `pom.xml`: org.elasticsearch.plugin elasticsearch-watcher - 2.0.0 + 2.0.0-beta1 ... @@ -60,13 +60,13 @@ repositories { dependencies { // Provide the Watcher jar on the classpath for compilation and at runtime - compile "org.elasticsearch.plugin:elasticsearch-watcher:2.0.0" + compile "org.elasticsearch.plugin:elasticsearch-watcher:2.0.0-beta1" /* ... */ } -------------------------------------------------------------- -You can manually download the http://maven.elasticsearch.org/releases/org/elasticsearch/plugin/elasticsearch-watcher/2.0.0/elasticsearch-watcher-2.0.0.jar[Watcher JAR] +You can manually download the http://maven.elasticsearch.org/releases/org/elasticsearch/plugin/elasticsearch-watcher/{version}/elasticsearch-{version}.jar[Watcher JAR] directly from our Maven repository. ==== Creating the WatcherClient diff --git a/watcher/docs/reference/rest/info.asciidoc b/watcher/docs/reference/rest/info.asciidoc index dedd87d9ead..627d9ffdd14 100644 --- a/watcher/docs/reference/rest/info.asciidoc +++ b/watcher/docs/reference/rest/info.asciidoc @@ -17,8 +17,8 @@ A successful call returns a JSON structure similar to the following example: -------------------------------------------------- { "version": { - "name": "2.0.0", - "number": "2.0.0", <1> + "name": "{version}", + "number": "{version}", <1> "build_hash": "41f64213d2d370bf66f0e9b839a30a19", <2> "build_timestamp": "2015-04-07T13:34:42Z", <3> "build_snapshot": true <4> diff --git a/watcher/docs/release-notes.asciidoc b/watcher/docs/release-notes.asciidoc index 50d78602783..dac2d5737d1 100644 --- a/watcher/docs/release-notes.asciidoc +++ b/watcher/docs/release-notes.asciidoc @@ -5,17 +5,17 @@ [[version-compatibility]] === Version Compatibility -Watcher 1.0.0 is compatible with: +Watcher {version} is compatible with: -* Elasticsearch: 1.5.2+ -* License: 1.0 -* Shield: 1.2.2 +* Elasticsearch: {version} +* License {version} +* Shield {version} [float] [[upgrade-instructions]] === Upgrading Watcher -Watcher 1.0.0 is not backward compatible with Watcher 1.0.0-rc1. Follow these steps to +Watcher {version} is backward compatible with Watcher 1.0.x. Follow these steps to upgrade: 1. Back up all of the watches you've defined. You can search/scan the `.watches` index and save the @@ -30,31 +30,18 @@ upgrade: bin/plugin remove watcher -------------------------------------------------- -4. Restart Elasticsearch on each node. - -5. Delete the `.watches` index and all of the existing `.watch_history-*` indices -+ -[source,yaml] --------------------------------------------------- -DELETE .watches --------------------------------------------------- -+ -[source,yaml] --------------------------------------------------- -DELETE .watch_history* --------------------------------------------------- - -6. Stop Elasticsearch on all nodes in your cluster. - -7. From here on you can simply follow the <> guide. If you are - upgrading from Beta1, you can skip the license installation as both Beta1 and Beta2 are - compatible with the same license version (1.0.0). Once Watcher is installed, you can use the - <> to restore your backed up watches. +4. From here on you can simply follow the <> guide. [float] [[change-list]] === Change List +[float] +==== 2.0.0-beta1 + +This release is primarily for compatibility with Elasticsearch 2.0.0-beta1. + + [float] ==== 1.0.0