Commit Graph

262 Commits

Author SHA1 Message Date
SrinivasaBharathKanta
958cd0bbb1
Merge pull request #68662 from kamoltat/wip-ksirivad-stretch-crush-experiment
src/script: init test_stretch_crush_collisions.sh
2026-06-16 09:53:01 +05:30
Afreen Misbah
154cf3271e mgr/dashboard: fix remaining FA icon references and test failures
- Fix icon size mismatches and HTML lint errors
- Fix remaining FA icon references in tests
- Replace FA icons with Carbon in upgrade component:
  use cds-inline-loading for spinners, cd-icon for status icons
- Update test selectors for Carbon icon queries

Fixes: https://tracker.ceph.com/issues/76631
Signed-off-by: Afreen Misbah <afreen23@gmail.com>
Assisted-by: Claude
2026-05-19 18:42:25 +05:30
Kamoltat (Junior) Sirivadhna
8899968104 src/test: update show-choose-tries.t tests
Since we modified crushtool cli commands, we need to also update
its test with new flag: --show-retry-exhaustion
and also the modified --show-choose-tries option

Also added /src/script/run-cli-tests.sh to run the cram test
easily without having the config headache

Signed-off-by: Kamoltat (Junior) Sirivadhna <ksirivad@redhat.com>
2026-04-29 18:38:06 +00:00
Patrick Donnelly
55968723d6
doc: remove references to ceph-deploy
Signed-off-by: Patrick Donnelly <pdonnell@ibm.com>
2026-04-14 09:03:58 -04:00
Ville Ojamo
f276ad9694 doc: Fix Sphinx warnings
Fix indentation and section title underline.
Fixes six Sphinx warnings.

Signed-off-by: Ville Ojamo <git2233+ceph@ojamo.eu>
2026-03-30 15:47:17 +07:00
Anthony D'Atri
0e10249fca
Merge pull request #68081 from lumir-sliva/fix-running-tests-locally-typos
doc/dev: fix typos in running-tests-locally.rst
2026-03-28 21:45:23 -04:00
Lumir Sliva
ed4c1a4a9d doc/dev: fix typos in running-tests-locally.rst
Fix grammar error ('is be tested' -> 'can be tested'), misspellings
of 'bootstrap', 'teuthology', and 'environment', a repeated word
('manually manually'), and a missing article ('maybe bootstrap' ->
'maybe the bootstrap').

Signed-off-by: Lumir Sliva <lumir.sliva@firma.seznam.cz>
2026-03-29 01:35:13 +01:00
Lumir Sliva
31842a048a doc: fix typos and outdated refs across developer guide
Fix 'elipsis' to 'ellipsis' in SubmittingPatches.rst, update
outdated 'master' branch references to 'main' in essentials.rst
and running-tests-locally.rst, fix 'sometime' to 'sometimes' in
merging.rst, and remove duplicated word in teuthology-intro.rst.

Signed-off-by: Lumir Sliva <lumir.sliva@firma.seznam.cz>
2026-03-29 00:43:27 +01:00
Lumir Sliva
a448957bc8 doc/dev: fix typo in basic-workflow.rst
Fix 'sometimeseven' to 'sometimes even' in the Code Review
section of the developer guide.

Signed-off-by: Lumir Sliva <lumir.sliva@firma.seznam.cz>
2026-03-28 23:31:52 +01:00
Kefu Chai
1832b1572c doc: update mgr module command documentation for per-module registries
Update documentation to reflect the new per-module command registry
pattern introduced in PR #66467. The old global CLICommand decorators
have been replaced with module-specific registries.

Changes:
- doc/mgr/modules.rst: Rewrite CLICommand section with setup guide,
  update all examples to use AntigravityCLICommand pattern
- src/pybind/mgr/object_format.py: Add note explaining per-module
  registries and update all decorator examples
- doc/dev/developer_guide/dash-devel.rst: Update dashboard plugin
  examples to use DBCLICommand

All examples now correctly show:
- Creating registry with CLICommandBase.make_registry_subtype()
- Using module-specific decorator names (e.g., @StatusCLICommand.Read)
- Setting CLICommand class attribute for framework registration

Signed-off-by: Kefu Chai <k.chai@proxmox.com>
2026-03-08 23:27:30 +08:00
Nizamudeen A
52aeababe4 mgr/dashboard: upgrade angular to 19
* bump nodejs to 22.21.1
* remove swagger-ui from the package.json and import the bundled version
  of it which is `swagger-ui-dist`. This removes the dependencies to the
react redux which is bought by the swagger-ui and also reduces the build
assets and build warnings. we really don't need the whole swagger-ui
package to be present here. Also importing the swagger-ui.css inside the
api-docs component lazily.

since our project is now under nx, upgraded using the nx migrate
command. It took care of the changes where it added the `standalone:
false` to all our files since we are still on modular architecture.

Other changes include
- adding `flush()` to fakeAsync mock test
- fixing some complaints raised by tsc linter as per the new typescript
  type checks
- removed `this` from html components
- fixed jest config for newer presets

Signed-off-by: Nizamudeen A <nia@redhat.com>
2025-12-23 09:16:52 +05:30
mrVectorz
c32027ba91 doc: Update the old ceph.com/community/ links to ceph.io/en/news/blog/
Signed-off-by: Marc Methot <mb.methot@gmail.com>
2025-11-02 23:24:59 -05:00
Kyr Shatskyy
6b0d6f2ba0 doc/dev: update suite example with latest os
Replace reference to centos_7.0 and ubuntu_16.04 with
rocky_10.0 and ubuntu_24.04 as an example.

Signed-off-by: Kyr Shatskyy <kyrylo.shatskyy@clyso.com>
2025-10-22 00:50:50 +02:00
Kyr Shatskyy
1371e1a220 doc/dev: fix suite sample layout example
Directory structure does not corresponds to the explanation below
the example.

Fixes: c80d5d47b3

Signed-off-by: Kyr Shatskyy <kyrylo.shatskyy@clyso.com>
2025-10-22 00:50:50 +02:00
Nizamudeen A
4c3e443b73 mgr/dashboard: bump node to 20.18.1
one of the inner dependency expects it
```
npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: 'undici@7.10.0',
npm WARN EBADENGINE   required: { node: '>=20.18.1' },
npm WARN EBADENGINE   current: { node: 'v20.13.1', npm: '10.5.2' }
npm WARN EBADENGINE }

```

Fixes: https://tracker.ceph.com/issues/70934
Signed-off-by: Nizamudeen A <nia@redhat.com>
2025-06-16 16:39:57 +05:30
Afreen Misbah
25fa4218f6 mgr/dashboard: deprecate transifex-i18ntool and support transifex cli
- transifex-i18ntool is no longer maintained
- transifex officialy supports now a tool https://github.com/transifex/cli
- doc update

Fixes https://tracker.ceph.com/issues/71127

Signed-off-by: Afreen Misbah <afreen@ibm.com>
2025-05-12 12:58:14 +05:30
Mike Perez
1992d9c8cd doc: Update Slack invite links
The invite links expire after 30 days. Here's a new one.

Signed-off-by: Mike Perez <thingee@gmail.com>
2025-03-26 07:12:38 -07:00
Laimis Juzeliลซnas
e7bf607269 doc/dev/developer_guide/essentials: update mailing lists
Update information for subscribing to Ceph development mailing lists as current documentation is outdated.

Fixes: https://tracker.ceph.com/issues/64580
Signed-off-by: Laimis Juzeliunas <laimis.juzeliunas@oxylabs.io>
2025-03-19 00:55:41 +02:00
Vallari Agrawal
dc539b3ea8
doc: improve tests-integration-testing-teuthology-workflow.rst
This commit adds:
1. workflow summary in the first section along with an image.
2. sub-section "Pushing to ceph-ci repository" to second section.
3. file doc/dev/developer_guide/testing_integration_tests/workflow.png

Signed-off-by: Vallari Agrawal <vallari.agrawal@ibm.com>
2025-01-10 17:07:23 +05:30
Ernesto Puerta
96ec7badb8
mgr/restful: remove deprecated module
Detailed changes:
* Remove `restful` mgr module dir,
* Remove Python depedencies (`pecan`, `werkzeug`) from ceph.spec and
  debian control,
* Remove docs,
* Remove associated QA tests,
* Update vstart.

Fixes: https://tracker.ceph.com/issues/47066
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2024-10-28 14:17:18 +01:00
Zac Dover
95916c9190 doc/dev: remove "Stable Releases and Backports"
Remove mention of "Stable Releases and Backports" from
doc/dev/developer_guide/essentials.rst.

Co-authored-by: Laura Flores <lflores@ibm.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-10-10 22:17:12 +10:00
Lucian Petrut
bb7d5b62d9 doc: Document the Windows CI job
We're adding a document that describes:

* the steps performed by the Windows CI job
* artifact structure
* frequently asked questions

The document is meant to assist the Ceph developers in investigating
CI failures. This is especially important as the Windows CI job runs
integration tests that would otherwise only be executed by
Teuthology, thus helping catch potential regressions quickly.

Note that the identified regressions are not necessarily Windows
specific, usually affecting Linux builds as well.

Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
2024-09-27 17:48:49 +00:00
Anthony D'Atri
858fcd5bda
Merge pull request #45807 from mchangir/doc-document-random-selection-teuthology-operator
doc/dev/developer_guide/testing_integration_tests: Document the random selection operator
2024-09-16 09:12:36 -04:00
Vallari Agrawal
9bfcb8e17d
doc: update tests-integration-testing-teuthology-workflow.rst
* add "Infrastructure" section.

* move "Naming the ceph-ci branch" section under
   "Getting binaries - Build Ceph". Also mention
   about centos9-only trick.

* in "Teuthology Archives", mention about developer
   playground machines and ceph log files.

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>
2024-09-01 15:05:41 +05:30
Zac Dover
b81d6af1b4 doc/dev: improve basic-workflow.rst
Make various improvements to doc/dev/developer_guide/basic-workflow.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-31 05:24:25 +10:00
Zac Dover
f836a76cb7
Merge pull request #58600 from zdover23/wip-doc-2024-07-16-dev-guide-basic-workflow
doc/dev: add formatting to basic workflow

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-07-23 04:00:49 +10:00
Zac Dover
02d5a6a337 doc/dev_guide: add needs-upgrade-testing label info
Add an explanation of the "needs-upgrade-testing" label and explain when
to use it.

Laura is the true author of this text.

Co-authored-by: Laura Flores <lflores@ibm.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-23 01:38:11 +10:00
Zac Dover
4c4063a097 doc/dev: add formatting to basic workflow
Add some formatting to a few sections near the end of
doc/dev/developer_guide_basic-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-16 02:03:37 +10:00
Zac Dover
5134aeb78b doc/dev: link to ceph.io leads list
Remove the docs.ceph.com list of team leads, and link to the list of
leads on ceph.io.

Fixes: https://tracker.ceph.com/issues/66392

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-18 00:39:10 +10:00
Ivo Almeida
e082a4d72d
Merge pull request #57746 from ceph/nodejs-lts-update
mgr/dashboard: update node js version  

Reviewed-by: Nizamudeen A <nia@redhat.com>
2024-06-07 10:23:29 +01:00
Ivo Almeida
45183620dd mgr/dashboard: update node js version
Fixes: https://tracker.ceph.com/issues/66249

Signed-off-by: Ivo Almeida <ialmeida@redhat.com>
2024-05-29 09:25:19 +01:00
Rishabh Dave
899c481d40 doc/developer_guide: update doc about installing teuthology
There are 2 more ways to install teuthology. Approach with boostrap
script is easier and more convenient while other approach is more
elaborate but manual, document both of them. Don't delete the currently
documented approach because it lets users install teuthology
conveniently in a custom virtual environment. So, keep all three.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2024-05-28 19:02:57 +05:30
Zac Dover
832358b072 doc/dev: s/to asses/to assess/
s/to asses/to assess/ in doc/deve/developer_guide/dash-devel.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-12 12:27:23 +10:00
Zac Dover
158b0403bd doc/dev: update leads list
Remove Joao Luis from the list of component leads.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-01 11:17:39 +10:00
Zac Dover
57e9427eac doc/dev: update leads list
Update the list of component leads in
doc/dev/developer_guide/essentials.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-29 22:28:35 +10:00
Patrick Donnelly
7060146d6a
doc/dev: update teuthology priority guidance
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-14 14:59:23 -04:00
Zac Dover
51796e80f3 doc/dev: edit teuthology workflow
Improve a couple of sentences in
doc/dev/developer_guide_testing_integration_tests/tests-integration-testing-teutology-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-06 17:15:20 +10:00
Vallari Agrawal
4719bfbda6
doc/dev/developer_guide: mention unit_test_summary.yaml & valgrind.yaml
In tests-integration-testing-teuthology-workflow.rst,
briefly mention unit_test_summary.yaml and valgrind.yaml
as other files that exist in teuthology archive.

Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>
2023-10-31 17:07:49 +05:30
Dhairya Parmar
1f78a32a18 doc: remove egg fragment from dev/developer_guide/running-tests-locally
DEPRECATION: git+https://github.com/ceph/teuthology#egg=teuthology
[test] contains an egg fragment with a non-PEP 508 name pip 25.0 will enforce
this behaviour change. A possible replacement is to use the req @ url syntax,
and remove the egg fragment. Discussion can be found at
https://github.com/pypa/pip/issues/11617

Signed-off-by: Dhairya Parmar <dparmar@redhat.com>
2023-10-05 20:17:14 +05:30
Nizamudeen A
47f49e5b1a mgr/dashboard: update nodejs to 18.17.0
the latest npm doesn't support setting python as a config like `npm
config set python3` instead it needs to be either set in the node-gyp
explicitly using the node-gyp command or through an environment
variable.
Since we are calling the node-gyp through npm, we need to set the
environment variable which is documented here: https://github.com/nodejs/node-gyp?tab=readme-ov-file#configuring-python-dependency

Accordingly the CMakeLists.txt for dashboard is adapted

Fixes: https://tracker.ceph.com/issues/62844
Signed-off-by: Nizamudeen A <nia@redhat.com>
2023-09-22 12:19:29 +05:30
Nizamudeen A
692a45362d deps: increase the node version to 16
With node 14, the angular 13 is going into some issues with node-gyp.
```
prebuild-install || node-gyp rebuild

prebuild-install WARN install No prebuilt binaries found (target=14.20.0 runtime=node arch=x64 libc= platform=linux)
make: Entering directory '/home/jenkins-build/build/workspace/ceph-dashboard-cephadm-e2e/src/pybind/mgr/dashboard/frontend/node_modules/tree-sitter/build'
  CC(target) Release/obj.target/tree_sitter/vendor/tree-sitter/lib/src/lib.o
  AR(target) Release/obj.target/tree_sitter.a
  COPY Release/tree_sitter.a
  CXX(target) Release/obj.target/tree_sitter_runtime_binding/src/binding.o
```
and in some other environments its like `cb() never called` and stops
the whole `npm ci` process.

After some research, looks like updating node is the way to stop this.

Also, ` npm 7 will block installations if an upstream dependency
conflict is present that cannot be automatically resolved.` https://github.blog/2021-02-02-npm-7-is-now-generally-available/#peer-dependencies

Fixes: https://tracker.ceph.com/issues/62107
Signed-off-by: Nizamudeen A <nia@redhat.com>
2023-07-21 11:33:18 +05:30
Zac Dover
e83949e7ed doc/dev: fix "deploying dev cluster" link
Fix a link to "Deploying a Development Cluster" that had been broken
since the transition from master to main.

This is the first part of an initiative to improve the vstart
documentation.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-06-13 21:51:26 +10:00
Nizamudeen A
54e8e8b96b mgr/dashboard: remove deprecated preserveOnce
cypress is deprecating preserveOnce and instead favoring using
cy.session(). session is already introduced as part of the upgrade to
cypress 10. So removing the preserveOnce here

Signed-off-by: Nizamudeen A <nia@redhat.com>
2023-05-25 13:45:24 +05:30
Milind Changire
7830383a1b
doc/dev/developer_guide/testing_integration_tests: Document the random selection operator
Document about the '$' operator which is the random selection operator.

Fixes: https://tracker.ceph.com/issues/55198
Signed-off-by: Milind Changire <mchangir@redhat.com>
2023-03-30 21:17:51 +05:30
Zac Dover
262b115b75 doc/dev: add full stop to sentence in basic-wo
Add a full stop to a sentence in basic-workflow.rst. I looked at this
document and noticed that it wasn't there, and it was just bugging me.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-07 02:15:27 +10:00
zdover23
0d343aafaf
Merge pull request #49908 from Matan-B/wip-matanb-upgrade-doc
doc/dev/developer_guide: Add Upgrade Testing Documentation

Reviewed-by: Zac Dover <zac.dover@proton.me>
2023-01-29 20:52:06 +10:00
Matan Breizman
c2642a97f3 doc/dev/developer_guide/testing_integration_tests: Add Upgrade Testing Documentation
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2023-01-29 10:25:30 +00:00
Zac Dover
c3288cf5be doc/dev: add Slack to Dev Guide essentials
Add Ceph's Slack to doc/developer_guide/essentials.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-01-26 01:57:17 +10:00
Zac Dover
f1c0c3ec3d doc/dev: add git branch management commands
Add git branch deleting and search commands to the "Basic Workflow" page
of the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-14 07:26:18 +10:00
Zac Dover
049e5aaade doc/dev: add push.autoSetupRemote instructions
Explain how to set up push.autoSetupRemote so that the origin branch is
properly set up when running "get push" without the need for the
"--set-upstream" option.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-12 06:24:55 +10:00