From eb6154b1618ff2a94c490491a753437f02a57f34 Mon Sep 17 00:00:00 2001 From: Sergiusz Bazanski Date: Mon, 27 Aug 2018 21:02:21 +0100 Subject: [PATCH] Update README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 59b8335..3074df0 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,41 @@ You can then start `arista-proxy` with default flags and talk to it via gRPC: alias grpc-dev="grpc -cacert $(pwd)/pki/ca.pem -key $(pwd)/pki/client-key.pem -cert $(pwd)/pki/client.pem" grpc-dev test.arista-proxy.svc.cluster.local:42000 proto.AristaProxy.ShowVersion +Debug Status Page +----------------- + +The `debug_address` flag controls spawning an HTTP server useful for debugging. You can use it to inspect gRPC request and view general status information of the proxy. + +Flags +----- + + ./arista-proxy -help + Usage of ./arista-proxy: + -alsologtostderr + log to standard error as well as files + -arista_api string + Arista remote endpoint (default "http://admin:password@1.2.3.4:80/command-api") + -debug_address string + Debug HTTP listen address, or empty to disable (default "127.0.0.1:30000") + -listen_address string + gRPC listen address (default "127.0.0.1:30001") + -log_backtrace_at value + when logging hits line file:N, emit a stack trace + -log_dir string + If non-empty, write log files in this directory + -logtostderr + log to standard error instead of files + -pki_realm string + PKI realm (default "svc.cluster.local") + -stderrthreshold value + logs at or above this threshold go to stderr + -tls_ca_path string + Path to PKI CA certificate (default "pki/ca.pem") + -tls_certificate_path string + Path to PKI service certificate (default "pki/service.pem") + -tls_key_path string + Path to PKI service private key (default "pki/service-key.pem") + -v value + log level for V logs + -vmodule value + comma-separated list of pattern=N settings for file-filtered logging