docs: Add retirement concept doc - #1488
Conversation
| =================== | ||
|
|
||
| After a deletion request, the account sits in a waiting state (called | ||
| ``PENDING``) for a configurable number of *cool-off days*. During this window a |
There was a problem hiding this comment.
How are cool-off days configured?
There was a problem hiding this comment.
I'm not sure that belongs in this doc, but it is covered in the new how-to I just added. I can link it here if you think that makes sense.
There was a problem hiding this comment.
I think it'd be good to reference the how-to here, yes
| The retirement process | ||
| ====================== | ||
|
|
||
| The retirement process is the batch job that actually carries out deletions. |
There was a problem hiding this comment.
I assume the retirement process is not enabled by default?
There was a problem hiding this comment.
The process itself isn't, but the UI to delete your account is
There was a problem hiding this comment.
Makes sense, maybe this could be clarified with something like
| The retirement process is the batch job that actually carries out deletions. | |
| The retirement process is a manually-configured batch job that actually carries out deletions. |
There was a problem hiding this comment.
It's somewhat confusing in that if you install the Tutor plugin and are on k8s it will actually create a cron for it and start running the pipeline. In all other cases you need to do something manual to kick the job. For this doc I was just trying to outline the concept of the process so didn't want to have to get into the weeds of various ways things might be configured.
| Deploying user retirement with Tutor | ||
| ************************************ | ||
|
|
||
| Setting up user retirement by hand involves several steps: creating a dedicated |
There was a problem hiding this comment.
what do you mean "by hand" here?
There was a problem hiding this comment.
Manually, vs using the Tutor plugin. I can clarify
There was a problem hiding this comment.
The section title here is "Deploying user retirement with Tutor", should it just be "without Tutor" then?
There was a problem hiding this comment.
I've removed "by hand" since it remains true that the process needs those steps whether the Tutor plugin does them or an operator configures it some other way. Does it read more clearly now?
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | | | | | |
There was a problem hiding this comment.
I would fill this out as accurate - is it accurate for Verawood, or only currently on main (eg Willow)?
There was a problem hiding this comment.
This should be up to date going back several releases. The process itself hasn't changed in years, but the Tutor plugin only goes back a few releases AFAIK.
There was a problem hiding this comment.
Would you be the working group reviewer here?
There was a problem hiding this comment.
Gotcha. Usually I put the person with expertise here - so you - or you could put "Data WG" if you don't want your own name in the docs.
2 participants
Documentation for the user retirement feature: