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

Docs for secrets storage in agent outputs #696

Merged
merged 6 commits into from
Dec 14, 2023

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Nov 16, 2023

This adds docs for agent output secrets.

@jillguyonnet This is definitely a "first draft". I'm not sure that I've got the "Policy secret values" section (down at the bottom) quite right. Please let me know what you think.

Target: 8.12
Rel: #692

Docs preview links:


Update to Logstash and Kafka outputs pages:
Screenshot 2023-12-05 at 4 43 45 PM

@kilfoyle kilfoyle requested a review from a team as a code owner November 16, 2023 22:40
@jillguyonnet jillguyonnet self-assigned this Nov 20, 2023
@kilfoyle
Copy link
Contributor Author

kilfoyle commented Dec 5, 2023

Thanks for the feedback @jillguyonnet. Sorry it took me so long to circle back to this PR!

jillguyonnet
jillguyonnet previously approved these changes Dec 13, 2023
Copy link
Contributor

@jillguyonnet jillguyonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, thanks!

I have a small suggestion (feel free to ignore): what do you think of adding a sentence like "Note that this setting can also be stored as secret value or plain text for preconfigured outputs" with a link to the Fleet settings page?

Also, will the secret storage of the service token for the remote Elasticsearch output type be documented separately? I had added it to the issue, but perhaps it would make more sense to include the part about secret storage in the dedicated doc issue.

karenzone
karenzone previously approved these changes Dec 13, 2023
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kilfoyle
Copy link
Contributor Author

@jillguyonnet Great suggestions! I added the note that you suggested to the three settings mentioned in this PR.

I missed the Remote ES service token setting so thanks for catching that. I've opened a separate PR for that update: Document that remote ES service token can be stored as a secret

Copy link
Contributor

@jillguyonnet jillguyonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for iterating, LGTM!

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kilfoyle kilfoyle merged commit f9e23bd into elastic:main Dec 14, 2023
4 checks passed
mergify bot pushed a commit that referenced this pull request Dec 14, 2023
* Docs for secrets storage in agent outputs

* secret storage through config file

* Jill's feedback

* remove changes from policies page

* Add reference to preconfiguration settings docs

* Add note to SSL key setting, Logstash & Kafka

(cherry picked from commit f9e23bd)
kilfoyle added a commit that referenced this pull request Dec 14, 2023
* Docs for secrets storage in agent outputs

* secret storage through config file

* Jill's feedback

* remove changes from policies page

* Add reference to preconfiguration settings docs

* Add note to SSL key setting, Logstash & Kafka

(cherry picked from commit f9e23bd)

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants