Repository navigation
docs: reflect changes from lamassuiot#685 (chore(authz): add default actions, route constraints and OTEL tracing to the au…) - #28
Open
gh-lamassu-docsagent[bot] wants to merge 2 commits into
Conversation
Signed-off-by: Lamassu Docs Bot <lamassu-docs-bot@users.noreply.github.com>
Author
|
📖 Preview: https://www.lamassu.io/docs/pr-preview/pr-28/ Rebuilt on every push to this PR. May take a minute to appear after GitHub Pages picks up the |
This branch has not been deployed
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
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.
Documents the user-facing changes from lamassuiot/lamassuiot.
Source: lamassuiot/lamassuiot#685
Summary
Now let me examine the source diff for the user-facing files.
I now have a clear picture of the changes. Let me record verified facts and then assess existing docs coverage.
Now let me read the source repo's authz spec to ground the HTTP schema contract details.
Let me verify what the ext_authz controller actually logs, so any diagnostics documentation stays accurate.
Let me verify the precedence behavior against the tests in the source repo.
All behaviors verified against source code and tests. Let me record the plan, then edit the English page.
English page done. Now the Spanish page — the same five edits mirrored.
Both locales updated. Now the review pass — let me re-read the changed regions of both pages to verify structure and coherence.
Let me polish one sentence in both diagnostics sections, then verify the Spanish page.
One coherence improvement: the ext_authz decision flow should acknowledge the policy's own
param_constraintsin step 7, so readers don't assume route constraints are the only narrowing mechanism.Edits are complete. Running the build gate now.
I don't have a shell/execute tool available in this session, so I cannot invoke
./context/check-builddirectly. I'll compensate with a rigorous manual build-readiness verification of every construct the check would flag, and flag this clearly in the handoff (the application re-runs the same build gate after I finish).All JSX tags balanced, all code fences paired, and EN/ES structures align line-for-line. Let me confirm the step-7 edits landed and the frontmatter is intact in both files.
All verifications pass. Finalizing my working notes and then delivering the summary.
All done. Here is the summary.
Docs update summary (for the docs PR body)
Feature assessed:
lamassuiot/lamassuiot#685adds three user-facing HTTP authorization capabilities to theauthzengine: (1)skip_authz: trueroute flag (authentication required, policy grant skipped — e.g./openapi.json, health/version), (2) schema-levelbase_paths+default_action: allow|denyfallback for unmapped paths (the packaged Job Manager schema now ships with an explicitdeny), and (3)param_constraintson policy HTTP rules, pinning a granted action to a literal request value (regex-captured path segment, query, header, or JSON body field) independent of subject attributes. The PR body's "Known limitation" about cross-schemadefault_actionconflicts is stale — the shippedevaluateHTTPOverrideresolves route matching across all schemas before any fallback (covered byTestEngineCheckHTTPRequest_SchemaDefaultActionDoesNotOverrideOtherSchemasRoute), so the docs describe the implemented behavior. The OTEL additions are internal spans; they are surfaced in docs only as one diagnostics aid, not as a feature write-up.What changed:
platform/pki/access-control.mdxand its Spanish twinaccess-control.es.mdx(the single home of this feature; no new page, no sidebar change):skip_authz(auth still required first, no constraints allowed, wins over other schemas' routes/defaults) andbase_paths/default_action(explicit route anywhere wins; longest overlapping prefix decides; conflicting duplicate base paths fail schema load), plus a warning callout that these decisions bypass policies.param_constraintswith a worked example (grantingsystem-info-readonly for system1), its validation rules, fail-closed semantics, AND-combination, and backward compatibility.engine.CheckHTTPOpenTelemetry span (withauthz.allowedand matched policy/principal attributes) available when chart instrumentation is enabled.skip_authz/default_actionwhen integrating or upgrading a service.Locale pairing: English
…/access-control.mdxand Spanish…/access-control.es.mdxwere updated together with equivalent scope, examples, warnings, headings and structure (fence/Callout layouts align 1:1). Canonical routes touched (no new/renamed pages):/docs/platform/pki/access-controland/docs/es/platform/pki/access-control.Build-gate caveat: no shell/execute tool is exposed in this session, so I could not run
./context/check-buildmyself. I instead manually verified every failure mode the check targets for both edited files: frontmatter intact and valid, locale pairs correct,meta.jsonuntouched (in-page edits only), all JSX tags balanced (only pre-existing<Callout>/<Steps>/<Step>components, 7/7 open/close per file), all{/<confined to code spans or fences, noimport/exportadded, no internal links added, no pages created or deleted. The application's mandatory post-finish build performs the same gate before anything is published; in the preview, verifypr-<N>/platform/pki/access-control(both locales via the change switch).