Purging Central resources via CLI
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- cli, documentation
Research direction
Start by locating the existing Central command-line script that purges soft-deleted forms and submissions. Document its daily schedule, 30-day default, flag for immediate purging, and how to target a subset such as one form. Done means server administrators can follow the documentation to purge resources immediately when needed.
Written by the indexing model from the issue text.
Description
Currently, it's possible in Central to purge forms and submissions that have been soft-deleted. Purging is done via a command-line script that's automatically run once a day. By default, a form or submission is purged 30 days after it's deleted. However, if manually run with the correct flag, the command-line script can be used to purge deleted resources immediately (not waiting for the 30 days). It's also possible use the script to immediately purge only a subset of deleted resources (e.g., a single form).
This issue is to document this command-line script for users. The goal is to give server admins a way to immediately purge resources if that's needed. We talked about adding an endpoint for purging (see getodk/central-backend#739). However, our currently thinking is that we don't want to make immediate purging too easy. Yet we still want to make it possible for server admins, which is why we want to document this command-line script.
- Dominant language
- Python
- Stars
- 58
- Forks
- 161
- Avg merge
- 20h 51m
- Merged PRs (30d)
- 2
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getodk/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
Central Collect
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Make it explicit that an S3 bucket configured for use with Central must accept abitrary connectionsOpenCentral
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
area:cli area:security enhancement priority:medium size:small
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
RonaldHensbergen/composable-data-stack#1338 ·
Maintainers usually reply within 1 day
-
area:stdlib effort:S impact:med platform:linux type:bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
almanac-data/climate-almanac#139 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
UKGovernmentBEIS/inspect_ai#6695 · 1 comment ·
Maintainers usually reply within 1 day