Feature #17313

[Documentation] improve federation documentation

Added by Ward Vandewege 3 months ago. Updated 2 months ago.

Status:
New
Priority:
Normal
Assigned To:
Category:
-
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)
Story points:
-

Description

The Architecture page at https://doc.arvados.org/v2.1/architecture/federation.html and the admin section at https://doc.arvados.org/v2.1/admin/federation.html have considerable overlap, but neither clearly lays out the types of federation and what some example use cases are.

We should upgrade the Architecture page to an entire Federation section, with these pages:

For each federation type the page needs to clarify:

  • when this type of federation is appropriate
  • how to configure the clusters involved
  • what the functional impact is (e.g. multisite search works in this particular way, login works like this, what happens when a user on cluster a requests a uuid that lives on another cluster, what happens when a workflow does that, etc)
  • security considerations

Needless to say, it's fine to say "not yet implemented" for stuff that does not work.


Subtasks

Task #17326: ReviewNewLucas Di Pentima


Related issues

Related to Arvados - Bug #17314: [API] [controller] [Workbench] 404 on foreign user UUID in admin interfaceNew

History

#1 Updated by Ward Vandewege 3 months ago

  • Description updated (diff)

#2 Updated by Ward Vandewege 3 months ago

  • Related to Bug #17314: [API] [controller] [Workbench] 404 on foreign user UUID in admin interface added

#3 Updated by Peter Amstutz 3 months ago

  • Target version changed from To Be Groomed to 2021-02-17 sprint

#4 Updated by Peter Amstutz 3 months ago

  • Assigned To set to Ward Vandewege

#5 Updated by Ward Vandewege 3 months ago

  • Target version changed from 2021-02-17 sprint to 2021-03-03 sprint

#6 Updated by Ward Vandewege 3 months ago

  • Target version changed from 2021-03-03 sprint to 2021-03-17 sprint

#7 Updated by Peter Amstutz 2 months ago

  • Target version deleted (2021-03-17 sprint)

Also available in: Atom PDF