Management subsystem settings

You can specify advanced configuration settings for the Management subsystem

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

Note: Optionally, you might want to increase the timeout settings for management endpoints, particularly for large deployments. See Configuring timeouts for management endpoints.

Database backup

Table 1. Database backup
Field Type Required Description
Credentials Drop down menu No. Optional
  • For objstore type backups, the name of the Kubernetes secret containing your S3 Access Key / Key Secret
  • For SFTP type backups, the name of the Kubernetes secret containing your SFTP Username/password

Default: (Generated Value)

See Configuring backup settings for fresh install of the Management subsystem.
Server hostname String No. Optional The backups host:
  • For objstore type backup, specify 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 type, the SFTP server hostname. For example: 203.0.113.0 or example.com
  • Not required for local storage backups

Default: none

See Configuring backup settings for fresh install of the Management subsystem.
Path String No. Optional The path to the location of the backup:
  • For objstore backups, the name of your S3 bucket to store backup data. For example, bucket-name/folder. The use of subdirectories in the bucket name is not supported.

    Ensure that bucket-name/folder is empty. If the folder was previously used for backups, the folder will not be empty, and stanza create might encounter an error.

  • For sftp type, the folder name on the SFTP server. For example: mgmt_backup.
  • Not required for local storage backups

Default: none

See Configuring backup settings for fresh install of the Management subsystem.
Server port String No. Optional Backup server port

The port for the protocol to connect to the host. The backup port is not required for object storage. Default: 22

See Configuring backup settings for fresh install of the Management subsystem.
Protocol String No The type of the backup. Supported types:
  • objstore
  • sftp

    The default value is sftp.

  • Local storage backups

    For local backups, do not specify this parameter. When the parameter is set to "", the backup type is set to local storage backup.

See Configuring backup settings for fresh install of the Management subsystem.
Restart database Toggle Switch No. Optional Flag to accept database reconfiguration. Restarting the database is required when changing the backup configuration. When marked true and the new backup configuration differs, the operator will stop the database and any dependent services, apply the change, and restart the stopped components.

Defaults to Off.

For more information on restarting the database, see Reconfiguring or adding backup settings after installation of the management subsystem
Retries String No. Optional For sftp type backups only, the number of times the ibm-apiconnect Operator attempts backups in the event of a failed SFTP backup.

Not used for objstore or local storage backup.

Default value: 0.

See Configuring backup settings for fresh install of the Management subsystem.
S3 provider type Drop down menu Required when using s3 provider. Name of the S3 provider to use. Not required for local backups or SFTP backups.

If you are configuring backups with an s3provider, you must specify one of the supported values of aws or ibm.

See Configuring backup settings for fresh install of the Management subsystem.
Schedule String No. Optional Cron like schedule for performing automatic backups. The format for the schedule is:
  • * * * * *
  • - - - - -
  • | | | | |
  • | | | | +----- day of week (0 - 6) (Sunday=0)
  • | | | +------- month (1 - 12)
  • | | +--------- day of month (1 - 31)
  • | +----------- hour (0 - 23)
  • +------------- min (0 - 59)

The backup schedule defaults to 0 0 * * *. This means a backup is run every day at midnight and minute zero UTC.

When you configure a host, if you do not specify a value for schedule, the default backup schedule is automatically set. Note that the default backup schedule is not set, and scheduled backups not enabled, until host configuration is completed.

See Configuring backup settings for fresh install of the Management subsystem.

Database persistence

Table 2. Database persistence
Field Type Required Description
Storage Class Drop down menu No. Optional Specify the RWO block storage class to use for persistence storage. This will be used when creating a PVC. Specification of the storage class is highly recommended.

If not specified the default cluster storage class is used.

See the IBM Cloud Pak documentation for guidance for Storage class selection. Go to the following page and select your Cloud Pack release level: https://www.ibm.com/support/knowledgecenter/SSGT7J. In the navigation panel of the KC, select System Requirements > Storage.

To review API Connect storage support, see Storage classes.
Volume size Integer No. Optional Represents the size of the Database volume. Defaults to 120G for n1xc4.m16 installation profile, 180G for n3xc4.m16 installation profile.

Site name

Table 3. Site Name
Field Type Required Description
Site name string No. Optional Site name is the logical name of this failure domain. Typically site name is the name of your data center, such as Amazon AZ.

Default: randomly generated name.

This will be the site name of the management deployment. For example, given the site name of test your management deployment will look like management-test-postgres.

Test and Monitor

Table 4. Test and Monitor
Field Type Required Description
Enable Test and Monitor Boolean. Toggle off/on No. Optional Test and Monitor automatically generates API test assertions. It contains dashboards for monitoring API test assertions and getting alerts on the health of your APIs.

Default: off

See Installing the Automated API behavior testing application.

Billing

Table 5. Billing
Field Type Required Description
Enable Billing Boolean. Toggle off/on No. Optional To enable the monetization of your Product Plans, you must add a billing integration resource in your API Connect provider organization that defines the configuration data needed to synchronize with an external subscription billing system.

Default: off

See Adding a billing integration resource.