Commit Graph

56 Commits (ebc901c6af67300f7b7b8da1b2d0a74147798da5)

Author SHA1 Message Date
Guillaume Abrioux 44fa0863fc tests: pin sphinx version to 1.7.9
using sphinx 1.8.0 breaks our doc test CI job.

Typical error:

```
Exception occurred:
  File
  "/home/jenkins-build/build/workspace/ceph-ansible-docs-pull-requests/docs/.tox/docs/lib/python2.7/site-packages/sphinx/highlighting.py",  line 26, in <module>
      from sphinx.ext import doctest
      SyntaxError: unqualified exec is not allowed in function 'run' it contains a nested function with free variables (doctest.py, line 97)
```

See: https://github.com/sphinx-doc/sphinx/issues/5417

Pinning to 1.7.9 to fix our CI.

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
(cherry picked from commit 8f2c660d25)
2018-09-13 13:24:40 +02:00
Sébastien Han bc50f1038c doc: remove old statement
We have been supporting multiple devices for journalin containerized
deployments for a while now and forgot about this.

Closes: https://bugzilla.redhat.com/show_bug.cgi?id=1622393
Signed-off-by: Sébastien Han <seb@redhat.com>
(cherry picked from commit 124fc727f4)
2018-08-28 22:47:50 +00:00
JohnHaan ad26d842f5 Fixed wrong path of ceph.conf in docs.
The path of ceph.conf sample template moved to ceph-config.
Therefore docs needs to be changed to the right directory.

Signed-off-by: JohnHaan <yongiman@gmail.com>
2018-04-10 10:33:25 +02:00
Andrew Schoen 21931c544c docs for creating encrypted OSDs with the lvm scenario
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2018-01-24 14:10:08 +01:00
Andrew Schoen fb4a6dc9a4 docs for the crush_device_class option of lvm_volumes
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2018-01-17 13:49:29 +01:00
Sébastien Han 7ba25b20dc ci: test on ansible 2.4.2
Signed-off-by: Sébastien Han <seb@redhat.com>
2018-01-11 17:27:42 +01:00
Aviolat Romain 9c5e8ce79a doc: corrected a typo 2018-01-02 11:57:52 +01:00
Andrew Schoen 3c604f1115 lvm: support --data as a raw device or partition in ceph-volume
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-11-15 09:36:17 -06:00
Yixing Yan 7d239b6908 fix the ansible version for the stable-3.0 branch 2017-11-06 16:15:47 +08:00
Guillaume Abrioux c9c278de7d docs: update patterns containing version number
Update doc regarding last changes (new branch, ansible version, ...)

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
2017-10-30 16:40:45 +01:00
Alfredo Deza 429622dd34 docs add lvm bluestore examples
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-10-27 11:33:54 -04:00
Sébastien Han b511b8679e Merge pull request #2064 from berendt/sphinx-conf-do-not-set-release-version
Do not set release/version in sphinx configuration
2017-10-17 11:06:28 +02:00
Christian Berendt 9a1e789a98 Add missing backticks in docs index 2017-10-17 11:00:02 +02:00
Christian Berendt 611138484d Do not set release/version in sphinx configuration 2017-10-17 10:55:54 +02:00
Guillaume Abrioux ea7a8fb807 Docs: fix error `Unknown target name`
Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
2017-10-10 11:36:03 +02:00
Sébastien Han f92eaea0fd Merge pull request #1977 from ktdreyer/doc-master-ansible-version
docs: master requires ansible 2.3.1
2017-10-03 22:55:22 +02:00
Ken Dreyer a1273f3dc8 docs: add instructions for installing Ansible
Add RPM and DEB instructions for installing Ansible.
2017-10-03 11:39:39 -06:00
Ken Dreyer 07edf7e38a docs: master requires ansible 2.3.1
We require Ansible 2.3.1 or greater to run ceph-ansible's master branch.
2017-10-03 11:26:43 -06:00
Sébastien Han ae2fd45994 common: refactor installation method
The installation process is now described as follow:

* you still have to choose a 'ceph_origin' installation method. The
origin can be a 'repository' (add a new repository), distro (it will use
the packages provided by the native repo source of your distribution),
local (only available on redhat system, it installs locally built
packages). This option is not well tested, so use it carefully

* if ceph_origin == 'repository' you will have to decide what kind of
repository you want to enable:
  - community: corresponds to the stable upstream/community version
  - enterprise: corresponds to the stable enterprise/downstream version
    (basically you are a red hat customer)
  - dev: it will install ceph from packages built out of the github
    development branches

Signed-off-by: Sébastien Han <seb@redhat.com>
Co-Authored-by: Guillaume Abrioux <gabrioux@redhat.com>
Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
2017-08-30 10:52:01 +02:00
Andrew Schoen 594d5e017a ceph-osd: restructure lvm_volumes variable for more flexiblity
The lvm_volumes variable is now a list of dictionaries that represent
each OSD you'd like to deploy using ceph-volume. Each dictionary must
have the following keys: data, journal and data_vg. Each dictionary also
can optionaly provide a journal_vg key.

The 'data' key represents the lv name used for the OSD and the 'data_vg'
key is the vg name that the given lv resides on. The 'journal' key is
either an lv, device or partition. The 'journal_vg' key is optional and
must be the vg name for the journal lv if given. This key is mainly used
for purging of the journal lv if purge-cluster.yml is run.

For example:

  lvm_volumes:
    - data: data_lv1
      journal: journal_lv1
      data_vg: vg1
      journal_vg: vg2
    - data: data_lv2
      journal: /dev/sdc
      data_vg: vg1

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-23 10:14:14 -05:00
Andrew Schoen 482114e9c5 docs: add examples for collocated and non-collocated osd scenarios
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-18 11:08:56 -05:00
Andrew Schoen 90efa30e27 docs: move testing/glossary after index in glossary.rst
We want the usage docs before the testing docs on this page.

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-18 11:06:59 -05:00
Andrew Schoen 16faf78ce2 docs: add docs for dev contributions
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-17 16:03:04 -05:00
Andrew Schoen da4a42de0a docs: add docs for ceph_conf_overrides usage
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-17 16:03:04 -05:00
Andrew Schoen a5116b2ff1 docs: add links to example videos
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-17 16:03:04 -05:00
Andrew Schoen ae60030c6c docs: collocated and non-collocated scenario docs
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-17 16:03:04 -05:00
Andrew Schoen 4d85560a5d docs: docs for installation and basic config
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-17 11:02:14 -05:00
Andrew Schoen e597628be9 lvm: update scenario for new osd_scenario variable
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-04 06:38:36 -05:00
Andrew Schoen fd4a021051 docs: add docs for the lvm_osds OSD scenario
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-08-04 06:13:09 -05:00
Andrew Schoen 7293c40c40 tests: run all existing tests with shaman repos
If you use the 'dev' factor, the testing scenario will
use repos from shaman.ceph.com. You can define CEPH_DEV_BRANCH
and CEPH_DEV_SHA1 to specify which repo you'd like to test.

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-07-17 14:42:32 -05:00
Andrew Schoen 8472472194 docs: update tox docs to reflect the removed environment variables
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-05-02 14:15:42 -05:00
Andrew Schoen e8e4245e43 Merge pull request #1453 from ceph/docs-fixtures
[docs] fixtures and Python tests
2017-04-17 15:46:02 -05:00
Andrew Schoen 03cafa3108 docs: review feedback on testing/tox.rst
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-04-17 15:39:01 -05:00
Andrew Schoen b45209c951 docs: fix rst error in scenarios.rst
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-04-17 15:29:18 -05:00
Andrew Schoen 80142ef3fd docs: write docs for tox.ini file
Signed-off-by: Andrew Schoen <aschoen@redhat.com>
2017-04-17 15:29:18 -05:00
Alfredo Deza 697e7534d0 docs: describe Python tests and fixtures
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-17 16:28:52 -04:00
Alfredo Deza f50494d7be docs: conventions for test layouts
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-17 16:28:52 -04:00
Alfredo Deza edc7872cea docs: describe all required scenario files
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-13 12:03:41 -04:00
Alfredo Deza 7412c085f0 docs: scenario files and section descriptions
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-13 10:17:55 -04:00
Alfredo Deza d26ed99dcc docs: force an empty _static dir so sphinx is happy
Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit aacbbf0efe)
2017-04-11 09:11:09 -04:00
Alfredo Deza df315fef89 docs: force an empty _templates dir so sphinx is happy
Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit 66a9817e56)
2017-04-11 09:11:01 -04:00
Alfredo Deza e8ae5c6aaf docs: add missing sections/refs in scenarios.rst
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:18:15 -04:00
Alfredo Deza c768f34219 docs: include testing conventions and testinfra in layout.rst
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:17:53 -04:00
Alfredo Deza 7eb26d1b00 docs: fix typo in testing/index.rst
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:17:31 -04:00
Alfredo Deza 3cde692482 docs: include the tests and tox files in the glossary
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:17:13 -04:00
Alfredo Deza f895b4c376 docs: create a tests doc file
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:07:42 -04:00
Alfredo Deza cb504f6d88 docs: create a separate tox doc file
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:07:26 -04:00
Alfredo Deza 41815f6b53 docs: use glossary for the :doc: directive
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:06:36 -04:00
Alfredo Deza ae6349fd21 docs: add the testing glossary in the toctree
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:06:16 -04:00
Alfredo Deza a5b2ede0ff docs: normalize the glossary vs. contents files
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-04-07 12:05:55 -04:00