Management subsystem settings

You can specify advanced configuration settings for the Management 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

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

Database backups settings

Table 1. Database backup
Field Type Required Description
Credentials Drop down menu Yes The name of the Kubernetes secret containing your S3 access key and secret or your or SFTP username and password or SSH key.

Default: (Generated Value)

See Configuring management database backups.

Server hostname String Yes Hostname of your remote SFTP backup server or object-store endpoint.
If specifying an S3 object-store, use the format <S3endpoint>/<S3region>. For example:
s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-standard

Default: none

See Configuring management database backups.

Path String Yes The path to the location of for your backups on your remote server.

If you are using a remote SFTP server, then this is a directory path.

If you are using an object-store, then this is the name of your S3 bucket. For example, bucket-name/folder. The use of subdirectories in the bucket name is not supported. Ensure that bucket-name/folder is empty.

Default: none

See Configuring management database backups.

Port Integer No

If you are using a remote SFTP server, set this to the port the SFTP server listens on. Default is 22.

Protocol String Yes Set according to your remote backup site as follows:
  • SFTP: Set protocol=sftp.
  • Object-store: Set protocol=objstore.
  • None: Set local. Backups are kept on local persistent storage.
Schedule String Yes 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)
  • +--------------- sec (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 management database backups.

Backup certs Drop down menu Optional, if S3 object-store requires them. Secret containing the CA certificate for your S3 object-store. Required for API Connect to trust the S3 object-store.
RepoRetentionFull Integer Yes The number of days to retain backups for.

For example, if RepoRetentionFull is set to 30, then any backups older than 30 days are deleted.

Backup S3 URI Style Drop down menu host Indicates whether URIs to your S3 backup specify a host or a path value. Set to either host or path.

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.