FURMS System Administrator Manual

installDir

filesystem path on Ansible management host

Directory name where FURMS services will be installed e.g. "{{inventory_dir}}/services"

furmsVersion

string

Version of released FURMS software e.g. "1.0.0"

backupDir

filesystem path on Ansible management host

Directory name where FURMS backup files are stored by dedicated Ansible playbook. For more information go to Backup section.

trustStore

trustStore.file

filesystem path on Ansible management host

The JKS format keystore path.

trustStore.password

string

The password of the keystore type truststore

unity.host

string

The hostname or IP address for HTTP connections.

unity.port

integer [0-65535]

The HTTP port to be used.

unity.advertisedHost

string

The hostname or IP address (optionally with port), which is advertised externally. Examples: login.unity.com or login.unity.com:8443. If host is not advertised externally this value must be set to the unity.host:unity.port setting.

unity.initialAdminUsername

string

Username of the FENIX administrator to be installed in the system upon first installation. This is also the initial Unity-IdM administrator.

unity.initialAdminPassword

string

Password of the FENIX & Unity-IdM administrator to be installed to the empty database.

unity.proxyCount

integer [0 - 32]

If set to 0 then it is assumed then Unity-IdM server is not behind a proxy. Otherwise the number should specify the number of (local, trusted) proxies that are protecting the server from the actual clients. In effect the assumed client IP will be taken from the X-Forwarded-For header, stripping the trailing ones from intermediary proxies. Note that only proxy servers setting X-Forwarded-For are supported.

unity.pki.keyStore.file

filesystem path on Ansible management host

Credential location.

unity.pki.keyStore.type

[jks, pkcs12]

Format of the credential.

unity.pki.keyStore.password

string

Password required to load the credential. Keystore must use the same key password as the keystore password.

unity.db.host

string

The hostname or IP address (optionally with port) that points to the PostgreSQL instance e.g. localhost:5432

unity.db.dbName

string

PostgreSQL database name used by Unity-IdM instance.

unity.db.username

string

Unity-IdM database username.

unity.db.password

string

Unity-IdM database password.

unity.cIdP

unity.cIdP.clientId

string

Client identifier, obtained during Unity’s registration at the Central IdP.

unity.cIdP.clientSecret

string

Client secret, obtained during Unity’s registration at the Central IdP.

unity.cIdP.discoveryEndpoint

string

Central IdP OpenID Connect Discovery endpoint address, for production environment https://central-proxy.fenix-ri.eu/.well-known/openid-configuration and for the acceptance environment https://proxy.acc.fenix.eduteams.org/.well-known/openid-configuration

unity.mail

unity.mail.from

string

User name which will be used for From: field of the email. It is also used as SMTP envelope return address.

unity.mail.smtp.host

string

The SMTP server to connect to.

unity.mail.smtp.port

integer [0-65535]

The SMTP server port to connect to.

unity.mail.smtp.username

string

User name to authenticate SMTP connection. Optional value, when provided Unity-IdM attempts to authenticate the user using the AUTH command.

unity.mail.smtp.password

string

Password to authenticate SMTP connection. Optional value, must be defined when unity.mail.smtp.username is provided.

unity.mail.smtp.starttls

boolean

If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Optional parameter that defaults to true.

unity.mail.smtp.ssl

boolean

If set to true then SSL is used to connect with server. This parameter is optional with default value set to false.

unity.msgTemplates

unity.msgTemplates.configuration

filesystem path on Ansible management host

Unity message templates configuration file.

unity.msgTemplates.files

filesystem path on Ansible management host

Path to directory with HTML body files used by message templates.

furmsServer.host

string

The hostname or IP address for HTTP connections.

furmsServer.port

integer [0 - 65535]

The HTTP port to be used.

furmsServer.advertisedHost

string

The hostname or IP address (optionally with port), which is advertised externally. Examples: login.unity.com or login.unity.com:8443. If host is not advertised externally this value must be set to the furmsServer.host:furmsServer.port setting.

furmsServer.pki.keyStore.file

filesystem path on Ansible management host

Credential location.

furmsServer.pki.keyStore.type

[jks, pkcs12]

Format of the credential.

furmsServer.pki.keyStore.password

string

Password required to load the credential. Keystore must use the same key password as the keystore password.

furmsServer.db.host

string

The hostname or IP address (optionally with port) that points to the PostgreSQL instance e.g. localhost:5432

furmsServer.db.dbName

string

PostgreSQL database name used by FURMS service instance.

furmsServer.db.username

string

FURMS service database username

furmsServer.db.password

string

FURMS service database password

furmsServer.preSharedKeys.cIdP

The cIdP key is defined by FURMS administrator. The information entered here setup the base authentication credentials, used to access the FURMS REST API exposed for Central IdP.

furmsServer.preSharedKeys.cIdP.username

string

Username for Central IdP REST API credential

furmsServer.preSharedKeys.cIdP.password

string

Password for Central IdP REST API credential

furmsServer.broker

Configuration options to setup connection with the RabbitMQ.

furmsServer.broker.host

string

The hostname or IP address that points to the RabbitMQ instance.

furmsServer.broker.port

integer [0-65535]

RabbitMQ port to which to connect.

furmsServer.broker.username

string

RabbitMQ user to use when connecting.

furmsServer.broker.password

string

RabbitMQ password for this user

furmsServer.broker.virtualHost

string

RabbitMQ virtual host name to which to connect.

furmsServer.ui

Configuration of user interface related features.

furmsServer.ui.maxSessionInactivityInSeconds

integer (default 1800)

Optional value, that defines number of seconds where users inactivity cases the automatic logout operation from FURMS UI.

furmsServer.ui.secondsBeforeShowingLogoutWarning

integer (default 120)

Optional value that, defines number of seconds before the user is shown the warning message about automatic logout from FURMS UI.

furmsServer.layout

furmsServer.layout.cssStyle

filesystem path on Ansible management host

Optional value with custom CSS styles applied to FURMS UI.

furmsServer.layout.panels

furmsServer.layout.panels.top

filesystem path on Ansible management host

Optional value which provides HTML content of the top outer element displayed in the FURMS application.

furmsServer.layout.panels.bottom

filesystem path on Ansible management host

Optional value which provides HTML content of the bottom outer element displayed in the FURMS application.

furmsServer.layout.panels.left

filesystem path on Ansible management host

Optional value which provides HTML content of the left outer element displayed in the FURMS application.

furmsServer.layout.panels.right

filesystem path on Ansible management host

Optional value which provides HTML content of the right outer element displayed in the FURMS application.

${custom.name}

Policy document name

${custom.furmsUrl}

URL to FURMS that points to the User Settings → Policy Documents view

invitationNew.html

${custom.role}

FURMS role that invitee is requested to accept

${custom.furmsUrl}

URL to FURMS that points to the User Settings → Invitations view

registrationInvitation.html

${custom.role}

FURMS role that invitee is requested to accept

${url}

URL to Unity-IdM that points to the registration form

${custom.role}

FURMS role that invitee has accept/rejected

${custom.email}

Email address of person that either accepted or declined the invitation

applicationNew.html

${custom.projectName}

Project name for which user has requested membership

${custom.email}

Email address of person that requested membership to a project

${custom.furmsUrl}

URL to FURMS that points to particular project’s Users view

${custom.projectName}

Project name for which user has requested membership

resourceUsageAlarm.html

${custom.projectAllocationName}

Project allocation name for which alarm was raised

${custom.alarmName}

Name of the alarm which triggered notification

${custom.furmsUrl}

URL of FURMS project, which triggered the alarm

${custom.projectAllocationName}

Project allocation name for which alarm was raised

${custom.alarmName}

Name of the alarm which triggered notification