[Chore] Updates developer guide for security development #5287
Conversation
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
ashwin-pc
requested review from
ananzh,
kavilla,
seanneumann,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
kristenTian,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
BSFishy and
curq
as code owners
ashwin-pc
added
backport 2.x
Skip-Changelog
ashwin-pc
added
docs
| > Running `yarn opensearch snapshot -P <security_plugin_url>` will not work since the plugin needs some additional configuration to setup correctly. To configure it correctly, here are the steps: | ||
| > | ||
| > 1. Run `yarn opensearch snapshot -P <security_plugin_url>`. This will fail to run and complain about missing certificates. Ignore that since what we want is for the build artifacts | ||
| > 2. Run `export initialAdminPassword=<inital admin password>` since its needed by the configuration script |
There was a problem hiding this comment.
should we provide just an example, like it can be admin or imply that this is setting up initial admin password not so much that it has to be preconfigured
There was a problem hiding this comment.
I'm okay with that. This is one of those docs where I want this to be a stub and see where people get confused and need more information. I think the variable name is quite self explanatory ;)
| > | ||
| > 1. Run `yarn opensearch snapshot -P <security_plugin_url>`. This will fail to run and complain about missing certificates. Ignore that since what we want is for the build artifacts | ||
| > 2. Run `export initialAdminPassword=<inital admin password>` since its needed by the configuration script | ||
| > 3. Run the config script in the plugin directory of opensearch. `bash .opensearch/<version>/plugins/opensearch-security/tools/install_demo_configuration.sh` |
There was a problem hiding this comment.
@manasvinibs do you think it's worth to consider provide an optional execute setup script or even "with security enabled that runs this default'
There was a problem hiding this comment.
That would be even better. A one line command would be ideal
There was a problem hiding this comment.
Yeah I agree! An additional flag to enable security which takes care of step 2 and step 3 will be neat.
There was a problem hiding this comment.
Do we want a separate PR for the additional flag?
|
I would prefer an automated approach like #5451 |
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
|
closing this since #5451 has made this a lot easier |
Description
Updates the developer guide with instructions on how to setup the security plugin for local development using the snapshot command
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integration