RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-23 02:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

:doc: Removing old init section.

Browse Source 
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
This commit is contained in:
John Wilkins 2012-09-18 11:02:41 -07:00
parent 4f3642c5f4
commit f60ea3836b
5 changed files with 0 additions and 479 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/init/check-cluster-health.rst
View File

@ -1,16 +0,0 @@
=========================
Checking Cluster Health
=========================
When you start the Ceph cluster, it may take some time to reach a healthy
state. You can check on the health of your Ceph cluster with the following::
ceph health
If you specified non-default locations for your configuration or keyring::
ceph -c /path/to/conf -k /path/to/keyring health
Upon starting the Ceph cluster, you will likely encounter a health
warning such as ``HEALTH_WARN XXX num pgs stale``. Wait a few moments and check
it again. When your cluster is ready, ``ceph health`` should return a message
such as ``HEALTH_OK``. At that point, it is okay to begin using the cluster.

352
doc/init/debug.rst
View File

@ -1,352 +0,0 @@
=======================
Debugging and Logging
=======================
Ceph is still on the leading edge, so you may encounter situations that
require using Ceph's debugging and logging.
Debugging and Logging Configuration
===================================
To activate Ceph's debugging output (*i.e.*, ``dout()``), you may add ``debug``
settings to your configuration. Ceph's logging levels operate on a scale of 1 to
20, where 1 is terse and 20 is verbose. Subsystems common to each daemon may be
set under ``[global]`` in your configuration file. Subsystems for particular
daemons are set under the daemon section in your configuration file (*e.g.*,
``[mon]``, ``[osd]``, ``[mds]``). For example::
[global]
debug ms = 1
[mon]
debug mon = 20
debug paxos = 20
debug auth = 20
[osd]
debug osd = 20
debug filestore = 20
debug journal = 20
debug monc = 20
[mds]
debug mds = 20
debug mds balancer = 20
debug mds log = 20
debug mds migrator = 20
When your system is running well, choose appropriate logging levels and remove
unnecessary debugging settings to ensure your cluster runs optimally. Logging
debug output messages is relatively slow, and a waste of resources when operating
your cluster.
.. tip: When debug output slows down your system, it can hide race conditions.
Reference
=========
Logging and debugging settings are not required, but you may override default settings
as needed. Ceph supports the following settings:
Logging
-------
``log file``
:Desription: The location of the logging file for your cluster.
:Type: String
:Required: No
:Default: ``/var/log/ceph/$cluster-$name.log``
``log max new``
:Description: The maximum number of new log files.
:Type: Integer
:Required: No
:Default: ``1000``
``log max recent``
:Description: The maximum number of recent events to include in a log file.
:Type: Integer
:Required: No
:Default: ``1000000``
``log to stderr``
:Description: Determines if logging messages should appear in ``stderr``.
:Type: Boolean
:Required: No
:Default: ``true``
``err to stderr``
:Description: Determines if error messages should appear in ``stderr``.
:Type: Boolean
:Required: No
:Default: ``true``
``log to syslog``
:Description: Determines if logging messages should appear in ``syslog``.
:Type: Boolean
:Required: No
:Default: ``false``
``err to syslog``
:Description: Determines if error messages should appear in ``syslog``.
:Type: Boolean
:Required: No
:Default: ``false``
``log flush on exit``
:Description: Determines if Ceph should flush the log files after exit.
:Type: Boolean
:Required: No
:Default: ``true``
``clog to monitors``
:Description: Determines if ``clog`` messages should be sent to monitors.
:Type: Boolean
:Required: No
:Default: ``true``
``clog to syslog``
:Description: Determines if ``clog`` messages should be sent to syslog.
:Type: Boolean
:Required: No
:Default: ``false``
``mon cluster log to syslog``
:Description: Determines if the cluster log should be output to the syslog.
:Type: Boolean
:Required: No
:Default: ``false``
``mon cluster log file``
:Description: The location of the cluster's log file.
:Type: String
:Required: No
:Default: ``/var/log/ceph/$cluster.log``
OSD
---
``osd debug drop ping probability``
:Description: ?
:Type: Double
:Required: No
:Default: 0
``osd debug drop ping duration``
:Description: The duration ?
:Type: Integer
:Required: No
:Default: 0
``osd debug drop pg create probability``
:Description:
:Type: Integer
:Required: No
:Default: 0
``osd debug drop pg create duration``
:Description: ?
:Type: Double
:Required: No
:Default: 1
``osd preserve trimmed log``
:Description: ?
:Type: Boolean
:Required: No
:Default: ``false``
``osd tmapput sets uses tmap``
:Description: For debug only. ???
:Type: Boolean
:Required: No
:Default: ``false``
``osd min pg log entries``
:Description: The minimum number of log entries for placement groups.
:Type: 32-bit Unsigned Integer
:Required: No
:Default: 1000
``osd op log threshold``
:Description: How many op log messages to show up in one pass.
:Type: Integer
:Required: No
:Default: 5
Filestore
---------
``filestore debug omap check``
:Description: Checks the ``omap``. This is an expensive operation.
:Type: Boolean
:Required: No
:Default: 0
MDS
---
``mds debug scatterstat``
:Description: ?
:Type: Boolean
:Required: No
:Default: ``false``
``mds debug frag``
:Description:
:Type: Boolean
:Required: No
:Default: ``false``
``mds debug auth pins``
:Description: ?
:Type: Boolean
:Required: No
:Default: ``false``
``mds debug subtrees``
:Description: ?
:Type: Boolean
:Required: No
:Default: ``false``
RADOS Gateway
-------------
``rgw log nonexistent bucket``
:Description: Should we log a non-existent buckets?
:Type: Boolean
:Required: No
:Default: ``false``
``rgw log object name``
:Description: Should an object's name be logged. // man date to see codes (a subset are supported)
:Type: String
:Required: No
:Default: ``%Y-%m-%d-%H-%i-%n``
``rgw log object name utc``
:Description: Object log name contains UTC?
:Type: Boolean
:Required: No
:Default: ``false``
``rgw enable ops log``
:Description: Enables logging of every RGW operation.
:Type: Boolean
:Required: No
:Default: ``true``
``rgw enable usage log``
:Description: Enable logging of RGW's bandwidth usage.
:Type: Boolean
:Required: No
:Default: ``true``
``rgw usage log flush threshold``
:Description: Threshold to flush pending log data.
:Type: Integer
:Required: No
:Default: ``1024``
``rgw usage log tick interval``
:Description: Flush pending log data every ``s`` seconds.
:Type: Integer
:Required: No
:Default: 30
``rgw intent log object name``
:Description:
:Type: String
:Required: No
:Default: ``%Y-%m-%d-%i-%n``
``rgw intent log object name utc``
:Description: Include a UTC timestamp in the intent log object name.
:Type: Boolean
:Required: No
:Default: ``false``
Runtime Configuration
=====================
To inject debug or logging configuration settings at runtime, execute ``ceph``
with the type of daemon, specify ``tell`` and ``injectargs`` with a key
and value, as follows::
ceph [osd|mon|mds] tell injectargs {daemon-id} --{key} {value} [--{key} {value} ...]
The following example tells ``osd.0`` to set ``debug osd`` to ``20``::
ceph osd tell 0 injectargs --debug_osd 20

79
doc/init/index.rst
View File

@ -1,79 +0,0 @@
=====================
Operating a Cluster
=====================
The ``ceph`` process provides functionality to **start**, **restart**, and
**stop** your Ceph cluster. Each time you execute ``ceph``, you must specify at
least one option and one command. You may also specify a daemon type or a daemon
instance. For most newer Debian/Ubuntu distributions, you may use the following
syntax::
sudo service ceph [options] [commands] [daemons]
For older distributions, you may wish to use the ``/etc/init.d/ceph`` path::
sudo /etc/init.d/ceph [options] [commands] [daemons]
The ``ceph`` options include:
+-----------------+----------+-------------------------------------------------+
| Option | Shortcut | Description |
+=================+==========+=================================================+
| ``--verbose`` | ``-v`` | Use verbose logging. |
+-----------------+----------+-------------------------------------------------+
| ``--valgrind`` | ``N/A`` | (Developers only) Use `Valgrind`_ debugging. |
+-----------------+----------+-------------------------------------------------+
| ``--allhosts`` | ``-a`` | Execute on all hosts in ``ceph.conf.`` |
| | | Otherwise, it only executes on ``localhost``. |
+-----------------+----------+-------------------------------------------------+
| ``--restart`` | ``N/A`` | Automatically restart daemon if it core dumps. |
+-----------------+----------+-------------------------------------------------+
| ``--norestart`` | ``N/A`` | Don't restart a daemon if it core dumps. |
+-----------------+----------+-------------------------------------------------+
| ``--conf`` | ``-c`` | Use an alternate configuration file. |
+-----------------+----------+-------------------------------------------------+
The ``ceph`` commands include:
+------------------+------------------------------------------------------------+
| Command | Description |
+==================+============================================================+
| ``start`` | Start the daemon(s). |
+------------------+------------------------------------------------------------+
| ``stop`` | Stop the daemon(s). |
+------------------+------------------------------------------------------------+
| ``forcestop`` | Force the daemon(s) to stop. Same as ``kill -9`` |
+------------------+------------------------------------------------------------+
| ``killall`` | Kill all daemons of a particular type. |
+------------------+------------------------------------------------------------+
| ``cleanlogs`` | Cleans out the log directory. |
+------------------+------------------------------------------------------------+
| ``cleanalllogs`` | Cleans out **everything** in the log directory. |
+------------------+------------------------------------------------------------+
The ``ceph`` daemons include the daemon types:
- ``mon``
- ``osd``
- ``mds``
The ``ceph`` daemons may also specify a specific instance::
sudo /etc/init.d/ceph -a start osd.0
Where ``osd.0`` is the first OSD in the cluster.
.. _Valgrind: http://www.valgrind.org/
.. toctree::
:hidden:
start-cluster
Check Cluster Health <check-cluster-health>
stop-cluster
debug
See `Operations`_ for more detailed information.
.. _Operations: ../ops/index.html

23
doc/init/start-cluster.rst
View File

@ -1,23 +0,0 @@
====================
Starting a Cluster
====================
To start your Ceph cluster, execute the ``ceph`` with the ``start`` command.
The usage may differ based upon your Linux distribution. For example, for most
newer Debian/Ubuntu distributions, you may use the following syntax::
sudo service ceph start [options] [start|restart] [daemonType|daemonID]
For older distributions, you may wish to use the ``/etc/init.d/ceph`` path::
sudo /etc/init.d/ceph [options] [start|restart] [daemonType|daemonID]
The following examples illustrates a typical use case::
sudo service ceph -a start
sudo /etc/init.d/ceph -a start
Once you execute with ``-a``, Ceph should begin operating. You may also specify
a particular daemon instance to constrain the command to a single instance. For
example::
sudo /etc/init.d/ceph start osd.0

9
doc/init/stop-cluster.rst
View File

@ -1,9 +0,0 @@
====================
Stopping a Cluster
====================
To stop a cluster, execute one of the following::
sudo service -a ceph stop
sudo /etc/init.d/ceph -a stop
Ceph should shut down the operating processes.