Add cockroach nodelocal upload docs #6871
Conversation
|
This change is |
lnhsingh
force-pushed
the
nodelocal-upload
branch
from
b9be776
to
e123cc5
Compare
lnhsingh
force-pushed
the
nodelocal-upload
branch
from
2546e6f
to
61625f2
Compare
v20.1/cockroach-commands.md
Outdated
| @@ -30,6 +30,7 @@ Command | Usage | |||
| [`cockroach debug zip`](cockroach-debug-zip.html) | Generate a `.zip` file that can help Cockroach Labs troubleshoot issues with your cluster. | |||
| [`cockroach debug merge-logs`](cockroach-debug-merge-logs.html) | Merge multiple log files from different machines into a single stream. | |||
| [`cockroach workload`](cockroach-workload.html) | Run a built-in load generator against a cluster. | |||
| [`cockroach nodelocal upload`](cockroach-nodelocal-upload.html) | <span class="version-tag">New in v20.1:</span> Upload a file to a node's local file system. | |||
There was a problem hiding this comment.
maybe "Upload a file to the external-IO-dir on a node's...". Just want to get out ahead of the security concerns this feature might immediately raise if someone didn't know that restriction was in place.
v20.1/cockroach-nodelocal-upload.md
Outdated
| toc: true | ||
| --- | ||
|
|
||
| <span class="version-tag">New in v20.1:</span> The `cockroach nodelocal upload` [command](cockroach-commands.html) uploads a file to a node's (the gateway node, by default) local file system. |
There was a problem hiding this comment.
ditto above -- i'm include right away that it is uploading to the external io dir in the introduction. I know it is a detail and that it is covered in the next paragraph, but arbitrary file access is scary and without that "node's local filesystem" makes it sounds like it is wide open. Someone might panic here instead of reading the details.
| @@ -0,0 +1,90 @@ | |||
| --- | |||
There was a problem hiding this comment.
the user must have the admin role, and the node they're uploading to much not have external-io disabled.
v20.1/import-into.md
Outdated
| @@ -100,7 +100,7 @@ To import a local file, you have the following options: | |||
| - Option 2. Make the file accessible from each local node's store: | |||
| 1. Create an `extern` directory on each node's store. The pathname will differ depending on the [`--store` flag passed to `cockroach start` (if any)](cockroach-start.html#general), but will look something like `/path/to/cockroach-data/extern/`. | |||
There was a problem hiding this comment.
the "on each node" part goes away as does step 2, but in fact, i think we could just say to to use cockroach nodelocal upload data.sql (or manually place the file in the extern directory).
v20.1/import-into.md
Outdated
| @@ -100,7 +100,7 @@ To import a local file, you have the following options: | |||
| - Option 2. Make the file accessible from each local node's store: | |||
| 1. Create an `extern` directory on each node's store. The pathname will differ depending on the [`--store` flag passed to `cockroach start` (if any)](cockroach-start.html#general), but will look something like `/path/to/cockroach-data/extern/`. | |||
| 2. Copy the file to each node's `extern` directory. | |||
There was a problem hiding this comment.
only to node 1 now, since that is where the URI points in the next step.
There was a problem hiding this comment.
TFTR!
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @dt and @mwang1026)
v20.1/cockroach-commands.md, line 33 at r1 (raw file):
Previously, dt (David Taylor) wrote…
maybe "Upload a file to the external-IO-dir on a node's...". Just want to get out ahead of the security concerns this feature might immediately raise if someone didn't know that restriction was in place.
Done.
v20.1/cockroach-nodelocal-upload.md, line 1 at r1 (raw file):
Previously, dt (David Taylor) wrote…
the user must have the admin role, and the node they're uploading to much not have external-io disabled.
Done.
v20.1/cockroach-nodelocal-upload.md, line 7 at r1 (raw file):
Previously, dt (David Taylor) wrote…
ditto above -- i'm include right away that it is uploading to the external io dir in the introduction. I know it is a detail and that it is covered in the next paragraph, but arbitrary file access is scary and without that "node's local filesystem" makes it sounds like it is wide open. Someone might panic here instead of reading the details.
Done.
v20.1/import-into.md, line 101 at r1 (raw file):
Previously, dt (David Taylor) wrote…
the "on each node" part goes away as does step 2, but in fact, i think we could just say to to use
cockroach nodelocal upload data.sql(or manually place the file in theexterndirectory).
Done.
v20.1/import-into.md, line 102 at r1 (raw file):
Previously, dt (David Taylor) wrote…
only to node 1 now, since that is where the URI points in the next step.
Done.
There was a problem hiding this comment.
LGTM
Reviewed 4 of 7 files at r1, 3 of 3 files at r2.
Reviewable status:
Changes:
cockroach-nodelocal-upload.md, which explains the new commandcockroach nodelocal uploadto the sidebar navcockroach nodelocal uploadtocockroach-commands.mdnodeID, which is now requiredCloses #6010, #6788.