cp-sso

Documentation is WORK IN PROGRESS
SAP Cloud Platform deployable Keycloak secured sample system that deploys multiple microservices that take advantage of the built in search index, geospatial and text analysis libraries in SAP HANA to query a data export from the The Armed Conflict Location & Event Data Project

Requirements

• For deployment on SAP Cloud Platform, a configured CloudFoundry cli with access to a user or trial account
• For deployment on SAP Cloud Plaform, Keycloak requires a hosted Postgresql backend. Project built with free tier instance from Amazon RDS
• Registration email feature in Keycloak requires a sendmail server. Project built with Amazon SES
• Map integration frontend with SAP HANA requires a Mapbox api token. Can be created for free at Mapbox

Keycloak container

• Deployed with cf-keycloak.sh

  • Default vendor, user and database are all postgres
  • PG_ADDR variable is just the hostname or ip address: sample-app.abcdefg.us-east-1.rds.amazonaws.com

• Keycloak security is disabled by default

Build

• Requires a PostgreSQL backend.

  This project was developed with a free tier Amazon RDS instance.

• Run the build script to copy over the custom CoreUI based theme

cd keycloak
./docker-build.sh

Run

• Update keycloak/docker-run.sh to have the values for your PostgreSQL instance.

  PG_ADDR and PG_PASSWORD are externalized to environment variables to avoid being checked into source control

cd keycloak
./docker-run.sh

Development

• Make sure the keycloak container is running. Get the id of the running container from this command

docker ps -f ancestor=quay.io/mechevarria/keycloak-coreui | awk '{print $1}'

• Copy the over the theme directory from the container by replacing $container with the value from the previous command. The system themes are automatically ignored by git

docker cp $container:/opt/jboss/keycloak/themes keycloak/

• Build a development image (turns off caching of pages)

cd keycloak
./docker-build-dev.sh

• Run the development image (mount the local themes directory)

cd keycloak
./docker-run-dev.sh

• Changes made locally to keycloak/themes will be seen when you refresh server pages in your browser.

SAP HANA Container

• Deployed with cf-db.sh
• A container named hdi-hana-deployer will be created in SAP Cloud Platform to deploy the hana database, populate data and create tables, indexes, etc. The container will then be stopped once complete

Springboot Container

Requires the SAP HANA database container to be deployed. Local development requires the SAP HANA host to whitelist external addresses

• Deployed with cf-springboot-api.sh
• Change the KEYCLOAK environment variable to true to enable sso integration
• Development tools are already integrated. To run use

springboot-api/local-run.sh

Express Container

Requires the SAP HANA database container to be deployed. Local development requires the SAP HANA host to whitelist external addresses

• Deployed with cf-express-api.sh
• Change the KEYCLOAK environment variable to true to enable sso integration

nginx Angular Container

Requires the Springboot and Express containers to be deployed

• Deployed with cf-nginx-angular.sh
• Change the KEYCLOAK environment variable to true to enable sso integration