Skip to content

Add EUROfusion access onboarding docs - #62

Open
krystophny wants to merge 4 commits into
mainfrom
slopqueue/019fe0933d8f-7d736f44
Open

Add EUROfusion access onboarding docs#62
krystophny wants to merge 4 commits into
mainfrom
slopqueue/019fe0933d8f-7d736f44

Conversation

@krystophny

Copy link
Copy Markdown
Member

Problem

Issue #18 tracks adding ITPcp members (Chris, Winny, Sergei, Max) to the
EUROfusion DevOps/Gateway infrastructure. There was nothing in the
repository documenting how EUROfusion access is obtained or verified, so
new members had no idea how to request an account and the checklist was
unverifiable from the repo.

Change

  • Add docs/eurofusion-access.md documenting the EUROfusion DevOps /
    Gateway access request route (via the group lead, not self-service),
    SSH key reuse, and the concrete commands each member should run to
    verify their account and — more importantly — their ITPcp group/project
    membership on the DevOps GitLab.
  • Link to it from the README ## Getting Started section, right after the
    existing SSH-key setup paragraph.

The exact Gateway/DevOps GitLab hosts intentionally come from the
account-grant mail rather than being guessed, so the doc cannot point
members at a wrong host; it instructs them to use the granted host.

Tests

Documentation-only change; no build or pytest surface is affected.
pytest tests/ is untouched.

Closes #18

Document how ITPcp members obtain and verify EUROfusion DevOps/Gateway
access (request route via group lead, SSH key reuse, access verification)
and link it from the README Getting Started section.

Closes #18
@krystophny

Copy link
Copy Markdown
Member Author

Review verdict: Request changes

Summary: Documentation-only change, but it does not satisfy the issue’s acceptance criteria because the core access instructions still contain unresolved host placeholders.

Findings:

  1. [major] docs/eurofusion-access.md:27,47,51 — The Gateway and DevOps GitLab hosts remain <gateway-host> and <eufus-gitlab-host>, so new members cannot follow or verify the documented setup. Replace them with the exact verified hosts from the account-grant documentation, or provide an authoritative route to obtain them.

Verdict: Request changes — the primary onboarding workflow is incomplete; no CI checks are configured for this commit.

Replace the unresolved <gateway-host> and <eufus-gitlab-host> placeholders
with the exact verified endpoints (EFGW Gateway at login.eufus.eu and the
CINECA-hosted EUROfusion DevOps GitLab SSH endpoint
gitlab-ssh.hpc.cineca.it) and document the authoritative UserDB account
grant route, so new members can follow and verify the onboarding steps.
@krystophny

Copy link
Copy Markdown
Member Author

Review verdict: Request changes

Summary: The documentation is clear and the Gateway details match the referenced issue and official CINECA guidance. CI was still running; no code or test changes are affected.

Findings:

  1. [major] docs/eurofusion-access.md:33 — The document names the DevOps GitLab SSH host but provides no web URL or project/group path for SSO. New members therefore cannot follow the required membership-verification step. Add the exact web URL and relevant ITPcp group/project.

Verdict: Request changes — the onboarding flow is incomplete without the DevOps GitLab web destination.

…tion

New members could not follow the membership-verification step because
the doc only named the SSH host gitlab-ssh.hpc.cineca.it with no web
destination. Add the exact CINECA-hosted web UI
(https://gitlab.hpc.cineca.it/) and the EUROfusion group URL
(https://gitlab.hpc.cineca.it/groups/eurofusion) under which the ITPcp
group/project membership is confirmed, in both the What-you-need bullet
and the verification step 3.
@krystophny

Copy link
Copy Markdown
Member Author

Review verdict: Request changes

Summary: Documentation-only change; the README link is appropriate, but the onboarding instructions contain an invalid UserDB hostname and omit the mandatory EFGW SSH-certificate/2FA setup. CI is still pending.

Findings:

  1. [major] docs/eurofusion-access.md:25-46 — userdb.cineca.it does not resolve; the linked CINECA documentation uses userdb.hpc.cineca.it. Additionally, current EFGW access requires a time-limited SSH certificate and 2FA, so reusing id_rsa alone will not make the Gateway command work. Correct the portal URL and document the step ssh login ... --provisioner efgw setup, distinguishing Gateway authentication from the GitLab SSH key.

Verdict: Request changes — new users cannot reliably follow the documented access procedure.

@krystophny krystophny left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review verdict: Comment

Summary: Documentation-only PR; the Gateway details match current CINECA documentation, but the access-status wording is inconsistent with issue #18, and CI is still running at NEO-2.

Findings:

  1. [minor] docs/eurofusion-access.md:19-21 — Says Chris, Winny, Sergei, and Max are current members “with access,” while issue #18 marks only Chris complete and explicitly says the others are unknown/untested. This can falsely indicate that access is already verified; describe them only as tracked members or update the issue with evidence.
  2. [minor] docs/eurofusion-access.md:48-53 — Recommends reusing the blank-passphrase id_rsa key. This inherits and reinforces insecure guidance from README; recommend a protected, dedicated key instead, or clearly document the security trade-off.

Verdict: Comment — the main documentation issues should be corrected, and CI completion is not yet available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add users to EUROfusion devops

1 participant