Environment checklist

Before deployment, perform an environment check based on the actual components and versions to be deployed.

Port planning and check

Port planning

When deploying OceanBase Database, the default ports that need to be opened for each component are listed in the following table. Before deployment, please allow the corresponding ports in the security group or firewall in advance based on the actual components and versions to be deployed, and check whether the ports are occupied.

OBServer core port

OBProxy (ODP) port

OCP (OceanBase Control Platform) port

OMS (OceanBase Migration Service) port

OAT (OceanBase Auto Tool) port

OCP-Agent port

OCS (OceanBase Cluster Service) port

Log service cluster port (OB 4.4.0+ shared storage mode)

OBD web management interface port

Summary of component ports

Considerations

1. Port conflict check: Before deployment, check whether the ports are occupied, especially ports in the 2881-2885 series. Note that port 2880 is deprecated, and port 2886 is used as the default port for the OCS service. Adjust the port according to the actual situation during deployment.
2. Firewall configuration: You must open the corresponding ports in the security group or firewall. In a production environment, we recommend that you restrict access sources by using firewall rules.
3. Version compatibility:
   • Port 2885 requires OBProxy-3.4.0 or later.
   • The log service's ports 7890 and 7891 are supported starting from OB 4.4.0.
   • OCS's port 2886 is supported starting from OCS-4.2.1.
4. Port range: All ports have a value range of (1024, 65536), which can be adjusted according to actual needs.
5. Production environment recommendation: It is recommended to use non-default ports to enhance security.

Port conflict check

Before deploying each component of OceanBase, confirm that all required ports are not occupied. Pay special attention to the following high-conflict-risk ports:

• Port 8088: The OMS cluster management module (oms_drc_cm) uses this port. Be cautious of conflicts when deploying it together with other components that also use port 8088.
• Port 8080: The standard edition HTTP service of OCP uses this port. Be cautious of conflicts when deploying it together with other components that also use port 8080.
• Ports 62888/62889: OCP-Agent uses these ports for O&M listening and data collection. Ensure they are not occupied.
• Ports 9000/9001: The OMS host Agent process uses these ports. Ensure they are not occupied.
• Mixed deployment of OCP and arbitration nodes: When OCP and arbitration nodes (Arbitration) are deployed on the same server, check in advance whether their default ports conflict and manually adjust the conflicting ports in the deployment configuration.

Common commands for checking port occupancy:

# Check if the specified port is occupied
ss -tlnp | grep <port number>
# or
lsof -i :<port number>

Disk space check

The installation packages for various OceanBase components are quite large (for example, a single OMS installation package can reach several GB). Additionally, the deployment process requires storing images, logs, and data files. Insufficient disk space will cause deployment failure.

Before deployment, confirm the available space in the following directories:

Common commands for checking disk space:

# Check the available space of each mount point.
df -h
# Check the space used by a specified directory
du -sh <directory path>

.bashrc check

Before installing OAT, check the /root/.bashrc file on the server to ensure it does not contain commands that are only applicable to interactive shells. Otherwise, OAT installation will fail.

Background information

During the OAT installation process, the Airflow task executes Python scripts in a non-interactive environment, where the .bashrc file is loaded. If the .bashrc file contains commands such as bind, which are intended for interactive shells, the following issues may occur:

1. When executing the bind command in a non-interactive shell, a "line editing not enabled" warning is generated.
2. This warning message is captured by the script that detects the operating system type.
3. The warning message is mistakenly passed to OAT as the operating system type.
4. OAT attempts to look up this incorrect "operating system type" in the configuration dictionary, resulting in a KeyError and installation failure.

Check method

Check the .bashrc file to confirm whether it contains content similar to the following:

bind 'set enable-bracketed-paste off'

Solution

Modify the bind command in .bashrc to be executed only in an interactive shell:

# Edit the .bashrc file.
vim /root/.bashrc

# Method 1 (recommended): Use conditional wrapping
if [[ $- == *i* ]]; then
    bind 'set enable-bracketed-paste off'
fi

# Method 2: Simplified syntax
[ -z "$PS1" ] || bind 'set enable-bracketed-paste off'

After making the fix, re-execute the OAT installation.