tiup/CHANGELOG.md at master · pingcap/tiup

TiUP Changelog

[1.16.5] 2026-04-10

New Features

tiup-playground-ng Initial commit: new playground experience with interactive TUI, boot plan, and dry-run support (#2662, @breezewish)
tiup-playground-ng support daemon mode with ps/stop-all commands and event-log progress replay (#2671, @breezewish)
tiup-playground-ng support parallel download for components (#2676, @breezewish)
tiup-cluster support deploying resource manager service (#2659, @okJiang)
tiup-cluster support router service mcs (#2636, @bufferflies)
tiup-cluster support retention by size for prometheus (#2612, @AstroProfundis)
tiup-cluster support ng-monitoring config via server_configs and per-instance overrides (#2685, @boltandrke)
tiup-cluster support RHEL9 (#2699, @xhebox)
tiup-playground support router and resource manager services (#2600, @rleungx)
tiup-playground support tidb-x (next generation mode) (#2619, #2608, #2641, @xhebox)
tiup add option to force redownload binaries (#2648, @xhebox)

Improvements

tiup-cluster unify default tiflash logger size/count with documentation (#2683, @fzzf678)
tiup-cluster use full env only when TIUP_CLUSTER_DEBUG is true (#2637, @mzhang77)
tiup-cluster replace TextToMetricFamilies with regexp (#2695, @xhebox)
tiup-cluster check both SELinux status and config (#2496, @dveeden)
tiup-cluster persistent disable THP (#2498, @dveeden)
tiup-playground wait PD ready before starting TiDB to avoid cluster ID mismatch (#2679, @amyangfei)
tiup-playground-ng fix arg0 and polish help rendering (#2673, @breezewish)
tiup-playground refine nextgen version resolve (#2640, #2621, #2622, @xhebox)
tiup-playground, tiup-cluster respect HOME env variable (#2628, @dveeden)
tiup-cluster cleanup ansible import related things (#2630, @dveeden)
tiup cleanup unit test generated data (#2647, @AstroProfundis)
tiup-playground don't request mirror when binpath specified (#2645, @xhebox)
tiup-playground better help message (#2664, @JaySon-Huang)
tiup upgrade usql (#2595, @dveeden)

Fixes

tiup-playground-ng fix force kill (#2674, @breezewish)
tiup-playground-ng fix release (#2667, @xhebox)
tiup disable ANSI escape sequences when stdout is not a TTY (#2701, @xhebox)
tiup fix recording of execution history with sensitive info redaction (#2635, @dveeden)
tiup fix yaml.v3 float serialization to preserve decimal point (#2687, @WizardWuuu)
tiup-playground fix metafile location (#2638, @dveeden)
tiup-playground fix monitor version for nextgen (#2622, @xhebox)
tiup-playground fix config in CSE/NextGen modes (#2666, @Lloyd-Pottiger)
tiup-playground fix tiflash start with old mode unexpectedly (#2670, @JaySon-Huang)
tiup fix no need mirror be set --version and --help (#2658, @u5surf)
tiup-cluster return the error message correctly (#2652, @xhebox)
tiup-cluster fix instance level timeout stop (#2644, @xhebox)
tiup-cluster fix panic with restore-leaders (#2697, @sgykfjsm)
tiup-cluster treat version as string instead of float when compare (#2656, @ghoshh)
tiup-playground fix nextgen install (#2649, @Lloyd-Pottiger)

Miscellaneous

Update dependencies (#2688, @dveeden)
Update golang.org/x/net (#2631, @dveeden)
Run go fix (#2689, @dveeden)
CI: update versions and rely on go.mod (#2690, @dveeden)
CI: update and fix integrate-dm (#2643, @dveeden)
CI: try fix release CD (#2700, @xhebox)
Switch to codecov-action (#2639, @dveeden)
Remove ansible import functionality (#2565, @dveeden)

[1.16.4] 2025-10-28

Fixes

Fix that tiup did not remove download tempdir (#2626, @xhebox)
Fix that tiup may not close gracefully sometimes (#2607, @xhebox)
Fix possible panic duration tiup-cluster upgrade (#2598, @xhebox)
Fix that tiup dont repect the HOME env variable in some cases (#2624, @dveeden)
Fix typos in tiup (#2601, @ottok)

[1.16.3] 2025-08-26

New Features

tiup-cluster now supports victoria metrics (#2520, #2530, #2532, @nolouch)
tiup-cluster could specify start/stop timeout for service (#2568, @xhebox)
tiup-cluster added --restart-timeout for intervals between rolling restart (#2513, @dveeden)
tiup-playground supports tikv-worker and --tikv.columnar in tidb-cse mode (#2536, @breezewish)

Fixes

Fix tiup-playground build for 32-bit platforms (#2528, @dveeden)
tiup will now exclude pre-release version from version list (#2550, @xhebox)
tiup-cluster check will also verify monitoring ports (#2563, @xhebox)
tiup-cluster has better compatibility with SELinux (#2501, @dveeden)
Fix wrong description of tiup-cluster --ssh (#2380, @xhebox)
Fix a config typo of PD for tiup-playground (#2578, @rleungx)
Fix missing tiflash-proxy metrics for tiup-playground (#2587, @Lloyd-Pottiger)
tiup-cluster will check if PD has loaded all regions after restart for v8.5.2 and above (#2592, @xhebox)
tiup-cluster will clear leader_priority to prevent failure of leader eviction (#2593, @xhebox)

Improvements

tiup-playground added --perf for high performance testing usage, for tiflash only (#2535, @breezewish)
tiup-cluster added example for tiflash and tiflash-proxy config for minimal.yaml and multi-dc.yaml (#2551, @JaySon-Huang)
Lots of code cleanup work (#2525, #2518, #2547, #2549, #2540, #2552, #2560, #2557, #2559, #2555, #2556, #2561, #2562, #2564, #2542, #2553, #2566, #2569, #2571, #2576, #2579, #2582, #2577, #2570, #2558, @dveeden, @xhebox, @wuhuizuo, @Lloyd-Pottiger)

[1.16.2] 2025-04-02

New Features

tiup-cluster display will also show dashboard server URLs (#2472, @xhebox)
Add --mode=tiflash-disagg for tiup-playground (#2492, @breezewish)
tiup-cluster now accepts args config for alertmanager (#2516, @WalterWj)
tiup-cluster will fill node & role information in custom upgrade scripts (#2524, @xhebox)

Fixes

Fix tiup-playground typo and display names for tiflash (#2454, @breezewish)
Fix # cannot be included in grafana password for tiup-cluster (#2468, @kaaaaaaang, @xhebox)
Fix binary name display of tiup-playground for pd-ms binaries (#2471, @xhebox)
In tiup-playground, MySQL 9.x don't need --comments (#2469, #dveeden)
Fix code typo (#2487, @rleungx)
Fix loong64 build (#2493, @xhebox)
Remove created directories after fio test in tiup-cluster check (#2511, @djshow832)
Remove some useless metrics for performance for tiup-cluster (#2523, @XuHuaiyu)

Improvements

Add cdc server topology example for tiup-cluster (#2466, @wk989898)
Add tiproxy to tiup-playground DSN (#2474, @xhebox)
Polish the trust key warning for tiup-cluster and tiup mirror (#2475, @breezewish)
Update supported OS version for tiup-cluster check (#2476, @dveeden)
add warning for deletion of data dir for tiup-playground (#2481, @xhebox, @bb7133)
tiup-cluster will now display grafana, and also grafana patched (#2483, @WalterWj)
Improve error of missing tar for tiup-cluster (#2499, @dveeden)
Reword for tiup uninstall (#2488, @makocchi-git)
Code cleanup, dependency sysinfo update (#2500, @dveeden)
Fix message for net.core.somaxconn check in tiup-cluster (#2495, @dveeden)
Code cleanup, fix code misc spelling (#2504, @ottok)
Add tmpdir option for tiup-cluster (#2505, @dveeden)
Code cleanup, unify main deps with client component deps (#2517, @dveeden)

[1.16.1] 2024-10-31

New Features

Deploy DM in tiup-playground (#2465, @GMHDBJD, @siddontang)

Fixes

Fix several racings during download, do not upgrade nightly automatically in tiup-cluster (#2458, @xhebox)
Fix possible panic when tiup-playground failed to start (#2457, @xhebox)
Respect component_versions when tiup-cluster scales (#2451, @djshow832)
Code clean: replace 'math/rand' with 'crypto/rand' (#2455, @bb7133)
Fix tiup cannot update itself when tiup component exist (#2443, @nexustar)
Do not check HTTP port for TiFlash 7.1.0 or above (#2440, @Lloyd-Pottiger)
Also hide other password args (#2436, @xhebox)

Improvements

Avoid unnecessary primary transfer for pdms mode in tiup-cluster (#2414, @HuSharp)
Add --port-offset for tiup-playground to start multiple instances without port conflicts (#2453, @breezewish)
Start with a name for pdms mode in tiup-cluster and tiup-playground (#2438, #2446, #2447, @HuSharp)
Remove prometheus systemd and interrupts collector (#2445, @xhebox)
Add example of setting the tiflash-proxy topology (#2444, @JaySon-Huang)
Improve cluster restart messaging for tiup-cluster (#2442, @zph)
Print version when filling tiup-playground --xx.binpath (#2334, @HuSharp)
Only display --comments when needed for tiup-playground (#2314, @dveeden)

[1.16.0] 2024-06-27

New Features

Deploy PD as microservices in tiup-cluster (#2377, @rleungx)

Fixes

Fix missing TiProxy session certs when tiup-cluster scale-out (#2432, @djshow832)

Improvements

Remove tombstone nodes of pd when executing tiup-cluster prune (#2044, @nexustar)
Redact -p (password) arguments in command execution (#2425, @nexustar)
Avoid duplicated downloads when upgrade (#2423, @nexustar)

[1.15.2] 2024-05-28

Improvements

Remove LGPL dependency

[1.15.1] 2024-04-11

Fixes

Fix cannot choose cluster version in tiup-playground (#2397 #2402, @nexustar)
Fix wrong TiFlash numa config in tiup-cluster (#2401, @gengliqi)

Improvements

Wait for TSO component ready in tiup-playground (#2349, @HuSharp)
Improve error handling of mirror renew in tiup (#2400, @dveeden)

[1.15.0] 2024-04-01

New Features

Support no-sudo mode in tiup-cluster (#2350 #2373, @Yujie-Xie)
Add tidb-cse mode and remove tidb-disagg mode in tiup-playground (#2386, @breezewish)

Fixes

Fix can not set runtime config in config file specific by --tiflash.config in tiup-playground (#2346 #2383, @Lloyd-Pottiger)
Fix not sanitize tiproxy component config when scale in in tiup-playground (#2365, @xhebox)
Fix timeout when checking component upgrade in tiup (#2379, @KanShiori)
Fix pdms grafana display in tiup-playground (#2382, @HuSharp)
Fix not update prometheus config when scale in in tiup-cluster (#2387, @Yujie-Xie)

Improvements

Set the TiFlash logger level to DEBUG in tiup-playground (#2346, @Lloyd-Pottiger)
Add integration tests for tiproxy in tiup-cluster (#2371, @xhebox)
Set tiproxy addr without schema in tiup-playground (#2368, @xhebox)
Only pull nightly from cluster version in tiup-playground (#2364, @xhebox)
Skip tiproxy download & copy when upgrade in tiup-cluster (#2366, @xhebox)
Auto set session certs if there is a tiproxy in tiup-cluster (#2374, @xhebox)
Auto generate self-signed certs for TiProxy session migration in tiup-playground (#2372, @xhebox)
Remove resource manager in tiup-playground (#2381, @rleungx)
Add config advertise-addr to tiproxy spec in tiup-cluster and tiup-playground (#2392, @djshow832)

[1.14.1] 2024-01-12

Fixes

Fix tiproxy will restart even if version is the same in tiup-cluster (#2358, @xhebox)
Fix that empty label is not allowed in Prometheus in tiup-cluster (#2349, @borissavelev)
Fix can not set runtime config in config file & set TiFlash logger level to debug in tiup-playground (#2346, @Lloyd-Pottiger)
Fix TLS configs for tiproxy in tiup-cluster (#2356, @xhebox)
Fix cannot clone without global version in tiup (#2359, @nexustar)
Fix tiproxy config and version in tiup-cluster (#2354, @xhebox)
TiProxy needs to override usercfg in tiup-playground (#2342, @xhebox)
Fix the start script for alertmanager when enabling numa in tiup-cluster and tiup-dm (#2337, @KanShiori)
Fix metric targets will be overrided in tiup-playground (#2324, @xhebox)

Improvements

Change typo waitting to waiting in output messages for pdapi.go in tiup-cluster (#2330, @guangleibao)
Add check for rocky linux in tiup-cluster (#2333, @dveeden)
Fallback to default version when componen specific version is empty in tiup-playground (#2344, @xhebox)

[1.14.0] 2023-11-17

New Features

Support use different component versions in tiup-cluster (#2010 #2264 #2306, @nexustar)
Add global listen_host config in tiup-cluster and tiup-dm (#2303, @nexustar)
Add global component_sources config in tiup-cluster and tiup-dm (#2320, @nexustar)
Support TiDB upgrade API to automatically pause DDL when upgrade in tiup-cluster(#2287 #2289, @nexustar)
Support TiProxy in tiup-cluster (#2271, @xhebox)
Support scheduling service in tiup-playground (#2273, @rleungx)
Support to show numa node when display in tiup-cluster and tiup-dm (#2295 #2312, @KanShiori)

Fixes

Make sure to signal tiproxy to stop in tiup-playground (#2318, @dveeden)
Fix "clone" operation may be missing packages without throwing an error in tiup (#2309 #2311, @nexustar)
Not cache the output of ss -tln command when checking wether components are started/stopped in tiup-cluster and tiup-dm (#2298, @KanShiori)
Fix tidb-dashboard listen_host in tiup-cluster (#2304, @nexustar)
Fix tiproxy metrics addr in tiup-playground (#2299, @xhebox)

Improvements

Upgrade go-sql-driver/mysql version to v1.7.1 (#2246, @srstack)
Use release version of TiProxy instead of nightly (#2305, @nexustar)
Use port to probe TiDB in tiup-playground (#2296, @KanShiori)
Add mcs name for pd log in tiup-playground (#2310, @HuSharp)
Not overwrite real error in retry function (#2290, @nexustar)
Fix alignment of output in tiup-playground (#2313, @dveeden)
ci improve (#2301 #2308 #2316, @nexustar @dveeden)

[1.13.1] 2023-09-25

Fixes

Increase timeout when publish package in tiup (#2269, @nexustar)
Fix pd microservice component id in tiup-playground (#2272, @iosmanthus)
Fix grafana for multiple instances using same host in tiup-cluster and tiup-dm (#2277, @lastincisor)
Add cdn workaround (#2285, @nexustar)
Mirror: fix progress bar is not accurate (#2284, @nexustar)

Improvement

Support ignore version check when upgrade in tiup-cluster and tiup-dm (#2282, @nexustar)

[1.13.0] 2023-08-26

New Features

Support run components without tiup in tiup (#2265, @nexustar)
Support tiproxy in tiup-playground (#2202, @xhebox)
Show warning and continue if cannot delete data dir when destroy/scale-in instead of error and exit in tiup-cluster (#2256, @nexustar)
Support specifying package name of components in tiup-cluster (#2236, @nexustar)
playground: support microservices mode in tiup-playground (#2226, @rleungx)

Fixes

Fix the issue meta backup is failed when symbolic links exist in meta dir in tiup-cluster (#2255, @@KanShiori)
Fix node filter on exec in tiup-cluster (#2251, @nexustar)

Improvements

Move to Go 1.21 (#2249, @dveeden)
Upgrade TiCDC before TiKV and PD when cluster is equal or greater than v5.1.0 in tiup-cluster (#2253, @KanShiori)
progress: Add option to add error detail (#2203, @dveeden)

[1.12.5] 2023-7-17

Fix

Fix cannot start tiflash above v7.1.0 in tiup-cluster (#2230, @zanmato1984)

[1.12.4] 2023-7-13

Fix

Fix cannot show tiflash uptime in tiup-cluster (#2227, @nexustar)

Improvement

Remove tcp_port for tiflash in tiup-cluster and tiup-playground (#2220, @zanmato1984)

[1.12.3] 2023-6-14

Fixes

Fix cannot edit manage_host on an exist cluster in tiup-cluster (#2210, @nexustar)
Fix still use host instead of manage_host in tiup-cluster (#2206 #2207, @nexustar)

Improvement

Check if the compnoent exists when uninstall in tiup (#2209, @srstack)

[1.12.2] 2023-5-19

Notes

Chore: migrate to new prow reviewing (#2160, @wuhuizuo)
Publish nightly tiup packages based on master branch (#2192, @nexustar)

Fixes

Fix cannot start alertmanager in tiup-cluster (#2200, @nexustar)
Fix TiFlash config not working in tiup-playground (#2190, @breezewish)
Fix --tiflash 0 not working in tiup-playground (#2189, @breezewish)
Fix port conflict when cluster version >= 5.4 and < 7.1 in tiup-playground (#2188, @Lloyd-Pottiger)
Fix cannot prune/scale-in tikv when use ipv6 in tiup-cluster (#2180, @nexustar)
Fix exec error when use ipv6 in tiup-cluster (#2193, @nexustar)

Improvements

Output PD endpoints in tikv-slim mode in tiup-playground (#2196, @breezewish)
Add --mode=tidb-disagg in tiup-playground (#2194, @breezewish)
Add option to specify TiKV port in tiup-playground (#2183, @dveeden)
include '--comments' in mysql command line arguments in tiup-playground (#2187, @mjonss)
Code refine for TiFlash in tiup-playground (#2177, @breezewish)
Code refine for args in tiup-playground (#2178, @breezewish)

[1.12.1] 2023-4-13

Fix

Fix ngm config in tiup-cluster (#2175, @Mystery-cyf)

Improvements

Remove TiFlash http service in tiup-cluster and tiup-playground (#2165, Lloyd-Pottige)
Remove ":" on default backup filename in tiup-cluster (#2174, @nexustar)
Allows setting other storage config for TiFlash when storage.main is not defined in tiup-cluster (#2161, @breezewish)
Support run TiFlash via args in tiup-playground (#2162, @breezewish)
Tidy output in tiup-playground (#2163, @breezewish)

[1.12.0] 2023-3-31

New Features

Support ipv6 in tiup-cluster and tiup-dm (#2068 #2069 #2070 #2075 #2117, @nexustar)
Add support for displaying the grafana URLs in JSON output in tiup-cluster and tiup-dm (#2041, @onlyacat)
Allow download directory when use builtin scp (#2098, @nexustar)
Support set manage host in tiup-cluster and tiup-dm (#2147, @srstack)
User perm from parent dir in tiup-cluster (#2143, @nexustar)
Support display tiflash uptime in tiup-cluster (#2094, @srstack)
Add ticdc port prob config in tiup-cluster (#2124, @sdojjy)
Allow users to run custom shell commands during the cluster rolling upgrade in tiup-cluster (#2130, @darkelf21cn)
Check upgrade offline in tiup-cluster (#2116, @srstack)
Check required CPU flags for TiFlash >= v6.3.0 in tiup-cluster (#2054, @solotzg)
Support connect to external Pushgateway in tiup-cluster (#2137, @nexustar)
Allow setting the TiCDC port in tiup-playground (#2140, @dveeden)

Improvements

Check the cdc capture can be found before drain the capture in tiup-cluster (#2059, @3AceShowHand)
Enable AutoTLS by default in tiup-playground (#2077, @dveeden)
Wait for leader to transfer back during rolling restart in tiup-cluster (#2051, @cosven)
Sync pdapi & typeutil with pd 6.3.0 in tiup-cluster (#2063, @AstroProfundis)
Optimize checks & tests (#2056, @AstroProfundis)
Mark openEuler as supported in tiup-cluster (#2145, @nexustar)
Merge tiflash config in tiup playground to reduce handwrite config in tiup-playground (#2086, @iosmanthus)
Add TIUP_VERBOSE in doc (#2111, @dveeden)
Delete storage.remote.cache.dir when prune in tiup-cluster (#2142, @hehechen)
Check process name before killing it in tiup clean (#2141, @dveeden)
Display disaggregated mode of TiFlash in tiup-cluster (#2133, @hehechen)
Remove mark_cache_size default value of tiflash.toml after v5.4.0 (#2138, @hongyunyan)
Delete !#$%&= from init password in tiup-cluster (#2136, @nexustar)

[1.11.3] 2023-02-14

Improvement

Disable telemetry by default (#2119, @nexustar)

[1.11.2] 2023-02-02

Fixes

base52: Check for invalid chars in Decode() (#2103, @AstroProfundis)

Improvements

Update upgrade message in tiup-cluster (#2110, @nexustar)
Comment out tidb-dashboard in template in tiup-cluster (#2112, @nexustar)
Warn for cleanup failures due to missing datadir in tiup clean (#2105, @dveeden)
Improve tiup timeout message in tiup (#2109, @nexustar)

[1.11.1] 2022-11-24

Note

tiup bench has been moved to https://github.com/PingCAP-QE/tiup-bench and not release with tiup

Fixes

Set madvdontneed=1 for PD to shrink RSS after GC in tiup-cluster (#2019, @lhy1024)
Fix playground may panic when component fail to start in tiup-playground (#2076, @nexustar)

Improvements

Support configuring scrape_interval and scrape_timeout for prometheus in tiup-cluster (#2071, @nexustar)
Remove the restriction that tikv num must be greater than 0 in tiup-playground (#2073, @lilinghai)
Mark kylin v10 as supported OS in tiup-cluster (#2079, @nexustar)
Set ETCDCTL_API=v3 to get the v3 API in tiup-ctl (#2081, @dveeden)
Avoid redirect when grafana root_url is set in tiup-cluster (#2082, @nexustar)

[1.11.0] 2022-09-23

New Features

Add support of new component tikv-cdc for tiup-cluster and tiup-playground (#2000, #2022, @pingyu)
Add support of dedicated tidb-dashboard in tiup-cluster (#2017, @nexustar)
Add support of TiCDC rolling upgrade for tiup-cluster (#1996, #2005, #2036, @3AceShowHand)
Add support to config TiCDC cluster-id for tiup-cluster (#2042, @nexustar)
Add support to set CPUAffinity in tiup-cluster (#2007, @YaozhengWang)
Allow to display memory usage in tiup-cluster (#1994, @nexustar)

Fixes

Fix tmp file not deleted when upload package in tiup-server (#2021, @nexustar)
Fix redundant log when start TiDB cluster with tiup-playground (#2032, @nexustar)
Fix panic when fail to start component in tiup-playground (#1933, @dveeden)
Fix scale-out cdc command in tiup-playground (#1935, @lonng)
Fix ineffectiveness of ticdc.config in tiup-playground (#1978, @pingyu)
Fix timezone check and remove duplicate cleanTasks in tiup-cluster (#2045, @nexustar)

Improvements

Use test-cluster as dashboard name in tiup-playground (#1920, @breezewish)
Add pd.port argument in tiup-playground (#1931, @pingyu)
Allow --tag argument on any locate in tiup-playground (#1998, @pingyu)

[1.10.3] 2022-08-11

Mirror update

Add new version for node_exporter (https://github.com/prometheus/node_exporter/releases/tag/v1.3.1) and blackbox_exporter (https://github.com/prometheus/blackbox_exporter/releases/tag/v0.21.1) in tiup repository. All the new tidb clusters or instances deployed by tiup cluster will use the new version by default.

Fixes

Fix cannot clean related tidb topology after scale-in in tiup-cluster (#2011, @nexustar)
Fix fail to push if server name has "-" in tiup-cluster (#2008, @nexustar)
Fix unable to configure tiflash LearnerConfig in tiup-cluster (#1991, @srstack)

Improvements

Improve the THP check rule in tiup-cluster (#2014, @nexustar)
Add an example in -h for tiup mirror clone for multiple versions (#2009, @nexustar)

[1.10.2] 2022-06-16

Fixes

Fix cannot get drainer status from pd in tiup-cluster (#1922, @srstack)
Fix error when check time zone in tiup-cluster (#1925, @nexustar)
Fix wrong parameter value of --peer-urls in tiup-dm (#1926, @nexustar)

[1.10.1] 2022-06-09

Fix

Fix SSH login error when identity file is specified for non-root user in tiup-cluster (#1914, @srstack)

[1.10.0] 2022-06-08

New Features

Add support of backup and restore the cluster metadata for tiup-cluster and tiup-dm (#1801, @nexustar)
Add history command for tiup to display component execution records (#1808, @srstack)
Add support of trying to disable swap when check --apply in tiup-cluster (#1803, @AstroProfundis)
Add Grafana URL in display output of tiup-cluster (#1819, @Smityz)
Add a latest alias for component versions when cloning repo with tiup mirror clone command (#1835, @srstack)
Add Kylin Linux 10+ as supported in check result of tiup-cluster (#1886, @srstack)
Add support of completion of cluster name with Tab button for tiup-cluster (#1891, @nexustar)
Add support of checking timezone consistency among servers in check command of tiup-cluster (#1890, @nexustar)
Add support of deploying on RHEL 8 in tiup-cluster (#1896, @nexustar)
Add support of specifying custom key directory when rotating root.json in tiup mirror command (#1848, @AstroProfundis)

Fixes

Fix typo in error message of tiup-bench (#1824, @Mini256)
Fix duplicated component path printed in tiup (#1832, @nexustar)
Fix outdated URL in topology example for tiup-cluster (#1840, @srstack)
Fix DM startup scripts to bind 0.0.0.0 instead of host IP (#1845, @nexustar)
Fix incorrect blackbox_exporter, node_exporter and Grafana status monitor for TLS enabled clusters (#1853, @srstack)
Fix priority of tag argument for tiup-playground (#1869, @nexustar)
Fix TIUP_HOME not loaded correctly on initializing metadata for some components (#1885, @srstack)
Fix concurrent error in display command of tiup-cluster (#1895, @srstack)
Fix incorrect workload loading in tiup-bench (#1827, @Smityz)
Fix OS type detection for hybrid platform deployment in tiup-cluster (#1753, @srstack)

Improvements

Add notes about default workload values in help message of tiup-bench (#1807, @Smityz)
Refactor -h/--help handling to avoid conflicts with component arguments (#1831, @nexustar)
Refactor version specific handlings of TiDB cluster to a dedicated Go package (#1873, @nexustar)
Improve integrate tests for tiup-cluster (#1882, @nexustar)
Adjust help information of edit-cluster command for tiup-cluster and tiup-dm (#1900, @nexustar)
Update configuration example of monitoring components (#1818, @glkappe; #1843, @nexustar)
Improve cluster shutting down process in playground (#1893, @nexustar)

[1.9.6] 2022-05-20

Fix

Fix incorrect output of display in certain circumstances for tiup-cluster (#1889, @srstack)

[1.9.5] 2022-05-10

Fixes

Fix prune incorrectly destroy pump/drainer node before they become Tombstone in tiup-cluster (#1851, @srstack)
Report error when multiple pump nodes with the same ip:port found in tiup-cluster (#1856, @srstack)
Get node status of pump/drainer from PD in tiup-cluster (#1862, @srstack)

Improvements

Check node status concurrently and support custom timeout for display in tiup-cluster (#1867, @srstack)
Support tidb-lightning in tiup-ctl (#1863, @nexustar)

[1.9.4] 2022-04-12

Fixes

Fix copy error when file is read only in tiup-playground (#1816, @breeswish)
Fix data-dir not properly handled for TiCDC v6.0.0 in tiup-cluster (#1838, @overvenus)

[1.9.3] 2022-03-24

Fixes

Fix error running exec subcommand of tiup-cluster when hostname contains '-' (#1794, @nexustar)
Fix port conflict check for TiFlash instances in tiup-cluster (#1805, @AstroProfundis)
Fix next-generation monitor (ng-monitor) not available in Prometheus (#1806, @nexustar)
Fix node_exporter metrics not collected if the host has only Prometheus deployed (#1806, @nexustar)
Fix --host 0.0.0.0 not working in tiup-playground (#1811, @nexustar)

Improvements

Support cleanup audit log files for tiup-cluster and tiup-dm (#1780, @srstack)
Add anonymous login example to Grafana configuration templates (#1785, @sunzhaoyang)

[1.9.2] 2022-03-10

Fixes

Fix next-generation monitor (ng-monitor) is not started by default for nightly versions in tiup-cluster (#1760, @nexustar)
Fix the --ignore-config-check argument not working during deploy process in tiup-cluster (#1774, @AstroProfundis)
Fix incorrect initial-commit-ts config for drainer in tiup-cluster (#1776, @nexustar)
Fix symbolic link handling when decompressing packages (#1784, @nexustar)

Improvements

Check for inactive Prometheus service before reload in tiup-cluster (#1775, @nexustar)
Mark Oracle Linux as supported OS in check result of tiup-cluster (#1786, @srstack)

[1.9.1] 2022-02-24

Fixes

Fix panic running TPCC with tiup-bench (#1755, @nexustar)
Fix blackbox_exporter and node_exporter not restarted during upgrade in tiup-cluster and tiup-dm (#1758, @srstack)
Fix messed stdout and stderr handling for SSH commands in tiup-cluster and tiup-dm (#1763, @tongtongyin)
Fix Grafana datasource config handling in tiup-cluster and tiup-dm (#1768, @srstack)

[1.9.0] 2022-02-10

New Features

Enable next-generation monitor (ng-monitor) by default for TiDB versions equal or later than v5.4.0 in tiup-cluster (#1699 #1743, @nexustar)
Add support of enabling and disabling TLS encryption for deployed TiDB cluster in tiup-cluster (#1657, @srstack)
Add support of deploying TLS enabled DM clusters in tiup-dm (#1745, @nexustar)
Add support of changing owner of a component in tiup mirror and tiup-server (#1676, @AstroProfundis)
Add support of specifying IP address to bind for AlertManager in tiup-cluster (#1665 #1669, @srstack)
Add support of initialing random root password for TiDB in tiup-cluster (#1700, @AstroProfundis)
Add support of check before scaling out a cluster in tiup-cluster (#1659, @srstack)
Add support of customizing Grafana configurations in server_configs section in tiup-cluster and tiup-dm (#1703, @nexustar)
Add support of Chrony as valid NTP daemon for check in tiup-cluster (#1714, @srstack)
Add Amazon Linux 2 as supported OS for check in tiup-cluster (#1740, @dveeden)
Add significant warning destroying a cluster in tiup-cluster and tiup-dm (#1723, @AstroProfundis)

Fixes

Fix DM hosts not added to node_exporter list of Prometheus configuration in tiup-dm (#1654, @AstroProfundis)
Adjust command argument of tiup to workaround conflict with some components (#1698, @nexustar)
Fix global configs not correctly set for new instances during scaling out in tiup-cluster (#1701, @srstack)
Fix incorrect initial_commit_ts set in start up script of Drainer in tiup-cluster (#1706, @nexustar)
Fix JSON output for check results in tiup-cluster (#1720, @AstroProfundis)
Fix incorrect instance status for display in tiup-cluster (#1742, @nexustar)
Fix malformed commands in local executor in tiup-cluster (#1734, @AstroProfundis)
Fix incorrect exit code for tiup (#1738, @nexustar)
Remove duplicate check results in tiup-cluster (#1737, @srstack)
Fix version check of TiFlash nightly builds for TLS enabled clusters in tiup-cluster (#1735, @srstack)

Improvements

Adjust configuration template for TiFlash to support new versions in tiup-cluster (#1673, @hehechen)
Adjust configuration sample for DM in tiup-dm (#1692, @lance6716)
Reder cluster name for custom Prometheus alert rules in tiup-cluster (#1674, @srstack)
Improve shell auto-completion to support cli of components (#1678, @nexustar)
Add checks for tiup installed with 3rd party package manager when running tiup update --self (#1693, @srstack)
Check for component updates before actually run it (#1718, @nexustar)
Use latest nightly build for each component in tiup-playground (#1727, @nexustar)

[1.8.2] 2022-01-11

Fixes

Fix global configuration not inherited correctly in scale-out command of tiup-cluster (#1701, @srstack)
Fix errors starting tiup-playground in some circumstances (#1712 #1715, @nexustar)
Fix error comparing nightly versions in tiup-cluster (#1702, @srstack)

Improvements

Update out-of-date documents of tiup mirror (#1705, @dveeden)

[1.8.1] 2021-12-20

Fixes

Fix port conflict not checked for TiDB clusters imported from tidb-ansible on scale-out in tiup-cluster (#1656, @srstack)
Fix SSH commands stale in some circumstances (#1664, @nexustar)
Fix default value of initial-commit-ts for drainer in tiup-cluster (#1678, @nexustar)

Improvements

Display check result of CPU frequency governor even when it's not available (#1663, @srstack)

[1.8.0] 2021-12-06

New Features

Add data-dir support for TiCDC in tiup-playground (#1631, @nexustar)
Add support of using custom files as input of edit-config, and support dumping the current full config to a file with show-config command in tiup-cluster (#1637, @haiboumich)
Add support of next-generation monitor (ng-monitor) in tiup-playground (#1648, @nexustar)
Add support of inserting custom scrape_configs to Prometheus configs in tiup-cluster (#1641, @nexustar)
[experimental] Support 2-staged scaling out for tiup-cluster (#1638 #1642, @srstack)
- Scaling out of a TiDB cluster can be divided with --stage1 and --stage2 arguments, the stage 1 deploys files and configs but not starting the new instances, and the stage 2 actually starts the new instances and reload necessary configs
- This could be useful if you want to modify config of the new instances or use a custom binary with patch before the first start of the new instances
[experimental] Implement plain text output and support custom output writer for logs (#1646, @AstroProfundis)

Fixes

Fix incorrect progress bar displaying in some tasks (#1624, @nexustar)
Fix incorrect argument flags in tiup-playground (#1635, @srstack)
Fix files of monitoring agents and TiDB audit log not cleaned with clean command of tiup-cluster (#1643 #1644, @srstack)
Fix confirmation prompt in scale-out can not be skipped with --yes argument in tiup-cluster (#1645, @srstack)
Fix directory conflict error in some circumstances even when node is marked as ignore_exporter (#1649, @AstroProfundis)
Fix DM nodes not added to node_exporter target list in Prometheus config in tiup-dm (#1654, @AstroProfundis)

Improvements

Add significant warning when --force argument is set for scale-in command in tiup-cluster (#1629, @AstroProfundis)
Add environment variables to skip topology sanity check in scale-in command in tiup-cluster (#1627, @AstroProfundis)
Update examples to use --without-monitor instead of --monitor for tiup-playground (#1639, @dveeden)

[1.7.0] 2021-11-15

New Features

Support deploying and managing TLS enabled TiDB cluster with TiFlash nodes (#1594, @nexustar)
Support rendering template for local deployment with vairables in tiup-cluster and tiup-dm (#1596, @makocchi-git)
[experimental] Support optionally enable next-generation monitor (ng-monitor) for latest TiDB releases (#1601, @nexustar)
[experimental] Support JSON output format for tiup-cluster and tiup-dm (#1617, @AstroProfundis)

Fixes

Remove warning about tag argument for tiup-playground (#1606, @nexustar)
Set --external-url for AlertManager in tiup-cluster (#1608, @reAsOn2010)
Fix auto detecting of system arch fail in certain circumstances (#1610, @AstroProfundis)

Improvements

Support getting cluster ID from PD in pdapi package (#1573 #1574, @nexustar; #1580, @AstroProfundis)
Accurately get status of TiFlash nodes during operations (#1600, @AstroProfundis)

[1.6.1] 2021-10-21

Fixes

Fix tiup-bench reporting wrong latency for TPCC workloads (#1577, @lobshunter)
Fix test cases for tiup-bench and tiup-client (#1579, @AstroProfundis)
Fix fetching component manifest error on certain circumstances (#1581, @nexustar)

[1.6.0] 2021-10-09

New Features

Add support of using ssh-agent auth socket in tiup-cluster (#1416, @9547)
Add parallel task concurrency control in tiup-cluster and tiup-dm with -c/--concurrency argument (#1420, @AstroProfundis)
- The default value of max number of parallel tasks allowed is 5, this feature could help users managing very large clusters to avoid connection errors on operations.
Add the ability to detect CPU arch for deployment servers automatically in tiup-cluster and tiup-dm if not set by user (#1423, @9547)
Add renew subcommand for tiup mirror to extend the expiration date of component manifest (#1479, @AstroProfundis)
Add the ability to ignore monitor agents for specific instances in tiup-cluster (#1492, @AstroProfundis)
Add --force argument for prune subcommand in tiup-cluster (#1552, @AstroProfundis)
Add more configuration fields for Grafana in tiup-cluster and tiup-dm (#1566, @haiboumich)
[Experimental] Add support of SSH connections via proxy in tiup-cluster (#1438, @9547)
Deprecate the --monitor argument and introduce a new --without-monitor argument to disable monitoring components in tiup-playground (#1512, @LittleFall)
Deprecate the TIUP_WORK_DIR environment as it's not actually been used, and make it possible for tiup-playground to run without tiup (#1553 #1556 #1558, @nexustar)

Fixes

Fix blackbox_exporter configs for TLS enabled clusters in tiup-cluster (#1443, @9547)
Only try to apply THP fix if it's available on the deployment server in tiup-cluster (#1458, @9547)
Fix sudo errors in tiup-cluster when devtoolset is enabled on deployment server (#1516, @nexustar)
Fix test cases for tiup-dm (#1540, @nexustar)
Fix downloading of uneeded component packages when --binpath is specifiedin tiup-playground (#1495, @AstroProfundis; #1545, @nexustar)
Fix panic when tiup-bench fails to connect to the database (#1557, @nexustar)
Fix numa_node configs are not rendered into PD startup script in tiup-cluster (#1565, @onlyacat)
Correctly handle -- in command line arguments passed to tiup (#1569, @dveeden)

Improvements

Reduce network usage on various operations and speed up the process
- Update component manifests simultaneously in tiup list (#1532, @nexustar)
- Not requesting manifest before actually using the component (#1539, @nexustar)
- Update root.json only when necessary (#1554, @nexustar)
Use the value of --wait-timeout argument as timeout of SSH command operations with the builtin executor (#1445, @AstroProfundis)
Refuse to clone a local mirror to the same location it is stored (#1464, @dveeden)
Set terminal title to show session tag in tiup-playground (#1506, @dveeden)
Show TiDB port when scale out in tiup-playground (#1520, @nexustar)
Cleanup files if component fails to install (#1562, @nexustar)
Update docs and examples (#1484, @ichn-hu; #1502, @AstroProfundis)
Use auto completion from cobra itself (#1544, @AstroProfundis; #1549, @nexustar)

[1.5.6] 2021-09-01

Fixes

Fix OS version check rules for tiup-cluster check (#1535, @AstroProfundis)
Fix component upgrade order for tiup-cluster to make sure TiCDC nodes work correctly (#1542, @overvenus)

Improvements

Adjust warning message of tiup-cluster restart to make users clear that the cluster will be unavailable during the process (#1523, @glkappe)
Reverse the order of audit log listing to show latest records at the buttom (#1538, @AstroProfundis)

[1.5.5] 2021-08-19

Fixes

Fix error when reloading a stopped cluster with --skip-restart argument (#1513, @AstroProfundis)
Use absolute path for sudo command, to workaround errors on systems where devtoolset is enabled (#1516, @nexustar)
Fix custom TiDB port not correctly set in playground (#1511, @hecomlilong)

Improvements

Adjust suggested argument order in playground examples (#1522, @glkappe)

[1.5.4] 2021-08-05

Fixes

Allow editing of lerner_config field in TiFlash spec (#1494, @AstroProfundis)
Fix incorrect timeout for telemetry requests (#1500, @AstroProfundis)
Ignore data_dir of monitor agents when checking for directory overlaps (#1510, @AstroProfundis)

Improvements

Distinguish cookie names of multiple grafana instances on the same host (#1491, @AstroProfundis)

[1.5.3] 2021-07-15

Fixes

Fix incorrect alert rules for TiDB version 3.x (#1463, @9547)
Fix TiKV config check to correctly handle the data_dir value (#1471, @tabokie)

Improvements

Update dependencies and adjust error message of ctl (#1459, @AstroProfundis)
Use $SHELL environment variable for completion (#1455, @dveeden)
Allow listing components from local cached manifests without network access (#1466, @c4pt0r)
Adjust error message of SELinux check failure (#1476, @AstroProfundis)
Adjust warning message when scale-in with --force argument to make it more clear of potential risks (#1477, @AstroProfundis)

[1.5.2] 2021-06-24

Fixes

Fix native SSH not working with custom SSH port (#1424, @9547)
Fix dashboard address displaying issue for tikv-slim clusters (#1428, @iosmanthus)
Fix a typo in help message of tiup-playground (#1429, @ekexium)
Fix TiFlash nodes not handled correctly in some commands (#1431, @lucklove)
Fix jemalloc config for TiKV nodes (#1435, @9547)
Fix the issue that slow log is not placed under log_dir (#1441, @lucklove)

Improvements

Update default alertmanager config template to avoid confusing (#1425 #1426, @lucklove)
Increase default timeout of transferring leader in upgrade progress (#1434, @AstroProfundis)
Update dependencies (#1433, @AstroProfundis)

[1.5.1] 2021-06-11

Fix

Fix the issue that some versions of TiCDC node may fail to start in tiup-cluster (#1421, @JinLingChristopher)

[1.5.0] 2021-06-09

New Features

Show more information in display subcommand of tiup-cluster
- Add an --uptime argument to show time since the last state change of process (#1231, @9547)
- Show deploy user in display output and adjust formats (#1390 #1409, @AstroProfundis)
Add JSON output for display subcommand of tiup-cluster (#1358, @dveeden)
Add double confirmation for scale-out subcommand in tiup-cluster to let users be aware of global configs being used (#1309, @AstroProfundis)
Support deploying pure TiKV cluster with --mode tikv-slim in playground (#1333, @iosmanthus; #1365, @tisonkun)
Support data dir settings for TiCDC in tiup-cluster (#1372, @JinLingChristopher)
Support change of GCTTL and TZ configs for TiCDC in tiup-cluster (#1380, @amyangfei)
Add a local deployment template for tiup-cluster (#1404, @kolbe)
Support using dot (.) in cluster name (#1412, @9547)

Fixes

Fix a variety of typos (#1306, @kolbe)
Fix non-common speed units shown in downloading progress (#1312, @dveeden)
Fix the issue that it may panic when user try to list expired component (#1391, @lucklove)
Fix the issue that tikv not upgraded on error increasing schedule limit (#1401, @AstroProfundis)

Improvements

Support specifying node counts in tests (#1251, @9547)
Add double confirmation for reload, patch and rename subcommands in tiup-cluster (#1263, @9547)
Add ability to list available make targets for developers (#1277, @rkazak)
Update links in doc/dev/README.md file (#1296, @mjonss)
Improve handling of latest versions in mirror clone subcommand (#1313, @dveeden)
Add check for dependencies before downloading package in installation script (#1348, @AstroProfundis)
Simplified the handling of configs imported from TiDB-Ansible (#1350, @lucklove)
Implement native scp downloading (#1382, @AstroProfundis)
Update and fix dependencies (#1362, @AstroProfundis; #1407, @dveeden)

[1.4.4] 2021.05.26

Fixes

Fix the issue that upgrade process may fail if the PD node is not available for longer than normal after restart (#1359, @AstroProfundis)
Fix incorrect MALLOC_CONF value for TiKV node, set prof_active to false (#1361 #1369, @YangKeao)
- Risk of this issue: Generating prof data for TiKV node with prof_active=true may cause high CPU systime usage in some circumstances, users need to regenerate startup scripts for TiKV nodes with tiup cluster reload <cluster-name> -R tikv to make the update applied
Fix the issue that the global log_dir not generated correctly for absolute paths (#1376, @lucklove)
Fix the issue that display command may report label mismatch warning if placement-rule is enabled (#1378, @lucklove)
Fix the issue that SELinux setting is incorrect when tiup-cluster tries to disable it with check --apply (#1383, @AstroProfundis)
Fix the issue that when scaling out instance on a host imported from tidb-ansible, the process may report error about monitor directory conflict (#1386, @lucklove)

Improvements

Allow scale in cluster when there is no TiSpark master node but have worker node in the topology (#1363, @AstroProfundis)
Make port check error message more clear to users (#1367, @JinLingChristopher)

[1.4.3] 2021.05.13

Fixes

Fix OS check for RHEL in tiup-cluster (#1336, @AstroProfundis)
Check for command depends before downloading packages in install script (#1348, @AstroProfundis)
Fix the issue that install script downloads an old TiUP package (#1349, @lucklove)
Fix the issue that drainer node imported from TiDB-Ansible may have incorrect data_dir (#1346, @AstroProfundis)

Improvements

Optimize some subcommands of tiup mirror (#1331, @AstroProfundis)
Set proper User-Agent for requests downloading manifests and files from remote (#1342, @AstroProfundis)
Add basic telemetry report for tiup and playground (#1341 #1353, @AstroProfundis)

[1.4.2] 2021.04.26

Fixes

Send meta output from tiup to stderr to not to mix with output of components (#1298, @dveeden)
Update confusing version selection examples in help message of playground (#1318, @AstroProfundis)
Fix the issue that tiup mirror clone command does exclude yanked component correctly (#1321, @lucklove)

Improvements

Adjust output messages and operation processes of tiup mirror command (#1302, @AstroProfundis)
Add tiup mirror show subcommand to display current mirror address in use (#1317, @baurine)
Optimize error handling if root.json fails to load (#1303, @AstroProfundis)
Update MySQL client connection example in playground (#1323, @tangenta)
Adjust data and fields report via telemetry (#1327, @AstroProfundis)

[1.4.1] 2021.04.07

Fixes

Fix pprof failing for TiKV in playground (#1272, @hicqu)
Fix the issue that TiFlash node may be failed to restart in playground (#1280, @lucklove)
Fix the issue that binlog_enable is not imported from tidb-ansible correctly (#1261, @lucklove)
Fix directory conflict check error for TiDB and DM clusters imported from ansible deployment (#1273, @lucklove)
Fix compatibility issue during upgrade for PD v3.x (#1274, @lucklove)
Fix failure of parsing very long audit log in replay for tiup-cluster (#1259, @lucklove)
Fix log dir path of Grafana for tiup-cluster (#1276, @rkazak)
Fix config check error when the cluster was deployed with an legacy nightly version in tiup-cluster (#1281, @AstroProfundis)
Fix error when using nightly version while the actual component is not available in repo (#1294, @lucklove)

Improvements

Refine PD scaling script rendering to optimize the code (#1253, @9547)
Start PD and DM master nodes sequentially in (#1262, @9547)
Properly follow the ignore config check argument in reload for tiup-cluster (#1265, @9547)

[1.4.0] 2021.03.31

New Features

EXPERIMENTAL: Add support of Apple M1 devices (#1122, @terasum @AstroProfundis @sunxiaoguang)
- Playground may not fully work as some components don't yet have packages for darwin-arm64 released
Not displaying dashboard address if it's "none" or "auto" (#1054, @9547)
Support filtering nodes and roles in check subcommand of tiup-cluster (#1030, @AstroProfundis)
Support retry of failed operations from where it broke with replay command of tiup-cluster and tiup-dm (#1069 #1157, @lucklove)
Support upgrade and patch a stopped TiDB / DM cluster (#1096, @lucklove)
Support setting global custom values for topology of tiup-cluster (#1098, @lucklove)
Support custom root_url and anonymous login for Grafana in tiup-cluster (#1085, @mianhk)
Support remote read and remote write for Prometheus node in tiup-cluster (#1070, @XSHui)
Support custom external AlertManager target for Prometheus node in tiup-cluster (#1149, @lucklove)
Support force reinstallation of already installed component (#1145, @9547)
Add --force and retain data options to tiup-dm (#1080, @9547)
Add enable/disable subcommands to tiup-dm (#1114, @9547)
Add template subcommand to tiup-cluster to print pre-defined topology templates (#1156, @lucklove)
Add --version option to display subcommand of tiup-cluster to print the cluster version (#1207, @AstroProfundis)
Allow value type change when editing topology with edit-config subcommand of tiup-cluster (#1050, @AstroProfundis)

Fixes

Not allowing deployment if the input topology file is empty (#994, @AstroProfundis)
Fix data dir setting for Prometheus (#1040, @9547)
Fix the issue that pre-defined Prometheus rules may be missing if a custom rule_dir is set (#1073, @9547)
Fix the issue that config files of Prometheus and Grafana are not checked before start (#1074, @9547)
Fix the issue that cluster name is not validated for some operations (#1177, @AstroProfundis)
Fix the issue that tiup-cluster reloads a cluster even if the config may contain errors (#1183, @9547)
Fix the issue that publish command may fail when uploading files without retry (#1174 #1202, @AstroProfundis; #1167, @lucklove)
Fix the issue that newly added TiFlash nodes may fail to start during scale-out in tiup-cluster (#1227, @9547)
Fix incorrect cluster name in alert messages (#1238, @9547)
Fix the issue that blackbox_exporter may not collecting ping metrics correctly (#1250, @STRRL)

Improvements

Reduce jitter during upgrade process of TiDB cluster
- Make sure PD node is online and serving before upgrading the next one (#1032, @HunDunDM)
- Upgrade PD leader node after upgrading other PD nodes (#1086, @AstroProfundis)
- Increase schedule limit during upgrade of TiKV nodes (#1661, @AstroProfundis)
- Add check to validate if all regions are healthy (#1126, @AstroProfundis)
Only reload Prometheus configs when needed (#989, @9547)
Show default option on prompted input messages (#1132 #1134, @wangbinhe3db)
Include user's input in error message if prompted challenge didn't pass (#1104, @AstroProfundis)
Check for data_dir and log_dir overlap before deploying a cluster (#1093, @9547)
Improve checking rules in tiup cluster check command (#1099 #1107, @AstroProfundis; #1118 #1124, @9547)
Refine list and display command for tiup-cluster (#1139, @baurine)
Mark patched nodes in display output of tiup-cluster and tiup-dm (#1125, @AstroProfundis)
Ignore users.* settings for TiFlash if the cluster version is later than v4.0.12 and v5.0.0-rc (#1211, @JaySon-Huang)
Cache timestamp manifest in memory to reduce network requests (#1212, @lucklove)
Upgrade toolchain to Go 1.16 (#1151 #1153 #1130, @AstroProfundis)
Use GitHub Actions to build and release TiUP components (#1158, @AstroProfundis)
Remove deprecated v0manifest support, TiUP version before v1.0.0 may not be able to download latest packages anymore (#906)

[1.3.7] 2021.03.25

Fixes

Fix the issue that metrics of tiflash-server instance may not collected correctly (#1083, @yuzhibotao)
Fix the issue that tiup-cluster disables monitoring services unexpectedly (#1088, @lucklove)
Fix wrong dashboard name for lightning in Grafana after renaming a cluster with tiup-cluster (#1196, @9547)
Fix the issue that tiup-cluster prune command may try to generate config for removed nodes (#1237, @lucklove)

[1.3.6] 2021.03.19

Fixes

Fix the issue that can't deploy arm64 binary with offline mirror (#1229, @lucklove)

[1.3.5] 2021.03.11

Fixes

Fix the issue that old nighlty may cause error (#1198, @lucklove)

[1.3.4] 2021.03.05

Fixes

Fix the issue that tiup-cluster can't generate prometheus config (#1185, @lucklove)
Fix the issue that tiup may choose yanked version if it's already installed (#1191, @lucklove)

[1.3.3] 2021.03.04

Fixes

Fix the issue that tiup will hang forever when reloading a stopped cluster (#1044, @9547)
Fix the issue that tiup mirror merge does not work on official offline package (#1121, @lucklove)
Fix the issue that there may be no retry when download component failed (#1137, @lucklove)
Fix the issue that PD dashboard does not report grafana address in playground (#1142, @9547)
Fix the issue that the default selected version may be a preprelease version (#1128, @lucklove)
Fix the issue that the error message is confusing when the patched tar is not correct (#1175, @lucklove)

Improvements

Add darwin-arm64 not support hint in install script (#1123, @terasum)
Improve playground welcome information for connecting TiDB (#1133, @dveeden)
Bind latest stable grafana and prometheus in DM deploying (#1129, @lucklove)
Use the advertised host instead of 0.0.0.0 for tiup-playground (#1152, @9547)
Check tarball checksum on tiup-server when publish component (#1163, @lucklove)

[1.3.2] 2021.01.29

Fixes

Fix the issue that the grafana and alertmanager target not set in prometheus.yaml (#1041, @9547)
Fix the issue that grafana deployed by tiup-dm missing home.json (#1056, @lucklove)
Fix the issue that the expires of cloned mirror is shourened after publish component to it (#1051, @lucklove)
Fix the issue that tiup-cluster may remove wrong paths for imported cluster on scale-in (#1068, @AstroProfundis)
- Risk of this issue: If an imported cluster has deploy dir ending with /, and sub dirs as <deploy-dir>//sub, it could results to delete wrong paths on scale-in
Fix the issue that imported *_exporter has wrong binary path (#1101, @AstroProfundis)

Improvements

Apply more strict check on tar.gz file for patch command: check if the entry is an executable file (#1091, @lucklove)

[1.3.1] 2020.12.31

Fixes

Workaround the issue that store IDs in PDs may not monotonically assigned (#1011, @AstroProfundis)
- Currently, the ID allocator is guaranteed not to allocate duplicated IDs, but when PD leader changes multiple times, the IDs may not be monotonic
- For tiup < v1.2.1, the command tiup cluster display may delete store (without confirm) by mistake due to this issue (high risk)
- For tiup >= v1.2.1 and <= v1.3.0, the command tiup cluster display may display up stores as tombstone, and encourages the user to delete them with the command tiup cluster prune (medium risk)
Fix the issue that the cluster check always fail on thp check even though the thp is disabled (#1005, @lucklove)
Fix the issue that the command tiup mirror merge -h outputs wrong usage (#1008, @lucklove)
- The syntax of this command should be tiup mirror merge <mirror-dir-1> [mirror-dir-N] but it outputs tiup mirror merge <base> <mirror-dir-1> [mirror-dir-N]
Fix the issue that prometheus doesn't collect drainer metrics (#1012, @SE-Bin)

Improvements

Reduce display duration when PD nodes encounter network problems and dropping packages (#986, @9547)
cluster, dm: support version input without leading 'v' (#1009, @AstroProfundis)
Add a warning to explain that we will stop the cluster before clean logs (#1029, @lucklove)
- When a user try to clean logs with the command tiup cluster clean --logs, he may expect that the cluster is still running during the clean operation
- The actual situation is not what he expect, which may surprise the user (risk)

[1.3.0] 2020.12.17

New Features

Modify TiFlash's query memory limit from 10GB to 0(unlimited) in playground cluster (#907, @LittleFall)
Import configuration into topology meta when migrating a cluster from Ansible (#766, @yuzhibotao)
- Before, we stored imported ansible config in ansible-imported-configs which is hidden for users, in this release, we merge the configs into meta.yaml so that the user can see the config with the command tiup cluster edit
Enhance the tiup mirror command (#860, @lucklove)
- Support merge two or more mirrors into one
- Support publish component to local mirror besides remote mirror
- Support add component owner to local mirror
Partially support deploy cluster with hostname besides ip address (EXPERIMENTAL) (#948,#949, @fln)
- Not usable for production, as there would be issue if a hostname resolves to a new IP address after deployment
Support setting custom timeout for waiting instances up in playground-cluster (#968, @unbyte)
Support check and disable THP in tiup cluster check (#964, @anywhy)
Support sign remote manifest and rotate root.json (#967, @lucklove)

Fixes

Fixed the issue that the public key created by TiUP was not removed after the cluster was destroyed (#910, @9547)
Fix the issue that user defined grafana username and password not imported from tidb-ansible cluster correctly (#937, @AstroProfundis)
Fix the issue that playground cluster not quitting components with correct order: TiDB -> TiKV -> PD (#933, @unbyte)
Fix the issue that TiKV reports wrong advertise address when --status-addr is set to a wildcard address like 0.0.0.0 (#951, @lucklove)
Fix the issue that Prometheus doesn't reload target after scale-in action (#958, @9547)
Fix the issue that the config file for TiFlash missing in playground cluster (#969, @unbyte)
Fix Tilfash startup failed without stderr output when numa is enabled but numactl cannot be found (#984, @lucklove)
Fix the issue that the deployment environment fail to copy config file when zsh is configured (#982, @9547)

Improvements

Enable memory buddyinfo monitoring on node_exporter to collect exposes statistics of memory fragments (#904, @9547)
Move error logs dumped by tiup-dm and tiup-cluster to ${TIUP_HOME}/logs (#908, @9547)
Allow run pure TiKV (without TiDB) cluster in playground cluster (#926, @sticnarf)
Add confirm stage for upgrade action (#963, @Win-Man)
Omit debug log from console output in tiup-cluster (#977, @AstroProfundis)
Prompt list of paths to be deleted before processing in the clean action of tiup-cluster (#981, #993, @AstroProfundis)
Make error message of monitor port conflict more readable (#966, @JaySon-Huang)

[1.2.5] 2020.11.27

Fixes

Fix the issue that can't operate the cluster which have tispark workers without tispark master (#924, @AstroProfundis)
- Root cause: once the tispark master been removed from the cluster, any later action will be reject by TiUP
- Fix: make it possible for broken clusters to fix no tispark master error by scaling out a new tispark master node
Fix the issue that it report pump node id not found while drainer node id not found (#925, @lucklove)

Improvements

Support deploy TiFlash on multi-disks with "storage" configurations since v4.0.9 (#931, #938, @JaySon-Huang)
Check duplicated pd_servers.name in the topology before truly deploy the cluster (#922, @anywhy)

[1.2.4] 2020.11.19

Fixes

Fix the issue that Pump & Drainer has different node id between tidb-ansible and TiUP (#903, @lucklove)
- For the cluster imported from tidb-ansible, if the pump or drainer is restarted, it will start with a new node id
- Risk of this issue: binlog may not work correctly after restart pump or drainer
Fix the issue that audit log may get lost in some special case (#879, #882, @9547)
- If the user execute two commands one follows the other, and the second one quit in 1 second, the audit log of the first command will be overwirten by the second one
- Risk caused by this issue: some audit logs may get lost in above case
Fix the issue that new component deployed with tiup cluster scale-out doesn't auto start when rebooting (#905, @9547)
- Risk caused by this issue: the cluster may be unavailable after rebooting
Fix the issue that data directory of TiFlash is not deleted if multiple data directories are specified (#871, @9547)
Fix the issue that node_exporter and blackbox_exporter not cleaned up after scale-in all instances on specified host (#857, @9547)
Fix the issue that the patch command will fail when try to patch dm cluster (#884, @lucklove)
Fix the issue that the bench component report Error 1105: client has multi-statement capability disabled (#887, @mahjonp)
Fix the issue that the TiSpark node can't be upgraded (#901, @lucklove)
Fix the issue that playground cluster can't start TiFlash with newest nightly PD (#902, @lucklove)

Improvements

Ignore no tispark master error when listing clusters since the master node may be remove by scale-in --force (#920, @AstroProfundis)

[1.2.3] 2020.10.30

Fixes

Fix misleading warning message in the display command (#869, @lucklove)

[1.2.1] 2020.10.23

Improvements

Introduce a more safe way to cleanup tombstone nodes (#858, @lucklove)
- When an user scale-in a TiKV server, it's data is not deleted until the user executes a display command, it's risky because there is no choice for user to confirm
- We have add a prune command for the cleanup stage, the display command will not cleanup tombstone instance any more
Skip auto-start the cluster before the scale-out action because there may be some damaged instance that can't be started (#848, @lucklove)
- In this version, the user should make sure the cluster is working correctly by themselves before executing scale-out
Introduce a more graceful way to check TiKV labels (#843, @lucklove)
- Before this change, we check TiKV labels from the config files of TiKV and PD servers, however, servers imported from tidb-ansible deployment don't store latest labels in local config, this causes inaccurate label information
- After this we will fetch PD and TiKV labels with PD api in display command

Fixes

Fix the issue that there is datarace when concurrent save the same file (#836, @9547)
- We found that while the cluster deployed with TLS supported, the ca.crt file was saved multi times in parallel, this may lead to the ca.crt file to be left empty
- The influence of this issue is that the tiup client may not communicate with the cluster
Fix the issue that files copied by TiUP may have different mode with origin files (#844, @lucklove)
Fix the issue that the tiup script not updated after scale-in PD (#824, @9547)

[1.2.0] 2020.09.29

New Features

Support tiup env sub command (#788, @lucklove)
Support TiCDC for playground (#777, @leoppro)
Support limiting core dump size (#817, @lucklove)
Support using latest Spark and TiSpark release (#779, @lucklove)
Support new cdc arguments gc-ttl and tz (#770, @lichunzhu)
Support specifying custom ssh and scp path (#734, @9547)

Fixes

Fix tiup update --self results to tiup's binary file deleted (#816, @lucklove)
Fix per-host custom port for drainer not handled correctly on importing (#806, @AstroProfundis)
Fix the issue that help message is inconsistent (#758, @9547)
Fix the issue that dm not applying config files correctly (#810, @lucklove)
Fix the issue that playground display wrong TiDB number in error message (#821, @SwanSpouse)

Improvements

Automatically check if TiKV's label is set (#800, @lucklove)
Download component with stream mode to avoid memory explosion (#755, @9547)
Save and display absolute path for deploy directory, data directory and log directory to avoid confusion (#822, @lucklove)
Redirect DM stdout to log files (#815, @csuzhangxc)
Skip download nightly package when it exists (#793, @lucklove)

[1.1.2] 2020.09.11

Fixes

Fix the issue that TiKV store leader count is not correct (#762)
Fix the issue that TiFlash's data is not clean up (#768)
Fix the issue that tiup cluster deploy --help display wrong help message (#758)
Fix the issue that tiup-playground can't display and scale (#749)

[1.1.1] 2020.09.01

Fixes

Remove the username root in sudo command #731
Transfer the default alertmanager.yml if the local config file not specified #735
Only remove corresponed config files in InitConfig for monitor service in case it's a shared directory #736

[1.1.0] 2020.08.28

New Features

[experimental] Support specifying customized configuration files for monitor components (#712, @lucklove)
Support specifying user group or skipping creating a user in the deploy and scale-out stage (#678, @lucklove)
- to specify the group: https://github.com/pingcap/tiup/blob/master/examples/topology.example.yaml#L7
- to skip creating the user: tiup cluster deploy/scale-out --skip-create-user xxx
[experimental] Support rename cluster by the command tiup cluster rename <old-name> <new-name> (#671, @lucklove)

Grafana stores some data related to cluster name to its grafana.db. The rename action will NOT delete them. So there may be some useless panel need to be deleted manually.
[experimental] Introduce tiup cluster clean command (#644, @lucklove):
- Cleanup all data in specified cluster: tiup cluster clean ${cluster-name} --data
- Cleanup all logs in specified cluster: tiup cluster clean ${cluster-name} --log
- Cleanup all logs and data in specified cluster: tiup cluster clean ${cluster-name} --all
- Cleanup all logs and data in specified cluster, excepting the Prometheus service: tiup cluster clean ${cluster-name} --all --ignore-role Prometheus
- Cleanup all logs and data in specified cluster, expecting the node 172.16.13.11:9000: tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.11:9000
- Cleanup all logs and data in specified cluster, expecting the host 172.16.13.11: tiup cluster clean ${cluster-name} --all --ignore-node 172.16.13.12
Support skipping evicting store when there is only 1 TiKV (#662, @lucklove)
Support importing clusters with binlog enabled (#652, @AstroProfundis)
Support yml source format with tiup-dm (#655, @july2993)
Support detecting port conflict of monitoring agents between different clusters (#623, @AstroProfundis)

Fixes

Set correct deploy_dir of monitoring agents when importing ansible deployed clusters (#704, @AstroProfundis)
Fix the issue that tiup update --self may make root.json invalid with offline mirror (#659, @lucklove)

Improvements

Add advertise-status-addr for TiFlash to support host name (#676, @birdstorm)

[1.0.9] 2020.08.03

tiup

Clone with yanked version #602
Support yank a single version on client side #602
Support bash and zsh completion #606
Handle yanked version when update components #635

tiup-cluster

Validate topology changes after edit-config #609
Allow continue editing when new topology has errors #624
Fix wrongly set data_dir of TiFlash when import from ansible #612
Support native ssh client #615
Support refresh configuration only when reload #625
Apply config file on scaled pd server #627
Refresh monitor configs on reload #630
Support posix style argument for user flag #631
Fix PD config incompatible when retrieving dashboard address #638
Integrate tispark #531 #621

FilesExpand file tree

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

[1.16.5] 2026-04-10

New Features

Improvements

Fixes

Miscellaneous

[1.16.4] 2025-10-28

Fixes

[1.16.3] 2025-08-26

New Features

Fixes

Improvements

[1.16.2] 2025-04-02

New Features

Fixes

Improvements

[1.16.1] 2024-10-31

New Features

Fixes

Improvements

[1.16.0] 2024-06-27

New Features

Fixes

Improvements

[1.15.2] 2024-05-28

Improvements

[1.15.1] 2024-04-11

Fixes

Improvements

[1.15.0] 2024-04-01

New Features

Fixes

Improvements

[1.14.1] 2024-01-12

Fixes

Improvements

[1.14.0] 2023-11-17

New Features

Fixes

Improvements

[1.13.1] 2023-09-25

Fixes

Improvement

[1.13.0] 2023-08-26

New Features

Fixes

Improvements

[1.12.5] 2023-7-17

Fix

[1.12.4] 2023-7-13

Fix

Improvement

[1.12.3] 2023-6-14

Fixes

Improvement

[1.12.2] 2023-5-19

Notes

Fixes

Improvements

[1.12.1] 2023-4-13

Fix

Improvements

[1.12.0] 2023-3-31

New Features

Improvements

[1.11.3] 2023-02-14

Improvement

[1.11.2] 2023-02-02

Fixes

Improvements

[1.11.1] 2022-11-24

Note

Fixes

Improvements

[1.11.0] 2022-09-23