Deploy ODP

Currently, obshell commands cannot be used to deploy ODP using. This topic describes how to deploy ODP by calling APIs and associate it with a three-replica OceanBase cluster.

Deployment mode

The following table lists the four servers used in this topic. obshell uses the default port 2886.

Procedure

Step 1: Start obshell

Log in to the node where ODP is to be deployed and start obshell. For more information, see obshell agent start.

[admin@test004 ~]$ /home/admin/oceanbase/bin/obshell agent start --ip 10.10.10.4 -P 2886

Step 2: Set the node password

Call the /api/v1/agent/password API of obshell to set the node password.

[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Header:${request_headers}' -X POST -d '${request_body}'  http://10.10.10.4:2886/api/v1/agent/password

{
  "password": "*****"
}

...
client = ClientSet("10.10.10.4", 2886)
client.v1.set_agent_password("*****")

# If the obshell node manages an OceanBase cluster, you must specify the root@sys password of the cluster when you create the client.
# client = ClientSet("10.10.10.4", 2886, PasswordAuth("***"))
...

Step 3: Create the proxyro@sys user

ODP needs to connect to the associated OceanBase cluster using the proxyro@sys user. If the target cluster does not have the proxyro user created under the sys tenant, you must manually create the proxyro user first.

If the target cluster is not managed by obshell, you can create the proxyro@sys user by referring to Create a user. If the target cluster is managed by obshell, you can use the /api/v1/tenant/{name}/user API of any obshell in the cluster to create the proxyro@sys user and grant the required privileges. Here is an example.

[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Header:${request_headers}' -X POST -d '${request_body}'  http://10.10.10.1:2886/api/v1/tenant/sys/user

{
  "user_name": "proxyro",
  "password": "*****",
  "global_privileges": [
    "CREATE",
    "DELETE"
  ],
  "db_privileges": [
    {
      "db_name": "oceanbase",
      "privileges": [
        "DROP"
      ]
    }
  ],
  "host_name": "%"
}

...
client = ClientSet("10.10.10.1", 2886, PasswordAuth("****"))
db_priv = {
        "db_name": "oceanbase",
        "privileges": ["SELECT"]
    }
client.v1.create_user(user_name="proxyro", password="*****", db_privileges=[db_priv])
...

Step 4: Deploy ODP

You need to manually download the ODP installation package from OceanBase Download Center, copy it to the server where you want to deploy ODP, and decompress it to the working directory. Then, call the /api/v1/obproxy API of the target obshell to deploy ODP and associate it with the target cluster.

[admin@test001 ~]$ curl -H "Content-Type: application/json" -H 'X-OCS-Agent-Header:${request_headers}' -X POST -d '${request_body}'  http://10.10.10.4:2886/api/v1/obproxy

{
    "home_path": "/data/obproxy",
    "name": "myobproxy",
    "sql_port": 2883,
    "exporter_port": 2884,
    "rpc_port": 2885,
    "rs_list": "10.10.10.1:2881;10.10.10.2:2881;10.10.10.3:2881",
    "proxyro_password": "********",
    "obproxy_sys_password": "********",
    "parameters": {
        "server_tcp_keepidle": "5",
        "enable_strict_kernel_release": "false"
    }
}

...
client = ClientSet("10.10.10.4", 2886, PasswordAuth(agent_password="****"))
client.v1.add_obproxy_sync(
    home_path="/data/obproxy",
    app_name="myobproxy",
    rs_list="10.10.10.1:2881;10.10.10.2:2881:10.10.10.3:2881",
    proxyro_password="********",
    obproxy_sys_password="********",
)
...

Step 5: Verify whether ODP is deployed

You can run the following command to check whether an ODP process exists:

[admin@test001 ~]$ ps -ef | grep obproxy

You can also use the ODP to access the OceanBase cluster and verify whether you can connect to it.

obclient -h10.10.10.4 -uroot@sys#obdemo -P2883 -p -c -A

For more information about how to connect to an OceanBase cluster, see Connect to OceanBase Database.