ceph.ceph_admin.dashboard module

Manage the Ceph Dashboard service via ceph CLI.

exception ceph.ceph_admin.dashboard.DaemonFailure

Bases: Exception

ceph.ceph_admin.dashboard.enable_alertmanager(cls, config)

Method to enable alertmanager. :param cls: cephadm instance object. :type cls: CephAdmin object :param config: Key/value pairs passed from the test suite. :type config: Dict

ceph.ceph_admin.dashboard.enable_dashboard(cls, config)

Method to enable the dashboard module.

if user bootstrap with skip-dashboard option then enabling the dashboard module.

Parameters
  • cls (CephAdmin object) – cephadm instance object.

  • config (Dict) – Key/value pairs passed from the test suite.

  • Example::

    param username

    admin123

    param password

    admin@123

ceph.ceph_admin.dashboard.enable_grafana(cls, config)

Method to enable grafana. :param cls: cephadm instance object. :type cls: CephAdmin object :param config: Key/value pairs passed from the test suite. :type config: Dict

ceph.ceph_admin.dashboard.enable_prometheus(cls, config)

Method to enable prometheus. :param cls: cephadm instance object. :type cls: CephAdmin object :param config: Key/value pairs passed from the test suite. :type config: Dict

ceph.ceph_admin.dashboard.execute_commands(cls, commands)
ceph.ceph_admin.dashboard.validate_enable_dashboard(cls, username, password)

Method to validate dashboard login.

After enabling the dashboard module validating by API login.

Parameters
  • cls (CephAdmin object) – cephadm instance.

  • username (str) – configured user name to login.

  • password (str) – configured password to login.

ceph.ceph_admin.dashboard.validate_url(url)

Method to validate provided API URL. The HTTP 200 OK success status response code indicates that the request has succeeded.

Parameters

url – URL of any API.