Sequence diagram of a registered install - #226
Merged
Merged
Conversation
The standalone diagram shows the Federation never being contacted. This is the other case, and the opaque one: answering yes to the registration sets off a chain of calls to three services, and until now nothing said what was created on the operator's behalf or which of it their Endpoint uses. It follows the run from the first prompt to the metrics going out, opens up what happens inside POST /ep/simple — Keycloak client, group with the registering user as administrator, staging-catalog token, Affinities entry — and lists the .env values that differ from a standalone install, with where each comes from.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #225.
The companion to the standalone diagram: the same lightest install — no local catalog, defaults everywhere — but registered with the Federation.
The part worth having is what the registration itself does. Answering yes sets off a chain of calls the operator never sees, across three services a standalone install never touches:
ep-<config-id>, confidential;ndp_ep/ep-<config-id>, with the registering user as its administrator;The diagram shows each of them, and the page then says which the Endpoint actually uses: the group gates every write through
GROUP_NAMES, the staging token lands inPRE_CKAN_API_KEY, and the client is created but not used — its tokens carry nosubclaim, so sign-in through it fails after a successful login (#219, and why the installer stopped offering it in 0.34.3).Also: the
.envvalues that differ from a standalone install and where each comes from, and the trap that a token minted before the group existed does not carry it — so a fresh one has to be copied after registering, or writes are denied for reasons that look like an Endpoint fault.Verified
Drawn from an actual registered install performed today, not from reading the code: the configuration id it printed, the record the Federation holds for it, the rendered
.env(21 values set), the container answering/healthand/ready, and four metrics reports already accepted with 201. The Mermaid source renders throughmermaid-cli.