Docker compose

tags:

administration
reference
kubernetes
docker image
docker compose

Docker monolith image packaging for Gluu Flex. This image packs janssen services including the auth-server, config-api, fido2, casa, scim and the Gluu admin ui.

#Pre-requisites

#Versions

See Releases for stable versions. This image should never be used in production. For bleeding-edge/unstable version, use gluufederation/monolith:0.0.0-nightly.

#Environment Variables

Installation depends on the set of environment variables shown below. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values.

ENV	Description	Default
`CN_HOSTNAME`	Hostname to install gluu with.	`demoexample.gluu.org`
`CN_ADMIN_PASS`	Password of the admin user.	`1t5Fin3#security`
`CN_ORG_NAME`	Organization name. Used for ssl cert generation.	`Gluu`
`CN_EMAIL`	Email. Used for ssl cert generation.	`team@gluu.org`
`CN_CITY`	City. Used for ssl cert generation.	`Austin`
`CN_STATE`	State. Used for ssl cert generation	`TX`
`CN_COUNTRY`	Country. Used for ssl cert generation.	`US`
`CN_INSTALL_MYSQL`	Install gluu with mysql as the backend	`false`
`CN_INSTALL_PGSQL`	Install gluu with Postgres as the backend	`false`
`CN_INSTALL_ADMIN_UI`	Installs the Admin-UI	`true`
`CN_INSTALL_CONFIG_API`	Installs the Config API service.	`true`
`CN_INSTALL_SCIM`	Installs the SCIM API service.	`true`
`CN_INSTALL_FIDO2`	Installs the FIDO2 API service.	`true`
`RDBMS_DATABASE`	RDBMS gluu database for MySQL or Postgres.	`gluu`
`RDBMS_USER`	RDBMS database user for MySQL or Postgres.	`gluu`
`RDBMS_PASSWORD`	RDBMS database user password for MySQL or Postgres.	`1t5Fin3#security`
`RDBMS_HOST`	RDBMS host for MySQL or Postgres.	`mysql` which is the docker compose service name
`TEST_CLIENT_ID`	ID of test client in UUID which has all available scopes to access any gluu API	`9876baac-de39-4c23-8a78-674b59df8c09`
`TEST_CLIENT_SECRET`	Secret for test client	`1t5Fin3#security`
`TEST_CLIENT_TRUSTED`	Trust test client	`true`
`TEST_CLIENT_REDIRECT_URI`	Not Implemented yet Redirect URI for test client. Multiple uri's with comma may be provided, if not provided redirect uris will be same as the config-api-client	``

#How to run

Download the compose file of your chosen persistence from mysql or postgres

wget https://raw.githubusercontent.com/GluuFederation/flex/main/docker-flex-monolith/flex-mysql-compose.yml 
wget https://raw.githubusercontent.com/GluuFederation/flex/main/docker-flex-monolith/flex-postgres-compose.yml

Download the script files


wget https://raw.githubusercontent.com/GluuFederation/flex/main/docker-flex-monolith/up.sh
wget https://raw.githubusercontent.com/GluuFederation/flex/main/docker-flex-monolith/down.sh
wget https://raw.githubusercontent.com/GluuFederation/flex/main/docker-flex-monolith/clean.sh

Give execute permission to the scripts chmod u+x up.sh down.sh clean.sh

This docker compose file runs two containers, the flex monolith container and mysql container.

To start the containers.

./up.sh #You can pass mysql|postgres as an argument to the script. If you don't pass any, it will default to mysql.

To view the containers running


docker compose -f flex-mysql-compose.yml ps

To stop the containers.

./down.sh #You can pass mysql|postgres as an argument to the script. If you don't pass any, it will default to mysql.

#Configure Gluu flex

Access the Docker container shell using:

docker compose -f flex-mysql-compose.yml exec flex /bin/bash #This opens a bash terminal in the running container

You can grab client_id and client_pw(secret), and other values from setup.properties or /opt/jans/jans-setup/setup.properties.last
Use the CLI tools located under /opt/jans/jans-cli/ to configure Gluu flex as needed. For example you can run the TUI:
```
python3 /opt/jans/jans-cli/config-cli-tui.py
```

#Access endpoints externally

Add to your /etc/hosts file the ip domain record which should be the ip of the instance docker is installed at and the domain used in the env above CN_HOSTNAME.

# For-example
172.22.0.3      demoexample.gluu.org

After adding the record you can hit endpoints such as https://demoexample.gluu.org/.well-known/openid-configuration

#Clean up

Remove setup and volumes

./clean.sh #You can pass mysql|postgres as an argument to the script. If you don't pass any, it will default to mysql.