pingcap / docs-tidb-operator Goto Github PK
View Code? Open in Web Editor NEWDocumentation for TiDB on Kubernetes in both English and Chinese.
Home Page: https://docs.pingcap.com/tidb-in-kubernetes
License: Other
Documentation for TiDB on Kubernetes in both English and Chinese.
Home Page: https://docs.pingcap.com/tidb-in-kubernetes
License: Other
this is a track issue for docs about Advanced StatefulSet feature
https://pingcap.com/docs/tidb-in-kubernetes/stable/benchmark-sysbench/ exists but no link links to it.
Which section should we put it in?
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
https://pingcap.com/docs/tidb-in-kubernetes/v1.1/deploy-tidb-from-kubernetes-kind/ is too complex to follow.
local-volume-provisioner
is not necessarywe can
kind create cluster
to start a single-node clusterhelm repo add .. && helm install ...
to install tidb-operator with default configurationkubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-cluster.yaml
to start a basic tidb clusterThis repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/#deploy-kubernetes-cluster
Consider linking to production deployment on public cloud
For deployment on public cloud, consider linking to production deployment on self managed k8s.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
this is a track issue for docs about GKE deployment with terraform
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
Is your feature request related to a problem? Please describe:
Describe the feature you'd like:
Describe alternatives you've considered:
Teachability, Documentation, Adoption, Migration Strategy:
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Scale TiDB Cluster
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
File: /en/deploy-on-general-kubernetes.md
on step 2 on Deploy TiDB Cluster
, it should be ${cluster_name}/tidb-cluster.yaml
rather than a cluster name, right?
kubectl apply -f ${cluster_name}/tidb-cluster.yaml -n ${namespace}
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
https://pingcap.com/docs/tidb-in-kubernetes/stable/access-tidb/
Delete in Kubenetes for “Access the TiDB Cluster in Kubernetes”
If this section is under a self managed k8s cluster, consider removing the load balancer as it is only used in public clouds.
Consider merging with configure TiDB.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
By default, the Backup
CR has a finalizer for protection, when users delete the object, it will hang in Terminating
state. This behavior is not documented thus confusing users.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Enable Automatic Failover -> Configure Automatic Failover
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
I have read the document about prerequisites... It shows that the minimum version of Kubernetes cluster is v1.12.5 and the minimum version of docker-ce is 18.09.6.
I Got a cluster which is v.1.12.4, docker-ce which is 18.06.3 and neither of them supports upgrade... So can I use the operator in the cluster? What effect do these differences take?
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Restart a TiDB Cluster
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
Move https://pingcap.com/docs/tidb-in-kubernetes/stable/tidb-operator-overview/#tidb-operator-architecture to a new page under architecture section.
this is track issue for docs about pause feature (pingcap/tidb-operator#2013)
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Before submitting your question, make sure you have:
Now, please describe your question here:
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
https://pingcap.com/docs/tidb-in-kubernetes/stable/restore-data-using-tidb-lightning/#deploy-tidb-lightning
Change name to Import Data
Change document name from “Restore Data into TiDB in Kubernetes” to “Import Data”
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
File: /zh/notes-tidb-operator-v1.1.md
从 TiDB Operator v1.1.0 开始,PingCAP 不再继续更新维护 tidb-cluster chart
,原来由 tidb-cluster chart 负责管理的组件或者功能在 v1.1 中的变更如下:
但后面的文字与上一句矛盾
tidb-cluster chart 仍然会继续发布,但是不再添加新功能
,比如组件 TLS(目前只是部分支持)、TiKV 和 TiDB 自动伸缩等功能。
Current disaster recovery documentation is very centered around an Ansible deployment. We need better docs for a disaster recovery on k8s.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/configure-cluster-using-tidbcluster/#%E9%85%8D%E7%BD%AE-tikv-%E9%85%8D%E7%BD%AE%E5%8F%82%E6%95%B0 the example configuration for tikv is not correct.
The below configurations cannot be configured under the config directly.
grpc-concurrenc: 4
sync-log: true
part of pingcap/tidb-operator#2061
This is useful when the connection to docker.io is slow or blocked.
We can use mirrors hosted by azure. (for azure IP only now, ref: http://mirror.azure.cn/help/docker-registry-proxy-cache.html)
As per pingcap/tidb-operator#1269
File: /zh/configure-storage-class.md
文章【Kubernetes 上的持久化存储类型配置】下,标题【本地 PV 配置】下 运行
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/local-dind/local-volume-provisioner.yaml
运行后,验证 pod 运行正常,但 PV 没有生成,是否要在文档下给出原因及 解决方案
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Modify TiDB Configuration
https://pingcap.com/docs/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster/#update-the-configuration-of-tidb-cluster-using-tidbcluster-cr
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
There are cases where users are running TiKVs using local disk in one node pool e.g. with 8 CPUs but want to migrate to another node pool with more cpus, e.g. 16 CPUs.
We have to provide procedures to instruct users to migrate.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
Currently, TiDB cluster does not have backup lock. Users have to manually configure TiKV GC lifetime to avoid data be GCed, tidb-operator automatically configures TiKV GC lifetime during backup. This should be documented and when the backup job failed, how users should handle it.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Lacks the broken link CI check
Describe your suggestion or addition.
Add the broken link CI check to this repo as that in pingcap/docs-cn. Thanks a lot!
Please note that the link path rule is not the same as that in pingcap/docs-cn. See TOC.md.
Provide some reference materials (documents, websites, etc) if you could.
draft: https://docs.google.com/document/d/18-15NjiltD1uSbEvE7IpyOFlPQUKskyyaH5h_pR7-kc/edit?usp=sharing
max open files
is already 1048576 by defaultThis repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Backup & Restore
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
binlog 部署好测试正常后,发现 binlog 监控面板没有数据
File: /en/deploy-on-gcp-gke.md
When running ./create-service-account.sh
Will encounter the following error,
creating a new service account terraform
ERROR: (gcloud) The project property must be set to a valid project ID, not the project name [
macro-griffin-333333
Had to use command line to create service account.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Lacks markdownlint check
Describe your suggestion or addition.
Add markdownlint rules to the CI check of this repo as that in pingcap/docs-cn
Provide some reference materials (documents, websites, etc) if you could.
集群的yaml metadata:name: test = 监控的yaml spec:clusters: name: test,这点可以多点阐述吗,有时候刚上手还是有点不解的
File: /zh/deploy-tidb-operator.md
I believe both English and Chinese version have the same issue. There is no steps for creating tidb-admin namespace.
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
Describe what you find is inappropriate or missing in the existing docs.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
File: /zh/upgrade-tidb-operator.md
Q1: 怎么确定升级operator成功?换句话说,怎么确定我的operator在版本1.1
Q2: 升级operator之后是否对已存在tidb cluster作变化? 如果没有变化,如何升级现有的tidb cluster?
This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
https://pingcap.com/docs/tidb-in-kubernetes/stable/monitor-using-tidbmonitor/
Consider removing the get started section or merge it with getting started doc https://pingcap.com/docs/tidb-in-kubernetes/stable/get-started/.
https://pingcap.com/docs/tidb-in-kubernetes/stable/monitor-a-tidb-cluster/
Consider moving the k8s monitoring to a separate document under Reference
.
Consider merging the above two docs into one doc.
Describe your suggestion or addition.
Provide some reference materials (documents, websites, etc) if you could.
aws/gke: #579
Since the network connection to docker.io is too slow in China, we can guide users to use alternative images.
btw, we should suggest users using the latest version of kind (0.8.1), as the contained
in the default node image of kind 0.7.0
has compatible issues in pulling images.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.