Code Monkey home page Code Monkey logo

docs-rancher2's Introduction

Rancher 中文文档

Rancher 中文文档,包括Rancher1.x、Rancher 2.x、RKE、K3s、Octopus、Harvester和 RKE2的中文文档,其中Rancher1.x的文档已经不再维护;Rancher 2.x、RKE、K3s、Octopus、Harvester和 RKE2的中文文档会定期刷新。

本网站使用了 Docusaurus 2 文档框架。

如何开发?

准备

确保您的开发环境有如下软件:

安装

如果yarn install的速度很慢,可以尝试配置淘宝Registry。

$ yarn config set registry https://registry.npmmirror.com -g

安装初始化

$ git clone 'https://github.com/cnrancher/docs-rancher2'
$ cd 'docs-rancher2'
$ yarn install

本地启动

$ yarn start

将在浏览器中自动打开http://localhost:3000/

构建

$ yarn build

docs-rancher2's People

Contributors

anthony-hoo avatar bwcxyk avatar daiyuzeng avatar dependabot[bot] avatar dingluyy avatar east4ming avatar guangbochen avatar guocaifeng avatar jaciechao avatar jimmoen avatar kingsd041 avatar krisyejh avatar leonlau avatar ltinyho avatar niusmallnan avatar opslx avatar orangedeng avatar rancher-sy-bot avatar scienceluo avatar tongjzh avatar vflong avatar vickyhella avatar wujun2016 avatar xinzhongyoumeng avatar yedward avatar yl-yue avatar yuanyi-wang avatar yzeng25 avatar zerchin avatar zhlking avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-rancher2's Issues

安装指南--安装要求--端口要求 章节中缺少对应的表格

问题描述
安装指南--安装要求--端口要求 章节中缺少对应的表格

问题类型
请选择一个最符合的选项:

  1. 缺少对应描述

现网文档URL

https://docs.rancher.cn/docs/rancher2.5/installation/requirements/ports/_index/#%E4%B8%8B%E6%B8%B8-kubernetes-%E9%9B%86%E7%BE%A4%E8%8A%82%E7%82%B9

文档网页截图截图
image

修改建议

  1. 提供对应的中文信息和表格。由于英文文档使用的表格过于复杂,可能需要做一些调整和优化才可以上线。上次上线之前,把英文文档照搬过来之后,在本地运行 yarn run start命令,会引起报错。所以当时没有把表格加上去。
  2. 或许可以考虑在缺少表格的地方添加链接,跳转到英文文档对应的位置?

其他备注或说明(可选)
短期的workaround:请参考Rancher英文文档网页https://rancher.com/docs/rancher/v2.x/en/installation/requirements/ports/,获取对应的表格和信息。

test

问题描述
请使用一到两句话概述这个问题

问题类型
请选择一个最符合的选项:

  1. 缺少对应描述
  2. 描述不准确
  3. 错别字/用词错误
  4. 链接跳转失败,单击该链接返回404
  5. 图片挂了
  6. 文档架构不合理,有些文档层级太深了,不好找
  7. 使用页面右上方的搜索框没找到想找的东西
  8. 其他问题(请详细说明)

现网文档URL

请输入文档页面的URL,利于快速发现和解决问题。

文档网页截图截图
请提供截图,利于快速定位和解决问题

修改建议
请说明您对这个问题的修改意见或建议,从用户的角度出发,您觉得应该怎么改。

其他备注或说明(可选)

搜索框返回结果有误

问题描述
搜索框返回的一些结果包含的链接为404.
问题类型
请选择一个最符合的选项:

  1. 链接跳转失败,单击该链接返回404

现网文档URL
无,每个页面都有搜索框
文档网页截图截图

修改建议

联系搜索框功能的供应商Algolia解决该问题
目前搜索框的工作原理是这样的:Algolia会在每24小时爬取一遍网页,然后更新搜索结果。但是文档更新了已经好几周了,仍然返回404链接,这明显是Algolia那边的爬取出现了问题。

其他备注或说明(可选)
进度:已联系,待回复。

文档页面内部跳转链接失效

描述
Rancher2.x文档存在页面内部跳转链接失效的问题。具体现象为:页面内容提供了跳转到同一页面不同章节的链接,单击该链接的结果应该是要跳转到同一页面对应的章节标题处。

复现步骤

  1. 选择一个有内部跳转的页面
  2. 单击跳转链接
  3. 无反应

期待结果
单击该链接的结果应该是要跳转到同一页面对应的章节标题处。

实际结果
无反应,无跳转

影响面
所有用户

解决方法
Rancher提供了两种页面内部跳转的方式,除了在文档内容里面可以跳转(暂时失效)外,用户可以选择在文档页面右上方导航栏处单击章节标题,实现页内跳转。

registry 应该翻译为 “镜像仓库”,而不是 “注册表”

问题描述
registry 应该翻译为 “镜像仓库”,而不是 “注册表”

问题类型
请选择一个最符合的选项:

  1. 错别字/用词错误

现网文档URL
https://docs.rancher.cn/docs/rke2/install/containerd_registry_configuration/_index
文档网页截图截图

修改建议
应该是机器翻译的时候出现的错误,全局搜一下,然后全局替换。

其他备注或说明(可选)
该问题由社区用户 @myselfghost 发现。

Rancher阿里云镜像仓库镜像版本与dockerhub版本差异过大

问题描述
Rancher阿里云镜像仓库镜像版本与dockerhub版本差异过大,如:rancher/fleet-agent 镜像,截止今日2021-1-18最新 rancher/fleet-agent:v0.3.3 已于6天前发布,而阿里云镜像仓库最新版本任然为rancher/fleet-agent:v0.3.2 .

问题类型
请选择一个最符合的选项:

  1. 其他问题(请详细说明)

现网文档URL
https://docs.rancher.cn/docs/rancher2/best-practices/2.0-2.4/use-in-china/_index#使用阿里云镜像仓库搭建-rancher

文档网页截图截图
image

修改建议
目前也没有办法,帮助官网同步最新镜像,导致镜像拉取失败,集群起不起来。是否可以探寻一个较为友好的方式,开发者也可以同步镜像

获取PDF页面偶发性报错

描述
通过Rancher2.x开源版文档页面获取离线PDF文档时,在所有信息都输入正确的情况下,会出现关于”手机号码错误“的报错,导致手机无法接受包含验证码的信息,进而无法获取PDF文档的下载地址和下载密码。

复现步骤

  1. 访问 https://docs.rancher.cn/pdf/
  2. 输入姓名、公司、职位、邮箱和手机号码五项必填后,单击 ”发送短信验证码“
  3. 页面出现报错提示:您输入的手机号码不正确

期待结果
执行完步骤1和步骤2后,会给输入的手机号码发送验证码消息。

实际结果
页面出现报错提示:您输入的手机号码不正确

影响面

  • 首次下载文档的用户:不受影响
  • 已经下载过至少一次的用户:受影响

解决方法
使用Chrome浏览器打开无痕式窗口,访问 https://docs.rancher.cn/pdf/ 并输入相关信息。无痕页面不会受到上述问题的影响。

离线部署的2.4与2.5的区别这里迷惑

问题描述
2.4启动参数
docker run -d --privileged --restart=unless-stopped -p 80:80 -p 443:443 rancher/rancher:latest
2.5启动参数
docker run -d --restart=unless-stopped -p 80:80 -p 443:443 --privileged rancher/rancher:latest

然后描述是这么说的:与 2.4.x 或之前的版本相比,使用docker run命令安装 Rancher 2.5.x 时,需要添加--privileged标志变量,启用特权模式安装 Rancher。

这两个命令分明就是参数位置变了而已嘛

rancher监控指标无法显示图表等信息

问题描述
Prometheus 表达式 中很多指标在在rancher2.4.4和2.4.11 版本中都显示为:
https://docs.rancher.cn/docs/rancher2/monitoring-alerting/2.0-2.4/cluster-monitoring/expression/_index/

问题类型
目前这边使用的版本信息:
rancher:2.4.4 k8s使用RKE进行安装,然后导入rancher进行管理,Kubernetes版本: v1.15.5
rancher:2.4.11 k8s使用RKE进行安装,然后导入rancher进行管理,Kubernetes 版本: v1.19.2
问题描述:

  1. 使用2.4.X 版本的rancher无法获取到数据信息,希望给出一下需要的最低版本信息之类的描述

现网文档URL
https://docs.rancher.cn/docs/rancher2/monitoring-alerting/2.0-2.4/cluster-monitoring/expression/_index/#%E5%B7%A5%E4%BD%9C%E8%B4%9F%E8%BD%BD-cpu-%E5%88%A9%E7%94%A8%E7%8E%87

文档网页截图截图
请提供截图,利于快速定位和解决问题
2.4.4
image
2.4.11
image

修改建议
第一次提交这个,描述不知道是否恰当,有不妥之处,还望理解

其他备注或说明(可选)
Rancher㉑群目前没有回复,期待大陆们指点一二。

kubernetes补丁版本升级方式有误

系统管理员指南->获取新的kubernetes版本里写到:
要升级补丁版本,只需refresh rke-metadata-config,然后:

  1. 转到全局视图并单击系统设置选项卡。
  2. 转到rke-metadata-config部分。单击省略号(…)并单击升级

这里是没有升级按钮的。

正确方式应该是:进入具体的集群编辑页面,然后选择新的版本,点击保存会自动更新。

preview分支build失败

12.16.0: Pulling from library/node

2 | Digest: sha256:454651174f54836571258a329788574cf6552bddfd1a7113e769bd9fc3776fe6
3 | Status: Downloaded newer image for node:12.16.0
4 | + yarn install
5 | yarn install v1.22.0
6 | [1/4] Resolving packages...
7 | [2/4] Fetching packages...
8 | info [email protected]: The platform "linux" is incompatible with this module.
9 | info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
10 | info [email protected]: The platform "linux" is incompatible with this module.
11 | info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
12 | [3/4] Linking dependencies...
13 | warning " > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
14 | warning " > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
15 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
16 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
17 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
18 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
19 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
20 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
21 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
22 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has unmet peer dependency "webpack@^4.41.2".
23 | warning "@docusaurus/preset-classic > @docusaurus/[email protected]" has incorrect peer dependency "@docusaurus/core@^2.0.0".
24 | warning "@docusaurus/preset-classic > @docusaurus/theme-classic > [email protected]" has unmet peer dependency "prop-types@^15.3.0 || ^16.0.0".
25 | [4/4] Building fresh packages...
26 | Done in 87.36s.
27 | + yarn build
28 | yarn run v1.22.0
29 | $ docusaurus build
30 | Creating an optimized production build...
31 | [info] [webpackbar] Compiling Client
32 | [info] [webpackbar] Compiling Server
33 | Browserslist: caniuse-lite is outdated. Please run:
34 | npx browserslist@latest --update-db
35 | [success] [webpackbar] Client: Compiled successfully in 1.56m
36 | [success] [webpackbar] Server: Compiled with some errors in 1.96m
37 |  
38 |  
39 | ReferenceError: mode is not defined
40 | (undefined) ReferenceError: mode is not defined
41 | at MDXContent (main:44554:8626)
42 | at d (main:58086:498)
43 | at $a (main:58089:16)
44 | at a.b.render (main:58094:476)
45 | at a.b.read (main:58094:18)
46 | at Object.renderToString (main:58104:364)
47 | at render (main:85953:252)
48 | at runNextTicks (internal/process/task_queues.js:62:5)
49 | at processTimers (internal/timers.js:489:9)
50 | Error: Failed to compile with errors.
51 | at /drone/src/node_modules/@docusaurus/core/lib/commands/build.js:37:24
52 | at finalCallback (/drone/src/node_modules/webpack/lib/MultiCompiler.js:254:12)
53 | at /drone/src/node_modules/webpack/lib/MultiCompiler.js:277:6
54 | at done (/drone/src/node_modules/neo-async/async.js:2931:13)
55 | at runCompilers (/drone/src/node_modules/webpack/lib/MultiCompiler.js:181:48)
56 | at /drone/src/node_modules/webpack/lib/MultiCompiler.js:188:7
57 | at /drone/src/node_modules/webpack/lib/MultiCompiler.js:270:7
58 | at finalCallback (/drone/src/node_modules/webpack/lib/Compiler.js:257:39)
59 | at /drone/src/node_modules/webpack/lib/Compiler.js:273:13
60 | at AsyncSeriesHook.eval [as callAsync] (eval at create (/drone/src/node_modules/tapable/lib/HookCodeFactory.js:33:10), :40:1)
61 | at AsyncSeriesHook.lazyCompileHook (/drone/src/node_modules/tapable/lib/Hook.js:154:20)
62 | at onCompiled (/drone/src/node_modules/webpack/lib/Compiler.js:271:21)
63 | at /drone/src/node_modules/webpack/lib/Compiler.js:681:15
64 | at AsyncSeriesHook.eval [as callAsync] (eval at create (/drone/src/node_modules/tapable/lib/HookCodeFactory.js:33:10), :4:1)
65 | at AsyncSeriesHook.lazyCompileHook (/drone/src/node_modules/tapable/lib/Hook.js:154:20)
66 | at /drone/src/node_modules/webpack/lib/Compiler.js:678:31
67 | error Command failed with exit code 1.
68 | info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

创建阿里云ACK集群,无法获取vpc,sw

问题描述
通过docker快速启动rancher2.5.3,在创建阿里云ack时无法获取vpc
在未选择vpc等必选项时,点击下一步,一直在加载
问题类型
请选择一个最符合的选项:

  1. 其他问题(请详细说明)

现网文档URL

请输入文档页面的URL,利于快速发现和解决问题。

文档网页截图截图
image
image

修改建议
请说明您对这个问题的修改意见或建议,从用户的角度出发,您觉得应该怎么改。

其他备注或说明(可选)

Rancher 2.5.8 Dashboard界面LDAP翻译有误

问题描述
Rancher 2.5.8 Dashboard界面LDAP翻译有误,由社区3群用户@---P คิดถึง 发现。

问题类型
请选择一个最符合的选项:
3. 错别字/用词错误

现网文档URL

文档网页截图截图

image
image

修改建议
应该改为已启用

其他备注或说明(可选)

官网快速启动命令缺少--privileged

问题描述
官网https://www.rancher.cn/quick-start/ 这里快速通过命令启动rancher,会无法启动 需要增加参数 --privileged

问题类型
请选择一个最符合的选项:1

  1. 缺少对应描述
  2. 描述不准确
  3. 错别字/用词错误
  4. 链接跳转失败,单击该链接返回404
  5. 图片挂了
  6. 文档架构不合理,有些文档层级太深了,不好找
  7. 使用页面右上方的搜索框没找到想找的东西
  8. 其他问题(请详细说明)

现网文档URL

请输入文档页面的URL,利于快速发现和解决问题。

文档网页截图截图
请提供截图,利于快速定位和解决问题
image
image

修改建议
请说明您对这个问题的修改意见或建议,从用户的角度出发,您觉得应该怎么改。

其他备注或说明(可选)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.