Skip to content

Commit cb7ef27

Browse files
committed
custom plugins bare min
1 parent d0a73b4 commit cb7ef27

File tree

1 file changed

+11
-4
lines changed
  • deploy-manage/users-roles/cluster-or-deployment-auth

1 file changed

+11
-4
lines changed

deploy-manage/users-roles/cluster-or-deployment-auth/custom.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,18 @@ To package your custom realm as a plugin:
5757

5858
To use a custom realm:
5959

60-
1. Install the realm extension on each node in the cluster. You run `bin/elasticsearch-plugin` with the `install` sub-command and specify the URL pointing to the zip file that contains the extension. For example:
60+
1. Install the realm extension on each node in the cluster.
61+
62+
* If you're usinga self-managed cluster, then run `bin/elasticsearch-plugin` with the `install` sub-command and specify the URL pointing to the zip file that contains the extension. For example:
63+
64+
```shell
65+
bin/elasticsearch-plugin install file:///<path>/my-realm-1.0.zip
66+
```
67+
* If you're using {{ech}}, then refer to [](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md).
68+
% * If you're using {{ece}}, then refer to []().
69+
% TODO: bad mapping in solutions/search/full-text/search-with-synonyms.md
70+
* If you're using {{eck}}, then refer to [](/deploy-manage/deploy/cloud-on-k8s/custom-configuration-files-plugins.md).
6171

62-
```shell
63-
bin/elasticsearch-plugin install file:///<path>/my-realm-1.0.zip
64-
```
6572

6673
2. Add a realm configuration of the appropriate realm type to `elasticsearch.yml` under the `xpack.security.authc.realms` namespace. You must define your realm within the namespace that matches the type defined by the extension. The options you can set depend on the settings exposed by the custom realm. At a minimum, you must explicitly set the `order` attribute to control the order in which the realms are consulted during authentication. You must also make sure each configured realm has a distinct `order` setting. In the event that two or more realms have the same `order`, the node will fail to start.
6774

0 commit comments

Comments
 (0)