octopus: admin/doc-requirements: bump sphinx to 4.4.0 by ljflores · Pull Request #45972 · ceph/ceph

ljflores · 2022-04-20T15:12:05Z

backport tracker: https://tracker.ceph.com/issues/55077

backport of #45266 (and 1704216)
parent tracker: https://tracker.ceph.com/issues/55050

this backport was staged using ceph-backport.sh version 16.0.0.6848
find the latest version at https://github.com/ceph/ceph/blob/master/src/script/ceph-backport.sh

Note: 1704216 needed to be included in this backport since add_javascript() is depreciated in Sphinx 4.4.0.

bump sphinx to latest stable. to address following build failure ERROR: sphinx-autodoc-typehints 1.17.0 has requirement Sphinx>=4, but you'll have sphinx 3.5.4 which is incompatible. ERROR: sphinx-substitution-extensions 2022.2.16 has requirement sphinx>=4.0.0, but you'll have sphinx 3.5.4 which is incompatible. also bump bump sphinx-rtd-theme, otherwise we'd have following build failure: ERROR: sphinx-rtd-theme 0.5.2 has requirement docutils<0.17, but you'll have docutils 0.17.1 which is incompatible. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit 0a5fab5) Conflicts: admin/doc-requirements.txt - `sphinx_rtd_theme` was not present in Octopus

ljflores · 2022-04-20T15:45:51Z

Exception occurred:
  File "/home/jenkins-build/build/workspace/ceph-pr-docs/doc/conf.py", line 117, in setup
    app.add_javascript('js/ceph.js')
AttributeError: 'Sphinx' object has no attribute 'add_javascript'

Looks like this backport is dependent on other changes, such as 1704216. Currently looking into the chronology of changes and seeing what else needs to happen to help the docs check pass.

ljflores · 2022-04-22T16:16:02Z

readthedocs is still failing because of this:

Collecting git+https://github.com/readthedocs/readthedocs-sphinx-search@master (from -r admin/doc-read-the-docs.txt (line 2))
  Cloning https://github.com/readthedocs/readthedocs-sphinx-search (to revision master) to /tmp/pip-req-build-syi7bhd6
  Running command git clone --filter=blob:none --quiet https://github.com/readthedocs/readthedocs-sphinx-search /tmp/pip-req-build-syi7bhd6
  WARNING: Did not find branch or tag 'master', assuming revision or ref.
  Running command git checkout -q master
  error: pathspec 'master' did not match any file(s) known to git.
  error: subprocess-exited-with-error
  
  × git checkout -q master did not run successfully.
  │ exit code: 1
  ╰─> See above for output.
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× git checkout -q master did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

But I think that is a separate issue.

ljflores · 2022-04-22T16:27:31Z

jenkins test make check

ljflores · 2022-04-22T17:46:01Z

@idryomov tagging you in this in case you have any opinions.

idryomov · 2022-04-22T18:39:04Z

readthedocs is still failing because of this:

Collecting git+https://github.com/readthedocs/readthedocs-sphinx-search@master (from -r admin/doc-read-the-docs.txt (line 2))
  Cloning https://github.com/readthedocs/readthedocs-sphinx-search (to revision master) to /tmp/pip-req-build-syi7bhd6
  Running command git clone --filter=blob:none --quiet https://github.com/readthedocs/readthedocs-sphinx-search /tmp/pip-req-build-syi7bhd6
  WARNING: Did not find branch or tag 'master', assuming revision or ref.
  Running command git checkout -q master
  error: pathspec 'master' did not match any file(s) known to git.
  error: subprocess-exited-with-error
  
  × git checkout -q master did not run successfully.
  │ exit code: 1
  ╰─> See above for output.
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× git checkout -q master did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

But I think that is a separate issue.

Yeah, it is being addressed in #45839.

idryomov

No opinion, any set of pins/versions that works is fine with me ;)

The backport looks good but I'll defer to @tchaikov and @adk3798 here as most of it is patching up new warnings in cephadm.

src/pybind/mgr/orchestrator/_interface.py

tchaikov

apart from the unnecessary reduce, looks good to me.

ljflores · 2022-04-25T16:30:28Z

@tchaikov thanks, I'll address that unnecessary import.

this allows the "rpc"ized methods of OrchestratorClientMixin to have the docstring defined by the original methods. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit d0db2ae) Conflicts: src/pybind/mgr/orchestrator/_interface.py - Removed some typing imports that were not present in Octopus

this helps to silence the warning from sphinx, like src/pybind/mgr/orchestrator/_interface.py:docstring of orchestrator._interface.Orchestrator.remove_osds:9: WARNING: Field list ends without a blank line; unexpected unindent. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit d9b8e38) Conflicts: src/pybind/mgr/orchestrator/_interface.py - `:param zap:` did not exist in Octopus; removed this from the param list.

breathe calls doxygen for extracting/generating docs from code. while doxygen complains at seeing undocumented fields/func. these warnings could fail the sphinx-build command, if it takes warnings as errors. in this change, these warnings are silenced. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit 8891d65)

so it can be rendered by sphinx in a better way. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit ba3ccee)

add an empty line before a doctest block would help sphinx to tell where the session starts. see also https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#doctest-blocks Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit 8685fff)

otherwise sphinx takes "Typical use" and the following line as a field. see also https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#field-lists Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit 05798f0)

to address following warning: jenkins-build/build/workspace/ceph-pr-docs/doc/conf.py:102: RemovedInSphinx40Warning: The app.add_javascript() is deprecated. Please use app.add_js_file() instead. Signed-off-by: Kefu Chai <kchai@redhat.com> (cherry picked from commit 1704216)

tchaikov · 2022-05-03T09:00:47Z

@yuriw hey Yuri, could you please prioritize your test to include this PR in your next batch. it is blocking quite a few octopus backports.

ljflores · 2022-05-04T15:54:35Z

jenkins retest this please

ljflores · 2022-05-04T16:38:18Z

I'm getting started on testing this. Here is the shaman build link if someone gets to it before I do: https://shaman.ceph.com/builds/ceph/wip-55077-octopus/

I'm thinking a regular rados suite run will work for this, with orchestrator approval.

Rados run: http://pulpito.front.sepia.ceph.com/lflores-2022-05-04_18:59:38-rados-wip-55077-octopus-distro-default-smithi/
Rerun: http://pulpito.front.sepia.ceph.com/lflores-2022-05-09_14:54:06-rados-wip-55077-octopus-distro-default-smithi/

ljflores · 2022-05-09T16:53:24Z

I'm getting started on testing this. Here is the shaman build link if someone gets to it before I do: https://shaman.ceph.com/builds/ceph/wip-55077-octopus/

I'm thinking a regular rados suite run will work for this, with orchestrator approval.

Rados run: http://pulpito.front.sepia.ceph.com/lflores-2022-05-04_18:59:38-rados-wip-55077-octopus-distro-default-smithi/ Rerun: http://pulpito.front.sepia.ceph.com/lflores-2022-05-09_14:54:06-rados-wip-55077-octopus-distro-default-smithi/

Summarized RADOS failures. Most failures in the initial run were due to fixes that have not yet been backported to Octopus. The rerun was almost all green, except for one job that failed because of trackers listed below. With Orch approval of the failures, this will be okay to merge. @adk3798:

Failures, unrelated:
1. https://tracker.ceph.com/issues/45423
2. https://tracker.ceph.com/issues/48899
3. https://tracker.ceph.com/issues/52553
4. https://tracker.ceph.com/issues/48793
5. https://tracker.ceph.com/issues/43584
6. https://tracker.ceph.com/issues/24990
7. https://tracker.ceph.com/issues/55582

Details:
1. api_tier_pp: [ FAILED ] LibRadosTwoPoolsPP.HitSetWrite - Ceph - RADOS (pending Octopus backport)
2. api_list: LibRadosList.EnumerateObjects and LibRadosList.EnumerateObjectsSplit failed - Ceph - RADOS (not backported to Octopus)
3. pybind: rados.RadosStateError raised when closed watch object goes out of scope after cluster shutdown - Ceph - RADOS (pending Octopus backport)
4. out of order op - Ceph - RADOS (not backported to Octopus)
5. MON_DOWN during mon_join process - Ceph - RADOS (pending Octopus backport)
6. api_watch_notify: LibRadosWatchNotify.Watch3Timeout failed - Ceph - RADOS (pending Octopus backport)
7. api_watch_notify: LibRadosWatchNotify.AioWatchDelete2 fails because rados_watch_check_err is neither -ENOTCONN nor -ENOENT - Ceph - RADOS (opened a new one for this, but does not seem related)

ljflores · 2022-05-09T18:39:32Z

Orch approved.

ljflores added this to the octopus milestone Apr 20, 2022

ljflores added the documentation label Apr 20, 2022

ljflores requested a review from a team as a code owner April 20, 2022 15:23

idryomov mentioned this pull request Apr 21, 2022

octopus:ImportError: cannot import name 'environmentfilter' from 'jinja2' #45839

Closed

3 tasks

pponnuvel mentioned this pull request Apr 22, 2022

octopus: rbd-mirror: synchronize with in-flight stop in ImageReplayer::stop() #45177

Merged

ljflores requested a review from tchaikov April 22, 2022 16:24

ljflores requested a review from idryomov April 22, 2022 17:44

idryomov reviewed Apr 22, 2022

View reviewed changes

adk3798 approved these changes Apr 22, 2022

View reviewed changes

ljflores added the needs-qa label Apr 22, 2022

tchaikov reviewed Apr 23, 2022

View reviewed changes

src/pybind/mgr/orchestrator/_interface.py Outdated Show resolved Hide resolved

tchaikov approved these changes Apr 23, 2022

View reviewed changes

tchaikov and others added 7 commits April 25, 2022 12:43

mgr/cephadm: document notes using "note::" directive

7e11b1a

so it can be rendered by sphinx in a better way. Signed-off-by: Kefu Chai <tchaikov@gmail.com> (cherry picked from commit ba3ccee)

ljflores force-pushed the wip-55077-octopus branch from a86235b to 7f781e2 Compare April 25, 2022 17:44

baryluk mentioned this pull request Apr 28, 2022

octopus: rgw: return OK on consecutive complete-multipart reqs #45488

Merged

tchaikov approved these changes May 2, 2022

View reviewed changes

tchaikov mentioned this pull request May 2, 2022

octopus: ceph.spec.in: remove build directory at end of %install #45699

Closed

ljflores mentioned this pull request May 2, 2022

Wip doc pr 46109 backport to octopus #46118

Closed

14 tasks

ljflores added the wip-lflores-testing label May 4, 2022

ljflores mentioned this pull request May 4, 2022

octopus: qa/tasks: teuthology octopus backport #46149

Merged

14 tasks

ljflores added TESTED and removed wip-lflores-testing labels May 9, 2022

ljflores merged commit 1290cb4 into ceph:octopus May 9, 2022

Conversation

ljflores commented Apr 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented Apr 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented Apr 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented Apr 22, 2022

Uh oh!

ljflores commented Apr 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

idryomov commented Apr 22, 2022

Uh oh!

idryomov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tchaikov left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ljflores commented Apr 25, 2022

Uh oh!

tchaikov commented May 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented May 4, 2022

Uh oh!

ljflores commented May 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented May 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ljflores commented May 9, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ljflores commented Apr 20, 2022 •

edited

Loading

ljflores commented Apr 20, 2022 •

edited

Loading

ljflores commented Apr 22, 2022 •

edited

Loading

ljflores commented Apr 22, 2022 •

edited

Loading

tchaikov left a comment •

edited

Loading

tchaikov commented May 3, 2022 •

edited

Loading

ljflores commented May 4, 2022 •

edited

Loading

ljflores commented May 9, 2022 •

edited

Loading