help.go 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. package etcdmain
  2. var (
  3. usageline = `usage: etcd [flags]
  4. start an etcd server
  5. etcd --version
  6. show the version of etcd
  7. etcd -h | --help
  8. show the help information about etcd
  9. `
  10. flagsline = `
  11. member flags:
  12. --name 'default'
  13. human-readable name for this member.
  14. --data-dir '${name}.etcd'
  15. path to the data directory.
  16. --snapshot-count '10000'
  17. number of committed transactions to trigger a snapshot to disk.
  18. --heartbeat-interval '100'
  19. time (in milliseconds) of a heartbeat interval.
  20. --election-timeout '1000'
  21. time (in milliseconds) for an election to timeout.
  22. --listen-peer-urls 'http://localhost:2380,http://localhost:7001'
  23. list of URLs to listen on for peer traffic.
  24. --listen-client-urls 'http://localhost:2379,http://localhost:4001'
  25. list of URLs to listen on for client traffic.
  26. -cors ''
  27. comma-separated whitelist of origins for CORS (cross-origin resource sharing).
  28. clustering flags:
  29. --initial-advertise-peer-urls 'http://localhost:2380,http://localhost:7001'
  30. list of this member's peer URLs to advertise to the rest of the cluster.
  31. --initial-cluster 'default=http://localhost:2380,default=http://localhost:7001'
  32. initial cluster configuration for bootstrapping.
  33. --initial-cluster-state 'new'
  34. initial cluster state ('new' or 'existing').
  35. --initial-cluster-token 'etcd-cluster'
  36. initial cluster token for the etcd cluster during bootstrap.
  37. --advertise-client-urls 'http://localhost:2379,http://localhost:4001'
  38. list of this member's client URLs to advertise to the rest of the cluster.
  39. --discovery ''
  40. discovery URL used to bootstrap the cluster.
  41. --discovery-fallback 'proxy'
  42. expected behavior ('exit' or 'proxy') when discovery services fails.
  43. --discovery-proxy ''
  44. HTTP proxy to use for traffic to discovery service.
  45. --discovery-srv ''
  46. dns srv domain used to bootstrap the cluster.
  47. proxy flags:
  48. --proxy 'off'
  49. proxy mode setting ('off', 'readonly' or 'on').
  50. security flags:
  51. --ca-file ''
  52. path to the client server TLS CA file.
  53. --cert-file ''
  54. path to the client server TLS cert file.
  55. --key-file ''
  56. path to the client server TLS key file.
  57. --peer-ca-file ''
  58. path to the peer server TLS CA file.
  59. --peer-cert-file ''
  60. path to the peer server TLS cert file.
  61. --peer-key-file ''
  62. path to the peer server TLS key file.
  63. unsafe flags:
  64. Please be CAUTIOUS to use unsafe flags because it will break the guarantee given
  65. by consensus protocol.
  66. --force-new-cluster 'false'
  67. force to create a new one-member cluster.
  68. `
  69. )