Commit Graph

831 Commits

Author SHA1 Message Date
Venky Shankar
bf19651d6a doc: cleanup cephfs-mirroring document
Remove references to in-progress feature, remove internal interfaces
section and minor cleanups.

Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-02-03 08:56:29 -05:00
Zac Dover
ebea923ffc doc:dev remove workbench sections
This PR removes the following two sections:

1. Getting Ceph Workbench
2. Linking Ceph Workbench With Your OpenStack Tenant

Fixes: https://tracker.ceph.com/issues/48942
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-02 01:01:25 +10:00
Sage Weil
713f79fdf4 Merge PR #39039 into master
* refs/pull/39039/head:
	src/test/cli/monmaptool: adjust for new monmap features
	qa/tasks/cephadm: allow custom git_url for cephadm_branch pull
	qa/suites/rados/upgrade: include pacific-x
	qa/suites/upgrade/pacific-x/parallel
	qa/suites: some clean up for quincy
	mon: updates for quincy
	mon: update for quincy ondisk features
	script: add pacific
	doc/dev/release-checklist: we tagged v17.0.0
	ceph-volume: change to quincy
	include/ceph_features: retire MON_SINGLE_PAXOS
	include/ceph_features: define FEATURE_SERVER_QUINCY
	mon/MgrMonitor: add always_on_modules for quincy
	add feature/release name quincy
	kickoff v17 quincy
	doc/dev/release-checklists: uncheck everything!

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-01-29 14:01:26 -06:00
Sebastian Wagner
9c4df44fc5
Merge pull request #37144 from jmolmo/storage_devices_mgmt
doc: High level workflow for storage devices

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Jan Fajerski <jfajerski@suse.com>
Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-01-29 19:16:54 +01:00
Sage Weil
a9c4d1f1e7 qa/suites: some clean up for quincy
- remove upgrades from nautilus
- stubs for completing upgrade to quincy

Still missing the pacific-x upgrade tests.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
7bbc92eda3 mon: updates for quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
d777adb89e mon: update for quincy ondisk features
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
8a0cd401a8 script: add pacific
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
fbd4356f0d doc/dev/release-checklist: we tagged v17.0.0
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
1c039854cb ceph-volume: change to quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
f1ecf99a86 include/ceph_features: retire MON_SINGLE_PAXOS
X-3 = Q-3 = Nautilus

Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
f954c7e985 include/ceph_features: define FEATURE_SERVER_QUINCY
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
348ed248f4 mon/MgrMonitor: add always_on_modules for quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
beb62c029a add feature/release name quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
d730a522e3 kickoff v17 quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
0a13114341 doc/dev/release-checklists: uncheck everything!
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Neha Ojha
a3d74ad052
Merge pull request #39108 from zdover23/wip-doc-leads-update-epuertat-28-Jan-2021
doc/dev: add Ernesto Puerta as dashboard lead

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2021-01-27 17:10:59 -08:00
Neha Ojha
36bf44e150
Merge pull request #37949 from ideepika/wip-docs-update
doc/dev/developer_guide:  teuthology update developer guide

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-01-27 16:35:23 -08:00
Zac Dover
d318b60cc1 doc/dev: add Ernesto Puerta as dashboard lead
This commit removes Lenz Grimmer's name and github
handle from the list of component leads and replaces
it with Ernesto Puerta's name and github handle.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-01-28 02:26:23 +10:00
Deepika Upadhyay
e179e14115 doc/dev/developer_guide/basic-workflow: fix integration tests link
Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:53:34 +05:30
Zac Dover
9ce222fee2 doc/dev: improving teuthology docs
This commit is a proof of concept and a repair of
links to the "Integration Tests" section of the
Developer Guide.

This fixes the "reading a standalone test" link
from the "Running Tests in the Cloud" page
to the "Reading a Standalone Test" section in
the "Tests: Integration Tests" page.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-01-26 16:53:34 +05:30
Deepika Upadhyay
4159d946d7 doc/dev/developer_guide/testing_integration_tests: fix broken links and
update teuthology guide

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:53:06 +05:30
Deepika Upadhyay
c77d0817d5 doc/dev/developer_guide: rearrange and improve docs
* move running-tests-using-teuth.rst to
doc/dev/developer_guide/tests-integration-testing-teuthology-workflow.rst

* introduce developer's guide for Sentry and improve teuthology docs

* add teuthology debugging guide * create testing_integration_tests
subfolder for teuthology

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:49:36 +05:30
Juan Miguel Olmo Martínez
bddb596011
doc: High level workflow for storage devices
A first document where to discuss how to improve and make more easy and effective for final users the storage devices and OSD management.

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-20 13:17:53 +01:00
Venky Shankar
439c18c490 doc: document mirror daemon internals
... fix some typos and reorganize sections to be reader
friendly. Also include a requirements section.

Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-12 05:56:52 -05:00
Sebastian Wagner
3aeda544a1 doc/cephadm: Rm doc/dev/cephadm from user docs
We should not link the dev guide form the user documentation. The user docs are already convoluted and hard to follow. Adding the dev guide is not helpful.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:12 +01:00
Sebastian Wagner
6b3c46f508 doc/dev: resurrect hidden dev/cephadm.rst
some time ago, a cephadm folder was added that did hide the
old dev documentation page.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-06 14:13:11 +01:00
Zac Dover
702cedf327 doc/dev: restructure basic-workflow.rst
- Rewrote a sentence about forking.
- s/exactly how to proceed/how to proceed/
- Changed titles to present participles
- Rewrote "Fixing the Bug Locally" to improve its elegance.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-31 15:18:34 +10:00
zdover23
d8675ecf80
Merge pull request #38187 from zdover23/wip-doc-dev-unit-tests-5-of-7
doc/dev: update unit-tests tox section

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2020-12-23 02:07:59 +10:00
Zac Dover
eb99594437 doc/dev: update unit-tests tox section
This commit
- alters the structure of the
  unit-test section of the Developer Guide
  that discusses the tox tool, which is
  used to run certain unit tests
- corrects some grammar
- updates the list of locations of tox.ini
  files
- This also incorporates N. Cutler's suggestions.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-22 22:24:19 +10:00
Kefu Chai
cbb8f8433e doc/dev/generatedocs.rst: fix highlight syntax
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-18 10:26:15 +08:00
Zac Dover
0eaf991bd8 doc/dev: update auto pr validation section
This commit updates the "Automated PR Validation"
section of the "Basic Workflow" page in the
Developer Guide. This is part of a project that
aims to clean all of the sentences currently extant
in the Dev Guide, prior to a slight reorganization
of that guide for the sake of clarity and simplicity.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-17 00:32:58 +10:00
Ernesto Puerta
9a71e9e363
Merge pull request #36715 from rhcs-dashboard/fix-39128-master
mgr/dashboard: new generic HTTP error page component

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-12-15 18:59:14 +01:00
Kefu Chai
c03415caf1 doc/dev/crimson: quote inline codeblock using "``"
backquote is used for quoting italic typed text.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-15 17:50:43 +08:00
Kefu Chai
370f04fa82 doc/dev/crimson: highlight code blocks using C++ lexer
also remove redundant ":", normally "::" would suffice to start a
codeblock.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-15 17:48:02 +08:00
Radoslaw Zarzynski
d788b6b5ac doc/dev/crimson: exemplify errorator usage in error-handling.rst
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-12-14 16:28:01 +01:00
Kefu Chai
219c8d177b doc/dev/crimson: add error-handling.rst
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-14 16:28:01 +01:00
Sebastian Wagner
cd97c73089
Merge pull request #38547 from varshar16/wip-kubejacker-updates
script/kubejacker: Add python_common library and misc updates

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-12-12 12:55:50 +01:00
Kefu Chai
db3516d8f8
Merge pull request #38544 from tchaikov/wip-build-doc-auto-build
admin/build-doc: add livehtml target

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-12-12 08:05:24 +08:00
Varsha Rao
c453493280 doc/dev/kubernetes: Add minikube tips and misc updates
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-12-11 23:23:28 +05:30
Kefu Chai
34f74e8a37 admin/build-doc: add livehtml target
it is time-consuming to rebuild the python bindings every time we
rebuild the document, it'd be ideal if we could just build document.

in this change, in addition to "html" and "doc", "livehtml" argument is
now supported by build-doc script, so one can just use

./build-doc livehtml

to build and start a web server. whenever a change in doc/ is detected,
the document is rebuilt. for more details, see
https://pypi.org/project/sphinx-autobuild/

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-11 22:30:56 +08:00
Aashish Sharma
13900cf6ae mgr/dashboard: new generic HTTP error page component
Added a generic Error component for HTTP Errors such as 404,403,501

Fixes:https://tracker.ceph.com/issues/39128
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2020-12-11 19:19:38 +05:30
Kefu Chai
864d7ffc2a
Merge pull request #38486 from Rjerk/fix-mds-conf-typo
doc: fix a couple of typos

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-12-11 20:46:24 +08:00
pcuzner
bb462f2cb8
Merge branch 'master' into cephadm-exporter-docs 2020-12-10 09:39:45 +13:00
Paul Cuzner
ba485f2472 doc/dev/cephadm: update index links
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-10 09:37:13 +13:00
Sebastian Wagner
7d7e6ad30d
Merge pull request #37519 from pcuzner/docs-cephadm-config-drift
doc/dev/cephadm: high level design for a compliance check feature

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-09 13:32:27 +01:00
Liu Lan
e29a3c7c2d doc: fix a couple of typos
Signed-off-by: Liu Lan <liulan_yewu@cmss.chinamobile.com>
2020-12-09 09:05:27 +08:00
Anthony D'Atri
bc41ae3a88 doc: clarify osd recovery op priority and fix a couple of typos
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-07 21:01:36 -08:00
Paul Cuzner
f2791c0e26 doc/dev/cephadm: Add link to the index
Adds a link to the index for the compliance-check doc

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:58:06 +13:00
Paul Cuzner
1facc5e9a7 doc/dev/cephadm: Updates following feedback
Minor grammatical and formatting changes

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:56:20 +13:00