[DOCS] Add 'secrets' to Fleet settings page #172637
Merged
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
|
Pinging @elastic/kibana-docs (Team:Docs) |
|
Documentation preview: |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
kilfoyle
added
the
release_note:skip
kilfoyle
added
backport:prev-minor
jillguyonnet
approved these changes
Dec 13, 2023
|
Approved with a small nit (typo). I have couple of questions that could be for future iterations:
|
Definitely! We should fill that gap. For now, I've added a link at the top of the page pointing to the Fleet UI settings page. However, I agree that this Kibana "Fleet settings" page really should document all available settings. I've opened a separate issue for that. If you can give me any guidance about where I can find a full list of those settings I'd appreciate it.
The remote ES output is documented here. In a separate PR I'll update that page to note that the "Service token" field can be stored as a secret setting. If you think it should also go on this "Fleet settings in Kibana" docs page, I'm happy to add it here too. |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Dec 14, 2023
This updates the list of available Fleet settings in the Kibana docs, as follows: - Moves the `config` and `proxy_id` settings from the Required to the Optional section of `xpack.fleet.outputs`. CC @nchaulet since the settings were added to the docs via elastic#158771). [See orange highlight] - Adds the `ssl` setting with the `certificate` property (this setting is already available but doesn't appear to have been documented). [See red highlight] - Adds the new `secrets` setting, with SSL `key` as a property. [See blue highlight] - Adds an example output configuration. [See green highlight] Rel: elastic/ingest-docs#692 See [docs preview](https://kibana_172637.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html) ---  (cherry picked from commit c7fabda)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Dec 14, 2023
# Backport This will backport the following commits from `main` to `8.12`: - [[DOCS] Add 'secrets' to Fleet settings page (#172637)](#172637) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"David Kilfoyle","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-12-14T16:01:26Z","message":"[DOCS] Add 'secrets' to Fleet settings page (#172637)\n\nThis updates the list of available Fleet settings in the Kibana docs, as\r\nfollows:\r\n\r\n- Moves the `config` and `proxy_id` settings from the Required to the\r\nOptional section of `xpack.fleet.outputs`. CC @nchaulet since the\r\nsettings were added to the docs via\r\nhttps://github.com//pull/158771). [See orange highlight]\r\n- Adds the `ssl` setting with the `certificate` property (this setting\r\nis already available but doesn't appear to have been documented). [See\r\nred highlight]\r\n- Adds the new `secrets` setting, with SSL `key` as a property. [See\r\nblue highlight]\r\n - Adds an example output configuration. [See green highlight]\r\n\r\nRel: https://github.com/elastic/ingest-docs/issues/692\r\nSee [docs\r\npreview](https://kibana_172637.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\n---\r\n\r\n","sha":"c7fabda4c59789facbbc6127589e66d162148669","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport:prev-minor","v8.13.0"],"number":172637,"url":"https://github.com/elastic/kibana/pull/172637","mergeCommit":{"message":"[DOCS] Add 'secrets' to Fleet settings page (#172637)\n\nThis updates the list of available Fleet settings in the Kibana docs, as\r\nfollows:\r\n\r\n- Moves the `config` and `proxy_id` settings from the Required to the\r\nOptional section of `xpack.fleet.outputs`. CC @nchaulet since the\r\nsettings were added to the docs via\r\nhttps://github.com//pull/158771). [See orange highlight]\r\n- Adds the `ssl` setting with the `certificate` property (this setting\r\nis already available but doesn't appear to have been documented). [See\r\nred highlight]\r\n- Adds the new `secrets` setting, with SSL `key` as a property. [See\r\nblue highlight]\r\n - Adds an example output configuration. [See green highlight]\r\n\r\nRel: https://github.com/elastic/ingest-docs/issues/692\r\nSee [docs\r\npreview](https://kibana_172637.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\n---\r\n\r\n","sha":"c7fabda4c59789facbbc6127589e66d162148669"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.13.0","labelRegex":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/172637","number":172637,"mergeCommit":{"message":"[DOCS] Add 'secrets' to Fleet settings page (#172637)\n\nThis updates the list of available Fleet settings in the Kibana docs, as\r\nfollows:\r\n\r\n- Moves the `config` and `proxy_id` settings from the Required to the\r\nOptional section of `xpack.fleet.outputs`. CC @nchaulet since the\r\nsettings were added to the docs via\r\nhttps://github.com//pull/158771). [See orange highlight]\r\n- Adds the `ssl` setting with the `certificate` property (this setting\r\nis already available but doesn't appear to have been documented). [See\r\nred highlight]\r\n- Adds the new `secrets` setting, with SSL `key` as a property. [See\r\nblue highlight]\r\n - Adds an example output configuration. [See green highlight]\r\n\r\nRel: https://github.com/elastic/ingest-docs/issues/692\r\nSee [docs\r\npreview](https://kibana_172637.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\n---\r\n\r\n","sha":"c7fabda4c59789facbbc6127589e66d162148669"}}]}] BACKPORT--> Co-authored-by: David Kilfoyle <[email protected]>
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.
This updates the list of available Fleet settings in the Kibana docs, as follows:
configandproxy_idsettings from the Required to the Optional section ofxpack.fleet.outputs. CC @nchaulet since the settings were added to the docs via [Docs] Add new Fleet preconfiguration settings #158771). [See orange highlight]sslsetting with thecertificateproperty (this setting is already available but doesn't appear to have been documented). [See red highlight]secretssetting, with SSLkeyas a property. [See blue highlight]Rel: elastic/ingest-docs#692
See docs preview