《OceanBase 4.x DBA 进阶教程》用户共建计划(2025.01.20 更新《云服务器上 OB 部署实践》)

用户投稿

天使轮投稿:

  • 2025.01.07 @甯空《负载均衡终极解决方案》,利用企业的实践经验,为我们弥补了进阶教程中容灾设计章节缺失的与负载 VIP 相关内容。作为本次共建活动的第一个投稿,为大家开了个好头。

  • 2025.01.08 @五月《OceanBase 后悔药 —— 误操作恢复指南》,为大家介绍了 OceanBase 中几种有效的恢复方法,为那些可能犯错的管理员们提供一份“后悔药”。传说中的 “单副本拉起”,也只是文中的冰山一角。

  • 2025.01.10 @qchenzi 《在 K8S 上部署 OceanBase 的最佳实践》,为大家介绍了美的集团在使用 OceanBase 企业版在公司内部完成 “去 Oracle” 的目标之后,继续对 OceanBase 进行容器化部署的探索,以及详细的实践经验分享。是本地活动中第一个通过在 github 上提交 pull request 完成的投稿。

  • 2025.01.18 @obpilot 《OceanBase 空间缩容实践》,专业且详细地为大家介绍了 OB 的空间资源分配原理,以及如何对 OB 的数据文件进行缩容。为咱们弥补了官网文档中只有扩容方法没有缩容方法的缺憾。

  • 2025.01.20 @obpilot 《云服务器上 OB 部署实践》,通过云服务器环境分析、云服务器部署建议、云盘性能提升方法、网卡速率设置等几个部分,毫无保留地为大家分享了在云服务器或虚拟机环下境部署 OB 的实践经验。感谢庆涛大神在周末加班为社区用户分享了两篇这么优质的实践文章!

共建背景

今年九月十五日,我们开始编写和整理了一个《OceanBase 4.x DBA 进阶教程》,并在 2024.12.31 完成了初版内容。

编写之前,我们在【OceanBase 4.x DBA 进阶教程】用户意见收集这个帖子里发起了一次教程内容的建议收集。社区论坛里有不少用户在内容的安排上,提出了诸多宝贵建议。

在此教程即将完成之际,对所有提出建议的用户表示由衷的感谢!


共建需求

因为进阶教程的初版内容暂时还没有用户参与编写,还是偏 “学院派” 一些。在用户的建议中,也有一些需要依靠广大用户,群策群力才能完成的 “用户实践向” 内容。

所以,我们想在初版内容接近完成之际,组织一个大家一起共建《进阶教程》的活动。希望大家能够一起参与进来,在这本教程中真正留下你们的足迹。

共建需求十分简单:希望大家能把使用 OceanBase 社区版过程中,真实用过的方案,以及积累的运维经验,在这本进阶教程中分享给大家。包括但不限于:根据业务特点设计数据库部署架构的思路、各种周边工具的使用技巧、性能调优技巧、让你有成就感的问题排查和分析过程,以及使用 OceanBase 社区版过程中发现的各种奇技淫巧等等等等。

大家共建的投稿内容不需要像官网文档一样写的那么严肃,社区里的内容就应该更接地气一些(《进阶教程》的编写本身就很随意,甚至还夹带了一些私货)。

共建时间

即日起至 2025 年 6 月 30 日。

共建福利

  • 对于每篇被选中的共建内容,除了会被收入到《进阶教程》中,还会得到超高额的积分奖励:

    • 天使轮投稿:前五个主动投稿并被选中的内容,奖励 1000 积分(由兹拉坦个人通过悬赏贴进行发放)。

    • 早鸟投稿:2025/3/31 之前被选中的每篇投稿,积分 * 2.5 倍,奖励 500 积分(由兹拉坦个人通过悬赏贴进行发放)。

    • 2025/4/1 ~ 2025/6/30 期间被选中的每篇投稿,奖励 200 积分。

  • 内容质量较高的共建内容,会通过征文计划评委 —— 开源生态技术部总经理 @longda 的推荐,直接进入征文计划评比的绿色通道,作者大概率会获得丰厚的 “物质” 奖励(详见征文计划链接)。

  • 参与投稿并被收入教程的企业或个人,会通过 OceanBase 开源社区负责人 @fionaduan 的推荐,直接进入月度之星、年度之星评比的绿色通道。

  • 投稿内容被选中的用户,可以进入我们专门为热爱分享的用户创建的一个 OceanBase 技术内容交流微信群,以便后续能够第一时间在群里和大家分享 OceanBase 的运维经验,以及交流与 OceanBase 相关的技术问题。

  • 所有参与共建的用户,都会出现在 OceanBase 进阶教程电子书的致谢名单中。

参与进阶教程共建的方法

  • 方法一:在论坛投稿,步骤详见这里

  • 方法二:在博客投稿,步骤详见这里

  • 方法三:在 github 上投稿,步骤详见这里

  • 方法四:除了向教程投稿,也可以通过教程捉虫参与共建。会根据贡献值大小,获得相应奖励。步骤详见这里

25 个赞

特别声明

  • 绝对禁止使用灌水文来参与此共建活动!

    • 禁止利用 AI 生成的水文参加此共建活动。

    • 禁止直接用从官网中复制黏贴一段内容来参加此共建活动。

    • 禁止复制黏贴论坛或博客中已经存在的技术内容来参加此共建活动。

    • 禁止其他一切 “搞破坏” 的行为。

    • 第一次违规,会在论坛中对违规者及违规行为进行公示,并禁言 30 天。如有第二次违规,永久封禁账号。 这个活动的目的是让大家来分享使用 OceanBase 的经验,只想刷积分的朋友请移步灌水乐园板块,不允许在这个活动中发布无意义的内容浪费大家的阅读时间。

  • 共建活动之前就已经在社区发布的技术内容,也可以向 @兹拉坦 投稿来参与此次共建活动,但不会获得 @兹拉坦 个人提供的积分奖励。

  • 如果大家对此共建活动有任何疑问,欢迎在本帖中留言评论,或者向 @兹拉坦 进行咨询。

19 个赞

共建内容范例

18 个赞

参与进阶教程共建的方法

方法一:在社区论坛投稿

可以通过在 “建议与反馈 —— 文档&教程优化需求” 板块发帖进行投稿。

  • 标题:【OceanBase DBA 进阶教程投稿】XXXXX
  • 板块:建议与反馈 文档&教程优化需求
  • 内容:包括但不限于问题分析排查记录、周边工具使用技巧、性能调优技巧等运维经验。

投稿后可手动在这个帖子下方艾特兹拉坦进行通知,或者私聊兹拉坦

17 个赞

方法二:在社区博客投稿

还可以通过在社区博客中发文进行投稿。

  • 标题:【OceanBase DBA 进阶教程投稿】XXXXX
  • 内容:包括但不限于问题分析排查记录、周边工具使用技巧、性能调优技巧等运维经验。
  • 标签:添加 “进阶教程投稿” 标签。


发布内容后,可以到社区论坛给这个叫兹拉坦的用户发送私信消息,催促他来对你的内容进行审核。

18 个赞

方法三:在 github 上提交内容

这种共建的方式,需要用户对 git 的使用有一些基础的了解。

需要大家有一个 github 的账号,并已经对你的开发环境进行过了配置。git 教程详见这里,本文不再详细赘述。

当然,在 github 上,提交内容远不止下文提及的通过命令行这一种方式,通过其他任何方式提交你的改动都是可以的。例如在 fork 仓库之后,直接在白屏页面通过 Add file、Contribute 等方式提交,可能会更符合部分用户的习惯。

步骤一

fork 项目,并添加上游仓库。

git clone https://github.com/your_name/oceanbase.github.io.git

cd oceanbase.github.io

# 添加上游仓库
git remote add upstream https://github.com/oceanbase/oceanbase.github.io.git

# 创建并切换新分支
git checkout -b your_branch_name

# 从远程仓库获取更新
git fetch upstream

步骤二

更新进阶教程的内容,并进行提交。

  • 文档内容oceanbase.github.io/docs/user_manual/operation_and_maintenance/zh-CN/user_practice_co-construction/ 路径下(可参考已有内容进行添加)。例如:01_introduction.md

  • 图片内容oceanbase.github.io/static/img/user_manual/operation_and_maintenance/zh-CN/user_practice_co-construction/ 路径下(可参考已有内容进行添加)。例如:01_introduction/001.png

  • 如需增加新的大章节,则需要修改这个文件 oceanbase.github.io/sidebars.ts (可参考已有内容进行添加)。

  • 过程中需要参考这个项目的 README 进行展示效果的测试,安装 yarn 之后,可以通过执行 yarn start && yarn build 来查看你提交的内容对应的网页渲染效果(这里可以在 .zshrc 或者 .bashrc 等文件中设置一个更简化的命令别名,例如 alias see='yarn start && yarn build' )。

  • 确认网页的渲染效果符合预期之后,执行以下命令序列,把你在本地的修改推送到远程仓库:

git add .

git commit -m "message of your content"

git fetch upstream

git merge upstream/master

# 这里可能需要解决冲突

git push origin your_branch_name
  • 然后到 github 上通过 pull request 提交你的修改即可。

  • 最后 reviewer 可以选 liboyang0730 这个人,并点击 request 催促他来 review 及合并你的内容(如果这个人很懒,没能及时 review 你的内容,还可以到社区论坛给一个叫兹拉坦的用户发送私信消息,继续催促他来 review)。


步骤三

  • 确认提交合并到主仓库之后,先手动 sync fork 一下 master 分支和你自己的分支。

  • 然后到你自己分支下执行 git fetch upstreamgit merge upstream/master 拉取上游主分支的最新内容。
  • 最后重复步骤二,即可继续提交新内容。
19 个赞

方法四:教程捉虫

可以通过在 “建议与反馈 —— 文档&教程优化需求” 板块发帖进行捉虫。

  • 标题:【OceanBase DBA 进阶教程捉虫】XXXXX
  • 板块:建议与反馈 文档&教程优化需求
17 个赞

同时欢迎大家在本帖中提出你对这个共建计划的建议,以及更有趣的共建想法~

19 个赞

很棒,大家积极参与。

12 个赞

欢迎 @obpilot @banjin @Giant @Livedba @ljware @Royce1220 @EINTR @AntTech_AMXM79 @皇甫侯 @咖啡哥 @五月 @坤易 @弋烆蘇 @宝耶 @治民 @无糖拿铁 @卡卡西 @靖顺 @渠磊 @爱可生_ActionDB 等一众活跃大佬,以及其他所有社区用户,都能够在这个共建活动中肆无忌惮地和大家分享各种技术内容!

23 个赞

加油加油

14 个赞

2025-01-07 15:07:20,在活动刚刚正式发起还不到一天的时候,@甯空 老师通过社区博客发起了第一篇共建投稿《负载均衡终极解决方案》


@甯空 老师的这篇博客《负载均衡终极解决方案》,利用企业的实践经验,为我们弥补了进阶教程中容灾设计章节缺失的与负载 VIP 相关的内容,欢迎大家阅读!

这篇博客也即将被收入到进阶教程中的对应章节(可能会有补充和调整)。

值得纪念的时刻,值得纪念的内容,值得纪念的用户,真是值得纪念呀!

14 个赞

@甯空 老师有空儿的时候在 进阶教程共建投稿《负载均衡终极解决方案》积分发放贴 中领取一下 1000 积分的奖励~

15 个赞

:+1:

9 个赞

张老师,你的单副本拉起之术呢?

10 个赞

哈哈一直犹豫没发出来,等我忙完这两天发出来

12 个赞

期待五月大作!

10 个赞

期待!!!!

8 个赞

:joy_cat:头像~蚂蚁也穿上棉服了

7 个赞

求一篇《tidb迁移oceanbase最佳实践》

8 个赞