Developer Portal subsystem settings

You can specify advanced configuration options for the Developer Portal subsystem directly in the CR or with the Platform UI in Cloud Pak for Integration.

The IBM Cloud Pak Platform UI enables you to specify settings for the following areas:

For annotations, labels, node selectors, and tolerations, see Additional Kubernetes settings

Known limitation: When deployed on OpenShift or Cloud Pak for Integration, the API Connect Developer Portal subsystem does not support multiple hosts for the portalUIEndpoint endpoint, due to a limitation of Routes in OCP.

Database backups

Table 1. Database backup settings
Field Type Description
Credentials String For objstore, this is the name of your Kubernetes secret that was generated with your username and password for your backup database. For sftp, this is the secret that contains the credentials for your sftp username and password. Required if configuring backups.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Backup host String The S3 endpoint with the corresponding S3 region in the format <S3endpoint>/<S3region>. For example:
s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-standard

For sftp, this is the sftp server host name.

Required if configuring backups.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Backup path String For objstore, the name of your S3 bucket to store backup data. For example: test-bucket/restore-test. For sftp, this is the path to the folder on the sftp server.

Required if configuring backups.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Backup port Integer This is the port for the protocol to connect to the host. There is no default.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Backup protocol String Choose the protocol (sftp or objstore) you wish to use to communicate with your remote backup endpoint. Objstore is recommended for most reliability. There is no default.

This field must be set to either sftp or objstore to configure backups.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Backup schedule String This is the schedule in cron string format for how often automatic Developer Portal backups are run. For example:
0 /3  * * *
means at minute 0 past every 3rd hour. There is no default.

Required if configuring backups.

See also Backing up and restoring the Developer Portal in a Kubernetes environment.

Site name

Table 2. Site name
Field Type Description
Site name string Site name is the logical name of the failure domain of this portal subsystem. Typically site name is the name of your data center, such as Amazon AZ. The default is a randomly generated name.