HDDS-14295. [Website v2] [Docs] [Administrator Guide] Ozone command line tools #256
Conversation
sarvekshayr
left a comment
sarvekshayr
left a comment
There was a problem hiding this comment.
Thanks @Russole for working on this.
Please include Ozone admin commands as well.
Let's change the structure a bit here -
Administrator Guide -> Operations -> Tools (Main page)
Sub pages:
- Ozone Admin
- Ozone Debug
- Ozone Repair
When we create Debug section, we can move LDB tool under it. (This can be done later)
| - FSO-tree | ||
|
|
||
| - snapshot | ||
|
|
||
| - update-transaction | ||
|
|
||
| - quota | ||
|
|
||
| - compact | ||
|
|
||
| - skip-ratis-transaction |
| **Note:** All repair commands support a `--dry-run` option which allows a user to see what repair the command will be performing without actually making any changes to the cluster. | ||
| Use the `--force` flag to override the running service check in false-positive cases. |
|
@Russole could you take a look at @echonesis 's comments above? |
|
Sure, I’ll update the changes based on the comments. |
|
Thanks @sarvekshayr and @echonesis for the review. Updates have been made based on the comments. |
jojochuang
added
the
website-v2
sarvekshayr
left a comment
sarvekshayr
left a comment
There was a problem hiding this comment.
Thanks for including all 3 sections in one PR.
| ## Snapshots | ||
|
|
||
| This section documents how to manage and configure Ozone snapshots. |
There was a problem hiding this comment.
This is not relevant here. Please remove it.
| > Multiple filtering options can be used together in a single command. | ||
| ### –startkey and –endkey |
There was a problem hiding this comment.
Use double dash before these options. Applies to --fields and --filter as well.
| ### –startkey and –endkey | |
| ### --startkey and --endkey |
There was a problem hiding this comment.
Agreed with @sarvekshayr
--startkey and --endkey imply command usage.
| @@ -0,0 +1,227 @@ | |||
| # LDB Tool | |||
There was a problem hiding this comment.
We already have an LDB page - https://ozone-site-v2.staged.apache.org/docs/administrator-guide/operations/ldb
Please move it here instead.
| By default, the contents are printed on the console, but it can be redirected to a file using the `--out` option. <br /> | ||
| `--length` can be used to limit the number of records being printed. <br /> | ||
| `--count` doesn’t print the records, it shows the approximate number of records. This is not accurate. <br /> | ||
| `ozone debug ldb scan` command provides many filtering options to make debugging easier, elaborated below: <br /> |
There was a problem hiding this comment.
<br /> is better for HTML.
In Markdown, we could use new line instead.
| > Multiple filtering options can be used together in a single command. | ||
| ### –startkey and –endkey |
There was a problem hiding this comment.
Agreed with @sarvekshayr
--startkey and --endkey imply command usage.
4 participants
What changes were proposed in this pull request?
Migrate the Ozone tools page https://ozone.apache.org/docs/edge/tools/index.html specifically Ozone Repair and Ozone Admin to the v2 page under Administrator Guide -> Operations https://ozone-site-v2.staged.apache.org/docs/administrator-guide/operations/
What is the link to the Apache Jira?
https://issues.apache.org/jira/browse/HDDS-14295
How was this patch tested?