Configuring GitHub OAuth for Spinnaker

This post describes how to configure GitHub and Spinnaker to use GitHub as an OAuth2 authenticator.

Requirements:

  • Ability to modify developer settings for your GitHub organization
  • Access to Halyard
  • A Spinnaker deployment with DNS and SSL configured

Configuring GitHub OAuth

  1. Login to GitHub and go to Settings > Developer Settings > OAuth Apps > New OAuth App
  2. Note the Client ID / Client Secret
  3. Homepage URL: This would be the URL of your Spinnaker service e.g. https://spinnaker.acme.com
  4. Authorization callback URL: This is going to match your --pre-established-redirect-uri in halyard and the URL needs login appended to your gate endpoint e.g. https://gate.spinnaker.acme.com/login or https://spinnaker.acme.com/gate/login

Configuring Spinnaker

Operator

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
      preEstablishedRedirectUri: https://gate.spinnaker.acme.com/login
    provider: github

For additional configuration options review the Spinnaker Operator Reference

Halyard

Run the following commands in Halyard with your Client ID and Client Secret.

CLIENT_ID=a08xxxxxxxxxxxxx93
CLIENT_SECRET=6xxxaxxxxxxxxxxxxxxxxxxx59
PROVIDER=github

hal config security authn oauth2 edit \
  --client-id $CLIENT_ID \
  --client-secret $CLIENT_SECRET \
  --provider $PROVIDER \
  --scope read:org,user:email \
  --pre-established-redirect-uri "https://gate.spinnaker.acme.com/login"

hal config security authn oauth2 enable

Last modified August 31, 2020: docs(authn-github): Update 'Configuring GitHub OAuth for Spinnaker' page to include Operator section (#190) (a0f3f51)