Skip to content

Commit

Permalink
[7.17] Adds documentation to clarify kibana-keystore behaviour (#157146
Browse files Browse the repository at this point in the history
…) (#157187)

# Backport

This will backport the following commits from `main` to `7.17`:
- [Adds documentation to clarify kibana-keystore behaviour
(#157146)](#157146)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Alex
Szabo","email":"alex.szabo@elastic.co"},"sourceCommit":{"committedDate":"2023-05-09T16:02:45Z","message":"Adds
documentation to clarify kibana-keystore behaviour (#157146)\n\n##
Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and
decided that we'd retain current\r\nbehaviour, and adjust the docs and
notes around the behaviour.\r\n\r\nfix(keystore): add warning note to
explain that input is being JSON\r\nparsed\r\ndocs(keystore): add
documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Operations","release_note:skip","backport:all-open","v8.9.0"],"number":157146,"url":"https://github.com/elastic/kibana/pull/157146","mergeCommit":{"message":"Adds
documentation to clarify kibana-keystore behaviour (#157146)\n\n##
Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and
decided that we'd retain current\r\nbehaviour, and adjust the docs and
notes around the behaviour.\r\n\r\nfix(keystore): add warning note to
explain that input is being JSON\r\nparsed\r\ndocs(keystore): add
documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157146","number":157146,"mergeCommit":{"message":"Adds
documentation to clarify kibana-keystore behaviour (#157146)\n\n##
Summary\r\nAddresses #155474 \r\n\r\nWe've discussed with the team, and
decided that we'd retain current\r\nbehaviour, and adjust the docs and
notes around the behaviour.\r\n\r\nfix(keystore): add warning note to
explain that input is being JSON\r\nparsed\r\ndocs(keystore): add
documentation to clarify behavior\r\n\r\n### Checklist\r\n\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n\r\n### For
maintainers\r\n\r\n- [x] This was checked for breaking API changes and
was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"58650c55456fbcf418f7a75edf98de32238f6bea"}}]}]
BACKPORT-->

Co-authored-by: Alex Szabo <alex.szabo@elastic.co>
  • Loading branch information
kibanamachine and delanni committed May 9, 2023
1 parent 2cd5456 commit 13f1a94
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/setup/secure-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 3 additions & 1 deletion src/cli_keystore/add.js
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down

0 comments on commit 13f1a94

Please sign in to comment.