kibana/docs
Kibana Machine e7e0a58578
[8.8] Improve keystore CLI (#157359) (#157886)
# Backport

This will backport the following commits from `main` to `8.8`:
- [Improve keystore CLI
(#157359)](https://github.com/elastic/kibana/pull/157359)

<!--- 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-16T14:21:25Z","message":"Improve
keystore CLI (#157359)\n\n## Summary\r\n\r\nRelates to: #113217\r\n\r\n-
Add extra documentation to highlight behaviour of the kibana
keystore\r\n(for #113217)\r\n- Fix/Tidy-up commands (`create`, `list`)
where the extra unused\r\narguments were preventing the `options` from
being passed to the\r\nfunctions. Also remove unnecessary `async`
keyword from the `remove`\r\ncommand.\r\n- Added new `show`
command\r\n```\r\nUsage: bin/kibana-keystore show [options]
<key>\r\n\r\nDisplays the value of a single setting in the keystore.
Pass the -o (or --output) parameter to write the setting to a
file.\r\n\r\nOptions:\r\n -s, --silent prevent all logging\r\n -o,
--output <file> output value to a file\r\n -h, --help output usage
information\r\n```\r\n\r\n### Checklist\r\n\r\nDelete any items that are
not applicable to this PR.\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- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Kaarina Tungseth
<kaarina.tungseth@elastic.co>","sha":"6ebfb8aa3ecd28ba1059e40ea8f9fea62ad52368","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Operations","release_note:skip","v8.8.0","v8.9.0"],"number":157359,"url":"https://github.com/elastic/kibana/pull/157359","mergeCommit":{"message":"Improve
keystore CLI (#157359)\n\n## Summary\r\n\r\nRelates to: #113217\r\n\r\n-
Add extra documentation to highlight behaviour of the kibana
keystore\r\n(for #113217)\r\n- Fix/Tidy-up commands (`create`, `list`)
where the extra unused\r\narguments were preventing the `options` from
being passed to the\r\nfunctions. Also remove unnecessary `async`
keyword from the `remove`\r\ncommand.\r\n- Added new `show`
command\r\n```\r\nUsage: bin/kibana-keystore show [options]
<key>\r\n\r\nDisplays the value of a single setting in the keystore.
Pass the -o (or --output) parameter to write the setting to a
file.\r\n\r\nOptions:\r\n -s, --silent prevent all logging\r\n -o,
--output <file> output value to a file\r\n -h, --help output usage
information\r\n```\r\n\r\n### Checklist\r\n\r\nDelete any items that are
not applicable to this PR.\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- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Kaarina Tungseth
<kaarina.tungseth@elastic.co>","sha":"6ebfb8aa3ecd28ba1059e40ea8f9fea62ad52368"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/157359","number":157359,"mergeCommit":{"message":"Improve
keystore CLI (#157359)\n\n## Summary\r\n\r\nRelates to: #113217\r\n\r\n-
Add extra documentation to highlight behaviour of the kibana
keystore\r\n(for #113217)\r\n- Fix/Tidy-up commands (`create`, `list`)
where the extra unused\r\narguments were preventing the `options` from
being passed to the\r\nfunctions. Also remove unnecessary `async`
keyword from the `remove`\r\ncommand.\r\n- Added new `show`
command\r\n```\r\nUsage: bin/kibana-keystore show [options]
<key>\r\n\r\nDisplays the value of a single setting in the keystore.
Pass the -o (or --output) parameter to write the setting to a
file.\r\n\r\nOptions:\r\n -s, --silent prevent all logging\r\n -o,
--output <file> output value to a file\r\n -h, --help output usage
information\r\n```\r\n\r\n### Checklist\r\n\r\nDelete any items that are
not applicable to this PR.\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- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Kaarina Tungseth
<kaarina.tungseth@elastic.co>","sha":"6ebfb8aa3ecd28ba1059e40ea8f9fea62ad52368"}}]}]
BACKPORT-->

Co-authored-by: Alex Szabo <alex.szabo@elastic.co>
2023-05-16 08:38:03 -07:00
..
api Document compatibilityMode query string parameter in Resolve import errors API. (#155696) 2023-04-25 17:36:31 +02:00
api-generated [8.8] [DOCS] Fix optional create connector id (#157031) (#157175) 2023-05-09 09:47:08 -07:00
apm [8.8] Update APM links (#156460) (#156462) 2023-05-02 22:04:47 -04:00
canvas [8.8] [Canvas] Update function reference docs (#156409) (#156610) 2023-05-03 14:50:09 -04:00
concepts [DOCS] Updates Discover docs (#151953) 2023-03-08 07:05:25 -08:00
dev-tools Add Console docs for Comments and Variables (#137225) 2022-07-28 10:52:20 -07:00
developer [APM] Create plugin for logs onboarding (#154728) 2023-04-25 11:14:21 -04:00
development/plugins/expressions/public Remove old doc generation system for core APIs (#134313) 2022-06-21 17:43:17 +02:00
discover [DOCS] How to duplicate a search (#154008) 2023-04-05 13:47:05 -07:00
fleet Update Fleet overview topic (#121153) 2021-12-14 09:14:02 -08:00
getting-started [DOCS] Adds the 8.6 Presentation docs (#145474) 2022-11-28 11:20:38 -05:00
management [8.8] [DOCS] Adds Global Settings (#157769) (#157780) 2023-05-15 14:07:14 -04:00
maps [DOCS] Remove or move book-scoped attributes (#155210) 2023-04-20 09:12:09 -07:00
migration [DOCS] Remove 8.0.0 coming tag (#125229) 2022-02-10 07:58:28 -05:00
observability Move observability content (#79978) 2020-10-13 16:08:48 +01:00
osquery Osquery: Update exported fields reference for osquery 5.7.0 (#150216) 2023-02-06 13:23:21 -05:00
settings [8.8] [Telemetry] Change Privacy Statement Link (#156845) (#156883) 2023-05-05 10:01:22 -07:00
setup [8.8] Improve keystore CLI (#157359) (#157886) 2023-05-16 08:38:03 -07:00
siem [DOCS] Elastic Sec Overview (Fixing Image) (#104529) 2021-07-07 09:58:09 -04:00
spaces Removing docs about multi-tenancy (#143698) 2022-10-24 16:01:43 -04:00
user [8.8] [DOCS] Documents AIOps Labs enhancements (#157716) (#157752) 2023-05-15 11:43:56 -04:00
accessibility.asciidoc
action-type-template.asciidoc [DOCS] Edit layout of connector pages (#151534) 2023-02-21 08:20:21 -08:00
apis.asciidoc [DOCS] Create open API specification for find rules (#147061) 2022-12-12 11:36:44 -08:00
CHANGELOG.asciidoc [8.8] [DOCS] Adds 8.8.0 release notes (#155951) (#157420) 2023-05-11 13:36:27 -04:00
gs-index.asciidoc [DOCS] Remove or move book-scoped attributes (#155210) 2023-04-20 09:12:09 -07:00
index-custom-title-page.html Updates docs landing page (#154400) 2023-04-17 07:59:31 -07:00
index.asciidoc [DOCS] Remove or move book-scoped attributes (#155210) 2023-04-20 09:12:09 -07:00
index.x.asciidoc
limitations.asciidoc [DOCS] Reallocates limitations to point-of-use (#79582) 2020-11-19 10:49:27 -06:00
migration.asciidoc [DOCS] Adds What's New (#68918) 2020-06-11 12:06:29 -07:00
redirects.asciidoc [DOCS] Remove obsolete X-Pack settings page (#154683) 2023-04-10 19:34:34 -07:00
rule-type-template.asciidoc [DOCS] Create and manage rule action frequencies (#150957) 2023-02-23 13:16:46 -08:00
template.asciidoc [DOCS] Remove snapshot and restore docs (#114836) 2021-11-16 16:59:24 -05:00