add bgp doc

kubeovn · May 8, 2021 · 5fc3cfb · 5fc3cfb
1 parent f16fcb9
commit 5fc3cfb
Showing 1 changed file with 27 additions and 22 deletions.
diff --git a/docs/bgp.md b/docs/bgp.md
@@ -6,28 +6,33 @@ To enable BGP advertise function, you need to install kube-ovn-speaker and annot
 ## List of Options
 ```text
 Usage of ovn-speaker:
-      --add_dir_header                   If true, adds the file directory to the header
-      --alsologtostderr                  log to standard error as well as files
-      --auth-password string             bgp peer auth password
-      --cluster-as uint32                The as number of container network, default 65000 (default 65000)
-      --grpc-host string                 The host address for grpc to listen, default: 127.0.0.1 (default "127.0.0.1")
-      --grpc-port uint32                 The port for grpc to listen, default:50051 (default 50051)
-      --holdtime duration                ovn-speaker goes down abnormally, the local saving time of BGP route will be affected.Holdtime must be in the range 3s to 65536s. (default 90s) (default 1m30s)
-      --kubeconfig string                Path to kubeconfig file with authorization and master location information. If not set use the inCluster token.
-      --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_file string                  If non-empty, use this log file
-      --log_file_max_size uint           Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
-      --logtostderr                      log to standard error instead of files (default true)
-      --neighbor-address string          The router address the speaker connects to.
-      --neighbor-as uint32               The router as number, default 65001 (default 65001)
-      --pprof-port uint32                The port to get profiling data, default: 10667 (default 10667)
-      --router-id string                 The address for the speaker to use as router id, default the node ip
-      --skip_headers                     If true, avoid header prefixes in the log messages
-      --skip_log_headers                 If true, avoid headers when opening log files
-      --stderrthreshold severity         logs at or above this threshold go to stderr (default 2)
-  -v, --v Level                          number for the log level verbosity
-      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging
+      --add_dir_header                            If true, adds the file directory to the header
+      --alsologtostderr                           log to standard error as well as files
+      --announce-cluster-ip                       The Cluster IP of the service to  announce to the BGP peers.
+      --auth-password string                      bgp peer auth password
+      --cluster-as uint32                         The as number of container network, default 65000 (default 65000)
+      --graceful-restart                          Enables the BGP Graceful Restart  so that routes are preserved on unexpected restarts
+      --graceful-restart-deferral-time duration   BGP Graceful restart deferral time according to RFC4724 4.1, maximum 18h. (default 6m0s)
+      --graceful-restart-time duration            BGP Graceful restart time according to RFC4724 3, maximum 4095s. (default 1m30s)
+      --grpc-host string                          The host address for grpc to listen, default: 127.0.0.1 (default "127.0.0.1")
+      --grpc-port uint32                          The port for grpc to listen, default:50051 (default 50051)
+      --holdtime duration                         ovn-speaker goes down abnormally, the local saving time of BGP route will be affected.Holdtime must be in the range 3s to 65536s. (default 1m30s)
+      --kubeconfig string                         Path to kubeconfig file with authorization and master location information. If not set use the inCluster token.
+      --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_file string                           If non-empty, use this log file
+      --log_file_max_size uint                    Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
+      --logtostderr                               log to standard error instead of files (default true)
+      --neighbor-address string                   The router address the speaker connects to.
+      --neighbor-as uint32                        The router as number, default 65001 (default 65001)
+      --pprof-port uint32                         The port to get profiling data, default: 10667 (default 10667)
+      --router-id string                          The address for the speaker to use as router id, default the node ip
+      --skip_headers                              If true, avoid header prefixes in the log messages
+      --skip_log_headers                          If true, avoid headers when opening log files
+      --stderrthreshold severity                  logs at or above this threshold go to stderr (default 2)
+  -v, --v Level                                   number for the log level verbosity
+      --vmodule moduleSpec                        comma-separated list of pattern=N settings for file-filtered logging
+
 
 ```