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

Remove limitations topic from Fleet and Agent docs #947

Merged
merged 3 commits into from
Aug 3, 2021

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Aug 2, 2021

Closes #856

Removes limitations topic. All relevant info will be moved to the appropriate section in the docs.

TODO:

  • Force the PR build to break to identify broken links across the library.
  • Open PRs in relevant repos to fix broken links
  • Create redirect page that redirects users to the beats/agent comparison topic
  • Move relevant limitations to other locations in the documentation
  • Figure out what to do with these limitations. Still valid? If so, where should they go:
    • In order to use Fleet, the Elastic Agents must have a direct network connection to Kibana and Elasticsearch. It is also possible to run the Elastic Agents in standalone mode in cases where a network connection is not available or not needed.
    • "Fleet is currently only available to users with the superuser role. This role is necessary to create indices, install integration assets, and update Elastic Agent policies."

TODO (after merging):

  • Create redirect request with the web team that goes live on release day
  • Remove redirect page after web team sets up redirects

NOTE: I have not added scaling guidelines to this PR. They should be part of the work Nima is doing on this issue: #523

@dedemorton dedemorton self-assigned this Aug 2, 2021
@dedemorton dedemorton requested a review from a team as a code owner August 2, 2021 18:56
@apmmachine
Copy link
Contributor

apmmachine commented Aug 2, 2021

A documentation preview will be available soon:

@dedemorton dedemorton changed the title Remove limitations topic [WIP] Remove limitations topic Aug 2, 2021
@dedemorton dedemorton requested a review from mostlyjason August 2, 2021 22:35
@dedemorton dedemorton added the Team:Elastic-Agent Label for the Agent team label Aug 2, 2021
@dedemorton dedemorton changed the title [WIP] Remove limitations topic Remove limitations topic from Fleet and Agent docs Aug 2, 2021
Copy link
Member

@bmorelli25 bmorelli25 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.

Both of these might fit into the prereq section on this page https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html#install-fleet-managed-agent?

  • In order to use Fleet, the Elastic Agents must have a direct network connection to Kibana and Elasticsearch. It is also possible to run the Elastic Agents in standalone mode in cases where a network connection is not available or not needed.
  • "Fleet is currently only available to users with the superuser role. This role is necessary to create indices, install integration assets, and update Elastic Agent policies."

@dedemorton
Copy link
Contributor Author

Both of these might fit into the prereq section on this page

Agreed. I think the requirements have changed though. Agent connects to Fleet Server now and can use a proxy server (or will be able to do so after a bug is fixed). Also I can't remember if superuser role is still required for Fleet. I'll wait for @mostlyjason to confirm.

@mostlyjason
Copy link
Contributor

@dedemorton looks good. I noticed it doesn't actually remove the limitations page, just adds a redirect. Is that intentional? Also, yes a superuser role is still required.

@dedemorton
Copy link
Contributor Author

@mostlyjason Yes, usually we set up a redirect when possible for moved or deleted pages to avoid 404s. If you think a redirect is confusing, I can remove it. Just let me know.

@EricDavisX
Copy link
Contributor

we are pulling out support for Proxy for 7.14 - does that make any impact? we aren't sure it will be fixed in 7.14.1 or 7.15.

And, about the 'direct connection' statment:
In order to use Fleet, the Elastic Agents must have a direct network connection to Kibana and Elasticsearch.
shouldn't it rather just be the below?
In order to use Fleet, the Elastic Agents must have a direct network connection to Fleet Server and Elasticsearch.

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 3, 2021

@EricDavisX

I've added this to the install topic: In order to use Fleet, the Elastic Agents must have a direct network connection to Fleet Server and Elasticsearch.

Do you think it also needs to be added to the getting started topics, or are the setup instructions clear enough? My concern is that the list of prereqs is getting quite long, and new users won't know what elastic agents and fleet server are until they run through the steps.

@EricDavisX
Copy link
Contributor

I think that is great - and I agree with your thinking about pre-reqs

@mostlyjason
Copy link
Contributor

Thanks for adding that to the install topic. Redirect should be fine. Can we publish this now?

Side note: Another option is to mention the requirement for connectivity to Fleet and ES later in the getting started instructions, like when the user is setting up the agent?

@dedemorton dedemorton merged commit 0fdb667 into elastic:master Aug 3, 2021
@dedemorton dedemorton deleted the remove_limitations branch August 3, 2021 15:52
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Aug 3, 2021
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
dedemorton added a commit to dedemorton/observability-docs that referenced this pull request Aug 3, 2021
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
dedemorton added a commit that referenced this pull request Aug 3, 2021
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
dedemorton added a commit that referenced this pull request Aug 3, 2021
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
bmorelli25 pushed a commit to bmorelli25/observability-docs that referenced this pull request Apr 11, 2023
* Remove limitations topic

* Add superuser role requirement

* Mention that agents must have direct connection to fleet server and es
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update limitations for GA release
5 participants