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

Add details to Fleet README #152348

Merged
merged 6 commits into from
Mar 2, 2023
Merged

Add details to Fleet README #152348

merged 6 commits into from
Mar 2, 2023

Conversation

jillguyonnet
Copy link
Contributor

Summary

As a new joiner to the Fleet team, I have gathered a few tips pertaining to dev environment setup and workflow. This PR adds some details and fixes (broken links) to the Fleet plugin README.

Checklist

N/A

For maintainers

@jillguyonnet jillguyonnet force-pushed the jillguyonnet/Improve-fleet-readme branch from c638e90 to e828f73 Compare February 28, 2023 14:28
@jillguyonnet jillguyonnet added Team:Fleet Team label for Observability Data Collection Fleet team release_note:skip Skip the PR/issue when compiling release notes labels Feb 28, 2023
@jillguyonnet jillguyonnet marked this pull request as ready for review February 28, 2023 14:30
@jillguyonnet jillguyonnet requested a review from a team as a code owner February 28, 2023 14:30
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@jillguyonnet
Copy link
Contributor Author

Hey @elastic/fleet 👋 Here are some suggestions to improve the Fleet plugin README. I left a couple of comments where I think the wording might be more accurate or helpful.

nchaulet
nchaulet reviewed Feb 28, 2023
View reviewed changes
x-pack/plugins/fleet/README.md Outdated
@@ -13,7 +13,7 @@

## Fleet Requirements

Fleet needs to have Elasticsearch API keys enabled, and also to have TLS enabled on kibana, (if you want to run Kibana without TLS you can provide the following config flag `--xpack.fleet.agents.tlsCheckDisabled=false`)
Fleet needs to have Elasticsearch API keys enabled, and also to have TLS enabled on Kibana, (if you want to run Kibana without TLS you can provide the following config flag `--xpack.fleet.agents.tlsCheckDisabled=false`)
Copy link
Member

Choose a reason for hiding this comment

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

I think only the first part is true now Fleet needs to have Elasticsearch API keys enabled. The tlsCheckDisabled has been deprecated and it's possible to run Kibana without TLS in development

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @nchaulet - actually, could this whole section be reframed better within the Development section below?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've removed this bit for now. Maybe the first two sections (Plugin and Fleet Requirements) could get a closer look at, possibly at a later stage.

criamico
criamico reviewed Feb 28, 2023
View reviewed changes
x-pack/plugins/fleet/README.md Show resolved Hide resolved
x-pack/plugins/fleet/README.md Outdated Show resolved Hide resolved
@jillguyonnet jillguyonnet force-pushed the jillguyonnet/Improve-fleet-readme branch from 20bdcd5 to 60263ac Compare March 1, 2023 08:54
juliaElastic
juliaElastic approved these changes Mar 1, 2023
View reviewed changes
Copy link
Contributor

@juliaElastic juliaElastic left a comment

Choose a reason for hiding this comment

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

LGTM

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 428 430 +2

Total ESLint disabled count

id before after diff
securitySolution 506 508 +2

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

criamico
criamico approved these changes Mar 1, 2023
View reviewed changes
Copy link
Contributor

@criamico criamico left a comment

Choose a reason for hiding this comment

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

🚢

@jillguyonnet jillguyonnet merged commit 6dcdabc into elastic:main Mar 2, 2023
@jillguyonnet jillguyonnet deleted the jillguyonnet/Improve-fleet-readme branch March 2, 2023 08:22
@kibanamachine kibanamachine added v8.8.0 backport:skip This commit does not require backporting labels Mar 2, 2023
bmorelli25 pushed a commit to bmorelli25/kibana that referenced this pull request Mar 10, 2023
@jillguyonnet @bmorelli25
Add details to Fleet README (elastic#152348)
23288d6 
Update the Fleet plugin README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nchaulet nchaulet nchaulet left review comments

@juliaElastic juliaElastic juliaElastic approved these changes

@criamico criamico criamico approved these changes

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@jillguyonnet @elasticmachine @kibana-ci @nchaulet @criamico @juliaElastic @kibanamachine