[Docs] Add new Fleet preconfiguration settings #158771
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
kilfoyle
added
release_note:skip
|
Pinging @elastic/fleet (Team:Fleet) |
|
Documentation preview: |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
kilfoyle
commented
May 31, 2023
| `certificate`::: | ||
| The name of the certificate to use to validate the proxy. | ||
| `certificate_key`::: | ||
| Hash pin used for certificate verification. The pin is a base64-encoded string of the SHA-256 fingerprint. |
There was a problem hiding this comment.
I'm not sure about this one. I copied the definition from xpack.fleet.agents.elasticsearch.ca_sha256.
There was a problem hiding this comment.
@kilfoyle certificate and certificate_key are usefull to do mutual tls and are used to authenticate to the proxy
There was a problem hiding this comment.
Sounds good! I've changed the definitions to:
`certificate`:::
The name of the certificate used to authenticate the proxy.
`certificate_key`:::
The certificate key used to authenticate the proxy.
But let me know if you think that's not clear enough.
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jun 1, 2023
This adds new Fleet preconfiguration settings to the Kibana [Fleet settings](https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html) page. I also moved the "example configuration" to right below the `xpack.fleet.agentPolicies` setting, since that's what's shown in the example. [Preview page](https://kibana_158771.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html) Closes: elastic/ingest-docs#191 (cherry picked from commit 3ac1666)
💚 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
Jun 1, 2023
# Backport This will backport the following commits from `main` to `8.8`: - [[Docs] Add new Fleet preconfiguration settings (#158771)](#158771) <!--- 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-06-01T14:51:55Z","message":"[Docs] Add new Fleet preconfiguration settings (#158771)\n\nThis adds new Fleet preconfiguration settings to the Kibana [Fleet\r\nsettings](https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html)\r\npage. I also moved the \"example configuration\" to right below the\r\n`xpack.fleet.agentPolicies` setting, since that's what's shown in the\r\nexample.\r\n\r\n[Preview\r\npage](https://kibana_158771.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\nCloses: https://github.com/elastic/ingest-docs/issues/191","sha":"3ac1666c1d5f8a9c1e9c8272d5baed56142b639a","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v8.8.0","v8.9.0"],"number":158771,"url":"https://github.com/elastic/kibana/pull/158771","mergeCommit":{"message":"[Docs] Add new Fleet preconfiguration settings (#158771)\n\nThis adds new Fleet preconfiguration settings to the Kibana [Fleet\r\nsettings](https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html)\r\npage. I also moved the \"example configuration\" to right below the\r\n`xpack.fleet.agentPolicies` setting, since that's what's shown in the\r\nexample.\r\n\r\n[Preview\r\npage](https://kibana_158771.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\nCloses: https://github.com/elastic/ingest-docs/issues/191","sha":"3ac1666c1d5f8a9c1e9c8272d5baed56142b639a"}},"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/158771","number":158771,"mergeCommit":{"message":"[Docs] Add new Fleet preconfiguration settings (#158771)\n\nThis adds new Fleet preconfiguration settings to the Kibana [Fleet\r\nsettings](https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html)\r\npage. I also moved the \"example configuration\" to right below the\r\n`xpack.fleet.agentPolicies` setting, since that's what's shown in the\r\nexample.\r\n\r\n[Preview\r\npage](https://kibana_158771.docs-preview.app.elstc.co/guide/en/kibana/master/fleet-settings-kb.html)\r\n\r\nCloses: https://github.com/elastic/ingest-docs/issues/191","sha":"3ac1666c1d5f8a9c1e9c8272d5baed56142b639a"}}]}] BACKPORT--> Co-authored-by: David Kilfoyle <[email protected]>
kilfoyle
added a commit
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 #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) --- 
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)
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 adds new Fleet preconfiguration settings to the Kibana Fleet settings page. I also moved the "example configuration" to right below the
xpack.fleet.agentPoliciessetting, since that's what's shown in the example.Preview page
Closes: elastic/ingest-docs#191