Merge pull request #918 from srl-labs/reconfigure-shorthand

reconfigure shorthand
srl-labs · Jun 27, 2022 · 44f6f37 · 44f6f37
2 parents 9d216b8 + 5ec3924
commit 44f6f37
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/cmd/deploy.go b/cmd/deploy.go
@@ -67,7 +67,7 @@ func init() {
 	deployCmd.Flags().StringVarP(&mgmtNetName, "network", "", "", "management network name")
 	deployCmd.Flags().IPNetVarP(&mgmtIPv4Subnet, "ipv4-subnet", "4", net.IPNet{}, "management network IPv4 subnet range")
 	deployCmd.Flags().IPNetVarP(&mgmtIPv6Subnet, "ipv6-subnet", "6", net.IPNet{}, "management network IPv6 subnet range")
-	deployCmd.Flags().BoolVarP(&reconfigure, "reconfigure", "", false, "regenerate configuration artifacts and overwrite the previous ones if any")
+	deployCmd.Flags().BoolVarP(&reconfigure, "reconfigure", "c", false, "regenerate configuration artifacts and overwrite previous ones if any")
 	deployCmd.Flags().UintVarP(&maxWorkers, "max-workers", "", 0, "limit the maximum number of workers creating nodes and virtual wires")
 	deployCmd.Flags().BoolVarP(&skipPostDeploy, "skip-post-deploy", "", false, "skip post deploy action")
 	deployCmd.Flags().StringVarP(&exportTemplate, "export-template", "", defaultExportTemplateFPath, "template file for topology data export")

diff --git a/docs/cmd/deploy.md b/docs/cmd/deploy.md
@@ -24,7 +24,7 @@ With the global `--name | -n` flag a user sets a lab name. This value will overr
 
 #### reconfigure
 
-The local `--reconfigure` flag instructs containerlab to first **destroy** the lab and all its directories and then start the deployment process. That will result in a clean (re)deployment where every configuration artefact will be generated (TLS, node config) from scratch.
+The local `--reconfigure | -c` flag instructs containerlab to first **destroy** the lab and all its directories and then start the deployment process. That will result in a clean (re)deployment where every configuration artefact will be generated (TLS, node config) from scratch.
 
 Without this flag present, containerlab will reuse the available configuration artifacts found in the lab directory.
 

diff --git a/docs/rn/0.28.md b/docs/rn/0.28.md
@@ -7,11 +7,14 @@ With embedded shorthands `containerlab`->`clab`, `deploy`->`dep` and so on, we m
 Please welcome the topology file auto-detect feature which turns `clab dep -t mytopo.clab.yml` to just `clab dep` :partying_face:
 
 !!!note
-    A single file matching `*.clab.y*ml` patter must be present in the current working directory for auto-detect feature to work.
+    A single file matching `*.clab.y*ml` pattern must be present in the current working directory for auto-detect feature to work.
 
     Should you have multiple topology files, use the `--topo` flag as before.
 
 ## Ignite-based linux containers
 Weaveworks/ignite runtime integration that was added by @networkop for [Cumulus VX](../manual/kinds/cvx.md) nodes got a new application. With #910 merged, users now can run Linux VMs in a container packaging and leverage VM-like experience while running lightweight and fast.
 
+## Miscellaneous
+
+* added `-c` shorthand for `--reconfigure` as it is very handy to use `clab dep -c` to cleanly redeploy the lab during the iterations of lab build-out.