Change components

This topic describes how to add or delete components in the graphical interface.

Prerequisites

Before you start, make sure that you have met the following conditions:

• You have installed obd V2.10.0 or later. We recommend that you install the latest version. For more information, see Install obd.

• obd manages at least one running OceanBase cluster.

• You can log in to the node where the component to be added is located by using password-free SSH.

Install the component

Step 1: Start the graphical interface

1. Start the graphical interface

   Run the obd web command in the command line to start the graphical interface, and click the provided address to access it.

   [admin@test001 ~]$ obd web
   start OBD WEB in 0.0.0.0:8680
   please open http://10.10.10.1:8680
   

   Note

   • The graphical interface by default uses port 8680. You can use the obd web -p <PORT> command to specify the port, which must be in the range [1025, 65535].

   • In Alibaba Cloud or other cloud environments, the program may fail to obtain a public IP address and instead output an internal IP address. This IP address is not a public IP address, so you need to use the correct IP address to access the graphical interface.

   • The obd web command is bound to 0.0.0.0. In a multi-network card deployment, you can access the graphical interface using any accessible IP address.

   • You can use the nohup or screen command to run the obd web command in the background.

2. (Optional) Place the cursor on the Chinese character in the upper-right corner of the graphical interface and click to switch between Chinese and English interfaces based on the displayed language.

3. Click Start Your Trial on the interface, and in the Welcome to the OceanBase Deployment Wizard window, select the Component Management module. Place the cursor on the Manage button and select the corresponding component management method. In this case, select Component Installation.

Step 2: Deployment configuration

You can select the components to be installed on the Deployment Configuration page. The Deployment Configuration page contains the following information.

After you select the deployment components, click Next in the lower-right corner to go to the Component Configuration page.

Step 3: Component configuration

You can configure the nodes, ports, and other related settings for the components to be deployed on the Component Configuration page. The component deployment page contains the following information.

After you configure all the parameters, click Next in the lower-right corner to go to the Precheck page.

Step 4: Precheck

On the Precheck page, view all the configuration information. If you find any issues, click Previous to modify them. After you confirm that all the configurations are correct, click Precheck to start the precheck.

If the precheck fails, you can click Auto Repair (for check items that can be automatically repaired) or click View More Solutions to go to the error code documentation and modify the configurations based on the documentation. After you modify all the errors, click Recheck to start the precheck again.

After the precheck passes, click Deploy to start the deployment of the component.

Step 5: Deploy

Where:

• If you deployed the OBProxy component, after the deployment is successful, you can copy the displayed connection string and execute it in the CLI to connect to ODP as the root@proxysys user.

• If you deployed a component with a graphical interface, such as Prometheus, Grafana, or Alertmanager, you can click the corresponding connection string to jump to the login page of the component. You can use the account and password displayed on the deployment page to log in.

  Note

  In an Alibaba Cloud or other cloud environment, the program may fail to obtain the public IP address and instead output the internal IP address. This IP address is not a public IP address. You need to use the correct IP address to access the graphical interface.

• In the Deployment Report, click the expand icon before the corresponding component to view the deployment logs. When you hover over View Details in the component list, the command to view the component logs is displayed. Click the copy icon next to the command to copy it. After copying, you can execute the command on the central control node to view the log location of the component.

• Click Copy Information to copy and save the account and password of all deployed components. Then, click Complete to exit the deployment program.

Uninstall a component

Step 1: Start the graphical interface

1. Start the graphical interface

   Run the obd web command in the CLI to start the graphical interface. Click the displayed address to access the graphical interface.

   [admin@test001 ~]$ obd web
   start OBD WEB in 0.0.0.0:8680
   please open http://10.10.10.1:8680
   

   Note

   • The graphical interface uses port 8680 by default. You can use the obd web -p <PORT> command to specify the port. The port value must be in the range [1025, 65535].

   • In Alibaba Cloud or other cloud environments, the program may fail to obtain the public IP address and output the internal IP address. In this case, you must use the correct IP address to access the graphical interface.

   • The obd web command is bound to 0.0.0.0. In a multi-network interface deployment, you can access the graphical interface through any accessible IP address.

   • You can use the nohup or screen command to set the obd web command to run in the background.

2. (Optional) Move the cursor to the Chinese character in the upper-right corner of the graphical interface and click the displayed language to switch between the Chinese and English interfaces.

3. Click Start the Experience in the operation interface. In the displayed Welcome to OceanBase Deployment Wizard interface, select the Component Management module. Move the cursor to the Manage button and select the component management method based on the displayed options. Here, select Component Uninstallation.

Step 2: Uninstall the component

You can select the component to be uninstalled in the Uninstall Configuration interface. The content of the Deployment Configuration interface is as follows.

After you select the component to be uninstalled, click Uninstall in the lower-right corner. In the confirmation dialog box that appears, click OK to enter the Uninstall interface.

Step 3: Uninstall

The uninstall interface displays the progress and result of the component uninstallation. You can view the Uninstall Status column of the component to determine whether the uninstallation is successful. Move the cursor to the View Running Log option in the Actions column of the component to view the uninstallation log.

The uninstallation result may be in one of the following states. You can perform the corresponding operation based on the displayed result.

Click Complete in the lower-right corner. In the confirmation dialog box that appears, click Exit to exit the graphical interface.