dagsthuhl: Deposit client configuration

Original demand [3]

staging:

• client: They need to create their staging account in the staging keycloak realm: dagpub-swh-staging
• Awaiting domain and provider url from client:
  • provider_url: https://submission-dev.dagstuhl.de/
  • domain: submission-dev.dagstuhl.de
• Add swh.deposit.api role to user in keycloak in staging realm
• deposit db: Create deposit api collection & client [2] (requires domain and provider url first)
• Ask client whether the deposit access is ok

production:

• client: They need to create their staging account in the staging keycloak realm: dagpub-swh
• Awaiting domain and provider url from client:
  • provider_url: https://doi.org/10.4230/ => To update
  • domain: submission.dagstuhl.de
• Add swh.deposit.api role to user in keycloak in staging realm
• deposit db: Create deposit api collection & client [2] (same as staging)
• Ask client whether the deposit access is ok

[1] https://docs.softwareheritage.org/devel/swh-deposit/api/register-account.html#as-a-sysadm

[2] Output sample cli

swhdeposit@deposit:~$ swh deposit admin \
  --config-file $SWH_CONFIG_FILENAME \
  --platform production \
  user create \
    --collection "<collection>" \
    --username "<username>" \
    --provider-url <url-tbd> \
    --domain "<domain>"
Collection '<collection>' exists, skipping.
Create user '<username>'.
User '<username>' created.

[3] as per @vlorentz 's email for dagstuhl deposit user

Valentin Lorentz 3:51 PM (0 minutes ago) to Ramy-Badr, Antoine

Now you need a sysadmin to grant you permission to send deposits.

Can you tell ardumont (CCed) the base URL you want to use for your
deposits, and your logins? (dagpub-swh and dagpub-swh-staging on Prod
and Staging respectively, I believe)

Then ardumont will tell you the URL to send the deposits to

On 08/03/2024 15:46, Ramy-Badr Ahmed wrote:
> Ah yes right, it was my mistake I tried it out as sysadm. Thanks :)
>
> But now it redirects me to the usual "Welcome to the Software Heritage
> archive "  webpage after successful authentication. I guess I once saw a
> UI for depositing metadata (or browsing) as clients, does that exist?
>
> As a first step, I should  follow these steps now:
> https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-meta-deposit.html . right?
>
> I currently have got only the XML format (converted from codemeta). Then
> I should POST it
>
> Kind regards,
> Ramy

added activity::MRO label

Follow up:

For our "Provider URLs" .. Can you please consider :

1. Staging:           https://submission-dev.dagstuhl.de/
2. Production:     https://submission.dagstuhl.de/

Our logins are as Valentin has mentioned:

1. Staging:           dagpub-swh-staging
2. Production:     dagpub-swh

changed title from Deposit client configuration to dagsthuhl: Deposit client configuration

Probably a follow-up from [1]

[1] #4693 (closed)

changed the description

marked the checklist item Add swh.deposit.api role to user in keycloak in staging realm as completed

marked the checklist item deposit db: Create deposit api collection & client [2] (requires domain and provider url first) as completed

marked the checklist item Ask client whether the deposit access is ok as completed

The users required are already configured in staging [1] [2] and production [3] [4].

[1]

2024-03-08 16:17:41 swh-deposit@db1:5432 λ select * from deposit_client dc inner join auth_user u on u.id=dc.user_ptr_id where username='dagpub-swh-staging';
+-------------+-------------+-------------------------------------+-------------+----+----------+------------+--------------+--------------------+------------+-----------+-------+----------+-----------+-------------------------------+
| user_ptr_id | collections |            provider_url             |   domain    | id | password | last_login | is_superuser |      username      | first_name | last_name | email | is_staff | is_active |          date_joined          |
+-------------+-------------+-------------------------------------+-------------+----+----------+------------+--------------+--------------------+------------+-----------+-------+----------+-----------+-------------------------------+
|          15 | {13}        | https://submission-dev.dagstuhl.de/ | dagstuhl.de | 15 |          | (null)     | f            | dagpub-swh-staging |            |           |       | f        | t         | 2023-06-23 10:14:11.689101+00 |
+-------------+-------------+-------------------------------------+-------------+----+----------+------------+--------------+--------------------+------------+-----------+-------+----------+-----------+-------------------------------+
(1 row)

Time: 5.485 ms

[2]

[3]

2024-03-08 16:22:02 softwareheritage-deposit@albertina:5432 λ select * from deposit_client dc inner join auth_user u on u.id=dc.user_ptr_id where username='dagpub-swh';
+-------------+-------------+---------------------------------+-------------+----+----------+------------+--------------+------------+------------+-----------+-------+----------+-----------+-------------------------------+
| user_ptr_id | collections |          provider_url           |   domain    | id | password | last_login | is_superuser |  username  | first_name | last_name | email | is_staff | is_active |          date_joined          |
+-------------+-------------+---------------------------------+-------------+----+----------+------------+--------------+------------+------------+-----------+-------+----------+-----------+-------------------------------+
|           9 | {8}         | https://submission.dagstuhl.de/ | dagstuhl.de |  9 |          | (null)     | f            | dagpub-swh |            |           |       | f        | t         | 2023-06-23 10:32:59.633149+00 |
+-------------+-------------+---------------------------------+-------------+----+----------+------------+--------------+------------+------------+-----------+-------+----------+-----------+-------------------------------+
(1 row)

Time: 6.120 ms

[4]

marked the checklist item Ask client whether the deposit access is ok as incomplete

marked the checklist item client: They need to create their staging account in the staging keycloak realm: dagstuhl-swh as completed

marked the checklist item Awaiting domain and provider url from client: as completed

marked the checklist item provider_url: https://submission.dagstuhl.de/ as completed

marked the checklist item domain: submission.dagstuhl.de as completed

marked the checklist item Add swh.deposit.api role to user in keycloak in staging realm as completed

marked the checklist item deposit db: Create deposit api collection & client [2] (same as staging) as completed

changed the description

marked the checklist item Ask client whether the deposit access is ok as completed

marked the checklist item Ask client whether the deposit access is ok as completed

closed

mentioned in issue swh/devel/swh-deposit#4629 (closed)

changed the description

reopened

I noticed the users are dagpub-swh (dagpub-swh-staging) and not dagstuhl-swh as mentioned in the description. I've adapted the description too (since the actual users in keycloak matched the formers).

I'll attend to the update of the provider-url.

changed the description

marked the checklist item provider_url: https://doi.org/10.4230/ => To update as completed

[x] provider_url: https://doi.org/10.4230/ => To update I'll attend to the update of the provider-url.

2024-11-12 10:50:35 *softwareheritage-deposit@albertina:5432 λ select * from deposit_client where user_ptr_id=9;
+-------------+-------------+--------------------------+-------------+
| user_ptr_id | collections |       provider_url       |   domain    |
+-------------+-------------+--------------------------+-------------+
|           9 | {8}         | https://doi.org/10.4230/ | dagstuhl.de |
+-------------+-------------+--------------------------+-------------+
(1 row)

Time: 4.437 ms

closed