Okta Integration

Okta is a authorization and authentication service provider using SAML.

To configure Spinnaker to use Okta, you will need to:

Configure a Spinnaker Application in Okta

Select Applications -> Applications from the top menu. Applications Screen

Click the green “Add Application” button. AddApplicationButton

Click the green “Create New App” button. CreateNewApp

In the dialog “Create a New Application Integration”, select the following values:

  • select Platform -> Web
  • select Sign on method -> SAML 2.0

Then hit the green “Create” button.

CreateNewIntegration

On “Create SAML Integration” page, enter an app name and hit the green “Next” button. CreateNewIntegration

On the “Configure SAML page”, configure the following settings:

  • Single sign on URL -> Enter the URL for your Gate service, with the path /saml/SSO. For example, https://oktaspinnaker.spinnaker.armory.io:8084/saml/SSO

  • Audience URI (SP Entity ID) -> Enter a unique entity id. For example, io.armory.spinnaker.oktatest

  • Name ID format -> For example, “EmailAddress”

  • Application username -> For example, “Email”

In the GROUP ATTRIBUTE STATEMENTS section:

  • Name = memberOf, Name format = Unspecified, Filter = Regex: .*

Then, hit the green “Next” button SamlSettings

On the Create SAML Integration Feedback page, select the “I’m an Okta customer adding an internal app” button, then hit the green “Finish” button. Feedback

This takes you to the “Sign On” tab of the application you just created.

You can navigate back to this page by going to applications -> applicationName -> Sign On tab. Click the button “View Setup Instructions”. This will display the page with configuration information necessary to configure Spinnaker. ViewSetupInstructions

Under the “Optional” section near the bottom, copy the contents of IDP metadata and save to file. For example, under /Users/armory/.hal/saml/metadata.xml. IDPmetadata

Configure Spinnaker to use Okta

1: Create a SAML keystore file

Generate a keystore and key with some password:

KEYSTORE_PATH=/Users/armory/.hal/saml/saml.jks
keytool -genkey -v -keystore $KEYSTORE_PATH -alias saml -keyalg RSA -keysize 2048 -validity 10000

2: Configure spinnaker to use SAML

KEYSTORE_PATH=/Users/armory/.hal/saml/saml.jks
KEYSTORE_PASSWORD=<password-entered-in-step-1>
METADATA_PATH=/Users/armory/.hal/saml/metadata.xml
SERVICE_ADDR_URL=https://<gate-URL>
ISSUER_ID=io.armory.spinnaker.oktatest

hal config security authn saml edit \
  --keystore $KEYSTORE_PATH \
  --keystore-alias saml \
  --keystore-password $KEYSTORE_PASSWORD \
  --metadata $METADATA_PATH \
  --issuer-id $ISSUER_ID \
  --service-address-url $SERVICE_ADDR_URL
    
hal config security authn saml enable

Note: The value you enter for issuerId must match the value entered in “Audience URI (SP Entity ID)” when configuring the app in Okta

Troubleshooting

Make sure the dns are correctly pointing to the loadbalancers of gate-URL and deck-URL.

Verify that the gate-URL is the one entered in Okta with :8084/saml/SSO appended to it.

Validate that the service-addess-url in your halconfig file is the gate-URL.