Tasks #47066: mgr/restful: Deprecate the "restful" module in favor of the Ceph Dashboard REST API - Dashboard - Ceph

Actions

Copy link

Tasks #47066

open

Feature #40907: mgr/dashboard: REST API improvements

mgr/restful: Deprecate the "restful" module in favor of the Ceph Dashboard REST API

Added by Lenz Grimmer over 3 years ago. Updated about 3 years ago.

Status:

In Progress

Priority:

Normal

Assignee:

Ernesto Puerta

Category:

Target version:

Ceph - v16.0.0

% Done:

25%

Tags:

Reviewed:

Affected Versions:

Pull request ID:

Description

The Ceph Dashboard REST API backend has gathered a significant amount of functionality compared to the original restful module. We would like to phase out the restful module post-pacific, so it should be marked as "deprecated" now, pointing to the Ceph Dashboard REST API (to be renamed "Ceph REST API") as its replacement.

A comparison between the RESTful module endpoints and capabilities, and the ones provided by Ceph-Dashboard RESTful API:

RESTful Resource	Dashboard API Resource	Description	Restful Capabilities	Dashboard API Capabilities
`/config/cluster`	`/api/cluster_conf`	Ceph cluster configuration	READ	CRUD
`/config/osd`	`/api/osd/flags`	OSD flags	READ-UPDATE	READ-UPDATE
`/crush/rule`	`/api/crush_rule`	CRUSH Rule	READ	CRUD
`/mon`	`/api/monitor`	Monitor Config	READ	READ
`/osd`	`/api/osd`	OSD management	READ	CRUD
`/pool`	`/api/pool`	Pool management	CRUD	CRUD
`/server`	`/api/host`	Host-Daemon management	READ	CRUD
`/request`	Unsupported (see note below)	Pass-through endpoint

Additionally, Ceph-Dashboard supports:

RBD management: incl. namespaces, snapshots, QoS, trash and mirroring.
iSCSI.
RGW management: incl. daemons, users, buckets, quotas, and some S3 advanced operations (MFA deletions, object locks, ...).
CephFS management: incl. clients, quotas, snapshots, tree operations.
NFS exports
Orchestrator management
Other Ceph-related features: Ceph cluster/audit logs, daemon monitoring/perf-counters.
Access management: multi-user, RBAC, SAML2 SSO, security account policies.
OpenAPI 3.0 specification.

Note on /request endpoint: Dashboard doesn't intentionally support a pass-through endpoint as it's considered not RESTful by design (it essentially provides an HTTP gateway to the Ceph CLI). Instead, Ceph-Dashboard API provides a more comprehensive coverage of the Ceph command set by means of RESTful Resources, not requiring a regular access to the CLI.

Subtasks 2 (2 open — 0 closed)