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.

Sign up for GitHub

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

Jump to bottom

[Fleet] Document output secrets #692

Closed
jillguyonnet opened this issue Nov 16, 2023 · 2 comments
Closed

[Fleet] Document output secrets #692

jillguyonnet opened this issue Nov 16, 2023 · 2 comments
Assignees
@kilfoyle
Labels
8.12-request Team:Docs Team:Fleet

Comments

@jillguyonnet
Copy link
Contributor

jillguyonnet commented Nov 16, 2023 •
edited
Loading

This is a followup to #161 which documented how Fleet handles secret in agent policies.

The scope of secret storage phase 1 also includes storing secrets that exist in outputs: elastic/kibana#157458.

Details

At this time, output secrets are one of the following:

  • Kafka output password
  • Kafka output SSL key
  • Logstash output SSL key
  • Remote ES service token

There are two ways secret values can be set for outputs:
@kilfoyle kilfoyle self-assigned this Nov 16, 2023
@kilfoyle kilfoyle mentioned this issue Nov 16, 2023
Merged
@jillguyonnet jillguyonnet mentioned this issue Nov 23, 2023
Closed
7 tasks
@jillguyonnet
Copy link
Contributor Author

Adding remote ES outputs to this.
cc @juliaElastic

@kilfoyle kilfoyle mentioned this issue Dec 5, 2023
Merged
@kilfoyle kilfoyle mentioned this issue Dec 13, 2023
Merged
kilfoyle added a commit to elastic/kibana that referenced this issue Dec 14, 2023
@kilfoyle
[DOCS] Add 'secrets' to Fleet settings page (#172637)
c7fabda 
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)

---

![Screenshot 2023-12-05 at 4 22 42
PM](https://github.com/elastic/kibana/assets/41695641/a547bad7-57aa-4470-8328-30b80f257973)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Dec 14, 2023
@kilfoyle
[DOCS] Add 'secrets' to Fleet settings page (elastic#172637)
5cc4aa2 
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)

---

![Screenshot 2023-12-05 at 4 22 42
PM](https://github.com/elastic/kibana/assets/41695641/a547bad7-57aa-4470-8328-30b80f257973)

(cherry picked from commit c7fabda)
kibanamachine referenced this issue in elastic/kibana Dec 14, 2023
@kibanamachine @kilfoyle
[8.12] [DOCS] Add 'secrets' to Fleet settings page (#172637) (#173401)
b58e5b2 
# 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![Screenshot
2023-12-05 at 4 22
42\r\nPM](https://github.com/elastic/kibana/assets/41695641/a547bad7-57aa-4470-8328-30b80f257973)","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![Screenshot
2023-12-05 at 4 22
42\r\nPM](https://github.com/elastic/kibana/assets/41695641/a547bad7-57aa-4470-8328-30b80f257973)","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![Screenshot
2023-12-05 at 4 22
42\r\nPM](https://github.com/elastic/kibana/assets/41695641/a547bad7-57aa-4470-8328-30b80f257973)","sha":"c7fabda4c59789facbbc6127589e66d162148669"}}]}]
BACKPORT-->

Co-authored-by: David Kilfoyle <[email protected]>
@kilfoyle
Copy link
Contributor

Completed via PR, PR, PR

Thanks a lot for all the help, Jill!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kilfoyle kilfoyle

Labels
8.12-request Team:Docs Team:Fleet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jillguyonnet @kilfoyle