plugin-descriptor-file.asciidoc 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. ifeval::["{plugin-type}" == "stable"]
  2. The stable plugin descriptor file is a Java properties file called
  3. `stable-plugin-descriptor.properties`
  4. endif::[]
  5. ifeval::["{plugin-type}" == "classic"]
  6. The classic plugin descriptor file is a Java properties file called
  7. `plugin-descriptor.properties`
  8. endif::[]
  9. that describes the plugin. The file is automatically created if you are
  10. using {es}'s Gradle build system. If you're not using the gradle plugin, you
  11. can create it manually using the following template.
  12. [source,properties]
  13. :plugin-properties-files: {elasticsearch-root}/build-tools/src/main/resources
  14. [source,yaml]
  15. ----
  16. include::{plugin-properties-files}/plugin-descriptor.properties[]
  17. ----
  18. [discrete]
  19. ==== Properties
  20. [cols="<,<,<",options="header",]
  21. |=======================================================================
  22. |Element | Type | Description
  23. |`description` |String | simple summary of the plugin
  24. |`version` |String | plugin's version
  25. |`name` |String | the plugin name
  26. ifeval::["{plugin-type}" == "stable"]
  27. |`classname` |String | this property is for classic plugins. Do
  28. not include this property for stable plugins.
  29. endif::[]
  30. ifeval::["{plugin-type}" == "classic"]
  31. |`classname` |String | the name of the class to load,
  32. fully-qualified.
  33. |`extended.plugins` |String | other plugins this plugin extends through
  34. SPI.
  35. |`modulename` |String | the name of the module to load classname
  36. from. Only applies to "isolated" plugins. This is optional. Specifying it causes
  37. the plugin to be loaded as a module.
  38. endif::[]
  39. |`java.version` |String | version of java the code is built against.
  40. Use the system property `java.specification.version`. Version string must be a
  41. sequence of nonnegative decimal integers separated by "."'s and may have leading
  42. zeros.
  43. |`elasticsearch.version` |String | version of {es} compiled against.
  44. |=======================================================================