Browse Source

doc: initial faq

Xiang Li 9 years ago
parent
commit
58150937c0
2 changed files with 21 additions and 1 deletions
  1. 4 1
      Documentation/docs.md
  2. 17 0
      Documentation/faq.md

+ 4 - 1
Documentation/docs.md

@@ -51,12 +51,15 @@ To learn more about the concepts and internals behind etcd, read the following p
  - [Migrate applications from using API v2 to API v3][v2_migration]
  - [Updating v2.3 to v3.0][v3_upgrade]
 
-## Troubleshooting
+## Frequently Asked Questions (FAQ)
+
+Answers to [common questions] about etcd.
 
 [api_ref]: dev-guide/api_reference_v3.md
 [api_grpc_gateway]: dev-guide/api_grpc_gateway.md
 [clustering]: op-guide/clustering.md
 [conf]: op-guide/configuration.md
+[common questions]: faq.md
 [data_model]: learning/data_model.md
 [demo]: demo.md
 [download_build]: dl_build.md

+ 17 - 0
Documentation/faq.md

@@ -0,0 +1,17 @@
+## Frequently Asked Questions (FAQ)
+
+### Configuration
+
+#### What is the difference between advertise-urls and listen-urls?
+
+`listen-urls` specifies the local addresses etcd server binds to for accepting incoming connections. To listen on a port for all interfaces, specify `0.0.0.0` as the listen IP address.
+
+`advertise-urls` specifies the addresses etcd clients or other etcd members should use to contact the etcd server. The advertise addresses must be reachable from the remote machines. Do not advertise addresses like `localhost` or `0.0.0.0` for a production setup since these addresses are unreachable from remote machines.
+
+### Operation
+
+#### How to backup a etcd cluster?
+
+etcdctl provides a `snapshot` command to create backups. See [backup] for more details.
+
+[backup]: https://github.com/coreos/etcd/blob/master/Documentation/op-guide/recovery.md#snapshotting-the-keyspace