add quick start demo config and readme file

2022-05-26 16:55:09 +08:00 · 2022-05-26 16:55:09 +08:00 · a9cc1b8cd0
commit a9cc1b8cd0
parent e48422a122
2 changed files with 114 additions and 0 deletions
--- a/tools/quick_start/README-CN.md
+++ b/tools/quick_start/README-CN.md
@ -0,0 +1,61 @@
+快速上手
+
+> 本文将会介绍如何在本地部署一本地单机OceanBase实例。
+> 注意：这里的介绍不适用于生产环境部署，如果想要在生产环境部署OceanBase，可以参考[OceanBase 社区版网站](open.oceanbase.com)中的文档。
+
+这里介绍的操作步骤适用于使用yum管理安装包的系统，比如CentOS。
+
+**资源要求**
+
+项目 | 描述
+-- | --
+CPU | 2 核以上，建议8核
+内存 | 8G 以上
+
+您需要确保能访问互联网。
+
+> 以下操作步骤以CentOS 7.9 为例
+
+**在 $HOME/oceanbase 目录安装 oceanbase**
+
+```bash
+# 1. 安装 obd
+sudo yum install -y yum-utils
+sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
+sudo yum install -y ob-deploy
+
+# 下载配置文件
+wget https://gitee.com/oceanbase/oceanbase/raw/master/tools/quick_start/quick_start_demo.yaml -O quick_start.yaml
+
+# 修改配置文件中的 home_path
+# 这里将配置文件设置在$HOME/oceanbase下
+sed -i "s?home_path:?home_path: $HOME/oceanbase?g" quick_start.yaml
+
+# 使用obd 部署并启动 oceanbase，并创建一个test租户
+# 部署会比较慢，需要等待2-10分钟
+obd cluster autodeploy obcluster -c quick_start.yaml -A
+
+obd cluster display obcluster
+```
+
+**使用客户端连接 oceanbase**
+
+安装后，可以使用mysql客户端或obclient连接oceanbase
+
+```bash
+mysql -uroot@test -P 2881 -h 127.0.0.1
+```
+或
+```bash
+obclient -uroot@test -P 2881 -h 127.0.0.1
+```
+
+如果您没有mysql客户端或obclient，可以使用下面的命令安装：
+
+```bash
+# 安装 mysql 客户端
+sudo yum install -y mysql
+
+# 安装 obclient
+sudo yum install -y obclient
+```
--- a/tools/quick_start/quick_start_demo.yaml
+++ b/tools/quick_start/quick_start_demo.yaml
@ -0,0 +1,53 @@
+# This is a quick start demo config file for ob-deploy
+# Please refer to https://github.com/oceanbase/obdeploy/tree/master/example for more examples
+# You must change the config item `home_path` to deploy an oceanbase instance
+# You can use the shell commands below to deploy an oceanbase instance:
+# yum install -y yum-utils
+# yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
+# yum install -y ob-deploy
+# obd cluster autodeploy obcluster -c quick_start.yaml
+
+oceanbase-ce:
+  servers:
+    # Please don't use hostname, only IP can be supported
+    - name: server1
+      # Please don't use hostname, only IP can be supported
+      ip: 127.0.0.1
+  global:
+    #  The working directory for OceanBase Database. OceanBase Database is started under this directory. This is a required field.
+    home_path: 
+    # The directory for data storage. The default value is $home_path/store.
+    # data_dir: /data
+    # The directory for clog, ilog, and slog. The default value is the same as the data_dir value.
+    # redo_dir: /redo
+    # Please set devname as the network adaptor's name whose ip is  in the setting of severs.
+    # if set severs as "127.0.0.1", please set devname as "lo"
+    # if current ip is 192.168.1.10, and the ip's network adaptor's name is "eth0", please use "eth0"
+    devname: lo
+    mysql_port: 2881 # External port for OceanBase Database. The default value is 2881. DO NOT change this value after the cluster is started.
+    rpc_port: 2882 # Internal port for OceanBase Database. The default value is 2882. DO NOT change this value after the cluster is started.
+    zone: zone1
+    cluster_id: 1
+    # please set memory limit to a suitable value which is matching resource. 
+    memory_limit: 6G # The maximum running memory for an observer
+    system_memory: 3G # The reserved system memory. system_memory is reserved for general tenants. The default value is 30G.
+    stack_size: 512K
+    cpu_count: 16
+    cache_wash_threshold: 1G
+    __min_full_resource_pool_memory: 268435456
+    workers_per_cpu_quota: 10
+    schema_history_expire_time: 1d
+    # The value of net_thread_count had better be same as cpu's core number. 
+    net_thread_count: 4
+    sys_bkgd_migration_retry_num: 3
+    minor_freeze_times: 10
+    enable_separate_sys_clog: 0
+    enable_merge_by_turn: false
+    datafile_size: 5G
+    # datafile_disk_percentage: 20 # The percentage of the data_dir space to the total disk space. This value takes effect only when datafile_size is 0. The default value is 90.
+    syslog_level: INFO # System log level. The default value is INFO.
+    enable_syslog_wf: false # Print system logs whose levels are higher than WARNING to a separate log file. The default value is true.
+    enable_syslog_recycle: true # Enable auto system log recycling or not. The default value is false.
+    max_syslog_file_count: 4 # The maximum number of reserved log files before enabling auto recycling. The default value is 0.
+    # root_password: # root user password, can be empty
+    appname: obtest