Mark lots of stuff `// NOTCONSOLE`

This commit is contained in:
Nik Everett 2016-08-26 16:18:58 -04:00
parent 5357d9d9ce
commit c24ad1df4e
5 changed files with 20 additions and 3 deletions

View File

@ -149,6 +149,7 @@ in the cluster:
---- ----
doc["num"].value * factor doc["num"].value * factor
---- ----
// NOTCONSOLE
then use the script as follows: then use the script as follows:

View File

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

View File

@ -18,5 +18,6 @@ using the <<cluster-nodes-stats>> API, with:
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
curl 'localhost:9200/_nodes/stats/process?pretty&filter_path=**.max_file_descriptors' GET _nodes/stats/process?filter_path=**.max_file_descriptors
-------------------------------------------------- --------------------------------------------------
// CONSOLE

View File

@ -63,6 +63,7 @@ in the jvm.options file and setting these values via `ES_JAVA_OPTS`:
ES_JAVA_OPTS="-Xms2g -Xmx2g" ./bin/elasticsearch <1> ES_JAVA_OPTS="-Xms2g -Xmx2g" ./bin/elasticsearch <1>
ES_JAVA_OPTS="-Xms4000m -Xmx4000m" ./bin/elasticsearch <2> ES_JAVA_OPTS="-Xms4000m -Xmx4000m" ./bin/elasticsearch <2>
------------------ ------------------
// NOTCONSOLE
<1> Set the minimum and maximum heap size to 2 GB. <1> Set the minimum and maximum heap size to 2 GB.
<2> Set the minimum and maximum heap size to 4000 MB. <2> Set the minimum and maximum heap size to 4000 MB.

View File

@ -35,8 +35,9 @@ request:
[source,sh] [source,sh]
-------------- --------------
curl 'http://localhost:9200/_nodes?pretty&filter_path=**.mlockall' GET _nodes?filter_path=**.mlockall
-------------- --------------
// CONSOLE
If you see that `mlockall` is `false`, then it means that the `mlockall` If you see that `mlockall` is `false`, then it means that the `mlockall`
request has failed. You will also see a line with more information in the request has failed. You will also see a line with more information in the
@ -69,6 +70,7 @@ specifying a new temp directory, by starting Elasticsearch with:
-------------- --------------
./bin/elasticsearch -Djava.io.tmpdir=/path/to/temp/dir ./bin/elasticsearch -Djava.io.tmpdir=/path/to/temp/dir
-------------- --------------
// NOTCONSOLE
or using the `ES_JAVA_OPTS` environment variable: or using the `ES_JAVA_OPTS` environment variable:
@ -77,6 +79,7 @@ or using the `ES_JAVA_OPTS` environment variable:
export ES_JAVA_OPTS="$ES_JAVA_OPTS -Djava.io.tmpdir=/path/to/temp/dir" export ES_JAVA_OPTS="$ES_JAVA_OPTS -Djava.io.tmpdir=/path/to/temp/dir"
./bin/elasticsearch ./bin/elasticsearch
-------------- --------------
// NOTCONSOLE
[[disable-swap-files]] [[disable-swap-files]]
==== Disable all swap files ==== Disable all swap files
@ -100,4 +103,3 @@ The second option available on Linux systems is to ensure that the sysctl value
`vm.swappiness` is set to `1`. This reduces the kernel's tendency to swap and `vm.swappiness` is set to `1`. This reduces the kernel's tendency to swap and
should not lead to swapping under normal circumstances, while still allowing should not lead to swapping under normal circumstances, while still allowing
the whole system to swap in emergency conditions. the whole system to swap in emergency conditions.