generate all the docs (#1587)

* generate all the docs Signed-off-by: Andrew Mason <[email protected]> * update to match latest Signed-off-by: Andrew Mason <[email protected]> * regenerate from PR latest Signed-off-by: Andrew Mason <[email protected]> --------- Signed-off-by: Andrew Mason <[email protected]>
vitessio · Sep 22, 2023 · 73a99a1 · 73a99a1
1 parent cc4ec07
commit 73a99a1
Show file tree

Hide file tree

Showing 5 changed files with 834 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -45,7 +45,7 @@ ifndef COBRADOC_VERSION_PAIRS
 export COBRADOC_VERSION_PAIRS="main:18.0,v17.0.2:17.0,v16.0.4:16.0,v15.0.4:15.0"
 endif
 
-generated-docs: mysqlctl-docs mysqlctld-docs vtctld-docs vtctldclient-docs vtgate-docs vtorc-docs vttablet-docs
+generated-docs: mysqlctl-docs mysqlctld-docs vtaclcheck-docs vtbackup-docs vtbench-docs vtclient-docs vtcombo-docs vtctld-docs vtctldclient-docs vtgate-docs vtorc-docs vttablet-docs
 
 # Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make mysqlctl-docs
 mysqlctl-docs:
@@ -55,6 +55,26 @@ mysqlctl-docs:
 mysqlctld-docs:
 	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" mysqlctld
 
+# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtaclcheck-docs
+vtaclcheck-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtaclcheck
+
+# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtbackup-docs
+vtbackup-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtbackup
+
+# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtbench-docs
+vtbench-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtbench
+
+# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtclient-docs
+vtclient-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtclient
+
+# Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtcombo-docs
+vtcombo-docs:
+	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtcombo
+
 # Usage: VITESS_DIR=/full/path/to/vitess.io/vitess make vtctld-docs
 vtctld-docs:
 	go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" vtctld

diff --git a/content/en/docs/18.0/reference/programs/vtaclcheck/_index.md b/content/en/docs/18.0/reference/programs/vtaclcheck/_index.md
@@ -0,0 +1,41 @@
+---
+title: vtaclcheck
+series: vtaclcheck
+---
+## vtaclcheck
+
+vtaclcheck checks that the access-control list (ACL) rules in a given file are valid.
+
+```
+vtaclcheck [flags]
+```
+
+### Options
+
+```
+      --acl-file string                                             The path of the JSON ACL file to check
+      --alsologtostderr                                             log to standard error as well as files
+      --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
+      --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
+      --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
+      --config-path strings                                         Paths to search for config files in. (default [/Users/andrew/dev/vitess])
+      --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
+      --config-type string                                          Config file type (omit to infer config type from file extension).
+  -h, --help                                                        help for vtaclcheck
+      --keep_logs duration                                          keep logs for this long (using ctime) (zero to keep forever)
+      --keep_logs_by_mtime duration                                 keep logs for this long (using mtime) (zero to keep forever)
+      --log_backtrace_at traceLocation                              when logging hits line file:N, emit a stack trace (default :0)
+      --log_dir string                                              If non-empty, write log files in this directory
+      --log_err_stacks                                              log stack traces for errors
+      --log_rotate_max_size uint                                    size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
+      --logtostderr                                                 log to standard error instead of files
+      --pprof strings                                               enable profiling
+      --purge_logs_interval duration                                how often try to remove old logs (default 1h0m0s)
+      --security_policy string                                      the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
+      --static-auth-file string                                     The path of the auth_server_static JSON file to check
+      --stderrthreshold severity                                    logs at or above this threshold go to stderr (default 1)
+      --v Level                                                     log level for V logs
+  -v, --version                                                     print binary version
+      --vmodule moduleSpec                                          comma-separated list of pattern=N settings for file-filtered logging
+```
+