DOC-15572: Product Change- PR #158961 - cli: set database user name in debug.zip and tsdump generation#22035
DOC-15572: Product Change- PR #158961 - cli: set database user name in debug.zip and tsdump generation#22035florence-crl merged 3 commits intomainfrom
Conversation
… flag to Client connection section.
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
| `--host` | The server host and port number to connect to. This can be the address of any node in the cluster.<br><br>**Env Variable:** `COCKROACH_HOST`<br>**Default:** `localhost:26257` | ||
| `--insecure` | Use an insecure connection.<br><br>**Env Variable:** `COCKROACH_INSECURE`<br>**Default:** `false` | ||
| <a name="sql-flag-url"></a> `--url` | A [connection URL]({% link {{ page.version.version }}/connection-parameters.md %}#connect-using-a-url) to use instead of the other arguments. To convert a connection URL to the syntax that works with your client driver, run [`cockroach convert-url`]({% link {{ page.version.version }}/connection-parameters.md %}#convert-a-url-for-different-drivers).<br><br>**Env Variable:** `COCKROACH_URL`<br>**Default:** no URL | ||
| `--user` | The [SQL user]({% link {{ page.version.version }}/create-user.md %}) that will own the client session.<br><br>**Default:** `root` |
There was a problem hiding this comment.
I think we should explicitly mention that the debug.zip expects user as either root or debug_user for successful debug.zip generation.
wdyt @kevin-v-ngo ?
There was a problem hiding this comment.
I think we should explicitly mention that the debug.zip expects user as either
rootordebug_userfor successful debug.zip generation. wdyt @kevin-v-ngo ?
Agree we should call out that root and debug_user should be specified to collect all contents of Debug zip.
But @aa-joshi, aren't we able to still specify any SQL user for the SQL requests the Debug zip make to CRDB?
There was a problem hiding this comment.
If the later is not supported, we should fix the doc in previous releases and only call out root and debug_user.
There was a problem hiding this comment.
@kevin-v-ngo The authorisation layer doesn't allow to connect apart from root and debug_user. In future, there is plan to generate debug.zip with any SQL user with essential permissions. @florence-crl Let's make it explicitly that only root and debug_user is allowed.
…values to --user flag and removed link on SQL user.
4 participants
Fixes DOC-15572
In cockroach-debug-zip.md and cockroach-debug-tsdump.md, added --user flag to Client connection section.
Rendered previews