Skip to content

Commit 18c7fb4

Browse files
DeepDiver1975claude
andcommitted
docs(ocis): add 8.2 updates -- clean-corrupt-public-shares CLI
Port of owncloud/docs-ocis#1285, which never merged upstream -- so ocis 8.2 shipped without this content and no version folder here carries it. Applied to content/ocis/8.2 and 8.3 (substantive content, per the README backport rule): * new "Clean Corrupt Public Shares" command page * its index entry in commands.adoc * the command added to the ocis-shares-cli help listing Applied to content/ocis/8.2 only (version bookkeeping): * changed-cli.adoc: 8.1.0 -> 8.2.0 delta The upstream PR wrote that delta as "between 8.0.0 and 8.1.0" -- a leftover from when its base branch was the 8.1 dev line. Corrected to 8.1.0 -> 8.2.0, which is the delta the content/ocis/8.2 folder describes. The 8.1 folder's own delta page is set by the companion 8.1 port, so the two no longer collide. Refs: owncloud/docs-ocis#1285 Refs: owncloud/docs-ocis#1275 Co-Authored-By: Martin Mattel <github@diemattels.at> Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com> Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent e454d54 commit 18c7fb4

7 files changed

Lines changed: 87 additions & 14 deletions

File tree

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Changed or Added CLI Commands
22
:toc: right
3-
:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 7.3.0 and 8.0.0.
3+
:description: This page contains a list with added, changed or removed CLI commands between Infinite Scale version 8.1.0 and 8.2.0.
44
:page-aliases: ROOT:maintenance/b-r/changed-cli.adoc
55

66
== Introduction
@@ -13,8 +13,5 @@
1313

1414
See the link for a detailed description of the respective CLI command if available.
1515

16-
* xref:maintenance/commands/commands.adoc#move-stuck-uploads[Move Stuck Uploads] +
17-
This CLI command has been added to remedy the issue when Infinite Scale metadata may become stuck in some cases of saturated disk usage.
18-
19-
* xref:maintenance/commands/commands.adoc#cleanup-orphaned-grants[Cleanup Orphaned Grants] +
20-
This CLI command has been added to cleanup orphaned grants when a share has been deleted but the removal process is not completed successfully.
16+
* xref:maintenance/commands/commands.adoc#clean-corrupt-public-shares[Clean Corrupt Public Shares] +
17+
This CLI command has been added to detect and remove corrupt public share entries.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Clean Corrupt Public Shares
2+
:toc: right
3+
4+
Detect and optionally delete storage grants that have no corresponding share-manager entry.
5+
6+
include::partial$/maintenance/ocis-shares-cli.adoc[]
7+
8+
== Command Details
9+
10+
If there is a single public-share entry with a corrupt `resource_id`, the public-share manager will be unable to read this public-share or any others from memory.
11+
12+
The following command fixes the problem of corrupt public shares.
13+
14+
.Usage:
15+
16+
[source,bash]
17+
----
18+
ocis shares -h clean-corrupt-public-shares
19+
NAME:
20+
ocis shares clean-corrupt-public-shares - Remove corrupt public-share entries (nil resource_id) that crash ListPublicShares.
21+
22+
USAGE:
23+
ocis shares clean-corrupt-public-shares [command options]
24+
25+
OPTIONS:
26+
--dry-run Only report corrupt entries, do not modify anything (default: true)
27+
--verbose, -v Verbose logging enabled (default: false)
28+
--help, -h show help
29+
----
30+
31+
.Notes:
32+
33+
- `--dry-run` defaults to `true` (no deletions). Set to `false` to remove corrupt public shares.

content/ocis/8.2/modules/admin/pages/maintenance/commands/commands.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ Compared to offline commands that can be issued when Infinite Scale is shut down
7272

7373
App Tokens are used to authenticate 3rd party access via https like when using curl (apps) to access an API endpoint. These apps need to authenticate themselves, as no logged in user authenticates the request. To be able to use an app token, one must first create a token via the cli. For details see the description in the xref:{s-path}/auth-app.adoc[auth-app] service.
7474

75+
=== Clean Corrupt Public Shares
76+
77+
In rare cases, information relating to a public share can become corrupted, which can prevent all other public shares from being read. Use the following xref:maintenance/commands/clean-corrupt-public-shares.adoc[CLI command] to identify and remove them.
78+
7579
=== Cleanup Orphaned Grants
7680

7781
Detect and, if desired, delete storage grants that have no corresponding share-manager entry. This can occur when a share is deleted, but the removal process is not completed successfully. Use the following xref:maintenance/commands/cleanup-orphaned-grants.adoc[CLI command] to cleanup those orphaned share grants.

content/ocis/8.2/modules/admin/partials/maintenance/ocis-shares-cli.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ CATEGORY:
1515
maintenance
1616
1717
COMMANDS:
18-
cleanup Clean up stale entries in the share manager.
19-
clean-orphaned-grants Detect and clean orphaned share-manager grants.
20-
move-stuck-upload-blobs Move stuck upload blobs to the jsoncs3 share-manager metadata
21-
help, h Shows a list of commands or help for one command
18+
cleanup Clean up stale entries in the share manager.
19+
clean-orphaned-grants Detect and clean orphaned share-manager grants.
20+
move-stuck-upload-blobs Move stuck upload blobs to the jsoncs3 share-manager metadata
21+
clean-corrupt-public-shares Remove corrupt public-share entries (nil resource_id) that crash ListPublicShares.
22+
help, h Shows a list of commands or help for one command
2223
2324
OPTIONS:
2425
--help, -h show help
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Clean Corrupt Public Shares
2+
:toc: right
3+
4+
Detect and optionally delete storage grants that have no corresponding share-manager entry.
5+
6+
include::partial$/maintenance/ocis-shares-cli.adoc[]
7+
8+
== Command Details
9+
10+
If there is a single public-share entry with a corrupt `resource_id`, the public-share manager will be unable to read this public-share or any others from memory.
11+
12+
The following command fixes the problem of corrupt public shares.
13+
14+
.Usage:
15+
16+
[source,bash]
17+
----
18+
ocis shares -h clean-corrupt-public-shares
19+
NAME:
20+
ocis shares clean-corrupt-public-shares - Remove corrupt public-share entries (nil resource_id) that crash ListPublicShares.
21+
22+
USAGE:
23+
ocis shares clean-corrupt-public-shares [command options]
24+
25+
OPTIONS:
26+
--dry-run Only report corrupt entries, do not modify anything (default: true)
27+
--verbose, -v Verbose logging enabled (default: false)
28+
--help, -h show help
29+
----
30+
31+
.Notes:
32+
33+
- `--dry-run` defaults to `true` (no deletions). Set to `false` to remove corrupt public shares.

content/ocis/8.3/modules/admin/pages/maintenance/commands/commands.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ Compared to offline commands that can be issued when Infinite Scale is shut down
7272

7373
App Tokens are used to authenticate 3rd party access via https like when using curl (apps) to access an API endpoint. These apps need to authenticate themselves, as no logged in user authenticates the request. To be able to use an app token, one must first create a token via the cli. For details see the description in the xref:{s-path}/auth-app.adoc[auth-app] service.
7474

75+
=== Clean Corrupt Public Shares
76+
77+
In rare cases, information relating to a public share can become corrupted, which can prevent all other public shares from being read. Use the following xref:maintenance/commands/clean-corrupt-public-shares.adoc[CLI command] to identify and remove them.
78+
7579
=== Cleanup Orphaned Grants
7680

7781
Detect and, if desired, delete storage grants that have no corresponding share-manager entry. This can occur when a share is deleted, but the removal process is not completed successfully. Use the following xref:maintenance/commands/cleanup-orphaned-grants.adoc[CLI command] to cleanup those orphaned share grants.

content/ocis/8.3/modules/admin/partials/maintenance/ocis-shares-cli.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ CATEGORY:
1515
maintenance
1616
1717
COMMANDS:
18-
cleanup Clean up stale entries in the share manager.
19-
clean-orphaned-grants Detect and clean orphaned share-manager grants.
20-
move-stuck-upload-blobs Move stuck upload blobs to the jsoncs3 share-manager metadata
21-
help, h Shows a list of commands or help for one command
18+
cleanup Clean up stale entries in the share manager.
19+
clean-orphaned-grants Detect and clean orphaned share-manager grants.
20+
move-stuck-upload-blobs Move stuck upload blobs to the jsoncs3 share-manager metadata
21+
clean-corrupt-public-shares Remove corrupt public-share entries (nil resource_id) that crash ListPublicShares.
22+
help, h Shows a list of commands or help for one command
2223
2324
OPTIONS:
2425
--help, -h show help

0 commit comments

Comments
 (0)