You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by "hanahmily (via GitHub)" <gi...@apache.org> on 2026/10/23 02:30:00 UTC

[I] [Feature] Canopy auth 6/6: auth design doc and README [skywalking]

hanahmily opened a new issue, #14164:
URL: https://github.com/apache/skywalking/issues/14164

   ## Summary (executable leaf 6/6 of #14001)
   
   Document Canopy's auth model as implemented by leaves 1–5: `canopy/docs/auth-design.md` and the `canopy/README.md` sections #14001 asks for. Depends on leaves 1–5.
   
   ## Required change
   
   1. `canopy/docs/auth-design.md` covering:
      - the `auth.*` / `session.*` config schema and its parity with Horizon's;
      - the resolution order (IdP bearer → API token → cookie session);
      - role re-resolution and caching (30 s success, never failure);
      - username as the credential anchor;
      - break-glass gating;
      - the argon2id (WASM) choice and bcrypt compatibility;
      - in-memory sessions and their restart behavior;
      - what is out of scope (LDAP/SAML, multi-IdP).
   2. `canopy/README.md`: every `CANOPY_AUTH_*` / config key with defaults, plus minimal working examples for `local`, `sso` (GitHub OAuth2 and a generic OIDC), tokens, and break-glass. Remove obsolete LDAP-centric or `CANOPY_USERS`-only notes, keeping the alias documented as deprecated.
   3. A link from the main BanyanDB docs where Canopy is described, if such a page exists.
   
   ## Acceptance criteria
   
   - [ ] Every config key the code reads appears in the README with its default. A Vitest test, or a script run in `npm test`, compares the schema's keys to the README table so they can't drift.
   - [ ] Examples parse with the real config loader (test).
   - [ ] Links are valid; `make check` passes.
   
   ## Out of scope
   
   Code changes beyond the doc-drift test.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Feature] Canopy auth 6/6: auth design doc and README [skywalking]

Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily commented on issue #14164:
URL: https://github.com/apache/skywalking/issues/14164#issuecomment-6356036540

   Merged into #14162 (Canopy auth 2/2) to keep each pull request a reviewable but not tiny unit.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Feature] Canopy auth 6/6: auth design doc and README [skywalking]

Posted by "hanahmily (via GitHub)" <gi...@apache.org>.
hanahmily closed issue #14164: [Feature] Canopy auth 6/6: auth design doc and README
URL: https://github.com/apache/skywalking/issues/14164


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org