Skip to content
This repository has been archived by the owner on Aug 16, 2022. It is now read-only.

Contradictory statement in documentation #489

Closed
geek981108 opened this issue May 17, 2021 · 2 comments
Closed

Contradictory statement in documentation #489

geek981108 opened this issue May 17, 2021 · 2 comments

Comments

@geek981108
Copy link

There's a confusing statement in the documentation of Open distro for ElasticSearch located at https://opendistro.github.io/for-elasticsearch-docs/docs/security/access-control/api/#update-configuration

The original text is as follows:

Creates or updates the existing configuration using the REST API rather than securityadmin.sh. This operation can easily break your existing configuration, so we recommend using securityadmin.sh instead. See Access control for the API for how to enable this operation.

In the first half of the paragraph the doc recommand us to use REST API and use securityadmin.sh in the rest of it.

Overall view of the full text, Using REST API should be recommanded.

geek981108 added a commit to geek981108/for-elasticsearch-docs that referenced this issue May 17, 2021
@aetter
Copy link
Contributor

aetter commented May 17, 2021

Hi @geek981108, agreed that the wording is a bit confusing. For most things -- creating users, roles, etc. -- the REST API is the better way to go. For updating the configuration, though, the REST API is pretty risky. We even keep the request disabled by default. securityadmin.sh is much safer. I've tried to clarify a bit here: e24c6a7

@aetter aetter closed this as completed May 17, 2021
@geek981108
Copy link
Author

Thank you for your work!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants