Merge flags-refactor branch to main (#18280)

Signed-off-by: mounicasruthi <[email protected]>
Signed-off-by: Mounica Sruthi <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Deepthi Sigireddi <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>

Author: 3 people

.gitignore

@@ -93,3 +93,4 @@ report
 # mise files
 .mise.toml
 /errors/
+go/flags/endtoend/count_flags.sh

config/tablet/default.yaml

@@ -1,34 +1,34 @@
 tabletID: zone-1234
 
 init:
-  dbName:            # init_db_name_override
-  keyspace:          # init_keyspace
-  shard:             # init_shard
-  tabletType:        # init_tablet_type
+  dbName:            # init-db-name-override
+  keyspace:          # init-keyspace
+  shard:             # init-shard
+  tabletType:        # init-tablet-type
   timeoutSeconds: 60 # init_timeout
 
 db:
-  socket:     # db_socket
-  host:       # db_host
-  port: 0     # db_port
-  charSet:    # db_charset
-  flags: 0    # db_flags
-  flavor:     # db_flavor
-  sslCa:      # db_ssl_ca
-  sslCaPath:  # db_ssl_ca_path
-  sslCert:    # db_ssl_cert
-  sslKey:     # db_ssl_key
-  serverName: # db_server_name
-  connectTimeoutMilliseconds: 0 # db_connect_timeout_ms
+  socket:     # db-socket
+  host:       # db-host
+  port: 0     # db-port
+  charSet:    # db-charset
+  flags: 0    # db-flags
+  flavor:     # db-flavor
+  sslCa:      # db-ssl-ca
+  sslCaPath:  # db-ssl-ca-path
+  sslCert:    # db-ssl-cert
+  sslKey:     # db-ssl-key
+  serverName: # db-server-name
+  connectTimeoutMilliseconds: 0 # db-connect-timeout-ms
   app:
     user: vt_app      # db_app_user
     password:         # db_app_password
     useSsl: true      # db_app_use_ssl
     preferTcp: false
   dba:
-    user: vt_dba      # db_dba_user
-    password:         # db_dba_password
-    useSsl: true      # db_dba_use_ssl
+    user: vt_dba      # db-dba-user
+    password:         # db-dba-password
+    useSsl: true      # db-dba-use-ssl
     preferTcp: false
   filtered:
     user: vt_filtered # db_filtered_user
@@ -87,7 +87,7 @@ gracePeriods:
 
 replicationTracker:
   mode: disable                    # enable_replication_reporter
-  heartbeatIntervalMilliseconds: 0 # heartbeat_enable, heartbeat_interval
+  heartbeatIntervalMilliseconds: 0 # heartbeat-enable, heartbeat-interval
 
 hotRowProtection:
   mode: disable|dryRun|enable # enable_hot_row_protection, enable_hot_row_protection_dry_run

doc/design-docs/TopoLocks.md

@@ -15,7 +15,7 @@ The implementations of `LockShard` and `CheckShardLocked` differ slightly for al
 
 ### Etcd
 
-In Etcd implementation, we use `KeepAlive` API to keep renewing the context that we have for acquiring the shard lock every 10 seconds. The duration of the lease is controlled by the `--topo_etcd_lease_ttl` flag which defaults to 10 seconds. Once we acquire the shard lock, the context for acquiring the shard lock expires and that stops the KeepAlives too.
+In Etcd implementation, we use `KeepAlive` API to keep renewing the context that we have for acquiring the shard lock every 10 seconds. The duration of the lease is controlled by the `--topo-etcd-lease-ttl` flag which defaults to 10 seconds. Once we acquire the shard lock, the context for acquiring the shard lock expires and that stops the KeepAlives too.
 
 The shard lock is released either when the unlock function is called, or if the lease ttl expires. This guards against servers crashing while holding the shard lock.
 
@@ -30,6 +30,6 @@ The Check function doesn't do anything in ZooKeeper. The implementation just ret
 
 ### Consul
 
-In Consul, the timeout for the lock is controlled by the `--topo_consul_lock_session_ttl` flag. 
+In Consul, the timeout for the lock is controlled by the `--topo-consul-lock-session-ttl` flag. 
 
 The Check function works properly and checks if the lock still exists.

docker/mini/vtctld-mini-up.sh

@@ -23,6 +23,7 @@ grpc_port=15999
 
 echo "- Starting vtctld..."
 # shellcheck disable=SC2086
+#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
 vtctld \
  $TOPOLOGY_FLAGS \
  --disable_active_reparents \

docker/mini/vttablet-mini-up.sh

@@ -39,6 +39,7 @@ echo "> Starting vttablet for server $mysql_host:$mysql_port"
 echo "  - Tablet alias is $alias"
 echo "  - Tablet listens on http://$hostname:$port"
 # shellcheck disable=SC2086
+#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
 vttablet \
  $TOPOLOGY_FLAGS \
  -log_dir $VTDATAROOT/tmp \

docker/vttestserver/run.sh

@@ -36,7 +36,7 @@ rm -vf "$VTDATAROOT"/"$tablet_dir"/{mysql.sock,mysql.sock.lock}
 	--num_shards "$NUM_SHARDS" \
 	--mysql_bind_host "${MYSQL_BIND_HOST:-127.0.0.1}" \
 	--vtcombo-bind-host "${VTCOMBO_BIND_HOST:-127.0.0.1}" \
-	--mysql_server_version "${MYSQL_SERVER_VERSION:-$1}" \
+	--mysql-server-version "${MYSQL_SERVER_VERSION:-$1}" \
 	--charset "${CHARSET:-utf8mb4}" \
 	--foreign_key_mode "${FOREIGN_KEY_MODE:-allow}" \
 	--enable_online_ddl="${ENABLE_ONLINE_DDL:-true}" \

examples/common/env.sh

@@ -53,6 +53,7 @@ if [ "${TOPO}" = "zk2" ]; then
     # Set topology environment parameters.
     ZK_SERVER="localhost:21811,localhost:21812,localhost:21813"
     # shellcheck disable=SC2034
+    #TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
     TOPOLOGY_FLAGS="--topo_implementation zk2 --topo_global_server_address ${ZK_SERVER} --topo_global_root /vitess/global"
 
     mkdir -p "${VTDATAROOT}/tmp"
@@ -61,10 +62,12 @@ elif [ "${TOPO}" = "consul" ]; then
     CONSUL_SERVER=127.0.0.1
     CONSUL_HTTP_PORT=8500
     CONSUL_SERVER_PORT=8300
+    #TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
     TOPOLOGY_FLAGS="--topo_implementation consul --topo_global_server_address ${CONSUL_SERVER}:${CONSUL_HTTP_PORT} --topo_global_root vitess/global/"
     mkdir -p "${VTDATAROOT}/consul"
 else
     ETCD_SERVER="localhost:2379"
+    #TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
     TOPOLOGY_FLAGS="--topo_implementation etcd2 --topo_global_server_address $ETCD_SERVER --topo_global_root /vitess/global"
 
     mkdir -p "${VTDATAROOT}/etcd"

examples/common/scripts/mysqlctl-down.sh

@@ -24,5 +24,6 @@ uid=$TABLET_UID
 printf -v alias '%s-%010d' $cell $uid
 echo "Shutting down MySQL for tablet $alias..."
 
+ #TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
 mysqlctl --tablet_uid $uid shutdown
 

examples/common/scripts/mysqlctl-up.sh

@@ -35,6 +35,7 @@ if [ -d $VTDATAROOT/$tablet_dir ]; then
  action='start'
 fi
 
+#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
 mysqlctl \
  --log_dir $VTDATAROOT/tmp \
  --tablet_uid $uid \

examples/common/scripts/vtctld-up.sh

@@ -23,6 +23,7 @@ grpc_port=15999
 
 echo "Starting vtctld..."
 # shellcheck disable=SC2086
+#TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
 vtctld \
  $TOPOLOGY_FLAGS \
  --cell $cell \