canariecaf/docker-cds-core repository overview

⁠A Central Discovery Service

A Docker⁠ image for an 'as is' base of the v1.20.2 SWITCHwayf⁠ built on Ubuntu 14.04.

This image uses Supervisord the daemon to allow 2 processes to run

• apache2
• a cron daemon

The image is purposely configured clean with an simple configuration for SWITCHwayf with options to permit derivations to choose what they customize.

⁠Building the image

⁠The variables & their defaults

Environment variables with their defaults if they do not exist are:

• CDS_AGGREGATE - the aggregate to point at and ingest via the cron command
  • defaults to: https://caf-shib2ops.ca/CoreServices/caf_metadata_signed_sha256.xml⁠
• CDS_HTMLROOTDIR - the HTML root directory of the webserver
  • defaults to: /var/www/html
• CDS_HTMLWAYFDIR - the location in the container where the DS lives
  • default to: DS
• CDS_WAYFDESTFILENAME - the actual WAYF file to invoke
  • defaults to: CAF.ds
• CDS_OVERLAYURL - The zip file in URI format to retrieve (note you can use file:/// to refer to a local zip)
  • defaults to:
• CDS_COMMONDOMAIN - Domain within the WAYF cookie should be readable. Must start with a .
  • defaults to: .example.com
• CDS_DEVELOPMENTMODE - If the development mode is activated, PHP errors and warnings will be displayed
  • defaults to: false

⁠Decorating the image with runtime overrides

• CDS_AGGREGATE - the aggregate to point at and ingest via the cron command
  • defaults to: https://caf-shib2ops.ca/CoreServices/caf_metadata_signed_sha256.xml⁠
• CDS_HTMLWAYFFDIR - the location in the container where the DS lives
  • default to: DS
• CDS_REFRESHFREQINMIN - # of minutes between cron'd processing of the aggregate after intial fetch on start
  • defaults to: 5
• CDS_DEVELOPMENTMODE - If the development mode is activated, PHP errors and warnings will be displayed and shell scripts will have 'set -x' activated
  • defaults to: false

pass them in on the command line:

$ sudo docker run -e CDS_AGGREGATE=ttps://caf-shib2ops.ca/CoreServices/caf_metadata_signed_sha256.xml -e CDS_REFRESHFREQINMIN=5 -d -p 80:80 --restart=always canariecaf/docker-cds-core

⁠How to do a basic test?

Open browser and point to: http://localhost⁠ If everthing is fine you should see the default Service Discovery Page with your aggregate

Additionally, you can visit http://localhost/DS/status.txt⁠ This single row will indicate the last aggregate fetched,frequency of update, and entity counts of the last processed list.

⁠Known limitations

• WAYF filename extension must be '.ds'
  • If you want a different file name termination a specific regex needs to be applied in your ds.conf.template file and currently requires another container. This may be adjusted in future versions, but for now, this is a limitation that exists. If you resolve the technique for ANY regex to be applied, it will be considered as a feature enhancement in future versions