Skip to content

Add hosts and K8s quickstarts to stateful docs #4168

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

Merged
merged 8 commits into from
Aug 26, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Aug 16, 2024

Ports hosts quickstart added in #4073 to stateful.

Also makes a few changes to the serverless files to sync them with this PR.

@dedemorton dedemorton self-assigned this Aug 16, 2024
@dedemorton dedemorton requested a review from a team as a code owner August 16, 2024 01:00
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Aug 16, 2024

This pull request does not have a backport label. Could you fix it @dedemorton? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Aug 16, 2024
@dedemorton
Copy link
Contributor Author

@alaudazzi Do you want me to port your changes, too, or do you want to do that?

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 19, 2024

@akhileshpok @thomheymann Who is the best person to ask about the privileges required to perform the steps in the hosts quickstart? Also can you please confirm that the hosts quickstart is available in 8.15? I spun up a cluster on cloud last week, and did not see the onboarding UI that I was expecting.

@alaudazzi
Copy link
Contributor

@dedemorton please go ahead and port my changes. Thank you and sorry for the late reply.

@dedemorton dedemorton changed the title Add hosts quickstart to stateful docs Add hosts and K8s quickstarts to stateful docs Aug 19, 2024
@dedemorton
Copy link
Contributor Author

I have the same question about K8s monitoring (which I added today): what should we document for required privileges when using stateful?

@akhileshpok
Copy link

@dedemorton - The hosts and the K8s quickstarts will only become available in stateful in 8.16. They are currently available on serverless. Is your question around required privileges focusing on Elasticsearch, Kibana or something else? Root level privileges are required to install an Elastic Agent for both of these quickstarts.

@dedemorton
Copy link
Contributor Author

Is your question around required privileges focusing on Elasticsearch, Kibana or something else?

@akhileshpok Yes, I mean are there any Elasticsearch/Kibana privileges that might be required for users who are using a stateful cluster (for serverless, we've documented that the Admin role is required).

@akhileshpok
Copy link

@thomheymann - Do you have any inputs on the above question related to ES/Kibana privileges? Thanks

@thomheymann
Copy link

@dedemorton Users need the following privileges to use data onboarding:

  • cluster privileges: ['monitor', 'manage_own_api_key']
  • index privileges: { names: ['logs-*-*', 'metrics-*-*'], privileges: ['auto_configure', 'create_doc'] }
  • kibana privileges: { spaces: ['*'], feature: { fleet: ['all'], fleetv2: ['all'] } }

The builtin role that has these privileges is the superuser role

@dedemorton
Copy link
Contributor Author

Noting here that backport-skip label is set because we don't yet have a branch for 8.16. Everything in master will end up in 8.16 when we create the branch.

@dedemorton
Copy link
Contributor Author

@alaudazzi Can you take a look at my changes in this commit to make sure you agree with the consistency changes that I"ve applied?

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

A couple of small things but otherwise LGTM!

mdbirnstiehl
mdbirnstiehl previously approved these changes Aug 23, 2024
@elasticdocs
Copy link

elasticdocs commented Aug 23, 2024

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

Copy link
Contributor

@alaudazzi alaudazzi 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 Author

@akhileshpok I'm going to merge this because it's blocking another PR I have in progress. If you have any concerns with the changes here, just open a docs issue, and we will address your concerns. Thanks!

@dedemorton dedemorton merged commit 5482e20 into elastic:main Aug 26, 2024
8 checks passed
@dedemorton dedemorton deleted the issue#4148 branch August 26, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants