-
Notifications
You must be signed in to change notification settings - Fork 500
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs/dind: update documentation of DinD installation #458
Conversation
* specify full path of template file * update commands and outputs
@@ -85,17 +86,17 @@ demo-tidb-peer ClusterIP None <none> 10080/TCP | |||
demo-tikv-peer ClusterIP None <none> 20160/TCP 1m | |||
|
|||
$ kubectl get configmap -n tidb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The output needs to be adjusted because of #435
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The output of configmap has no difference with the one currently in doc.
docs/local-dind-tutorial.md
Outdated
@@ -37,16 +45,9 @@ $ KUBE_REPO_PREFIX=uhub.ucloud.cn/pingcap manifests/local-dind/dind-cluster-v1.1 | |||
|
|||
## Step 2: Install TiDB Operator in the DinD Kubernetes cluster | |||
|
|||
Uncomment the `scheduler.kubeSchedulerImage` in `values.yaml`, set it to the same as your kubernetes cluster version. | |||
Uncomment the `scheduler.kubeSchedulerImage` in `charts/tidb-operator/values.yaml`, set it to desired version if needed, it is default to matching your kubernetes cluster version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With line 52, changing the values.yaml is unnecessary.
docs/local-dind-tutorial.md
Outdated
- [Helm Client](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client): 2.9.0 or later | ||
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl): 1.10 or later | ||
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl): at least 1.10 required, 1.13 or later recommended |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing. Could you make it clearer? Do you mean 1.10, 1.13 or later
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At least 1.10 is required to work, but we recommend users to use 1.13 or later for best compatibility.
docs/local-dind-tutorial.md
Outdated
|
||
In this sample output, the ports are: 32503 for Grafana, 32448 for Prometheus, and 32714 for TiDB. | ||
|
||
2. Find host IP address of the cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Find host IP address of the cluster. | |
2. Find the host IP address of the cluster. |
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
Co-Authored-By: AstroProfundis <allen@moe.cat>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What problem does this PR solve?
Testing current documentation of DinD installation and keep it up to date.
What is changed and how it works?
Tested all instructions in the DinD installation documentation on CentOS 7 and latest ArchLinux VMs, updated them to fit testing results and added some detailed notes.
Check List
Tests
Code changes
Side effects
Related changes