doc: added deletion overview with very high level chart. #288

[panta-123]

Added the deletion overveiw in different chapter.

Few things I am not clear.

1. When setting TOMBSTONE by cleaner and undertaker , what is the value it sets. I look through the code and not clear to me.

2. The chart are very crude and may need some imporvement suggestion needed here.

[panta-123]

All the comments has been resolved !!

[bari12]

Just one more change :-)

[voetberg]

Thanks for the changes! 👍

[voetberg]

@bari12 Can you verify your requested changes are completed?

[bari12]

It's good. Thanks @panta-123 and @voetberg
You need to add the file to the sidebars.json though, otherwise it won't show up in the doc

[rdimaio]

Suggested change

	Each rule has a corresponding lifetime associated with it (default is None). The attribute `expires at` of the rule is the time when the lifetime is set plus the lifetime associated with rule.
	Each rule has a corresponding lifetime associated with it (default is None). The attribute `expires_at` of the rule is the time when the lifetime is set plus the lifetime associated with the rule.

[rdimaio]

Suggested change

	Deletion in rucio can be performed in broadly two ways.
	Deletion in Rucio can be performed in broadly two ways.

[rdimaio]

Suggested change

	The `Undertaker` daemon is responsible for handling expired dids. The daemon checks if none of the associated rules to the did are locked, if not it removes all rules of the did (see section above). The did itself is then removed from the catalog.
	The `Undertaker` daemon is responsible for handling expired DIDs. The daemon checks if none of the associated rules to the DID are locked, if not it removes all rules of the DID (see section above). The DID itself is then removed from the catalog.

[rdimaio]

Suggested change

	**The did expiration overrules the rule expiration. But the locked rules are protected.**
	**The DID expiration overrules the rule expiration. But the locked rules are protected.**

[rdimaio]

Suggested change

	The reaper daemon gets all the replicas with tombstone in the RSE and immediately delete all replicas.
	The reaper daemon gets all the replicas with tombstone in the RSE and immediately deletes all replicas.

[rdimaio]

Suggested change

	The reaper daemon first check if the free space is needed in the RSE. The needed free space is the difference of minimum free space (attrribute set for RSE) and actual free space in RSE. Deletion only occurs once free space is needed.
	The reaper daemon first checks if the free space is needed in the RSE. The needed free space is the difference of minimum free space (attrribute set for RSE) and actual free space in RSE. Deletion only occurs once free space is needed.

[rdimaio]

nit: all other filenames in this asset folder are lowercase; for consistency, this could be renamed to judge-cleaner.png

[rdimaio]

In case future changes need to be done, it would be great to have the source code for the flowcharts as part of the documentation repo. Maybe we could use Mermaid.js to handle this?

[rdimaio]

"Are rule locked?" should be "Is rule locked?"

[rdimaio]

also - "child(s)" should likely be "child(ren)"

[rdimaio]

"get list of all replica with tombstone" -> "get list of all replicas with tombstone"

[rdimaio]

There are two identical "get list of all replicas with tombstone" blocks; the chart could be simplified so that there is only one block, to which you can either get via "Is greedy? YES" or "needed_free_space >= 0"