Repository navigation
docs: Wave 2b fixes (B4 alerts/reports, B6 engines, B7 auth/roles; KI-260 onwards) - #30
Merged
Merged
Conversation
… to KI-266) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The cp-engine-* shots take DOCS_ENGINE and alerts/run-log takes RUN_LOG_ALERT, so a pass can point them at its own objects. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…#728 Generated from the openapi.json of #728's branch head (2021bff8), which is platform main plus #728. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Documentation for Wave 2b of the Known-issues fix programme. Every statement was checked against the platform PRs #726 (B4, alerts and reports delivery), #727 (B7, authentication, sessions and roles) and #728 (B6, engines and monitor): their descriptions, their diffs and the code on platform
main(40176006) and, for #728, its branch head.Pages changed (31, plus known-issues and the REST reference)
run-history.md(Success only when every destination took the message, Error otherwise; each failed destination named,webhook <host>only; Run now updates Last run and the badge, not Next run),notifications.md(when delivery fails: the grace table for all, some and no destinations reached; Slack without an app is an Error; subject withoutreport report),schedules.md(items due together run four at a time; grace starts from the last run that reached someone),reports.md(render limit 30 s per object plus 30 s and the timeout message, CSV/Text numbers like the table's defaults, subject rule),index.md,create-an-alert.md;dashboards/export-and-reports.mdtroubleshooting/cannot-sign-in.md(failures only, 5 per 5 minutes, the 429 body withRetry-After, Try again in N minutes, success clears the count; No workspaces yet, synced groups hold no role by themselves, verified email for pre-registration),authentication.md(openidonce,email_verifiedredemption, limiter),workspace-settings/members.md(add someone who has not signed in yet: Waiting for first sign-in, Withdraw, verified email only, workspace roles only; pickers list workspace roles, nodata_api_invoker),roles-and-permissions.md(9 permissions (7 inherited), Inherited from, whydata_api_invokeris missing),access-requests.md,control-plane/audit-log.md(opens on Changes and denials,hideAllowed,actorEmail,member:invite/member:uninvite),access-control/users.md(Disable confirmation; roles listed are direct grants only),access-control/index.md(Recent changes by email),faq.md,first-login-tour.md,quick-start.md,run-the-demo-stack.md,security-hardening.md,troubleshooting/index.md,configuration-keys.mdengines-and-ranger.md(/rangerroutes, per-engine Basic credential,auth_mode, operator token, plugin 2.8.0 floor, the XML with the credential lines),ranger-plugin.md(Authentication text, warnings, what you supply),security-hardening.md,kubernetes.md(the ingress routes/ranger),configuration-keys.md(ranger.auth_mode)query-engines/engine-detail.md(endpoint, containers on Docker, no Logs/Exec there, Review changes confirms the save, ingress Host required, Restart recreates an engine whose containers are gone, Monitor sign-in table and node fallback, catalog test runs as you on a JWT engine),provision.md(Worker 0, ingress host),query-engines/index.md(Endpoint column, demo-down/up),run-the-demo-stack.md(Restart afterdemo-down/demo-up),data-governance/lineage.md(new section How egret computes lineage: whoegret-lineageis served to and what it is granted),overview.md,classifications/view-exposure.mdscripts/gen-api-reference.mjs(separate commits): from platform main'sopenapi.jsonfor #726/#727 (auth.md: 429RateLimitedwithRetry-After;control-plane-audit.md:hideAllowed;workspace-members.md:invited,GET/DELETE /invites;index.md), then from #728's branch head2021bff8(main plus #728) forcontrol-plane-engines.md(endpoint,runtime, nullablenodes). #728 was still open when this was written; if itsopenapi.jsonchanges before it merges, regenerate from main.Known issues
Closed with a Status note: KI-032, KI-033, KI-034, KI-157, KI-167, KI-169, KI-173 (#726); KI-002, KI-017, KI-018, KI-019, KI-127, KI-142, KI-144, KI-145, KI-185, KI-209 (#727); KI-194, KI-195, KI-196, KI-197, KI-198, KI-199, KI-200, KI-201, KI-213 (#728). KI-021 closed as by design (the group is synced; a platform role comes only from an admin's grant to the group; the dev stack's seed makes it, the demo stack does not). KI-148 closed as no longer applying (since #713/#714
ranger.auth_tokenis only the operator bearer; plugins use per-engine Basic credentials). No S1 row is open; none was in this wave.Added at the end of the last table, each checked against platform code:
POST /ws/{ws}/membersstill acceptsdata_api_invoker(direct call or pre-registration) although the pickers hide itegret-monitorprobably sees no other user's queries (not reproduced)The catalog test (
SHOW SCHEMAS) running as the viewer on a JWT engine is described on the Engine detail page instead of a row: it is the intended sign-in, and the page says the test fails when the engine's policy does not let you read the catalog. The intro paragraph names the source of KI-260 to KI-266.Screenshots
Re-shot on the shared demo stack (
egret.localtest.me:18080, running #728's images; B7's UI is not in them), light, 1440×900, every PNG viewed:admin/cp-engine-overview,admin/cp-engine-monitor,admin/cp-engine-settings,admin/cp-engine-delete(a temporary enginedocs-w2b-trino, deleted afterwards; the shot scripts takeDOCS_ENGINEfor its name)alerts/run-log(run log ofb4-premise multi-destination: Error naming two failed destinations, then On grace;RUN_LOG_ALERTpicks the alert)sql-datasets/sqllab-error(line 1:35),ops/get-started/sql-lab-run(rows in order)Still out of date:
admin/cp-audit-log(no Changes and denials),admin/cp-user-detailandadmin/cp-users-bulk(no Disable confirmation),admin/ws-membersandadmin/ws-add-member(no Waiting for first sign-in, no SSO hint),admin/ws-roles-expanded(own permissions only),ops/get-started/sign-in/loginerror text.alerts/detail(Recent runs of an alert that no longer exists on the stack) andalerts/alerts-listkept: the stack's Default workspace now holds only theb4-test items, so a re-shot list would not show what the page describes.admin/gov-table-lineage, the Governance overview and View exposure shots (the stack has noanalytics.sessionsor view),admin/cp-engine-catalogs/cp-engine-workspaces(no docs seed),admin/cp-engine-logs(no longer referenced; Docker shows no Logs button).Not verified
docs/en/guides/ranger-surface.md, not observed on the stack.finance_reporter's count (9 permissions (7 inherited)) is inferred from theb7_reporterlive check of the same shape.The build passes for en and vi with
DOCUSAURUS_NO_PERSISTENT_CACHE=1 npm run build.🤖 Generated with Claude Code