ODC 页面空闲超时设置方法

本文档旨在介绍如何设置 ODC 的超时时间。

ODC 白屏登录会话超时时间设置方法如下：

1. 升级 ODC 到 V3.3.3 及以上版本。

2. 在部署和启动 Docker 时，设置环境变量 ODC_APP_EXTRA_ARGS=--server.servlet.session.timeout=过期时间。

   示例：部署 ODC 容器并设置 Session 超时时间为 10 分钟。

   [root@ob-xxx-xxx-x-xx soft]# docker run --volume   /var/log/odc:/opt/odc/log \
   > -d -i --net host --cpu-period 100000 --cpu-quota 400000 --memory 8G --name "obodc" \
   > -e "DATABASE_HOST=xxx.xxx.x.xx" \
   > -e "DATABASE_PORT=2883" \
   > -e "DATABASE_USERNAME=root@******" \
   > -e "DATABASE_PASSWORD=root" \
   > -e "DATABASE_NAME=odc_metadb" \
   > -e "ODC_PROFILE_MODE=alipay" \
   > -e "ODC_APP_EXTRA_ARGS=--server.servlet.session.timeout=10m" \
   > reg.docker.alibaba-inc.com/oceanbase/odc-server:4.1.2-20230317
   a29xxxxxxxxxda19f4fea09xxxxxxxxxxxxd048cc9a1413dxxxxxxxxxxx16d74
   
   [root@ob-xxx-xxx-x-xx soft]# docker ps
   CONTAINER ID        IMAGE                                                            COMMAND                  CREATED             STATUS              PORTS               NAMES
   a29078f17751        reg.docker.alibaba-inc.com/oceanbase/odc-server:4.1.2-20230317   "/usr/bin/supervis..."   4 seconds ago       Up 3 seconds                            obodc
   

   参数	说明
   --net	指定容器的网络配置，指定该参数值为 host 即直接使用宿主机网络。 您也可以使用 --publish（-p）参数配置端口映射，但是部分环境可能出现因为 Docker 内 DNS 解析出错而启动容器失败，此时请使用 --net host 方式启动 Docker。
   --cpu-period --cpu-quota	---cpu-period 用来指定容器对 CPU 的使用要在多长时间内做一次重新分配。单位：微秒。 ---cpu-quota 用来指定在这个周期内，最多可以有多少时间用来运行当前容器。单位：微秒。 配合使用可指定容器使用的 CPU 核数。cpu-quota/cpu-period 的值即为 Docker 可以使用的 CPU 核数，示例语句中 400000/100000=4 表示最多可以使用 4 个核。
   --memory	设置容器使用的内存最大值。
   --name	指定容器名称。
   DATABASE_HOST	元数据库 IP 地址。
   DATABASE_PORT	元数据库端口号。
   DATABASE_USERNAME	元数据库用户名。OceanBase 数据库用户名的格式：db_user@tenant_name#cluster_name。
   DATABASE_PASSWORD	连接数据库的密码。
   DATABASE_NAME	元数据库名。
   ODC_PROFILE_MODE	指定模式，默认指定：alipay。
   ODC_APP_EXTRA_ARGS	其它需要指定的 App 参数。 例如 --server.servlet.session.timeout=10m，表示 Session 过期时间为 10 分钟。默认值：空。 注意 修改此变量需要重新部署 ODC。

3. 确认设置是否成功。

   [root@ob-192-168-2-51 obytt111]# docker exec -it obodc bash
   [root@ob-192-168-2-51 odc]# cd log
   [root@ob-192-168-2-51 log]# grep -i 'server.servlet.session.timeout' odc.log 
    "ODC_APP_EXTRA_ARGS" : "--server.servlet.session.timeout=10m",
     "sun.java.command" : "/opt/odc/lib/odc-web-starter-4.1.2-20230317-executable.jar --server.port=8989 --obclient.work.dir=/opt/odc/data --obclient.file.path=/opt/odc/obclient/bin/obclient --file.storage.dir=/opt/odc/data --server.servlet.session.timeout=10m",
   

适用版本

ODC 所有版本。