Before you deploy OceanBase Cloud Platform (OCP), you must add an OCP configuration file.
Prerequisites
You have added an OCP server and manually set and initialized the server.
If you want to use a custom OCP docker image, make sure that the custom image file has been uploaded to the /data_dir/ocp directory on the OceanBase Admin Toolkit (OAT) server.
Single-node deployment
In the left-side navigation pane, choose Service Deployment > Configuration File.
In the upper-right corner of the page, choose Add Configuration File > OCP . The Add OCP Configuration File page appears.
In the Basic Information step, enter the basic information about the configuration file and click Next .
The following table describes the basic information.
Field Description Configuration Name The name of the configuration file. It distinguishes the file from configuration files for other deployment scenarios of the services. OCP Type Select Single-Node . OCP Server Select a server to deploy OCP.
Configure load balancing and click Next .
The default value of Load Balancing Mode is none . You do not need to modify it.
Configure the MetaDB container and click Next .
The following table describes the fields of the MetaDB container.
Field Description Basic Configuration MetaDB Image File The .tar package of the MetaDB image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration MetaDB Image Repository The address of the MetaDB image. If you select the default .tar package, the system automatically selects the corresponding image address. Basic Configuration MetaDB Image Tag The tag of the MetaDB image. If you select the default .tar package, the system automatically selects the corresponding image tag. Advanced Configuration Container CPU The number of CPU cores allocated to the MetaDB container. Default value: 32, indicating 32 cores. Advanced Configuration Container Memory The memory allocated to the MetaDB container. Default value: 128G, indicating 128 GB. Advanced Configuration MetaDB Service Port The real service port of MetaDB. Default value: 2881. Advanced Configuration MetaDB RPC Port The remote access port of MetaDB. Default value: 2882. Advanced Configuration MetaDB Data Directory The directory that stores the MetaDB data. Default value: /data1. Advanced Configuration MetaDB Log Directory The directory that stores MetaDB log files. Default value: /data/log1.Advanced Configuration MetaDB Cluster Name The name of the MetaDB cluster. Advanced Configuration Percentage of Pre-allocated Disk Space Default value: 90. Advanced Configuration Enable Backup Specifies whether to enable backup. Default value: FALSE . Advanced Configuration MetaDB Backup Directory The backup directory of the MetaDB data. Default value: /obbackup.Advanced Configuration IDC Name The name of the IDC where OCP is deployed. Advanced Configuration Region Name The name of the region where OCP is deployed.
Configure the OBProxy container and click Next .
The following table describes the configuration fields of the OBProxy container.
Field Description Basic Configuration OBProxy Image File The .tar package of the OBProxy image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration OBProxy Image Repository The address of the OBProxy image. Basic Configuration OBProxy Image Tag The tag of the OBProxy image. Advanced Configuration OBProxy Service Port The service port of OBProxy. Default value: 2883. Advanced Configuration OBProxy Container CPU The number of CPU cores allocated to the OBProxy container. Default value: 4, indicating 4 cores. Advanced Configuration OBProxy Container Memory The memory allocated to the OBProxy container. Default value: 6G, indicating 6 GB. Advanced Configuration OBProxy Container Name The name of the OBProxy container. Default value: obproxy.
Configure the OCP Server container.
The following table describes the configuration fields of the OCP Server container.
Field Description Basic Configuration OCP Server Image File The .tar package of the OCP Server image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration OCP Server Image Repository The address of the OCP Server image. Basic Configuration OCP Server Image Tag The tag of the OCP Server image. Advanced Configuration OCP Server Container CPU The number of CPU cores allocated to the OCP Server container. Default value: 4, indicating 4 cores. Advanced Configuration OCP Server Container Memory The memory allocated to the OCP Server container. Default value: 16G, indicating 16 GB. Advanced Configuration OCP Server Service Port The service port of OCP Server. Default value: 8080. Advanced Configuration OCP Server Container Name The name of the OCP Server container. Default value: ocp.
Click OK .
The system generates a task flow and starts to deploy OCP. You can view its progress on the Tasks page.
Three-node deployment
In the left-side navigation pane, choose Service Deployment > Configuration File.
In the upper-right corner of the page, choose Add Configuration File > OCP . The Add OCP Configuration File page appears.
In the Basic Information step, enter the basic information about the configuration file and click Next .
The following table describes the configuration fields in the Basic Information step.
Field Description Configuration Name The name of the configuration file. It distinguishes the file from configuration files for other deployment scenarios of the services. OCP Type Select Three-Node . OCP Server Select three servers to deploy OCP.
Configure load balancing and click Next .
The following table describes the configuration fields of load balancing.
Field Description Basic Configuration Load Balancing Mode In three-node deployment, the valid values of the Load Balancing Mode field are: * dns : If you select this option, you must specify the load balancing image file, load balancing image repository address, and the load balancing image tag. You can also set fields in Advanced Configuration as needed. * f5 : If you select this option, you must set the OCP Proxy IP, OCP Proxy Port, OBProxy IP, and OBProxy Port parameters. Basic Configuration Load Balancing Image File The .tar package of the load balancing image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration SLB Image Repository The address of the SLB image. Basic Configuration Load Balancing Image Tag The tag of the load balancing image. Basic Configuration OCP Proxy IP The virtual IP address (VIP) of OCP. You must apply for the VIP before you deploy OCP. Basic Configuration OCP Proxy Port The virtual port (VPort) of OCP. Basic Configuration OBProxy Proxy IP The VIP of OBProxy. You must apply for the VIP address before you deploy OCP. Basic Configuration OBProxy Port The VPort of OBProxy. Advanced Configuration Basic Domain Name By default, oceanbase.com is the recommended domain name and can be accessed only through OCP nodes. If a non-OCP node needs to access this domain name, /etc/hostsparsing must be configured.Advanced Configuration OCP Proxy Port The VPort of OCP. Default value: 80. Advanced Configuration OCP Subdomain Name Default value: ocp. Advanced Configuration OBProxy Subdomain Name Default value: obproxy. Advanced Configuration Load Balancing Container Name Default value: ob_dns. Advanced Configuration Load Balancing Listening Port Default value: 85.
Configure the MetaDB container and click Next .
The following table describes the configuration fields of the MetaDB container.
Field Description Basic Configuration MetaDB Image File The .tar package of the MetaDB image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration MetaDB Image Repository The address of the MetaDB image. Basic Configuration MetaDB Image Tag The tag of the MetaDB image. Advanced Configuration Container CPU The number of CPU cores allocated to the MetaDB container. Default value: 32, indicating 32 cores. Advanced Configuration Container Memory The memory allocated to the MetaDB container. Default value: 128G, indicating 128 GB. Advanced Configuration MetaDB Service Port The real service port of MetaDB. Default value: 2881. Advanced Configuration MetaDB RPC Port The remote access port of MetaDB. Default value: 2882. Advanced Configuration MetaDB Data Directory The directory that stores the MetaDB data. Default value: /data1.Advanced Configuration MetaDB Log Directory The directory that stores MetaDB log files. Default value: /data/log1.Advanced Configuration MetaDB Cluster Name The name of the MetaDB cluster. Advanced Configuration Percentage of Pre-allocated Disk Space Default value: 90. Advanced Configuration Enable Backup Specifies whether to enable backup. Default value: FALSE . Advanced Configuration MetaDB Backup Directory The backup directory of the MetaDB data. Default value: /obbackup.Advanced Configuration IDC Name The name of the IDC where OCP is deployed. Advanced Configuration Region Name The name of the region where OCP is deployed.
Configure the OBProxy container and click Next .
The following table describes the configuration fields of the OBProxy container.
Field Description Basic Configuration OBProxy Image File The .tar package of the OBProxy image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration OBProxy Image Repository The address of the OBProxy image. Basic Configuration OBProxy Image Tag The tag of the OBProxy image. Advanced Configuration OBProxy Service Port The service port of OBProxy. Default value: 2883. Advanced Configuration OBProxy Container CPU The number of CPU cores allocated to the OBProxy container. Default value: 4, indicating 4 cores. Advanced Configuration OBProxy Container Memory The memory allocated to the OBProxy container. Default value: 6G, indicating 6 GB. Advanced Configuration OBProxy Container Name The name of the OBProxy container. Default value: obproxy.
Configure the OCP Server container.
The following table describes the configuration fields of the OCP Server container.Field Description Basic Configuration OCP Server Image File The .tar package of the OCP Server image. You can select the default proxy.tar package or click Other to select a custom remote image. Basic Configuration OCP Server Image Repository The address of the OCP Server image. Basic Configuration OCP Server Image Tag The tag of the OCP Server image. Advanced Configuration OCP Server Container CPU The number of CPU cores allocated to the OCP Server container. Default value: 4, indicating 4 cores. Advanced Configuration OCP Server Container Memory The memory allocated to the OCP Server container. Default value: 16G, indicating 16 GB. Advanced Configuration OCP Server Service Port The service port of OCP Server. Default value: 8080. Advanced Configuration OCP Server Container Name The name of the OCP Server container. Default value: ocp.
Click OK .
The system generates a task flow and starts to deploy OCP. You can view its progress on the Tasks page.