CSS allows you to view default and custom plugins. If the plugin provided by CSS cannot meet your requirements, you can install, uninstall, or delete the plugin based on your needs.

1. Log in to the CSS management console.
2. On the Clusters page, click the name of a cluster for which you want to install a plugin.

   The Basic Information page is displayed.

3. Click the Plugins tab.
4. View the information about default plugins.
   On the Default Plugins page, view default plugins supported by the current version.

   Table 1 Cluster versions supported by default plugins

   Plugin	Supported Cluster Version
   analysis-dynamic-synonym	5.5.1, 6.2.3, 6.5.4, and 7.1.1
   analysis-icu	6.2.3, 6.5.4, and 7.1.1
   analysis-ik	5.5.1, 6.2.3, 6.5.4, and 7.1.1
   analysis-pinyin	5.5.1, 6.2.3, 6.5.4, and 7.1.1
   analysis-poisson	6.2.3
   analysis-stconvert	5.5.1, 6.2.3, 6.5.4, and 7.1.1
   lasthit	5.5.1 and 6.2.3
   repository-obs	5.5.1, 6.2.3, 6.5.4, and 7.1.1
   vector-search	6.2.3
   opendistro_alerting	6.5.4 and 7.1.1
   opendistro_security	6.5.4 and 7.1.1
   opendistro_sql	6.5.4 and 7.1.1
   analysis-kuromoji	6.5.4 and 7.1.1
   analysis-nori	6.5.4 and 7.1.1
   ingest-attachment	6.5.4 and 7.1.1

5. Install custom plugins.
   

   If you want to use custom plugins, submit a service ticket to apply for permissions. Keep custom plugins available and secure because they may affect cluster stability.

   1. On the Custom Plugins page, click Upload to upload the desired plugin from the OBS bucket to the cluster.
      • OBS Bucket: OBS bucket where the plugin to be installed is stored. If no OBS bucket is available, click Create Bucket to create one. For details, see Creating a Bucket. The OBS bucket to be created must be in the same region as the cluster.
      • Plugin: Plugin to be uploaded. Select a .zip file.
   2. Click OK.

      After the upload completes, view the plugin information on the Plugins page. You can also view plugin operation records in the upper right corner of the page.

      Figure 1 Viewing operation records
      

      Table 2 Viewing the plugin information

      Parameter	Description
      ID	Plugin ID, which is automatically generated
      Name	Name of the plugin to be uploaded The plugin name must be unique.
      Plugin Status	Plugin status. The options are as follows: To be installed: indicates the plugin has been uploaded but not installed. Installed and to be effective upon cluster restart: If this status is displayed, restart the cluster for the plugin to take effect. Installed: If this status is displayed after restarting the cluster, the plugin can work properly. Uninstalled and to be effective upon cluster restart: If this status is displayed, restart the cluster for the plugin to take effect. Uninstalled: If this status is displayed after restarting the cluster, the plugin is not available.
      Task Status	Running status of the plugin. The options are as follows: Uploading Installing Uninstalling Deleting
      Uploaded	Time when the plugin is uploaded
      Operation	Install: After uploading the plugin, click Install. Task Status changes to Installing. Uninstall: If you want to uninstall the plugin, click Uninstall. Task Status changes to Uninstalling. The uninstalled plugin is still displayed in the list. If you want to use it again, install it directly. Delete: If you want to delete the plugin, click Delete. Task Status changes to Deleting. If you delete the plugin, you need to upload it before installing it again.

      

      • After you install plugins such as readonlyrest and siren-federate, manually modify the configurations. You cannot install the plugins by yourself. If you need to install plugins, contact the technical support.
      • Custom plugins can be automatically uploaded and installed after the cluster scale-out.
      • If a plugin fails to be installed, view the failure cause on the Operation Records page. If you still cannot locate the fault, contact technical support.

      Table 3 Parameters on the Operation Records page

      Parameter	Description
      Name/ID	Name of the plugin you perform operations on
      Operation Type	Operations performed on the plugin, including Upload, Install, Uninstall, and Delete.
      Task Status	Status of a task, including Successful, Failed, and Running.
      Created	Time when a task is created
      Completed	Time when a task is completed
      Error Message	Message reported when a task fails Common error messages are as follows: If the error message is Instance: xx.xx.xx.xx. ERROR: `elasticsearch` directory is missing in the plugin zip., Check whether the plugin file is a standard .zip file. If the error message is Instance: xx.xx.xx.xx.. Exception in thread "main" java.lang.IllegalArgumentException: plugin [analysis-pinyin] is incompatible with version [5.5.1]; was designed for version [6.2.3] at, the plugin version does not match the cluster version. If you still cannot locate the fault, contact technical support.