File: /zh/maintain-a-kubernetes-node.md

这里的命令kubectl写错了

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Question

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?

draft: https://docs.google.com/document/d/18-15NjiltD1uSbEvE7IpyOFlPQUKskyyaH5h_pR7-kc/edit?usp=sharing

• using eksctl
• using network-attached PVs (no local volume provisioner etc)
• no user-data script
  • without local PVs, we don't need to format & mount local PVs
  • max open files is already 1048576 by default
• using helm 3 (helm 2 is old and hard to use)
• remove "自定义" sections
  • but may add instructions on how to add a new node group to deploy TiFlash, etc.

Error Report

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!

1. What is the URL/path of the document related to this issue?

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

2. How would you like to improve it?

#362
#405
#406
#437
#439
#453
#460
#496

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

Backup & Restore

• Overview
  • 需要提一下Scenarios -- link to logical and physical backup & restore
• Grant Permissions to Remote Storage
  • S3
  • GCS
• Backup with Dumpling
  • Backup to S3
  • Backup to GCS
• Restore with TiDB Lightning
  • Restore from S3
  • Restore from GCS
• Backup with BR
  • Backup to S3
  • Backup to GCS
  • Backup to NFS
• Restore with BR
  • Restore from S3
  • Restore from GCS
  • Restore from NFS

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Question

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:

• Searched existing Stack Overflow questions.
• Googled your question.
• Read the documentation:
  • TiDB Operator (en)
  • TiDB Operator (zh)

Now, please describe your question here:

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

Enable Automatic Failover -> Configure Automatic Failover

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Change Request

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!

1. 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

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

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)

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 没有生成，是否要在文档下给出原因及 解决方案

part of pingcap/tidb-operator#2061

this is a track issue for docs about Advanced StatefulSet feature

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.

File: /zh/upgrade-tidb-operator.md

Q1: 怎么确定升级operator成功？换句话说，怎么确定我的operator在版本1.1
Q2: 升级operator之后是否对已存在tidb cluster作变化？ 如果没有变化，如何升级现有的tidb cluster?

https://github.com/pingcap/docs-tidb-operator/blob/master/en/collect-tidb-logs.md

Change Request

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!

1. 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.

2. Describe your suggestion or addition.

3. 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.

pingcap/tidb-operator#2754

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.

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

Scale TiDB Cluster

• https://pingcap.com/docs/tidb-in-kubernetes/stable/scale-a-tidb-cluster/#horizontal-scaling-operations-cr
• Add a command to scale up
• Add a note that horitzontal scaling may not be successful and link to https://pingcap.com/docs/tidb-in-kubernetes/stable/troubleshoot/#the-pod-is-in-the-pending-state
• Add a note that vertical scaling may not be successf https://pingcap.com/docs/tidb-in-kubernetes/stable/scale-a-tidb-cluster/#vertical-scaling
• https://pingcap.com/docs/tidb-in-kubernetes/stable/enable-tidb-cluster-auto-scaling/ Rename Quick Start to example, add expected behaviors and what to look for when running sysbench.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

https://pingcap.com/docs/tidb-in-kubernetes/stable/benchmark-sysbench/ exists but no link links to it.

Which section should we put it in?

集群的yaml metadata:name: test = 监控的yaml spec:clusters: name: test，这点可以多点阐述吗，有时候刚上手还是有点不解的

Change Request

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

   Lacks markdownlint check

2. Describe your suggestion or addition.

   Add markdownlint rules to the CI check of this repo as that in pingcap/docs-cn

3. Provide some reference materials (documents, websites, etc) if you could.

   pingcap/docs-cn

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.

Change Request

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!

1. 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
   Data Import

• Deploy tikv-importer
• Deploy tidb-lightening
  • Configure
    • SecretKey
      • Grant Permissions
      • Create Secret
    • IAM role
      • Grant Permissions
      • Create Secret
    • Service Account
      • Grant Permissions
      • Create Secret
  • Deploy
  • Destroy

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

ref: https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/tidb-operator-overview/

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

https://pingcap.com/docs/tidb-in-kubernetes/v1.1/deploy-tidb-from-kubernetes-kind/ is too complex to follow.

2. Describe your suggestion or addition.

• kind is not for production, in quick start, we don't need to create a multiple node cluster
• kind has builtin storage now, local-volume-provisioner is not necessary

we can

• install kind and run kind create cluster to start a single-node cluster
• run helm repo add .. && helm install ... to install tidb-operator with default configuration
• run kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-cluster.yaml to start a basic tidb cluster

3. Provide some reference materials (documents, websites, etc) if you could.

https://kind.sigs.k8s.io/

this is track issue for docs about pause feature (pingcap/tidb-operator#2013)

Change Request

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!

1. 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.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Change Request

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.

Change Request

As per pingcap/tidb-operator#1269

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

Restart a TiDB Cluster

• https://pingcap.com/docs/tidb-in-kubernetes/stable/restart-a-tidb-cluster/
• https://pingcap.com/docs/tidb-in-kubernetes/stable/restart-a-tidb-cluster/#performing-a-graceful-rolling-restart-to-all-pods-in-a-component Change to kubectl edit to add annotation.
• When linking to install or update TiDB Operator, link to https://pingcap.com/docs/tidb-in-kubernetes/stable/deploy-tidb-operator/#customize-tidb-operator

2. Describe your suggestion or addition.

3. 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.

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 自动伸缩等功能。

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}

Change Request

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!

1. 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”

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Feature Request

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:

• #378

this is a track issue for docs about GKE deployment with terraform

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

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.

2. Describe your suggestion or addition.

3. 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.

Change Request

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!

1. Describe what you find is inappropriate or missing in the existing docs.

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.

2. Describe your suggestion or addition.

3. Provide some reference materials (documents, websites, etc) if you could.

Current disaster recovery documentation is very centered around an Ansible deployment. We need better docs for a disaster recovery on k8s.

Change Request

Please answer the following questions before submitting your issue. Thanks!

1. Describe what you find is inappropriate or missing in the existing docs.

   Lacks the broken link CI check

2. 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.

3. Provide some reference materials (documents, websites, etc) if you could.

   pingcap/docs-cn