Repository navigation
feat(ui): security access control, zero-knowledge guidance, FAQ, and interactive user guide - #49
Merged
Conversation
…and interactive user guide
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.
…d documentation alignment
…s from command replies
Collaborator
Author
|
@copilot review the pr |
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.
Summary
This pull request implements comprehensive security access controls, zero-knowledge pipeline guidance, official documentation routing, upstream wire parity fixes, and security advisory remediation for rekuiper:
Security & Access Control Guard (
crates/rekuiper-conf,crates/kuiperd,crates/rekuiper-server):enableUi: false) to meet zero-trust edge requirements.--enable-ui(--ui),--ui-allow-ip, and--ui-passwordCLI flags, environment variables, andkuiper.yamlconfig options.127.0.0.1,10.0.0.0/8,::1)./ui) and sensitive REST mutation endpoints (/rules,/streams,/connections, etc.) when password protection is configured.Upstream Wire Parity & Test Stability (
crates/rekuiper-server):auth_guardincrates/rekuiper-server/src/state.rsso JWT-authenticated requests return the exact wire-compatible error strings (Missing authorization header\n) expected by upstream client specifications while preserving UI password protection and fleet tokens.crates/rekuiper-server/tests/fvt_compat.rsfortest_issue14_shared_stream_multi_rule_no_duplicate_deliveryfrom 3s to 10s to eliminate test flakes under concurrent CI runner load.Security Advisory & Dependency Hygiene (
Cargo.lock,deny.toml):webpki-rootstov1.0.10and registered the transitive advisory exception with documentation indeny.toml.[workspace.package]metadata (description,homepage,repository,keywords,categories) across all 8 workspace crate manifests.Zero-Knowledge Pipeline Guidance & Usability (
crates/rekuiper-server/src/ui.html):openDoc()to route tohttps://rekuiper.indramqtt.comrather than the upstream repository, and added a topbarHelp & FAQbutton.Technical Documentation & Architecture (
docs/):docs/en_US/mqtt-rule-engine.mddetailing MQTT v3.1.1/v5.0 ingestion, streaming SQL rule execution, bounded channel backpressure, and single-core benchmark measurements, accompanied by an ASD-STE100 light-theme SVG architecture diagram.docs/en_US/guide/ui/web_console_user_guide.mdwith clean light-theme SVG architecture diagram and step-by-step walkthroughs.docs/en_US/faq.mdwith SVG architecture flow diagram.docs/.vitepress/config.mtsanddocs/directory.json, withrobots.txt, sitemap, and canonical link generation.Local CI Verification
All local CI checks were verified inside WSL and Windows:
cargo fmt --all -- --checkpassed cleanly.cargo deny check advisoriespassed with 0 unhandled advisories.rekuiper-coreandrekuiper-sql.cargo clippy --workspace --all-targets -- -D warningspassed with 0 warnings.rekuiper-conf,rekuiper-core,rekuiper-sql,rekuiper-connectors,rekuiper-mcp,rekuiper-cli,rekuiper-server, andkuiperdtests all passed cleanly.npm --prefix docs run buildcompleted with 0 errors.