Remove most of the need for // NOTCONSOLE

and be much more stingy about what we consider a console candidate.

* Add `// CONSOLE` to check-running
* Fix version in some snippets
* Mark groovy snippets as groovy
* Fix versions in plugins
* Fix language marker errors
* Fix language parsing in snippets

  This adds support for snippets who's language is written like
  `[source, txt]` and `["source","js",subs="attributes,callouts"]`.

  This also makes language required for snippets which is nice because
  then we can be sure we can grep for snippets in a particular language.
This commit is contained in:
Nik Everett 2016-08-29 17:33:25 -04:00
parent 6df70444a3
commit 5cff2a046d
44 changed files with 167 additions and 159 deletions

View file

@ -15,7 +15,6 @@ Run the following command to get usage instructions:
-----------------------------------
sudo bin/elasticsearch-plugin -h
-----------------------------------
// NOTCONSOLE
[IMPORTANT]
.Running as root
@ -42,7 +41,6 @@ Core Elasticsearch plugins can be installed as follows:
-----------------------------------
sudo bin/elasticsearch-plugin install [plugin_name]
-----------------------------------
// NOTCONSOLE
For instance, to install the core <<analysis-icu,ICU plugin>>, just run the
following command:
@ -51,7 +49,6 @@ following command:
-----------------------------------
sudo bin/elasticsearch-plugin install analysis-icu
-----------------------------------
// NOTCONSOLE
This command will install the version of the plugin that matches your
Elasticsearch version and also show a progress bar while downloading.
@ -65,7 +62,6 @@ A plugin can also be downloaded directly from a custom location by specifying th
-----------------------------------
sudo bin/elasticsearch-plugin install [url] <1>
-----------------------------------
// NOTCONSOLE
<1> must be a valid URL, the plugin name is determined from its descriptor.
For instance, to install a plugin from your local file system, you could run:
@ -74,7 +70,6 @@ For instance, to install a plugin from your local file system, you could run:
-----------------------------------
sudo bin/elasticsearch-plugin install file:///path/to/plugin.zip
-----------------------------------
// NOTCONSOLE
The plugin script will refuse to talk to an HTTPS URL with an untrusted
certificate. To use a self-signed HTTPS cert, you will need to add the CA cert
@ -84,7 +79,6 @@ to a local Java truststore and pass the location to the script as follows:
-----------------------------------
sudo ES_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install https://....
-----------------------------------
// NOTCONSOLE
[[listing-removing]]
=== Listing and Removing Installed Plugins
@ -98,7 +92,6 @@ A list of the currently loaded plugins can be retrieved with the `list` option:
-----------------------------------
sudo bin/elasticsearch-plugin list
-----------------------------------
// NOTCONSOLE
Alternatively, use the {ref}/cluster-nodes-info.html[node-info API] to find
out which plugins are installed on each node in the cluster
@ -113,7 +106,6 @@ Plugins can be removed manually, by deleting the appropriate directory under
-----------------------------------
sudo bin/elasticsearch-plugin remove [pluginname]
-----------------------------------
// NOTCONSOLE
After a Java plugin has been removed, you will need to restart the node to complete the removal process.
@ -145,7 +137,6 @@ can do this as follows:
---------------------
sudo bin/elasticsearch-plugin -Epath.conf=/path/to/custom/config/dir install <plugin name>
---------------------
// NOTCONSOLE
You can also set the `CONF_DIR` environment variable to the custom config
directory path.
@ -168,7 +159,6 @@ sudo bin/elasticsearch-plugin install analysis-icu --timeout 1m
# Wait forever (default)
sudo bin/elasticsearch-plugin install analysis-icu --timeout 0
-----------------------------------
// NOTCONSOLE
[float]
=== Proxy settings
@ -181,7 +171,6 @@ and `http.proxyPort` (or `https.proxyHost` and `https.proxyPort`):
-----------------------------------
sudo ES_JAVA_OPTS="-Dhttp.proxyHost=host_name -Dhttp.proxyPort=port_number -Dhttps.proxyHost=host_name -Dhttps.proxyPort=https_port_number" bin/elasticsearch-plugin install analysis-icu
-----------------------------------
// NOTCONSOLE
Or on Windows:
@ -190,7 +179,6 @@ Or on Windows:
set ES_JAVA_OPTS="-DproxyHost=host_name -DproxyPort=port_number -Dhttps.proxyHost=host_name -Dhttps.proxyPort=https_port_number"
bin/elasticsearch-plugin install analysis-icu
------------------------------------
// NOTCONSOLE
=== Plugins directory