Skip to content

add a maintainance command overview#1004

Open
Svanvith wants to merge 2 commits into
mainfrom
add-maintainance-commands
Open

add a maintainance command overview#1004
Svanvith wants to merge 2 commits into
mainfrom
add-maintainance-commands

Conversation

@Svanvith

@Svanvith Svanvith commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@Svanvith Svanvith requested a review from micbar July 1, 2026 10:23
@v-scharf

v-scharf commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

cli commands:

  • removes all the file versions: opencloud revisions purge

  • check opencloud version: opencloud version

  • search index: opencloud search index --all-spaces

  • check backup consistency: opencloud backup consistency
    not sure about opencloud benchmark client has a panic and opencloud benchmark syscalls need ask @rhafer

  • admin reset password: idm resetpassword

  • create app tokens: auth-app create --user-name=$user --expiration=$expirationTime

@v-scharf v-scharf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the recommended Docker Compose stack, we use posix by default, but some commands do not work with posix.
We need to decide what to do: either fix the commands (which I think is the right approach) or remove them from the documentation.

cc @rhafer @micbar

clicommand tests we run only on decomposed storage

in posix we cannot do some important commands like: deleting version, backup consistency, etc (need double check)

Example:

```bash
docker compose exec opencloud opencloud backup consistency -p /var/lib/opencloud/storage/users

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry Anja, that was bad suggestion from me. I tested it and it works only for decomposed storage

$ opencloud backup consistency -p /var/lib/opencloud/storage/users
💚 No inconsistency found. The backup in '/var/lib/opencloud/storage/users' seems to be valid.

in posix (default storage) it doesn't work, we get:
~ $ opencloud backup consistency -p /var/lib/opencloud/storage/users no backup found. Double check storage path Error: no backup found. Double check storage path

so I think we should remove it

Comment on lines +59 to +71
### Check storage consistency

Checks the storage for inconsistencies such as orphaned blobs, missing blobs, missing nodes, missing links, missing files, missing or malformed metadata, and invalid parent-child relationships.

```bash
opencloud backup consistency -p /var/lib/opencloud/storage/users
```

To return a non-zero exit code when inconsistencies are found:

```bash
opencloud backup consistency -p /var/lib/opencloud/storage/users --fail
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't work on posix

Comment on lines +75 to +94
### Purge file revisions

By default, the command runs as a dry-run and prints which revisions would be removed without deleting anything. Review the output before running with `--dry-run=false`.

List revisions that would be purged:

```bash
opencloud revisions purge -p /var/lib/opencloud/storage/users
```

Purge revisions for all spaces:

```bash
opencloud revisions purge -p /var/lib/opencloud/storage/users --dry-run=false
```

Purge revisions for a specific space (pass the space ID as `--resource-id`):

```bash
opencloud revisions purge -p /var/lib/opencloud/storage/users --resource-id '<space-id>' --dry-run=false

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here. doesn't work on posixfs

decomposed:

~ $ opencloud revisions purge -p /var/lib/opencloud/storage/users --dry-run=false
✅ Deleted 2 revisions (6 files / 2 blobs)
~ $ opencloud revisions purge -p /var/lib/opencloud/storage/users --dry-run
👉 Would delete 1 revisions (3 files / 1 blobs)
~ $ opencloud revisions purge -p /var/lib/opencloud/storage/users
👉 Would delete 1 revisions (3 files / 1 blobs)

posix:
opencloud revisions purge -p /var/lib/opencloud/storage/users --dry-run no nodes found. Double check storage path ❎ No revisions found. Storage provider is clean.

By default, the command runs as a dry-run and prints which empty folders would be removed.

```bash
opencloud trash purge-empty-dirs -p /var/lib/opencloud/storage/users

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems doesn't work on decomposed

  • create empty dir1
  • create and remove empty dir2
  • opencloud trash purge-empty-dirs -p /var/lib/opencloud/storage/users

result: both dir still exist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants