Configuring IBM Optim Data Privacy

Edit online

Configure IBM Optim Data Privacy by setting environment variables, customizing service parameters, and preparing identity and access management settings.

These configurations help to ensure that the platform operates correctly within your infrastructure and meets security and performance requirements.

Who needs to complete this task?: A system administrator with non-root access must configure the installation. The administrator should operate as a standard user, without using sudo or su to root commands.

Before you begin

Ensure that IBM Optim Data Privacy is installed.
Verify access to the installation directory and permission to edit configuration files.
Confirm that no port conflicts exist on your system.

Procedure

To configure IBM Optim, complete the following procedure:

Go to the installation directory where the IBM Optim files are located.
Open the .env file in a text editor to begin configuration.
Locate the OPTIM_METADB_DATA_DIR parameter and set its value to define where PostgreSQL stores its data files.

Review and, optionally, modify configuration parameters to suit your environment.

Parameter	Description	Default value
`OPTIM_UI_URL`	URL for accessing the IBM Optim UI	`http://localhost:7780`
`OPTIM_UI_PORT`	Port for the IBM Optim UI	`7780`
`OPTIM_LOG_LEVEL`	The logging level of the application. Valid values include: `DEBUG` `INFO` `ERROR`	`INFO`
`OPTIM_KEYCLOAK_PORT`	Port for Keycloak service	`7780`
`OPTIM_METADB_PORT`	Port for the metastore database (PostgreSQL)	`5432`

Check your system for port conflicts before saving the .env file.
The setup script generates a self-signed certificate and internal secrets to enable encrypted communication between containers. It stores these artifacts in the designated directories that it creates during setup.
- Certificates: Used for HTTPS and secure API calls
- Secrets: Used for container-to-container authentication
Note: Modify these files only if IBM Support instructs you to do so.
Run the following commands to stop and restart the IBM Optim containers so that they pick up the changes:
```
podman-compose -f optim-compose.yaml down
```
```
podman-compose -f optim-compose.yaml up -d
```
Open the .env file again and locate the OPTIM_UI_URL parameter.
Verify that the UI is accessible at the configured URL.

Note: For more information on advanced configurations, see the Keycloak documentation.

Results

IBM Optim is configured with the appropriate environment variables, authentication settings, and UI access parameters, ready for deployment and use.

What to do next

Use version control to track changes to the .env file.
Avoid hard-coding sensitive credentials; use secrets management tools.
Document any customizations for future maintenance.
Refer to the Keycloak documentation for advanced identity management configurations. For details, see the Keycloak documentation.
To enable multifactor authentication (MFA) for users, configure authentication policies in Keycloak. MFA is available but not enabled by default. For instructions, see Two-factor authentication with OTP in the Red Hat build of Keycloak documentation.