Skip to content

docs(baton): show how to mount GitHub App private key in Kubernetes - #465

Merged
mindymo merged 1 commit into
mainfrom
docs/github-app-key-volume-mount
Aug 20, 2026
Merged

docs(baton): show how to mount GitHub App private key in Kubernetes#465
mindymo merged 1 commit into
mainfrom
docs/github-app-key-volume-mount

Conversation

@mindymo

@mindymo mindymo commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The GitHub and GitHub Enterprise Cloud self-hosted setup guides both reference BATON_APP_PRIVATEKEY_PATH but never show how to get the private key file onto the connector container's filesystem at that path.
  • Adds a Secret manifest holding the key file contents, plus a volumeMounts/volumes example in the Deployment manifest, mirroring the existing pattern in successfactors-scim.mdx and the Kubernetes secret-volume guide.
  • Reported by an SRE who noticed the gap while configuring the GitHub connector in service mode.
  • Also brought the GitHub Enterprise Cloud self-hosted section up to the same level of detail as GitHub's (full Secret + Deployment YAML) since it previously only had a loose list of env vars with no working example.

Test plan

  • Docs-only change; visually reviewed rendered YAML blocks for correct indentation/fencing.

Both the GitHub and GitHub Enterprise Cloud self-hosted setup guides
referenced BATON_APP_PRIVATEKEY_PATH without showing how the key file
actually gets onto the container filesystem. Add a Secret + volume
mount example, consistent with the pattern already used in
successfactors-scim.mdx.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
conductorone 🟢 Ready View Preview Aug 20, 2026, 9:30 PM

@mindymo
mindymo requested a review from ennyjfrick August 20, 2026 21:29
@mindymo

mindymo commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator Author

@ennyjfrick if you approve these changes, we'll also need to update the upstream docs in the baton-github and baton-github-enterprise-cloud connector repos so they stay in sync.

@ennyjfrick ennyjfrick left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@mindymo
mindymo merged commit 59c4d11 into main Aug 20, 2026
3 checks passed
@mindymo
mindymo deleted the docs/github-app-key-volume-mount branch August 20, 2026 22:29
@mindymo

mindymo commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator Author

Follow-up done: opened upstream ports of this fix —

(Note: the enterprise-cloud connector repo is actually named baton-axiomatic-github-enterprise-cloud, not baton-github-enterprise-cloud as referenced in the earlier PR comment.)

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.

2 participants