Updates to cockroach demo docs #5363
Conversation
|
This change is |
There was a problem hiding this comment.
LGTM with one small correction
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @ericharmeling and @rmloveland)
v19.2/cockroach-demo.md, line 49 at r1 (raw file):
Flag | Description -----|------------ `--demo-locality` | Specify [locality](start-a-node.html#locality) information for each demo node. The input is a colon-separated list of key-value pairs, where the i<sup>th</sup> pair is the locality setting for the i<sup>th</sup> demo cockroach node.<br><br>For example, the following option assigns node 1's region to `us-east1` and availability zone to `1`, node 2's region to `us-east2` and availability zone to `2`, and node 3's region to `us-east3` and availability zone to `3`: `--demo-locality=region=us-east1,az=1:region=us-east1,az=2:region=us-east1,az=3`. You can also include
"You can also include" at end is incomplete....
There was a problem hiding this comment.
Reviewable status:
v19.2/cockroach-demo.md, line 49 at r1 (raw file):
Previously, jseldess (Jesse Seldess) wrote…
"You can also include" at end is incomplete....
Done.
ericharmeling
force-pushed
the
demo-args
branch
from
2b82e1a
to
e33edb2
Compare
|
@rmloveland @jseldess |
|
@ericharmeling would you mind updating
so they match the contents of these new updates? That way we will know what's in here when it pops up in search results or when looking at |
ericharmeling
changed the title
ericharmeling
force-pushed
the
demo-args
branch
from
e33edb2
to
36ca844
Compare
@rmloveland Sure thing! Done. |
There was a problem hiding this comment.
Reviewable status:
_includes/v19.2/sql/partitioning-enterprise.md, line 1 at r2 (raw file):
Partitioning is an enterprise-only feature. Each instance of `cockroach demo` loads a temporary enterprise license that expires after an hour of usage. If you want to use enterprise-only features outside of a `cockroach demo` instance, [request a trial enterprise license](https://www.cockroachlabs.com/get-cockroachdb/), and then [set the license key](enterprise-licensing.html#set-the-trial-or-enterprise-license-key).
nit: after an hour of usage > after an hour.
v19.2/cockroach-demo.md, line 12 at r2 (raw file):
<span class="version-tag">New in v19.2:</span> Each instance of `cockroach demo` loads a temporary [enterprise license](https://www.cockroachlabs.com/get-cockroachdb) that expires after an hour of usage.
after an hour of usage > after an hour
v19.2/cockroach-demo.md, line 59 at r2 (raw file):
`--safe-updates` | Disallow potentially unsafe SQL statements, including `DELETE` without a `WHERE` clause, `UPDATE` without a `WHERE` clause, and `ALTER TABLE ... DROP COLUMN`.<br><br>**Default:** `true` for [interactive sessions](use-the-built-in-sql-client.html#session-and-output-types); `false` otherwise<br><br>Potentially unsafe SQL statements can also be allowed/disallowed for an entire session via the `sql_safe_updates` [session variable](set-vars.html). `--set` | Set a [client-side option](use-the-built-in-sql-client.html#client-side-options) before starting the SQL shell or executing SQL statements from the command line via `--execute`. This flag may be specified multiple times, once per option.<br><br>After starting the SQL shell, the `\set` and `unset` commands can be use to enable and disable client-side options as well. `--with-load` | <span class="version-tag">New in v19.2:</span> Run a demo [`movr`](movr.html) workload against the pre-loaded `movr` database.
Should we add an example for this, or somehow cover it in an example?
v19.2/show-locality.md, line 31 at r2 (raw file):
{% include copy-clipboard.html %} ~~~ shell $ cockroach demo movr --nodes=3 --demo-locality=region=us-east1:region=us-central1:region=us-west1
Ugh, the command is showing up different on the page: http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/36ca844770fbc027139bcdde066263bbdfec9873/v19.2/show-locality.html#show-locality
Also in other places where we feature the --demo-locality flag: http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/36ca844770fbc027139bcdde066263bbdfec9873/v19.2/cockroach-demo.html#load-a-sample-dataset-and-start-an-interactive-sql-shell
This is probably due to some JS we're using to string certain things out of code samples. We'll have to look at it. We might need @benesch.
ericharmeling
force-pushed
the
demo-args
branch
from
36ca844
to
5096f75
Compare
There was a problem hiding this comment.
Reviewable status:
_includes/v19.2/sql/partitioning-enterprise.md, line 1 at r2 (raw file):
Previously, jseldess (Jesse Seldess) wrote…
nit:
after an hour of usage>after an hour.
Done.
v19.2/cockroach-demo.md, line 12 at r2 (raw file):
Previously, jseldess (Jesse Seldess) wrote…
after an hour of usage>after an hour
Done.
v19.2/cockroach-demo.md, line 59 at r2 (raw file):
Previously, jseldess (Jesse Seldess) wrote…
Should we add an example for this, or somehow cover it in an example?
Yes. I just added a small one.
v19.2/show-locality.md, line 31 at r2 (raw file):
Previously, jseldess (Jesse Seldess) wrote…
Ugh, the command is showing up different on the page: http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/36ca844770fbc027139bcdde066263bbdfec9873/v19.2/show-locality.html#show-locality
Also in other places where we feature the
--demo-localityflag: http://cockroach-docs-review.s3-website-us-east-1.amazonaws.com/36ca844770fbc027139bcdde066263bbdfec9873/v19.2/cockroach-demo.html#load-a-sample-dataset-and-start-an-interactive-sql-shellThis is probably due to some JS we're using to string certain things out of code samples. We'll have to look at it. We might need @benesch.
We discussed offline... rebasing master.
ericharmeling
force-pushed
the
demo-args
branch
from
bf1d448
to
039da9f
Compare
cockroach demodefault localities, nodes, andmovrdatabase are preloaded (Fixes demo: Add location information to default demo localities. #5378)cockroach demoloads a temporary enterprise license, simplified includes (Fixes demo: cockroach demo attempts to obtain a temporary license #5379)--with-loadflag to rundemowithmovrworkload (Fixes demo: Add a Movr workload to run in cockroach demo #5377)