pingcap / pingcap/tiup

`tiup playground scale-out` should support the `--ticdc.config` and `--kvcdc.config` flags

Open
#2,615 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type/feature-request
Dominant language
Go
Stars
466
Forks
338
Avg merge
3d 7h
Merged PRs (30d)
8

Description

Feature Request

Is your feature request related to a problem? Please describe:

$ tiup playground scale-out --ticdc 1 --ticdc.config new-arch-cdc.toml 
Error: unknown flag: --ticdc.config

Describe the feature you'd like:

Support --ticdc.config (and --kvcdc.config). All other components have a config flag in the scale-out subcommand, so these are likely an oversight.

$ tiup playground scale-out --help | grep config
      --db.config string            TiDB instance configuration file
      --dm-master.config string     DM-master instance configuration file
      --dm-worker.config string     DM-worker instance configuration file
      --drainer.config string       Drainer instance configuration file
      --kv.config string            TiKV instance configuration file
      --pd.config string            PD instance configuration file
      --pump.config string          Pump instance configuration file
      --scheduling.config string    Scheduling instance configuration file
      --tiflash.config string       TiFlash instance configuration file
      --tiproxy.config string       TiProxy instance configuration file
      --tso.config string           TSO instance configuration file

Why the feature is needed:

Obvious.

Describe alternatives you've considered:

None.

Teachability, Documentation, Adoption, Migration Strategy:

Trivial.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the tiup playground scale-out command and inspect how the existing component .config flags are defined and passed through. Add equivalent support for --ticdc.config and --kvcdc.config, then verify that scale-out --help lists both flags and that the example command no longer reports an unknown flag.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.