Configure GitHub OAuth for Spinnaker
Configure GitHub and Spinnaker to use GitHub as an OAuth2 authenticator.
Before you begin
- You have the ability to modify developer settings for your GitHub organization.
- You have a SpinnakerTM instance with DNS and SSL configured.
Configure GitHub OAuth in GitHub
Follow the instructions in GitHub’s Creating an OAuth App guide.
- Homepage URL: This is the URL of your the Gate service; for example,
https://gate.spinnaker.acme.com
. - Authorization callback URL: The URL needs
login
appended to your Gate endpoint; for example,https://gate.spinnaker.acme.com/login
orhttps://spinnaker.acme.com/gate/login
.
Configure GitHub OAuth in Spinnaker
Add the following snippet to your SpinnakerService
manifest under the spec.spinnakerConfig.config.security.authn
level:
oauth2:
enabled: true
client:
clientId: a08xxxxxxxxxxxxx93
clientSecret: 6xxxaxxxxxxxxxxxxxxxxxxx59 # Secret Enabled Field
scope: read:org,user:email
provider: GITHUB
Review the Armory Continuous Deployment Manifest Configuration Reference for additional configuration options.
What’s next
Feedback
Was this page helpful?
Thank you for letting us know!
Sorry to hear that. Please tell us how we can improve.
Last modified December 9, 2022: (77a2e500)