Add web consoles doc page #7123

jon-wei · 2019-02-21T23:08:46Z

This PR adds a new doc page containing information about Druid's web consoles.

fjy · 2019-02-21T23:11:57Z

docs/content/operations/web-consoles.md

+  ~ under the License.
+  -->
+
+# Web Consoles


I think we should only talk about the unified console and really de-emphasize the old consoles

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.

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.

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 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

fjy · 2019-02-22T22:36:40Z

docs/content/toc.md

@@ -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)


Can we call this GUIs?

Renamed the page to "GUIs"

clintropolis

LGTM 👍

fjy · 2019-02-26T19:24:11Z

docs/content/operations/web-consoles.md

+
+# Web Consoles
+
+Druid has a few console UIs that provide cluster management functionality, described below.


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.

Moved these under a "Legacy" section, added a recommendation to use the new console if possible

fjy · 2019-02-26T19:28:17Z

docs/content/operations/web-consoles.md

+
+This console subsumes the functionality provided by the older consoles described below, which are still available if needed.
+
+## Coordinator Consoles


I think this section shoul dbe called Legacy consoles and emphasize the recommendation to use the new one

Also note that we may remove these consoles in the future

Added note about possible removal

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.

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.

Added a link to the design/processes page, put in a note about the legacy consoles possibly being removed again

fjy · 2019-02-27T00:02:37Z

docs/content/operations/guis.md

@@ -0,0 +1,81 @@
+---
+layout: doc_page
+title: "Web Consoles"


can we call this GUIs?

Renamed to "Management GUIs"

fjy · 2019-02-27T00:02:54Z

docs/content/operations/guis.md

+
+# GUIs
+
+Druid has a few console UIs that provide cluster management functionality, described below.


I would remove this sentence

Removed the sentence

fjy · 2019-02-27T00:03:26Z

docs/content/operations/guis.md

+
+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.


I would add "We recommend running this process on your Query server."

fjy · 2019-02-27T00:05:14Z

docs/content/toc.md

@@ -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)


How about changing this to 'Management GUIs' here and in other places? This way people don't get it confused with data visualization UIs

Changed to Management GUIs here and elsewhere

jon-wei · 2019-02-28T01:38:05Z

Updated the router docs to reference the new web console

jihoonson

LGTM

jon-wei · 2019-02-28T22:02:34Z

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

Add web consoles doc page

c766b82

jon-wei added the Area - Documentation label Feb 21, 2019

jon-wei added this to the 0.14.0 milestone Feb 21, 2019

fjy reviewed Feb 21, 2019

View reviewed changes

jon-wei added 2 commits February 21, 2019 16:01

PR comments

9740751

Remove 'unified'

3afad3f

fjy reviewed Feb 22, 2019

View reviewed changes

clintropolis approved these changes Feb 26, 2019

View reviewed changes

fjy reviewed Feb 26, 2019

View reviewed changes

jon-wei added 2 commits February 26, 2019 14:17

PR comments

1041511

Fix TOC

66a992b

fjy reviewed Feb 27, 2019

View reviewed changes

jon-wei added 4 commits February 26, 2019 17:48

PR comments

dafea42

More revisions

5b44a30

GUI -> UI

a42f617

Update router docs

c9a8543

Reword router doc

d4a18cb

jihoonson approved these changes Feb 28, 2019

View reviewed changes

jon-wei merged commit a0afd79 into apache:master Feb 28, 2019

jon-wei mentioned this pull request Feb 28, 2019

[Backport] Add web consoles doc page (#7123) #7168

Merged

fjy pushed a commit that referenced this pull request Mar 1, 2019

Add web consoles doc page (#7123) (#7168)

43fe265

* 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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add web consoles doc page #7123

Add web consoles doc page #7123

jon-wei commented Feb 21, 2019

fjy Feb 21, 2019

jihoonson Feb 21, 2019

clintropolis Feb 21, 2019

fjy Feb 22, 2019

jon-wei Feb 22, 2019

fjy Feb 22, 2019

jon-wei Feb 26, 2019

clintropolis left a comment

fjy Feb 26, 2019

jon-wei Feb 26, 2019

fjy Feb 26, 2019

fjy Feb 26, 2019

jon-wei Feb 26, 2019

jon-wei Feb 27, 2019

gianm Feb 27, 2019 •

edited

Loading

jon-wei Feb 27, 2019

fjy Feb 27, 2019

jon-wei Feb 27, 2019

fjy Feb 27, 2019

jon-wei Feb 27, 2019

fjy Feb 27, 2019

jon-wei Feb 27, 2019

fjy Feb 27, 2019

jon-wei Feb 27, 2019

jon-wei commented Feb 28, 2019

jihoonson left a comment

jon-wei commented Feb 28, 2019


		# Web Consoles

		Druid has a few console UIs that provide cluster management functionality, described below.


		This console subsumes the functionality provided by the older consoles described below, which are still available if needed.

		## Coordinator Consoles


		# GUIs

		Druid has a few console UIs that provide cluster management functionality, described below.


		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.

Add web consoles doc page #7123

Add web consoles doc page #7123

Conversation

jon-wei commented Feb 21, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clintropolis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gianm Feb 27, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jon-wei commented Feb 28, 2019

jihoonson left a comment

Choose a reason for hiding this comment

jon-wei commented Feb 28, 2019

gianm Feb 27, 2019 •

edited

Loading