-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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 web consoles doc page #7123
Conversation
~ under the License. | ||
--> | ||
|
||
# Web Consoles |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should only talk about the unified console and really de-emphasize the old consoles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I think we can talk about only the unified console in the future once the router becomes a mandatory module of a druid cluster or the unified console can be run on other modules. But, for now, I guess it's not easy to tell them about only the unified console. Even all our tutorials are saying the old consoles.
How about mentioning the unified console first and then others later in this page? I guess a sort of screenshots of the unified console would help too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also think operationally the old consoles still serve a purpose in times of outages to help isolate where the issues are happening, since i think the new console requires basically all of the cluster to be up to work. Until either the unified console can more gracefully degrade in functionality, or the old consoles can be replaced with new ui's built with these new ui controls but hosted on their respective services to serve as fallbacks, I think it's worth having them documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the router not going to be packaged by default in the new 0.14 packaging? I would assume if that's the case, then everyone should be using the unified console. Asking ppl to install the router and then use the console will just mean new folks trying Druid may never find it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are example and quickstart confs for the router now, but there's no guarantee that people would use the router in their prod clusters since it's an optional component, and existing clusters wouldn't necessarily have a router, so I think it needs to be called out here
docs/content/toc.md
Outdated
@@ -130,6 +130,7 @@ layout: toc | |||
* [Different Hadoop Versions](/docs/VERSION/operations/other-hadoop.html) | |||
* [High Availability](/docs/VERSION/operations/high-availability.html) | |||
* [Performance FAQ](/docs/VERSION/operations/performance-faq.html) | |||
* [Web Consoles](/docs/VERSION/operations/web-consoles.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we call this GUIs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed the page to "GUIs"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
|
||
# Web Consoles | ||
|
||
Druid has a few console UIs that provide cluster management functionality, described below. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should strongly emphasize the new console and direct people to use that. Because the new console calls the coordinator and overlord consoles legacy consoles I think the documentation should also reflect this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved these under a "Legacy" section, added a recommendation to use the new console if possible
|
||
This console subsumes the functionality provided by the older consoles described below, which are still available if needed. | ||
|
||
## Coordinator Consoles |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this section shoul dbe called Legacy consoles and emphasize the recommendation to use the new one
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also note that we may remove these consoles in the future
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added note about possible removal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, on second thought, I took out the note on removal, in #6923 I don't think we've quite reached consensus on what to do with the older consoles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, the best way to present the new console is that it is something that we believe is better / easier to use / more capable than the older consoles, so really encourage people to check it out and present it as the 'main' or 'default' option. I'd also be clear that it lives on the Router right now, and in particular that means (a) you need a Router running to use it [link to other docs discussing running Brokers and Routers on a Query server]; and (b) it hasn't fully replaced the older consoles yet [they are still being served in their traditional locations] but it may in the future.
If readers get the above picture then I think the docs are doing their job.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a link to the design/processes
page, put in a note about the legacy consoles possibly being removed again
docs/content/operations/guis.md
Outdated
@@ -0,0 +1,81 @@ | |||
--- | |||
layout: doc_page | |||
title: "Web Consoles" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we call this GUIs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed to "Management GUIs"
docs/content/operations/guis.md
Outdated
|
||
# GUIs | ||
|
||
Druid has a few console UIs that provide cluster management functionality, described below. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove this sentence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the sentence
docs/content/operations/guis.md
Outdated
|
||
Druid provides a console for managing datasources, segments, tasks, data processes (Historicals and MiddleManagers), and coordinator dynamic configuration. The user can also run SQL and native Druid queries within the console. | ||
|
||
To use this console, it is necessary to run a [Router](../development/router.html) process. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add "We recommend running this process on your Query server."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
docs/content/toc.md
Outdated
@@ -130,6 +130,7 @@ layout: toc | |||
* [Different Hadoop Versions](/docs/VERSION/operations/other-hadoop.html) | |||
* [High Availability](/docs/VERSION/operations/high-availability.html) | |||
* [Performance FAQ](/docs/VERSION/operations/performance-faq.html) | |||
* [GUIs](/docs/VERSION/operations/guis.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about changing this to 'Management GUIs' here and in other places? This way people don't get it confused with data visualization UIs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to Management GUIs here and elsewhere
Updated the router docs to reference the new web console |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
License check passes for new page, skipping other CI for doc-only change |
* Add web consoles doc page * PR comments * Remove 'unified' * PR comments * Fix TOC * PR comments * More revisions * GUI -> UI * Update router docs * Reword router doc
This PR adds a new doc page containing information about Druid's web consoles.