Skip to content

docs(runbooks): connector credentials setup (GitHub App, Slack, Discord) - #1738

Merged
lilyshen0722 merged 1 commit into
mainfrom
wren/connector-credentials-runbook
Sep 18, 2026
Merged

lilyshen0722 merged 1 commit into
mainfrom
wren/connector-credentials-runbook

Conversation

@lilyshen0722

Copy link
Copy Markdown
Contributor

Runbook for what the 2026-09-17/18 connector setup taught, per Sam's pod ask (69418). Docs only: one new file, docs/runbooks/connector-credentials-setup.md, read against main cda51208.

Contents:

  • §0 the two cross-cutting rules: one missing remoteRef freezes the whole api-keys ExternalSecret (create SM values → merge mapping → deploy), and the cutover is the new pod's startTime, not the workflow tick; checks by presence + length only.
  • §1 GitHub App: permission set derived from the eight broker tools (issues / pull_requests / contents write, metadata read), webhook off, install on the target repo only, the three SM names api-keys.yaml maps, the fix(helm): map GitHub App credentials #1716 chart shape and hold rule, out-of-band JWT → installation-token verification, post-deploy acceptance.
  • §2 Slack: reuse of the existing app; manifest API with a 12-hour App Configuration Token (export → merge → validate → update) and what to merge (redirect, scopes, /commonly); the five SM names behind slack.oauth.enabled and the k1:<base64> ring format; chore(helm): enable Slack OAuth secrets on dev #1725 shape; why the events request_url must wait for the signing secret to be deployed (/events sits behind the signed middleware, so the url_verification challenge 401s before it); socket mode off after the deploy.
  • §3 Discord: verify_key read via GET /applications/@me with the bot token from inside the pod, one SM name, fix(helm): wire Discord webhook public key #1685 shape; pointers into docs/discord/DISCORD_APP_SETUP.md and docs/discord/DISCORD_INTEGRATION_ARCHITECTURE.md.
  • §4 one-page order of operations.

No secret values, no project or cluster identifiers, no hostname beyond api.commonly.me (grep-checked). Pointers into docs/slack/README.md (legacy ingest path) and the Discord docs where they already say it.

Gate: Vera. Merge: Sam.

🤖 Generated with Claude Code

… Discord

What the 2026-09-17/18 setup taught, written as operational how-to: the
ESO one-missing-remoteRef trap and the pod-startTime cutover rule; the
GitHub App permission set, webhook-off, repo-scoped install, three SM
names and the #1716 chart shape; the Slack manifest-API path with a
12-hour App Configuration Token, the five SM names behind
slack.oauth.enabled, why the events request_url waits for the signing
secret to be deployed, and the post-deploy socket-mode switch; the
Discord verify_key read via GET /applications/@me and its one SM name.
No secret values, no project or cluster identifiers.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@lilyshen0722
lilyshen0722 merged commit 15bbd6d into main Sep 18, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant