tidb-operator: fix documentation usability issues in GCP document #519
Conversation
|
|
deploy/gcp/README.md
Outdated
| ```bash | ||
| gcloud compute ssh bastion --zone <zone> | ||
| mysql -h <tidb_ilb_ip> -P 4000 -u root | ||
| ``` | ||
|
|
||
| It is possible to interact with the cluster using `kubectl` and `helm` with the kubeconfig file `credentials/kubeconfig_<cluster_name>`. The default `cluster_name` is `my-cluster`, it can be changed in `variables.tf` | ||
| It is possible to interact with the cluster using `kubectl` and `helm` with the kubeconfig file `credentials/kubeconfig_<cluster_name>`. The default `cluster_name` is `my-cluster`, it can be changed in `variables.tf`: |
There was a problem hiding this comment.
Putting the descriptions for helm and kubectl in "access the database" section is not reasonable, suggest adding a new section like "interact with the cluster" or "manage the cluster"?
deploy/gcp/README.md
Outdated
| When you are done, the infrastructure can be torn down by running: | ||
|
|
||
| ``` shell |
There was a problem hiding this comment.
All "bash" in above codes, keep it same here？
deploy/gcp/README.md
Outdated
|
|
||
| > *Note*: The service account must have sufficient permissions to create resources in the project. The `Project Editor` primitive will accomplish this. | ||
|
|
||
| To set the three environment variables, you can first run `vi ~/.bash_profile` and insert the `export` statements in it. Here is an example in `~/.bash_profile`: |
There was a problem hiding this comment.
Suggest to replace "insert" with "append", BTW, also need to source the file (source ~/.bash_profile or . ~/.bash_profile) after editing
deploy/gcp/README.md
Outdated
|
|
||
| > *Note*: Incrementing the node count will create a node per GCP availability zones. | ||
| > *Note*: Incrementing the node count will create a node per GCP availability zone. |
There was a problem hiding this comment.
Should be "available zone"?
There was a problem hiding this comment.
In the variables.tf file, the descriptions for tidb_count, tikv_count and other variables all use "per GCP availability zone", so I think we should unify the wording by using "availability" here.
|
I have updated some examples and descriptions according to other deployment docs (see PR#507). PTAL @DanielZhangQD @jlerche @tennix |
deploy/gcp/README.md
Outdated
| The upgrading does not finish immediately. You can run `kubectl --kubeconfig credentials/kubeconfig_<cluster_name> get po -n tidb --watch` to verify that all pods are in `Running` state. Then you can [access the database](#access-the-database) and use `tidb_version()` to see whether the cluster has been upgraded successfully: | ||
|
|
||
| ```sql | ||
| MySQL [(none)]> select tidb_version()\G |
…-usability-issues-found-in-GCP-deployment-doc
deploy/gcp/README.md
Outdated
| > *Note*: The service account must have sufficient permissions to create resources in the project. The `Project Editor` primitive will accomplish this. | ||
|
|
||
| To set the three environment variables, you can first run `vi ~/.bash_profile`, append the `export` statements to it and run `source ~/.bash_profile`. | ||
|
|
There was a problem hiding this comment.
You can actually type export FOO=var or something like that in the terminal, so setting the environment variables in bash_profile is a little overkill. I would suggest removing the line "To set the three environment variables, you can first run vi ~/.bash_profile, append the export statements to it and run source ~/.bash_profile. "
There was a problem hiding this comment.
If export in the terminal, after customer quit from the session and then open another session to run terraform, the variables need to be exported again, I think it's not convenient
deploy/gcp/README.md
Outdated
|
|
||
| To set the three environment variables, you can first run `vi ~/.bash_profile`, append the `export` statements to it and run `source ~/.bash_profile`. | ||
|
|
||
| Here is an example of `~/.bash_profile`: |
There was a problem hiding this comment.
| Here is an example of `~/.bash_profile`: | |
| For example, in your terminal you can enter: |
There was a problem hiding this comment.
Updated. PTAL again. @jlerche @DanielZhangQD
…n-GCP-deployment-doc
yikeke
deleted the
Fix-documentation-usability-issues-found-in-GCP-deployment-doc
branch
What problem does this PR solve?
fix documentation usability issues found in GCP deployment document
What is changed and how it works?
Check List
Tests
Code changes
Side effects
Related changes
Does this PR introduce a user-facing change?: