From 9a3ebd633d489d1abc7dcfe3fb8be5f4837b4937 Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Wed, 17 Jan 2024 11:30:16 +0800 Subject: [PATCH] tiup: add instructions for the --local option (#16097) (#16171) --- tiup/tiup-component-cluster-template.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tiup/tiup-component-cluster-template.md b/tiup/tiup-component-cluster-template.md index 628002ccaee56..3fe0c7a1dc332 100644 --- a/tiup/tiup-component-cluster-template.md +++ b/tiup/tiup-component-cluster-template.md @@ -28,6 +28,11 @@ If this option is not specified, the output default template contains the follow - Outputs a detailed topology template that is commented with configurable parameters. To enable this option, add it to the command. - If this option is not specified, the simple topology template is output by default. +### --local + +- Outputs a simple topology template for the local cluster, which can be used directly, and the `global` parameter can be adjusted as needed. +- This template creates a PD service, a TiDB service, a TiKV service, a monitoring service, and a Grafana service. + ### --multi-dc - Outputs the topology template of multiple data centers. To enable this option, add it to the command.