Page MenuHomeSoftware Heritage

docs: Add a reference authentication page to explain auth schemes
ClosedPublic

Authored by ardumont on Fri, Mar 26, 2:57 PM.

Details

Summary

Both basic and keycloak are supported through configuration now.

It's a reference docs so "dry explanation".

You can find the output schema in the following screenshot:

Related to T2858

Test Plan

make -C docs happy

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build is green

Patch application report for D5361 (id=19207)

Rebasing onto 39f3aef892...

Current branch diff-target is up to date.
Changes applied before test
commit 1ce4bdae17d615c060fc1cd73704f9fd6b194eee
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Fri Mar 26 14:54:30 2021 +0100

    docs: Add a reference authentication page to explain schemes
    
    Related to T2858

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/606/ for more details.

ardumont edited the summary of this revision. (Show Details)
anlambert added a subscriber: anlambert.

Looks good to me.

docs/authentication.rst
12

other parts

16

you should use permission instead of role

28

credentials

29

is allowed (to avoid the repetition)

This revision is now accepted and ready to land.Fri, Mar 26, 3:13 PM
  • Adapt according to review
  • update schema to use permission instead of role as well

Build is green

Patch application report for D5361 (id=19210)

Rebasing onto 39f3aef892...

Current branch diff-target is up to date.
Changes applied before test
commit 99ff706e7a3d39091a80a0bc6b053c91f2124a68
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Fri Mar 26 14:54:30 2021 +0100

    docs: Add a reference authentication page to explain schemes
    
    Related to T2858

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/607/ for more details.

ardumont retitled this revision from docs: Add a reference authentication page to explain schemes to docs: Add a reference authentication page to explain auth schemes.Fri, Mar 26, 5:23 PM
ardumont edited the summary of this revision. (Show Details)

Rework a bit to present basic first and explain the keycloak one after.

Build is green

Patch application report for D5361 (id=19216)

Rebasing onto 39f3aef892...

Current branch diff-target is up to date.
Changes applied before test
commit 82e56c9e3bbad50b9d0b07a6f1b258abc71464ec
Author: Antoine R. Dumont (@ardumont) <ardumont@softwareheritage.org>
Date:   Fri Mar 26 14:54:30 2021 +0100

    docs: Add a reference authentication page to explain auth schemes
    
    Both basic and keycloak are supported through configuration now.
    
    Related to T2858

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/608/ for more details.