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

tiup: deployment of tiproxy might be incomplete #20084

Open
dveeden opened this issue Jan 21, 2025 · 1 comment · May be fixed by #20141 or pingcap/docs-cn#19686
Open

tiup: deployment of tiproxy might be incomplete #20084

dveeden opened this issue Jan 21, 2025 · 1 comment · May be fixed by #20141 or pingcap/docs-cn#19686
Assignees
Labels
area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool.

Comments

@dveeden
Copy link
Contributor

dveeden commented Jan 21, 2025

Error Report

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

https://docs.pingcap.com/tidb/stable/tiproxy-overview#deploy-tiproxy

  1. How would you like to improve it?

It looks like something like this is missing:

tiproxy_servers:
  - host: 192.168.122.196

Maybe besides "Configure the TiProxy instances." there should also be a "Define TiProxy instances"?

See also: https://docs.pingcap.com/tidb/stable/tiup-cluster-topology-reference#tiproxy_servers

cc @djshow832 @qiancai

@dveeden dveeden added the area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool. label Jan 21, 2025
@djshow832 djshow832 self-assigned this Jan 21, 2025
@dveeden
Copy link
Contributor Author

dveeden commented Jan 22, 2025

Related issue:

https://docs.pingcap.com/tidb/stable/tiup-cluster-topology-reference#tiproxy_servers says there is a data_dir under tiproxy_servers.

But https://github.com/pingcap/tiup/blob/8e15a038a9fcd7c4562fc9839263609fb9eafe37/pkg/cluster/spec/tiproxy.go#L73-L84 doesn't show this.

When deploying it leads to this:

$ tiup cluster check tidb-dba scale-out-tiproxy.yaml --cluster
Checking updates for component cluster...
Error: Failed to parse topology file scale-out-tiproxy.yaml (topology.parse_failed)
  caused by: yaml: unmarshal errors:
  line 5: field data_dir not found in type spec.TiProxySpec

Please check the syntax of your topology file scale-out-tiproxy.yaml and try again.
tiproxy_servers:
  - host: 10.0.0.1
    deploy_dir: "/tiproxy-deploy"
    data_dir: "/tiproxy-data"
    port: 3306
    status_port: 3080
    config:
      log.level: warn
      log.format: json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tiup Indicates that the Issue or PR belongs to the area of the TiUP tool.
Projects
None yet
2 participants