Document process on how to enable/disable plugins with the opensearch_dashboards.yml config file #6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: manasvinibs <manasvis@amazon.com>
|
Probably rename this to be how to enable and disable plugins with the config file. This does not apply to any config setting after all |
joshuarrrr
approved these changes
Jul 27, 2022
| @@ -0,0 +1,49 @@ | |||
| # Add new config to the {root}/config/opensearch-dashboards.yml file | |||
There was a problem hiding this comment.
Suggested change
| # Add new config to the {root}/config/opensearch-dashboards.yml file | |
| # Add new config to the `{root}/config/opensearch-dashboards.yml` file |
| @@ -0,0 +1,49 @@ | |||
| # Add new config to the {root}/config/opensearch-dashboards.yml file | |||
|
|
|||
| 1. Add new config value in the opensearch_dashboards.yml file. Below is an example where I'm adding new flag to hide/show | |||
There was a problem hiding this comment.
Suggested change
| 1. Add new config value in the opensearch_dashboards.yml file. Below is an example where I'm adding new flag to hide/show | |
| 1. Add a commented out new config value in the `opensearch_dashboards.yml` file. Below is an example where I'm adding new flag to hide/show |
| # wizard.enabled: true | ||
| ``` | ||
|
|
||
| Note that the yml config values are read as path to the plugin config schema file. In the above example, `wizard` is the `Id` of the plugin to which I'm introducing this new config value. |
There was a problem hiding this comment.
Suggested change
| Note that the yml config values are read as path to the plugin config schema file. In the above example, `wizard` is the `Id` of the plugin to which I'm introducing this new config value. | |
| Note that the yml config values are read as path to the plugin config schema file. In the above example, `wizard` is the `Id` of the plugin to which I'm introducing this new config value. The value should match the default, so that if a user uncomments the line, it will still have the default behavior. |
| }; | ||
|
|
||
| ``` | ||
| We need to set `exposeToBrowser` true for the config property `enabled` which we have defined in the config schema. |
There was a problem hiding this comment.
Just pure speculation, but my guess is that you can use the config in server components even without that setting, but it's necessary for it to be available to public components and services.
There was a problem hiding this comment.
Yes. exposeToBrowser will allow the components in the public folder to get that value but is still usable in the server.
manasvinibs
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: manasvinibs manasvis@amazon.com