nodes-reload-secure-settings.asciidoc 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. [[cluster-nodes-reload-secure-settings]]
  2. == Nodes Reload Secure Settings
  3. The cluster nodes reload secure settings API is used to re-read the
  4. local node's encrypted keystore. Specifically, it will prompt the keystore
  5. decryption and reading accross the cluster. The keystore's plain content is
  6. used to reinitialize all compatible plugins. A compatible plugin can be
  7. reinitilized without restarting the node. The operation is
  8. complete when all compatible plugins have finished reinitilizing. Subsequently,
  9. the keystore is closed and any changes to it will not be reflected on the node.
  10. [source,js]
  11. --------------------------------------------------
  12. POST _nodes/reload_secure_settings
  13. POST _nodes/nodeId1,nodeId2/reload_secure_settings
  14. --------------------------------------------------
  15. // CONSOLE
  16. // TEST[setup:node]
  17. // TEST[s/nodeId1,nodeId2/*/]
  18. The first command reloads the keystore on each node. The seconds allows
  19. to selectively target `nodeId1` and `nodeId2`. The node selection options are
  20. detailed <<cluster-nodes,here>>.
  21. Note: It is an error if secure settings are inconsistent across the cluster
  22. nodes, yet this consistency is not enforced whatsoever. Hence, reloading specific
  23. nodes is not standard. It is only justifiable when retrying failed reload operations.
  24. [float]
  25. [[rest-reload-secure-settings]]
  26. ==== REST Reload Secure Settings Response
  27. The response contains the `nodes` object, which is a map, keyed by the
  28. node id. Each value has the node `name` and an optional `reload_exception`
  29. field. The `reload_exception` field is a serialization of the exception
  30. that was thrown during the reload process, if any.
  31. [source,js]
  32. --------------------------------------------------
  33. {
  34. "_nodes": {
  35. "total": 1,
  36. "successful": 1,
  37. "failed": 0
  38. },
  39. "cluster_name": "my_cluster",
  40. "nodes": {
  41. "pQHNt5rXTTWNvUgOrdynKg": {
  42. "name": "node-0"
  43. }
  44. }
  45. }
  46. --------------------------------------------------
  47. // TESTRESPONSE[s/"my_cluster"/$body.cluster_name/]
  48. // TESTRESPONSE[s/"pQHNt5rXTTWNvUgOrdynKg"/\$node_name/]