Node Map: Related changes #2808

Amruta-Ranade · 2018-03-28T17:39:12Z

@jseldess I opened this separate PR for the structural changes related to the Node Map. (Not many content changes from v1.1)

cockroach-teamcity · 2018-03-28T17:39:17Z

This change is

cockroach-teamcity · 2018-03-28T17:41:18Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/

jseldess

Thanks, @Amruta-Ranade. See my comments/questions.

You're going to update the other ui pages with relevant navigation changes when you clean up the screenshots? For example, the intro on admin-ui-overview-dashboard.md` is currently:

On accessing the CockroachDB Admin UI, the Overview is shown by default.

jseldess · 2018-03-28T18:49:14Z

v2.0/admin-ui-access-and-navigate.md

-{{site.data.alerts.end}}
-
-#### Change time range
+<img src="{{ 'images/admin_ui_overview.gif' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" />


This image doesn't exist. What image are you trying to include here? Btw, you can see this breakage in the test version of the page on s3. Be sure to always check the rendered pages.

On second glance, I think you just need to include the version directory, i.e., images/v2.0/...

jseldess · 2018-03-28T18:50:02Z

v2.0/admin-ui-access-and-navigate.md

-
-### Summary Panel
-<img src="{{ 'images/v2.0/admin_ui_summary_panel.png' | relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:40%" />
+<img src="{{ 'images/admin_ui_summary_panel.png' | relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:40%" />


Same as above. Image doesn't exist.

On second glance, I think you just need to include the version directory, i.e., images/v2.0/...

jseldess · 2018-03-28T18:52:38Z

v2.0/admin-ui-access-and-navigate.md

+
+<img src="{{ 'images/v2.0/admin-ui-node-components.png' | relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:90%" />
+
+**Region component**


Should we list region before node, if that's the hierarchy from a user's perspective?

The node has the individual metrics that are then aggregated to the region level. Hence the hierarchy in the doc.

Yeah, but my question is about UX: Should we list these in the order that users will encounter them? They won't see nodes until they drill into regions, right? If so, I'd list regions first.

jseldess · 2018-03-28T18:53:29Z

v2.0/admin-ui-access-and-navigate.md

@@ -107,6 +84,58 @@ Down Since | How long the node has been down.

 When you decommission a node, CockroachDB lets the node finish in-flight requests, rejects any new requests, and transfers all range replicas and range leases off the node so that it can be safely shut down. See [Remove Nodes](remove-nodes.html) for more information.

+### Node Map (Enterprise)
+
+The **Node Map** is an [enterprise-only](enterprise-licensing.html) feature that gives you a visual representation of the geographical configuration of your cluster. To set up and enable the Node Map, see [Enable Node Map](enable-node-map.html). The Node Map consists of the following components:


I'd cut out the second sentence and move it after the component sections, with some edits:

For guidance on enabling and using the node map, see ...

jseldess · 2018-03-28T18:55:53Z

v2.0/admin-ui-access-and-navigate.md

-{{site.data.alerts.end}}
+Capacity Usage | <ul><li>The storage capacity used as a percentage of total storage capacity allocated across all nodes.</li><li>The current capacity usage.</li></ul>
+Node Status | <ul><li>The number of [live nodes](admin-ui-access-and-navigate.html#live-nodes) in the cluster.</li><li>The number of suspect nodes in the cluster. A node is considered a suspect node if it's liveness status is unavailable or the node is in the process of decommissioning.</li><li>The number of [dead nodes](admin-ui-access-and-navigate.html#dead-nodes) in the cluster.</li>
+Replication Status | <ul><li>The total number of ranges in the cluster.</li><li>The number of [under-replicated ranges](admin-ui-replication-dashboard.html#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li><li>The number of [unavailable ranges](admin-ui-replication-dashboard.html#review-of-cockroachdb-terminology) in the cluster. A non-zero number indicates an unstable cluster.</li>

 ### Nodes List


Shouldn't we update this to reference the Node List on the ui landing page rather than reference the more deeply buried version of the Node List?

Ahh..excellent catch. The Node List is the default view on the Overview page now, need to specify that. Thanks!

jseldess · 2018-03-28T18:58:41Z

v2.0/admin-ui-access-and-navigate.md

+
+<img src="{{ 'images/v2.0/admin-ui-region-component.png' | relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:90%" />
+
+### Time Series Graphs


For this, the Summary panel, and the Events panel, don't we need to tell users how to get to these areas now that they're not available from the main ui landing page?

Hmmm...yes..for the Time Series as well. Adding the navigation now.

jseldess · 2018-03-28T19:02:40Z

Also looks like there are some links to fix:

[17:41:18][Step 1/1] 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-access-and-navigate.html
[17:41:18][Step 1/1]   target does not exist --- 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-access-and-navigate.html --> admin-ui-access-and-navigate.htmll#events-panel
[17:41:18][Step 1/1]   target does not exist --- 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-access-and-navigate.html --> /13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/images/admin_ui_overview.gif
[17:41:18][Step 1/1]   target does not exist --- 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-access-and-navigate.html --> /13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/images/admin_ui_summary_panel.png
[17:41:18][Step 1/1] 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-overview.html
[17:41:18][Step 1/1]   target does not exist --- 13ca5e1dd51f7156ef6f159f5ec9f768e411d5b1/v2.0/admin-ui-overview.html --> admin-ui-node-map.html

Amruta-Ranade · 2018-03-28T19:03:11Z

@jseldess About images and navigation changes, I am planning to open a separate PR just for the bulk changes (screenshots, navigation, links). Wanted to get the content/structural changes done to get them reviewed.

cockroach-teamcity · 2018-03-28T19:21:24Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/ac48ff14102dd2d5485d734d9e9227a5a610c5d6/

cockroach-teamcity · 2018-03-28T21:05:21Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/eea07c4792322911ba6923e8d03815fdbe4dc5d2/

cockroach-teamcity · 2018-03-28T21:10:53Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/178ff911ec0349efd849d527f50c14345aefc2da/

Amruta-Ranade · 2018-03-28T21:11:30Z

@jseldess Fixed the links and images

cockroach-teamcity · 2018-03-29T01:09:37Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/efa59f721724a757ace17fd74c1b24ad2c7b1059/

jseldess

LGTM, with one nit. Also, the new image for the Node List is nice in that it shows all 3 sections, but it represents an unhealthy cluster; any cluster with only 2 live nodes is under-replicated. Any chance you could get an image showing all 3 sections, but where there are at least 3 healthy live nodes?

jseldess · 2018-03-29T01:38:45Z

v2.0/admin-ui-access-and-navigate.md

+-----------|------------
+Cluster Overview | <ul><li>[Cluster Overview panel](admin-ui-access-and-navigate.html#cluster-overview-panel)</li><li>[Node List](admin-ui-access-and-navigate.html#node-list). [Enterprise users](enterprise-licensing.html) can enable and switch to the [Node Map](admin-ui-access-and-navigate.html#node-map-enterprise) view. </li></ul>
+Cluster Metrics | <ul><li>[Time Series graphs](admin-ui-access-and-navigate.html#time-series-graphs)</li><li>[Summary Panel](admin-ui-access-and-navigate.html#summary-panel)</li><li>[Events List](admin-ui-access-and-navigate.html#events-panel)</li></ul>
+Databases | Information about the Tables or Grants in your [databases](admin-ui-databases-page.html).


nit: use lowercase for tables and grants. Also probably want to change or to and.

Amruta-Ranade · 2018-03-29T02:51:51Z

@jseldess Done.

cockroach-teamcity · 2018-03-29T02:53:08Z

http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/92ee9aa6e638c6cee0575d44d9a576ea7d4bd168/

jseldess · 2018-03-29T03:24:26Z

Thanks, @Amruta-Ranade!

Node Map: Related changes

13ca5e1

Amruta-Ranade added the in progress label Mar 28, 2018

Amruta-Ranade requested a review from jseldess March 28, 2018 17:39

jseldess reviewed Mar 28, 2018

View reviewed changes

admin_ui_changes

ac48ff1

Fixed images

eea07c4

Fixed broken links

178ff91

Stumbled upon beautiful scenario for Node List so updating image

efa59f7

jseldess approved these changes Mar 29, 2018

View reviewed changes

Better image for node list

92ee9aa

Amruta-Ranade merged commit 8d92906 into master Mar 29, 2018

Amruta-Ranade removed the in progress label Mar 29, 2018

Amruta-Ranade deleted the admin_ui_changes branch March 29, 2018 03:28

Amruta-Ranade mentioned this pull request Mar 29, 2018

Cluster Visualization: General Overview #2033

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Node Map: Related changes #2808

Node Map: Related changes #2808

Amruta-Ranade commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

jseldess left a comment

jseldess Mar 28, 2018

jseldess Mar 28, 2018

jseldess Mar 28, 2018

jseldess Mar 28, 2018

jseldess Mar 28, 2018

Amruta-Ranade Mar 28, 2018

jseldess Mar 28, 2018

jseldess Mar 28, 2018

jseldess Mar 28, 2018

Amruta-Ranade Mar 28, 2018

jseldess Mar 28, 2018

Amruta-Ranade Mar 28, 2018

jseldess commented Mar 28, 2018

Amruta-Ranade commented Mar 28, 2018 •

edited

Loading

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

Amruta-Ranade commented Mar 28, 2018

cockroach-teamcity commented Mar 29, 2018

jseldess left a comment

jseldess Mar 29, 2018

Amruta-Ranade commented Mar 29, 2018

cockroach-teamcity commented Mar 29, 2018

jseldess commented Mar 29, 2018


		<img src="{{ 'images/v2.0/admin-ui-node-components.png' \| relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:90%" />

		Region component


		<img src="{{ 'images/v2.0/admin-ui-region-component.png' \| relative_url }}" alt="CockroachDB Admin UI Summary Panel" style="border:1px solid #eee;max-width:90%" />

		### Time Series Graphs

Node Map: Related changes #2808

Node Map: Related changes #2808

Conversation

Amruta-Ranade commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

jseldess 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

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

jseldess commented Mar 28, 2018

Amruta-Ranade commented Mar 28, 2018 • edited Loading

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

cockroach-teamcity commented Mar 28, 2018

Amruta-Ranade commented Mar 28, 2018

cockroach-teamcity commented Mar 29, 2018

jseldess left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amruta-Ranade commented Mar 29, 2018

cockroach-teamcity commented Mar 29, 2018

jseldess commented Mar 29, 2018

Amruta-Ranade commented Mar 28, 2018 •

edited

Loading