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

Add hosts/auto-detection + K8s quick start plus overview #4073

Merged
merged 16 commits into from
Aug 13, 2024

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Jul 16, 2024

Closes https://github.com/elastic/obs-docs-projects/issues/248

Preview links:

(1) We'll add over quickstarts to the list in the overview as they become available.

This PR includes:

  • Basic navigation and overview for all the quickstarts:

    image

  • Topic about auto-detecting logs/metrics (host monitoring) (WIP)

TODO before merging (Host monitoring QS):

  • Resolve inline TODO items:
    • Add more detail to this section to highlight "the salient points of the specific dashboards or pages." Waiting for info from SMEs.
    • Decide where to crop the Host overview dashboard...it's kind of big to include it its entirety.

TODO after merging:

  • Port to stateful

Open questions

  • @thomheymann Akhilesh mentioned that some integrations that are part of this auto-detection based flow are only available for Linux. Which ones? See answer is this comment.
  • @thomheymann What advice do we want to give users if they look at the dashboards and realize they've missed some logs they want to ingest. Is there a way to re-run the auto-detection script and add new logs without having uninstall Elastic Agent and go through all the steps again? See answer in this comment.
    IMO, telling users to modify the yaml config would be throwing folks into the deep end.
  • @akhileshpok @mykolaharmash Still waiting for your response here.
  • @akhileshpok @thomheymann Still waiting for your resonse here.

Copy link
Contributor

mergify bot commented Jul 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 Jul 16, 2024
@dedemorton dedemorton changed the title Add scaffolding for quickstarts Add quickstart about auto detection plus quickstart intro Jul 18, 2024
@dedemorton dedemorton changed the title Add quickstart about auto detection plus quickstart intro Add hosts/auto-detection quick start plus overview Jul 18, 2024
@dedemorton dedemorton self-assigned this Jul 18, 2024
@dedemorton dedemorton force-pushed the onboarding_2024 branch 2 times, most recently from e10077d to eb6e91e Compare July 20, 2024 01:48
@elasticdocs
Copy link

elasticdocs commented Jul 20, 2024

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

Issues? Visit #next-docs in Slack

@dedemorton dedemorton marked this pull request as ready for review July 20, 2024 02:03
@dedemorton dedemorton requested a review from a team as a code owner July 20, 2024 02:03
@akhileshpok
Copy link

@dedemorton - Thanks. The draft looks good. A couple of points to consider; a) I believe that under 'Visualize your data' we will only show the call-to-action button once the script has verified that the relevant data has started flowing into ES. Maybe, it is worth mentioning or re-formulating the description accordingly. b) Under the 'Get value out of your data' section, can we briefly describe the salient points of the specific dashboards or pages that we ask the user to explore for each of the supported integrations? This a key part of the quick start flow design, as we will typically select one dashboard or feature per installed integration type. c) Should we consider a dedicated section for 'Constraints or limitations' because there will be a few for each of the new quick start flows? It might be easier to draw the attention of the user if we provide a dedicated section for this content.

@alaudazzi
Copy link
Contributor

alaudazzi commented Jul 23, 2024

@dedemorton

I pushed a first draft of the k8s quickstart, with relevant images.

@mykolaharmash @akhileshpok
How do we want to expand the section Get value out of your data? The dashboards are pretty intuitive with the data you can monitor, but maybe you want to emphasize something in particular?

CC @flash1293

@dedemorton
Copy link
Contributor Author

dedemorton commented Jul 23, 2024

@akhileshpok

a) I believe that under 'Visualize your data' we will only show the call-to-action button once the script has verified that the relevant data has started flowing into ES. Maybe, it is worth mentioning or re-formulating the description accordingly.

👍 will do

b) Under the 'Get value out of your data' section, can we briefly describe the salient points of the specific dashboards or pages that we ask the user to explore for each of the supported integrations? This a key part of the quick start flow design, as we will typically select one dashboard or feature per installed integration type.

Great idea! Is there a document somewhere that explains the salient points we want to add about each of the dashboards? I can probably look at the dashboards and summarize each of them, but without more guidance, I'm not sure I can add much value beyond what users can figure out by looking for themselves. If there's no existing document, maybe you or another SME can walk me through the points we want to highlight? Let me know what you think.

c) Should we consider a dedicated section for 'Constraints or limitations' because there will be a few for each of the new quick start flows? It might be easier to draw the attention of the user if we provide a dedicated section for this content.

👍 sure it can be a dedicated section

@dedemorton
Copy link
Contributor Author

@akhileshpok Check out the lastest preview (linked at the top) and let me know if I'm on the right track. I may need to tweak the headings a little more, but I think we should put the details about available assets under "Visualize your data" so the section maps to what users see in the UI. Let me know what you think.

cc @alaudazzi You might want to wait for feedback before applying parallel changes to your topic.

@alaudazzi
Copy link
Contributor

@dedemorton Thank you for fixing it, and sorry again 🙏

@alaudazzi
Copy link
Contributor

@akhileshpok @mykolaharmash
Here is a doc preview of the K8s quickstart. Would you mind checking if it's OK and if additional content is required?

@dedemorton
Copy link
Contributor Author

@akhileshpok @thomheymann I am still waiting for feedback/input to finalize this PR (specifically I need to know what we want to say about the integration assets promoted in the quickstart). See the table under "Visualize your data" in the preview. I've filled out one row as an example, but I can put whatever you feel is right.

@dedemorton dedemorton changed the title Add hosts/auto-detection quick start plus overview Add hosts/auto-detection + K8s quick start plus overview Aug 6, 2024
@akhileshpok
Copy link

doc preview of the K8s quickstart

@alaudazzi - Can we please include this image of the flow entry point under step 3 of 'Collect your data'?

Screenshot 2024-08-07 at 18 02 03

Under Visualise your data, '.. the Visualize your data section provides a link to the Kubernetes Cluster Overview dashboard that can be used to monitor the health of the cluster. Further, there are links available to other useful prebuilt dashboards for Kubernetes monitoring.

@akhileshpok
Copy link

akhileshpok commented Aug 7, 2024

@dedemorton - In the Quickstarts overview page, probably better to state that 'Auto-detection of logs and metrics for Hosts monitoring'. Auto-detection is not available for other use cases currently.
I will come back to you on the missing descriptions under the Visualize your data section for the Hosts quickstart flow.

@alaudazzi
Copy link
Contributor

@abhishekbhatia1710
I've added the image of the flow entry point under step 3 of 'Collect your data' and updated the page with the text you suggested.

@abhishekbhatia1710
Copy link

I'm not sure if I'm the appropriate reviewer for this PR. Is it possible I was tagged by mistake? Please let me know if otherwise.

@akhileshpok
Copy link

@alaudazzi - Sorry, but I still don't see the image of the entry point in Step 3. Also, can you please update the title of this section to something like, 'Monitor your Kubernetes cluster with Elastic Agent'? Further, can you please amend the last sentence in first section to, 'The kubectl command installs the standalone Elastic Agent in your Kubernetes cluster ....'. Thanks

@akhileshpok
Copy link

@dedemorton - Here are my suggestions on the the missing descriptions under the Visualize your data section for the Hosts quickstart flow.
Docker - Prebuilt dashboard for monitoring the status and health of Docker containers.
Apache - Prebuilt dashboard for monitoring of the Apache HTTP server health using error and access logs data.
Nginx - Prebuilt dashboard for monitoring of the Nginx server health using error and access logs data.
Custom logs - Logs Explorer for analysing the custom logs.

@dedemorton
Copy link
Contributor Author

dedemorton commented Aug 9, 2024

@akhileshpok Thanks! BTW the preview links change every time we push a new commit, so you might have been looking at an old build when you were reading Arianna's doc. I've updated the links in the summary.

@dedemorton
Copy link
Contributor Author

I've applied the requested changes and updated the links in the description to point to the latest build. I think we are ready for a final review! Thanks!

@alaudazzi
Copy link
Contributor

@dedemorton thank you for handling the doc fixes for the k8s quickstart during my sick leave, really appreciate it.

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

I'm going to merge this. If additional changes are required, please open an issue to report the change. Thanks!

@dedemorton dedemorton merged commit 3824ce1 into elastic:main Aug 13, 2024
5 checks passed
@dedemorton dedemorton deleted the onboarding_2024 branch August 13, 2024 23:54
@dedemorton dedemorton removed the backport-skip Skip notification from the automated backport with mergify label Aug 13, 2024
Copy link
Contributor

mergify bot commented Aug 13, 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 13, 2024
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 ci:doc-build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants