mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
Adds documentation to clarify kibana-keystore behaviour (#157146)
## Summary Addresses #155474 We've discussed with the team, and decided that we'd retain current behaviour, and adjust the docs and notes around the behaviour. fix(keystore): add warning note to explain that input is being JSON parsed docs(keystore): add documentation to clarify behavior ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
This commit is contained in:
parent
c024591493
commit
58650c5545
2 changed files with 5 additions and 1 deletions
|
@ -36,6 +36,8 @@ bin/kibana-keystore list
|
|||
[[add-string-to-keystore]]
|
||||
=== Add string settings
|
||||
|
||||
NOTE: Your input will be JSON-parsed to allow for object/array input configurations. To enforce string values, use "double quotes" around your input.
|
||||
|
||||
Sensitive string settings, like authentication credentials for Elasticsearch
|
||||
can be added using the `add` command:
|
||||
|
||||
|
|
|
@ -64,7 +64,9 @@ export async function add(keystore, key, options = {}) {
|
|||
export function addCli(program, keystore) {
|
||||
program
|
||||
.command('add <key>')
|
||||
.description('Add a string setting to the keystore')
|
||||
.description(
|
||||
'Add a setting to the keystore. Note: The value will be JSON parsed. Use quotes to force string inputs.'
|
||||
)
|
||||
.option('-f, --force', 'overwrite existing setting without prompting')
|
||||
.option('-x, --stdin', 'read setting value from stdin')
|
||||
.option('-s, --silent', 'prevent all logging')
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue