Skip to content
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

Merged
merged 25 commits into from
May 9, 2019

Conversation

AstroProfundis
Copy link
Contributor

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

  • No code

Code changes

  • Has documents change

Side effects

  • N/A

Related changes

  • N/A

@AstroProfundis AstroProfundis requested review from tennix and lilin90 May 7, 2019 03:56
@CLAassistant
Copy link

CLAassistant commented May 7, 2019

CLA assistant check
All committers have signed the CLA.

docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
@@ -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
Copy link
Member

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

Copy link
Contributor Author

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.

@@ -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.
Copy link
Member

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.

@lilin90 lilin90 self-assigned this May 7, 2019
@tennix tennix added the area/doc label May 8, 2019
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
- [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
Copy link
Member

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?

Copy link
Contributor Author

@AstroProfundis AstroProfundis May 8, 2019

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 Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Find host IP address of the cluster.
2. Find the host IP address of the cluster.

docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
AstroProfundis and others added 10 commits May 8, 2019 15:16
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>
tennix
tennix previously approved these changes May 8, 2019
Copy link
Member

@tennix tennix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AstroProfundis AstroProfundis changed the title docs/dind: update documentation of DinD installation docs/dind: update deployment documentations May 9, 2019
@AstroProfundis AstroProfundis changed the title docs/dind: update deployment documentations docs/dind: update documentation of DinD installation May 9, 2019
docs/local-dind-tutorial.md Outdated Show resolved Hide resolved
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
@AstroProfundis AstroProfundis dismissed stale reviews from tennix via 712a103 May 9, 2019 04:56
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@AstroProfundis AstroProfundis merged commit 8e0cc92 into pingcap:master May 9, 2019
@AstroProfundis AstroProfundis deleted the validate-docs branch May 9, 2019 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants