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

[Ingest Manager] Document fleet configuration flags #66736

Merged
merged 6 commits into from
Jun 10, 2020

Conversation

nchaulet
Copy link
Member

@nchaulet nchaulet commented May 15, 2020

Summary

Resolve #61699 and #62440

Add documentation on fleet settings, flags and TLS requirements.

Screen Shot 2020-05-15 at 4 35 42 PM

@dedemorton It's my first time adding doc not sure about the process

@nchaulet nchaulet added v8.0.0 v7.8.0 v7.9.0 Team:Fleet Team label for Observability Data Collection Fleet team labels May 15, 2020
@nchaulet nchaulet requested a review from dedemorton May 15, 2020 14:19
@elasticmachine
Copy link
Contributor

Pinging @elastic/ingest-management (Team:Ingest Management)

@nchaulet nchaulet self-assigned this May 15, 2020
@nchaulet nchaulet added the release_note:skip Skip the PR/issue when compiling release notes label May 15, 2020
@dedemorton
Copy link
Contributor

dedemorton commented May 15, 2020

Thanks for copying me. I'll be working with @skh on the doc plans for ingest management, but haven't gotten started yet. We need a cohesive story that describes how to use ingest manager.

For now, I think you just need document the configuration flags in the Kibana settings reference. So, in the Kibana docs, create a topic under Set Up Kibana > Configuring Kibana called Ingest management settings (we might refine that name later). Use the same structure as the other topics in that section.

image

I realize there won't be much content in the beginning, but that's OK because I'm sure we'll have to add other settings.

We are going to create a step-by-step getting started guide for alpha1. Any how-to steps and guidance about configuration should go in that guide. We are also planning to create an architecture doc that describes all the moving parts in ingest management.

cc @gchaps

@nchaulet
Copy link
Member Author

@dedemorton just created a settings page for Ingest Manager 👍

@gchaps
Copy link
Contributor

gchaps commented May 15, 2020

@dedemorton are any of these setting supported on Cloud. We use an icon to identify those. See #65610

@nchaulet
Copy link
Member Author

The three generals settings *.enabled are available on cloud

@skh
Copy link
Contributor

skh commented Jun 4, 2020

@dedemorton @nchaulet What is the status of these changes? What needs to be done to get these merged?

@skh
Copy link
Contributor

skh commented Jun 4, 2020

@nchaulet Could you also add documentation for xpack.ingestManager.epm.registryUrl in this PR?

@nchaulet
Copy link
Member Author

nchaulet commented Jun 4, 2020

@skh Thanks for the reminder on this PR, I think I need to the cloud icon for the settings that are available into cloud, and I would like to add the other ingestManager flags too here (not just the fleet related) I am trying to this by the end of the week.

@gchaps
Copy link
Contributor

gchaps commented Jun 4, 2020

@nchaulet The cloud icon is already in the repo. You just have to code it like this:

xpack.apm.ui.enabled {ess-icon}

See this example for how the published doc looks.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Looks good overall. Thanks for adding this!

docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
@mostlyjason
Copy link
Contributor

@ph @ruflin are these flags going away in 7.9? My only concern is that we have one with epm included. However, we don't tell customers what epm is and it's not shown in the UI anywhere. Its a little confusing what that is referring to. If they are going to remain in the product, we might want to name it something more clear.

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

I've added suggestions for the shared attributes. I'm still unsure whether to use package-registry or package manager. Are these separate concepts, or the same?

docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
docs/settings/ingest-manager-settings.asciidoc Outdated Show resolved Hide resolved
@nchaulet
Copy link
Member Author

nchaulet commented Jun 9, 2020

I've added suggestions for the shared attributes. I'm still unsure whether to use package-registry or package manager. Are these separate concepts, or the same?

The package registry is an internal of the package manager, it's the place where all the package are stocked

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@mostlyjason
Copy link
Contributor

mostlyjason commented Jun 9, 2020

@dedemorton FYI my comments about the EPM naming being included should not block this release because we are already past code freeze. Its something we can consider improving on for 7.9 and I created a separate issue to track that #68658

@nchaulet nchaulet requested a review from dedemorton June 9, 2020 17:47
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

LGTM

@dedemorton
Copy link
Contributor

I've approved so that we can get this content merged. The table formatting looks a little off, though. I can follow up with a fix if you are happy with the content itself.

@nchaulet nchaulet merged commit 08ca314 into elastic:master Jun 10, 2020
@nchaulet nchaulet deleted the feature-fleet-document-config-flags branch June 10, 2020 12:51
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jun 10, 2020
* master:
  [Ingest Manager] Document fleet configuration flags (elastic#66736)
  [Metrics UI] Fix fatal error when no data is available for Metric Threshold Alerts (elastic#68678)
  [SIEM][Detections Engine] - Exceptions viewer cleanup (elastic#68651)
  [SIEM] Fixes flyout flaky test (elastic#68683)
  [SIEM] Cypress renaming (elastic#68659)
nchaulet added a commit to nchaulet/kibana that referenced this pull request Jun 10, 2020
nchaulet added a commit to nchaulet/kibana that referenced this pull request Jun 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.8.0 v7.9.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Fleet] Run locally the package registry during api integration tests
6 participants