From 6149fb700fe88d303f4adcc88734b730ae5187f4 Mon Sep 17 00:00:00 2001 From: Ross Turk Date: Mon, 21 May 2012 18:21:39 -0700 Subject: doc: Added a FAQ page. Added a FAQ page, which we will need to put more content in. Signed-off-by: Ross Turk --- doc/faq.rst | 39 +++++++++++++++++++++++++++++++++++++++ doc/index.rst | 1 + 2 files changed, 40 insertions(+) create mode 100644 doc/faq.rst (limited to 'doc') diff --git a/doc/faq.rst b/doc/faq.rst new file mode 100644 index 00000000000..b482ad7b234 --- /dev/null +++ b/doc/faq.rst @@ -0,0 +1,39 @@ +============================ + Frequently Asked Questions +============================ + +These questions have been frequently asked on the ceph-devel mailing +list, the IRC channel, and on the Ceph.com blog. + +Is Ceph Production-Quality? +=========================== + +The definition of "production quality" varies depending on who you ask. +Because it can mean a lot of different things depending on how you want to +use Ceph, we prefer not to think of it as a binary term. + +At this point we support the RADOS object store, radosgw, and rbd because +we think they are sufficiently stable that we can handle the support +workload. There are several organizations running those parts of the +system in production. Others wouldn't dream of doing so at this stage. + +The CephFS POSIX-compliant filesystem is functionally-complete and has +been evaluated by a large community of users, but has not yet been +subjected to extensive, methodical testing. + +We can tell you how we test, and what we support, but in the end it's +your judgement that matters most! + +How can I add a question to this list? +====================================== + +If you'd like to add a question to this list (hopefully with an +accompanying answer!), you can find it in the doc/ directory of our +main git repository: + +.. http://github.com/ceph/ceph/doc/faq.rst + +We use Sphinx to manage our documentation, and this page is generated +from reStructuredText source. See the section on Building Ceph +Documentation for the build procedure. + diff --git a/doc/index.rst b/doc/index.rst index e1a588af72f..77b6bf85ae6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -30,5 +30,6 @@ cluster to ensure that the storage hosts are running smoothly. Internals man/index architecture + faq papers appendix/index -- cgit v1.2.1 From cf5848676e7b48d252fae9ff525795d574bef188 Mon Sep 17 00:00:00 2001 From: Ross Turk Date: Mon, 21 May 2012 18:22:35 -0700 Subject: doc: added links from the chef install doc to the chef config doc and back Signed-off-by: Ross Turk --- doc/config-cluster/chef.rst | 3 ++- doc/install/chef.rst | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/config-cluster/chef.rst b/doc/config-cluster/chef.rst index cd78e15314d..b204af0a13f 100644 --- a/doc/config-cluster/chef.rst +++ b/doc/config-cluster/chef.rst @@ -3,7 +3,8 @@ ===================== We use Chef cookbooks to deploy Ceph. See `Managing Cookbooks with Knife`_ for details -on using ``knife``. +on using ``knife``. For Chef installation instructions, see +`Installing Chef <../../install/chef>`_. Add a Cookbook Path ------------------- diff --git a/doc/install/chef.rst b/doc/install/chef.rst index 583128eb851..0af291ebe6f 100644 --- a/doc/install/chef.rst +++ b/doc/install/chef.rst @@ -195,6 +195,10 @@ Chef nodes. :: A list of the nodes you've boostrapped should appear. + +See the `Deploy With Chef <../../config-cluster/chef>`_ section for information +on using Chef to deploy your Ceph cluster. + .. _Chef Architecture Introduction: http://wiki.opscode.com/display/chef/Architecture+Introduction .. _Installing Chef Client on Ubuntu or Debian: http://wiki.opscode.com/display/chef/Installing+Chef+Client+on+Ubuntu+or+Debian .. _Installing Chef Server on Debian or Ubuntu using Packages: http://wiki.opscode.com/display/chef/Installing+Chef+Server+on+Debian+or+Ubuntu+using+Packages -- cgit v1.2.1 From 5959ea7b78d75ee4f0ccf187fd203d848ebdb28e Mon Sep 17 00:00:00 2001 From: Ross Turk Date: Mon, 21 May 2012 19:36:59 -0700 Subject: doc: fix broken link in FAQ Signed-off-by: Ross Turk --- doc/faq.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/faq.rst b/doc/faq.rst index b482ad7b234..f4e97adc30c 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -31,7 +31,9 @@ If you'd like to add a question to this list (hopefully with an accompanying answer!), you can find it in the doc/ directory of our main git repository: -.. http://github.com/ceph/ceph/doc/faq.rst + `https://github.com/ceph/ceph/blob/master/doc/faq.rst`_ + +.. _https://github.com/ceph/ceph/blob/master/doc/faq.rst: https://github.com/ceph/ceph/blob/master/doc/faq.rst We use Sphinx to manage our documentation, and this page is generated from reStructuredText source. See the section on Building Ceph -- cgit v1.2.1