Overview
The ssl_external_kms_info parameter is used to record information required for the SSL feature of OceanBase AI Database. It uses a JSON string to record the configuration dependencies for different SSL usage modes. The JSON string must contain at least the ssl_mode field.
Privilege requirements
Query parameters
Both the
systenant and all user tenants can query this parameter using theSHOW PARAMETERSstatement or theGV$OB_PARAMETERSview.Modify parameters
Only the
systenant can modify this parameter. User tenants cannot modify it.
Attributes
Attribute |
Description |
|---|---|
| Parameter type | String |
| Default Value | "" indicates an empty string. |
| Modifiable | Yes, you can use theALTER SYSTEM SETStatement modification. |
| Whether to restart the OBServer node for the change to take effect | No, the setting takes effect immediately. |
Usage instructions
The default value of this parameter is an empty string. When the SSL switch is turned on, SSL uses the key to retrieve the default file from the default path.
The value of this parameter must be valid JSON; otherwise, the configuration check will fail.
Currently, this parameter only supports two values:
fileandbkmi, which are used to specifyssl_mode.When set to file, the SSL key and certificate files are read from the local default path. No additional JSON fields are required.
When specified as
bkmi, the runtime obtains the SSL file from BKMI and does not persist it locally. Additionally, the JSON string must provide the complete application name, BKMI URL, BKMI root certificate, identity key, identity key password, SSL private key name, SSL private key version number, and SSL certificate name. These details must be valid and accessible to retrieve the private key and certificate from BKMI; otherwise, a response error code will be returned.
To support external certificate issuance systems,
ssl_external_kms_infocan also be customized to extend it with other content in a JSON string.
Configuration example
Set the SSL certificate configuration to file mode.
obclient> ALTER SYSTEM SET ssl_external_kms_info = '
{
"ssl_mode":"file"
}';