elasticsearch/docs/plugins/install_remove.asciidoc
James Rodewig 1301995a46
[DOCS] Remove unneeded ifevals from install docs (#98952)
Problem: The current install docs contain several `ifeval` statements that hide commands and code snippets based on the branch's release state. These statements make the Asciidoc hard to read  and maintain. It also makes doc changes difficult to preview.

Solution: Remove `ifeval` statements that hide commands or code snippets. Leave in any `ifeval` statements used to add warnings.
2023-08-29 07:56:10 -04:00

39 lines
1.3 KiB
Text

[discrete]
[id="{plugin_name}-install"]
==== Installation
ifeval::["{release-state}"=="unreleased"]
WARNING: Version {version} of the Elastic Stack has not yet been released.
endif::[]
This plugin can be installed using the plugin manager:
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
sudo bin/elasticsearch-plugin install {plugin_name}
----------------------------------------------------------------
The plugin must be installed on every node in the cluster, and each node must
be restarted after installation.
You can download this plugin for <<plugin-management-custom-url,offline
install>> from {plugin_url}/{plugin_name}/{plugin_name}-{version}.zip. To verify
the `.zip` file, use the
{plugin_url}/{plugin_name}/{plugin_name}-{version}.zip.sha512[SHA hash] or
{plugin_url}/{plugin_name}/{plugin_name}-{version}.zip.asc[ASC key].
[discrete]
[id="{plugin_name}-remove"]
==== Removal
The plugin can be removed with the following command:
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------
sudo bin/elasticsearch-plugin remove {plugin_name}
----------------------------------------------------------------
The node must be stopped before removing the plugin.