Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fleet] Update doc for preconfiguration #191

Closed
3 tasks done
nchaulet opened this issue Nov 28, 2022 · 5 comments · Fixed by elastic/kibana#158771
Closed
3 tasks done

[Fleet] Update doc for preconfiguration #191

nchaulet opened this issue Nov 28, 2022 · 5 comments · Fixed by elastic/kibana#158771

Comments

@nchaulet
Copy link
Member

nchaulet commented Nov 28, 2022

Description

The doc for preconfigured object (policy, outputs, ...) as not been updated since a long time and is out of date with what we currently support.

Link to the doc:

https://www.elastic.co/guide/en/kibana/master/fleet-settings-kb.html

Source of the doc:

https://github.com/elastic/kibana/blob/main/docs/settings/fleet-settings.asciidoc

We should:

  • In outputs support for logstash and add missing properties (ssl) is_default_monitoring
  • Add Fleet server hosts xpack.fleet.fleetServerHosts
  • Add proxy xpack.fleet.proxy
@elasticmachine
Copy link

Pinging @elastic/fleet (Team:Fleet)

@jen-huang jen-huang transferred this issue from elastic/kibana May 2, 2023
@jen-huang
Copy link
Contributor

FYI @karenzone, just transferred this one here.

@kilfoyle kilfoyle self-assigned this May 16, 2023
@kilfoyle
Copy link
Contributor

Hi @nchaulet

I'd like to add these missing settings to the docs but I'll need some help.

We added the is_default_monitoring setting already via elastic/kibana#154247

For the other settings xpack.fleet.fleetServerHosts and xpack.fleet.proxy can you help me with:

  • a description of what each setting is
  • where I can find the required and optional parameters

I tried looking in the Fleet API docs and I also searched through the code in the Kibana repo, but I was a bit lost. :-)

@nchaulet
Copy link
Member Author

Hi @kilfoyle (here is the schema we use for the config of preconfigured object not obvious to find and neither to read https://github.com/nchaulet/kibana/blob/2dd3a8faf266a8d88e4955cd7dcbe7e3b8f25bb7/x-pack/plugins/fleet/server/types/models/preconfiguration.ts#L89-L116)

for the xpack.fleet.fleetServerHosts we accept an array of object with the following properties

required:
 id: string; // an unique id
 name: string;  // A name for the UI
 host_urls: string array;  // an array of https url 

optionnal:    
  is_default: boolean; // if it's the default fleet server host
  proxy_id: string; // the proxy to use with that fleet server host

for xpack.fleet.proxy we accept an array of object with the following properties

required:
  id: string;
  name:string;
  url: string // the proxy url

optionnal:
    proxy_headers: object [key string, value string] a map of headers to use with the proxy
    certificate_authorities: string;
    certificate: string;
    certificate_key: string;

we also support the proxy_id for output that allow to use a proxy with an output

Let me know if you have more questions

kilfoyle added a commit to elastic/kibana that referenced this issue 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
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue 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)
kibanamachine referenced this issue in elastic/kibana 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
Copy link
Contributor

kilfoyle commented Jun 1, 2023

The Fleet settings in Kibana page is now updated with the is_default_monitoring, xpack.fleet.fleetServerHosts, and xpack.fleet.proxy settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants