From: Patrick Nawracay Date: Mon, 29 Oct 2018 08:59:59 +0000 (+0100) Subject: mgr/dashboard: Add support for managing RBD QoS X-Git-Tag: v14.1.0~63^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=cfbefbf169635912c6608488182d924f0455ecc5;p=ceph.git mgr/dashboard: Add support for managing RBD QoS Fixes: http://tracker.ceph.com/issues/36191 Signed-off-by: Patrick Nawracay --- diff --git a/qa/suites/rados/mgr/tasks/dashboard.yaml b/qa/suites/rados/mgr/tasks/dashboard.yaml index 0c2dfc880404..d24cdf63a6a2 100644 --- a/qa/suites/rados/mgr/tasks/dashboard.yaml +++ b/qa/suites/rados/mgr/tasks/dashboard.yaml @@ -20,6 +20,7 @@ tasks: - \(MDS_UP_LESS_THAN_MAX\) - \(OSD_DOWN\) - \(OSD_HOST_DOWN\) + - \(POOL_APP_NOT_ENABLED\) - pauserd,pausewr flag\(s\) set - Monitor daemon marked osd\.[[:digit:]]+ down, but it is still running - rgw: [client.0] diff --git a/qa/tasks/mgr/dashboard/test_rbd.py b/qa/tasks/mgr/dashboard/test_rbd.py index 7d8773cb031e..f9b7dd022fa6 100644 --- a/qa/tasks/mgr/dashboard/test_rbd.py +++ b/qa/tasks/mgr/dashboard/test_rbd.py @@ -89,9 +89,9 @@ class RbdTest(DashboardTestCase): # pylint: disable=too-many-arguments @classmethod - def edit_image(cls, pool, image, name=None, size=None, features=None): - return cls._task_put('/api/block/image/{}/{}'.format(pool, image), - {'name': name, 'size': size, 'features': features}) + def edit_image(cls, pool, image, name=None, size=None, features=None, **kwargs): + kwargs.update({'name': name, 'size': size, 'features': features}) + return cls._task_put('/api/block/image/{}/{}'.format(pool, image), kwargs) @classmethod def flatten_image(cls, pool, image): @@ -139,7 +139,7 @@ class RbdTest(DashboardTestCase): '--yes-i-really-really-mean-it']) @classmethod - def create_image_in_trash(cls, pool, name, delay=0, **kwargs): + def create_image_in_trash(cls, pool, name, delay=0): cls.create_image(pool, name, 10240) img = cls._get('/api/block/image/{}/{}'.format(pool, name)) @@ -201,6 +201,11 @@ class RbdTest(DashboardTestCase): 'timestamp': JLeaf(str, none=True), 'disk_usage': JLeaf(int, none=True), 'total_disk_usage': JLeaf(int, none=True), + 'configuration': JList(JObj(sub_elems={ + 'name': JLeaf(str), + 'source': JLeaf(int), + 'value': JLeaf(str), + })), }) self.assertSchema(img, schema) @@ -288,6 +293,33 @@ class RbdTest(DashboardTestCase): self.remove_image('rbd', rbd_name) + def test_create_with_configuration(self): + pool = 'rbd' + image_name = 'image_with_config' + size = 10240 + configuration = { + 'rbd_qos_bps_limit': 10240, + 'rbd_qos_bps_burst': 10240 * 2, + } + expected = [{ + 'name': 'rbd_qos_bps_limit', + 'source': 2, + 'value': str(10240), + }, { + 'name': 'rbd_qos_bps_burst', + 'source': 2, + 'value': str(10240 * 2), + }] + + self.create_image(pool, image_name, size, configuration=configuration) + self.assertStatus(201) + img = self._get('/api/block/image/rbd/{}'.format(image_name)) + self.assertStatus(200) + for conf in expected: + self.assertIn(conf, img['configuration']) + + self.remove_image(pool, image_name) + def test_create_rbd_in_data_pool(self): if not self.bluestore_support: self.skipTest('requires bluestore cluster') @@ -460,6 +492,57 @@ class RbdTest(DashboardTestCase): self.remove_image('rbd', 'edit_img') self.assertStatus(204) + def test_image_change_config(self): + pool = 'rbd' + image = 'image_with_config' + initial_conf = { + 'rbd_qos_bps_limit': 10240, + 'rbd_qos_write_iops_limit': None + } + initial_expect = [{ + 'name': 'rbd_qos_bps_limit', + 'source': 2, + 'value': '10240', + }, { + 'name': 'rbd_qos_write_iops_limit', + 'source': 0, + 'value': '0', + }] + new_conf = { + 'rbd_qos_bps_limit': 0, + 'rbd_qos_bps_burst': 20480, + 'rbd_qos_write_iops_limit': None + } + new_expect = [{ + 'name': 'rbd_qos_bps_limit', + 'source': 2, + 'value': '0', + }, { + 'name': 'rbd_qos_bps_burst', + 'source': 2, + 'value': '20480', + }, { + 'name': 'rbd_qos_write_iops_limit', + 'source': 0, + 'value': '0', + }] + + self.create_image(pool, image, 2**30, configuration=initial_conf) + self.assertStatus(201) + img = self._get('/api/block/image/{}/{}'.format(pool, image)) + self.assertStatus(200) + for conf in initial_expect: + self.assertIn(conf, img['configuration']) + + self.edit_image(pool, image, configuration=new_conf) + img = self._get('/api/block/image/{}/{}'.format(pool, image)) + self.assertStatus(200) + for conf in new_expect: + self.assertIn(conf, img['configuration']) + + self.remove_image(pool, image) + self.assertStatus(204) + def test_update_snapshot(self): self.create_snapshot('rbd', 'img1', 'snap5') self.assertStatus(201) diff --git a/src/pybind/mgr/dashboard/controllers/__init__.py b/src/pybind/mgr/dashboard/controllers/__init__.py index e8839a43b3cb..339646638681 100644 --- a/src/pybind/mgr/dashboard/controllers/__init__.py +++ b/src/pybind/mgr/dashboard/controllers/__init__.py @@ -317,24 +317,24 @@ class Task(object): @wraps(func) def wrapper(*args, **kwargs): arg_map = self._gen_arg_map(func, args, kwargs) - md = {} + metadata = {} for k, v in self.metadata.items(): if isinstance(v, str) and v and v[0] == '{' and v[-1] == '}': param = v[1:-1] try: pos = int(param) - md[k] = arg_map[pos] + metadata[k] = arg_map[pos] except ValueError: if param.find('.') == -1: - md[k] = arg_map[param] + metadata[k] = arg_map[param] else: path = param.split('.') - md[k] = arg_map[path[0]] + metadata[k] = arg_map[path[0]] for i in range(1, len(path)): - md[k] = md[k][path[i]] + metadata[k] = metadata[k][path[i]] else: - md[k] = v - task = TaskManager.run(self.name, md, func, args, kwargs, + metadata[k] = v + task = TaskManager.run(self.name, metadata, func, args, kwargs, exception_handler=self.exception_handler) try: status, value = task.wait(self.wait_for) @@ -350,7 +350,7 @@ class Task(object): raise ex if status == TaskManager.VALUE_EXECUTING: cherrypy.response.status = 202 - return {'name': self.name, 'metadata': md} + return {'name': self.name, 'metadata': metadata} return value return wrapper diff --git a/src/pybind/mgr/dashboard/controllers/pool.py b/src/pybind/mgr/dashboard/controllers/pool.py index cdd9a7110d45..b20e19842f17 100644 --- a/src/pybind/mgr/dashboard/controllers/pool.py +++ b/src/pybind/mgr/dashboard/controllers/pool.py @@ -8,6 +8,7 @@ from . import ApiController, RESTController, Endpoint, ReadPermission, Task from .. import mgr from ..security import Scope from ..services.ceph_service import CephService +from ..services.rbd import RbdConfiguration from ..services.exception import handle_send_command_error from ..tools import str_to_bool @@ -67,7 +68,9 @@ class Pool(RESTController): def get(self, pool_name, attrs=None, stats=False): # type: (str, str, bool) -> dict - return self._get(pool_name, attrs, stats) + pool = self._get(pool_name, attrs, stats) + pool['configuration'] = RbdConfiguration(pool_name).list() + return pool @pool_task('delete', ['{pool_name}']) @handle_send_command_error('pool') @@ -76,19 +79,20 @@ class Pool(RESTController): yes_i_really_really_mean_it=True) @pool_task('edit', ['{pool_name}']) - def set(self, pool_name, flags=None, application_metadata=None, **kwargs): + def set(self, pool_name, flags=None, application_metadata=None, configuration=None, **kwargs): self._set_pool_values(pool_name, application_metadata, flags, True, kwargs) + RbdConfiguration(pool_name).set_configuration(configuration) @pool_task('create', {'pool_name': '{pool}'}) @handle_send_command_error('pool') def create(self, pool, pg_num, pool_type, erasure_code_profile=None, flags=None, - application_metadata=None, rule_name=None, **kwargs): + application_metadata=None, rule_name=None, configuration=None, **kwargs): ecp = erasure_code_profile if erasure_code_profile else None CephService.send_command('mon', 'osd pool create', pool=pool, pg_num=int(pg_num), pgp_num=int(pg_num), pool_type=pool_type, erasure_code_profile=ecp, rule=rule_name) - self._set_pool_values(pool, application_metadata, flags, False, kwargs) + RbdConfiguration(pool).set_configuration(configuration) def _set_pool_values(self, pool, application_metadata, flags, update_existing, kwargs): update_name = False @@ -137,10 +141,17 @@ class Pool(RESTController): reset_arg(arg, '0') reset_arg('compression_algorithm', 'unset') + @RESTController.Resource() + @ReadPermission + def configuration(self, pool_name): + return RbdConfiguration(pool_name).list() + @Endpoint() @ReadPermission - def _info(self): + def _info(self, pool_name=''): + # type: (str) -> dict """Used by the create-pool dialog""" + def rules(pool_type): return [r for r in mgr.get('osd_map_crush')['rules'] @@ -155,7 +166,7 @@ class Pool(RESTController): for o in mgr.get('config_options')['options'] if o['name'] == conf_name][0] - return { + result = { "pool_names": [p['pool_name'] for p in self._pool_list()], "crush_rules_replicated": rules(1), "crush_rules_erasure": rules(3), @@ -165,3 +176,8 @@ class Pool(RESTController): "compression_algorithms": compression_enum('bluestore_compression_algorithm'), "compression_modes": compression_enum('bluestore_compression_mode'), } + + if pool_name: + result['pool_options'] = RbdConfiguration(pool_name).list() + + return result diff --git a/src/pybind/mgr/dashboard/controllers/rbd.py b/src/pybind/mgr/dashboard/controllers/rbd.py index f16f7b56c5c8..14a751b93c2c 100644 --- a/src/pybind/mgr/dashboard/controllers/rbd.py +++ b/src/pybind/mgr/dashboard/controllers/rbd.py @@ -13,10 +13,11 @@ import six import rbd from . import ApiController, RESTController, Task, UpdatePermission, \ - DeletePermission, CreatePermission + DeletePermission, CreatePermission, ReadPermission from .. import mgr from ..security import Scope from ..services.ceph_service import CephService +from ..services.rbd import RbdConfiguration from ..tools import ViewCache, str_to_bool from ..services.exception import handle_rados_error, handle_rbd_error, \ serialize_dashboard_exception @@ -121,12 +122,11 @@ class Rbd(RESTController): RESOURCE_ID = "pool_name/image_name" # set of image features that can be enable on existing images - ALLOW_ENABLE_FEATURES = set(["exclusive-lock", "object-map", "fast-diff", - "journaling"]) + ALLOW_ENABLE_FEATURES = {"exclusive-lock", "object-map", "fast-diff", "journaling"} # set of image features that can be disabled on existing images - ALLOW_DISABLE_FEATURES = set(["exclusive-lock", "object-map", "fast-diff", - "deep-flatten", "journaling"]) + ALLOW_DISABLE_FEATURES = {"exclusive-lock", "object-map", "fast-diff", "deep-flatten", + "journaling"} @classmethod def _rbd_disk_usage(cls, image, snaps, whole_object=True): @@ -152,7 +152,8 @@ class Rbd(RESTController): return total_used_size, snap_map - def _rbd_image(self, ioctx, pool_name, image_name): + @classmethod + def _rbd_image(cls, ioctx, pool_name, image_name): with rbd.Image(ioctx, image_name) as img: stat = img.stat() stat['name'] = image_name @@ -213,7 +214,7 @@ class Rbd(RESTController): for s in stat['snapshots']] snaps.sort(key=lambda s: s[0]) snaps += [(snaps[-1][0]+1 if snaps else 0, stat['size'], None)] - total_prov_bytes, snaps_prov_bytes = self._rbd_disk_usage( + total_prov_bytes, snaps_prov_bytes = cls._rbd_disk_usage( img, snaps, True) stat['total_disk_usage'] = total_prov_bytes for snap, prov_bytes in snaps_prov_bytes.items(): @@ -228,17 +229,20 @@ class Rbd(RESTController): stat['total_disk_usage'] = None stat['disk_usage'] = None + stat['configuration'] = RbdConfiguration(pool_ioctx=ioctx, image_name=image_name).list() + return stat + @classmethod @ViewCache() - def _rbd_pool_list(self, pool_name): + def _rbd_pool_list(cls, pool_name): rbd_inst = rbd.RBD() with mgr.rados.open_ioctx(pool_name) as ioctx: names = rbd_inst.list(ioctx) result = [] for name in names: try: - stat = self._rbd_image(ioctx, pool_name, name) + stat = cls._rbd_image(ioctx, pool_name, name) except rbd.ImageNotFound: # may have been removed in the meanwhile continue @@ -255,6 +259,8 @@ class Rbd(RESTController): for pool in pools: # pylint: disable=unbalanced-tuple-unpacking status, value = self._rbd_pool_list(pool) + for i, image in enumerate(value): + value[i]['configuration'] = RbdConfiguration(pool, image['name']).list() result.append({'status': status, 'value': value, 'pool_name': pool}) return result @@ -275,7 +281,7 @@ class Rbd(RESTController): @RbdTask('create', {'pool_name': '{pool_name}', 'image_name': '{name}'}, 2.0) def create(self, name, pool_name, size, obj_size=None, features=None, - stripe_unit=None, stripe_count=None, data_pool=None): + stripe_unit=None, stripe_count=None, data_pool=None, configuration=None): size = int(size) @@ -293,8 +299,9 @@ class Rbd(RESTController): rbd_inst.create(ioctx, name, size, order=l_order, old_format=False, features=feature_bitmask, stripe_unit=stripe_unit, stripe_count=stripe_count, data_pool=data_pool) + RbdConfiguration(pool_ioctx=ioctx, image_name=name).set_configuration(configuration) - return _rbd_call(pool_name, _create) + _rbd_call(pool_name, _create) @RbdTask('delete', ['{pool_name}', '{image_name}'], 2.0) def delete(self, pool_name, image_name): @@ -302,7 +309,7 @@ class Rbd(RESTController): return _rbd_call(pool_name, rbd_inst.remove, image_name) @RbdTask('edit', ['{pool_name}', '{image_name}', '{name}'], 4.0) - def set(self, pool_name, image_name, name=None, size=None, features=None): + def set(self, pool_name, image_name, name=None, size=None, features=None, configuration=None): def _edit(ioctx, image): rbd_inst = rbd.RBD() # check rename image @@ -329,6 +336,9 @@ class Rbd(RESTController): f_bitmask = _format_features([feature]) image.update_features(f_bitmask, True) + RbdConfiguration(pool_ioctx=ioctx, image_name=image_name).set_configuration( + configuration) + return _rbd_image_call(pool_name, image_name, _edit) @RbdTask('copy', @@ -339,7 +349,7 @@ class Rbd(RESTController): @RESTController.Resource('POST') def copy(self, pool_name, image_name, dest_pool_name, dest_image_name, snapshot_name=None, obj_size=None, features=None, stripe_unit=None, - stripe_count=None, data_pool=None): + stripe_count=None, data_pool=None, configuration=None): def _src_copy(s_ioctx, s_img): def _copy(d_ioctx): @@ -356,6 +366,8 @@ class Rbd(RESTController): s_img.copy(d_ioctx, dest_image_name, feature_bitmask, l_order, stripe_unit, stripe_count, data_pool) + RbdConfiguration(pool_ioctx=d_ioctx, image_name=dest_image_name).set_configuration( + configuration) return _rbd_call(dest_pool_name, _copy) @@ -386,6 +398,11 @@ class Rbd(RESTController): rbd_inst = rbd.RBD() return _rbd_call(pool_name, rbd_inst.trash_move, image_name, delay) + @RESTController.Resource() + @ReadPermission + def configuration(self, pool_name, image_name): + return RbdConfiguration(pool_name, image_name).list() + @ApiController('/block/image/{pool_name}/{image_name}/snap', Scope.RBD_IMAGE) class RbdSnapshot(RESTController): @@ -444,8 +461,11 @@ class RbdSnapshot(RESTController): 'child_image_name': '{child_image_name}'}, 2.0) @RESTController.Resource('POST') def clone(self, pool_name, image_name, snapshot_name, child_pool_name, - child_image_name, obj_size=None, features=None, - stripe_unit=None, stripe_count=None, data_pool=None): + child_image_name, obj_size=None, features=None, stripe_unit=None, stripe_count=None, + data_pool=None, configuration=None): + """ + Clones a snapshot to an image + """ def _parent_clone(p_ioctx): def _clone(ioctx): @@ -462,9 +482,12 @@ class RbdSnapshot(RESTController): child_image_name, feature_bitmask, l_order, stripe_unit, stripe_count, data_pool) + RbdConfiguration(pool_ioctx=ioctx, image_name=child_image_name).set_configuration( + configuration) + return _rbd_call(child_pool_name, _clone) - return _rbd_call(pool_name, _parent_clone) + _rbd_call(pool_name, _parent_clone) @ApiController('/block/image/trash', Scope.RBD_IMAGE) diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/block.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/block.module.ts index b21930172a7f..4c706d4ae629 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/block.module.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/block.module.ts @@ -21,6 +21,8 @@ import { IscsiTargetIqnSettingsModalComponent } from './iscsi-target-iqn-setting import { IscsiTargetListComponent } from './iscsi-target-list/iscsi-target-list.component'; import { IscsiComponent } from './iscsi/iscsi.component'; import { MirroringModule } from './mirroring/mirroring.module'; +import { RbdConfigurationFormComponent } from './rbd-configuration-form/rbd-configuration-form.component'; +import { RbdConfigurationListComponent } from './rbd-configuration-list/rbd-configuration-list.component'; import { RbdDetailsComponent } from './rbd-details/rbd-details.component'; import { RbdFormComponent } from './rbd-form/rbd-form.component'; import { RbdImagesComponent } from './rbd-images/rbd-images.component'; @@ -77,7 +79,10 @@ import { RbdTrashRestoreModalComponent } from './rbd-trash-restore-modal/rbd-tra IscsiTargetFormComponent, IscsiTargetImageSettingsModalComponent, IscsiTargetIqnSettingsModalComponent, - IscsiTargetDiscoveryModalComponent - ] + IscsiTargetDiscoveryModalComponent, + RbdConfigurationListComponent, + RbdConfigurationFormComponent + ], + exports: [RbdConfigurationListComponent, RbdConfigurationFormComponent] }) export class BlockModule {} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html new file mode 100644 index 000000000000..63a5c88fc7c8 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html @@ -0,0 +1,79 @@ +
+ RBD Configuration + +
+

+ {{ section.heading }} +

+
+
+ + +
+
+ + + + + + + + + + + + + + +
+ The mininum value is 0 +
+
+
+
+ +
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.scss b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.scss new file mode 100644 index 000000000000..ba6460c32f54 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.scss @@ -0,0 +1,4 @@ +.collapsible { + cursor: pointer; + user-select: none; +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.spec.ts new file mode 100644 index 000000000000..dbce86384d25 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.spec.ts @@ -0,0 +1,305 @@ +import { EventEmitter } from '@angular/core'; +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { ReactiveFormsModule } from '@angular/forms'; +import { By } from '@angular/platform-browser'; + +import { ComponentLoaderFactory } from 'ngx-bootstrap/component-loader'; +import { PositioningService } from 'ngx-bootstrap/positioning'; +import { TooltipConfig, TooltipModule } from 'ngx-bootstrap/tooltip'; + +import { configureTestBed, FormHelper, i18nProviders } from '../../../../testing/unit-test-helper'; +import { DirectivesModule } from '../../../shared/directives/directives.module'; +import { CdFormGroup } from '../../../shared/forms/cd-form-group'; +import { RbdConfigurationSourceField } from '../../../shared/models/configuration'; +import { DimlessBinaryPerSecondPipe } from '../../../shared/pipes/dimless-binary-per-second.pipe'; +import { FormatterService } from '../../../shared/services/formatter.service'; +import { RbdConfigurationService } from '../../../shared/services/rbd-configuration.service'; +import { SharedModule } from '../../../shared/shared.module'; +import { RbdConfigurationFormComponent } from './rbd-configuration-form.component'; + +describe('RbdConfigurationFormComponent', () => { + let component: RbdConfigurationFormComponent; + let fixture: ComponentFixture; + let sections: any[]; + let fh: FormHelper; + + configureTestBed({ + imports: [ReactiveFormsModule, TooltipModule, DirectivesModule, SharedModule], + declarations: [RbdConfigurationFormComponent], + providers: [ + ComponentLoaderFactory, + PositioningService, + TooltipConfig, + RbdConfigurationService, + FormatterService, + DimlessBinaryPerSecondPipe, + i18nProviders + ] + }); + + beforeEach(() => { + fixture = TestBed.createComponent(RbdConfigurationFormComponent); + component = fixture.componentInstance; + component.form = new CdFormGroup({}, null); + fh = new FormHelper(component.form); + fixture.detectChanges(); + sections = TestBed.get(RbdConfigurationService).sections; + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should create all form fields mentioned in RbdConfiguration::OPTIONS', () => { + /* Test form creation on a TypeScript level */ + const actual = Object.keys((component.form.get('configuration') as CdFormGroup).controls); + const expected = sections + .map((section) => section.options) + .reduce((a, b) => a.concat(b)) + .map((option) => option.name); + expect(actual).toEqual(expected); + + /* Test form creation on a template level */ + const controlDebugElements = fixture.debugElement.queryAll(By.css('input.form-control')); + expect(controlDebugElements.length).toBe(expected.length); + controlDebugElements.forEach((element) => expect(element.nativeElement).toBeTruthy()); + }); + + it('should only contain values of changed controls if submitted', () => { + let values = {}; + component.changes.subscribe((getDirtyValues: Function) => { + values = getDirtyValues(); + }); + fh.setValue('configuration.rbd_qos_bps_limit', 0, true); + fixture.detectChanges(); + + expect(values).toEqual({ rbd_qos_bps_limit: 0 }); + }); + + describe('test loading of initial data for editing', () => { + beforeEach(() => { + component.initializeData = new EventEmitter(); + fixture.detectChanges(); + component.ngOnInit(); + }); + + it('should return dirty values without any units', () => { + let dirtyValues = {}; + component.changes.subscribe((getDirtyValues) => { + dirtyValues = getDirtyValues(); + }); + + fh.setValue('configuration.rbd_qos_bps_limit', 55, true); + fh.setValue('configuration.rbd_qos_iops_limit', 22, true); + + expect(dirtyValues['rbd_qos_bps_limit']).toBe(55); + expect(dirtyValues['rbd_qos_iops_limit']).toBe(22); + }); + + it('should load initial data into forms', () => { + component.initializeData.emit({ + initialData: [ + { + name: 'rbd_qos_bps_limit', + value: 55, + source: 1 + } + ], + sourceType: RbdConfigurationSourceField.pool + }); + + expect(component.form.getValue('configuration.rbd_qos_bps_limit')).toEqual('55 B/s'); + }); + + it('should not load initial data if the source is not the pool itself', () => { + component.initializeData.emit({ + initialData: [ + { + name: 'rbd_qos_bps_limit', + value: 55, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_iops_limit', + value: 22, + source: RbdConfigurationSourceField.global + } + ], + sourceType: RbdConfigurationSourceField.pool + }); + + expect(component.form.getValue('configuration.rbd_qos_iops_limit')).toEqual('0 IOPS'); + expect(component.form.getValue('configuration.rbd_qos_bps_limit')).toEqual('0 B/s'); + }); + + it('should not load initial data if the source is not the image itself', () => { + component.initializeData.emit({ + initialData: [ + { + name: 'rbd_qos_bps_limit', + value: 55, + source: RbdConfigurationSourceField.pool + }, + { + name: 'rbd_qos_iops_limit', + value: 22, + source: RbdConfigurationSourceField.global + } + ], + sourceType: RbdConfigurationSourceField.image + }); + + expect(component.form.getValue('configuration.rbd_qos_iops_limit')).toEqual('0 IOPS'); + expect(component.form.getValue('configuration.rbd_qos_bps_limit')).toEqual('0 B/s'); + }); + + it('should always have formatted results', () => { + component.initializeData.emit({ + initialData: [ + { + name: 'rbd_qos_bps_limit', + value: 55, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_iops_limit', + value: 22, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_read_bps_limit', + value: null, // incorrect type + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_read_bps_limit', + value: undefined, // incorrect type + source: RbdConfigurationSourceField.image + } + ], + sourceType: RbdConfigurationSourceField.image + }); + + expect(component.form.getValue('configuration.rbd_qos_iops_limit')).toEqual('22 IOPS'); + expect(component.form.getValue('configuration.rbd_qos_bps_limit')).toEqual('55 B/s'); + expect(component.form.getValue('configuration.rbd_qos_read_bps_limit')).toEqual('0 B/s'); + expect(component.form.getValue('configuration.rbd_qos_read_bps_limit')).toEqual('0 B/s'); + }); + }); + + it('should reset the corresponding form field correctly', () => { + const fieldName = 'rbd_qos_bps_limit'; + const getValue = () => component.form.get(`configuration.${fieldName}`).value; + + // Initialization + fh.setValue(`configuration.${fieldName}`, 418, true); + expect(getValue()).toBe(418); + + // Reset + component.reset(fieldName); + expect(getValue()).toBe(null); + + // Restore + component.reset(fieldName); + expect(getValue()).toBe(418); + + // Reset + component.reset(fieldName); + expect(getValue()).toBe(null); + + // Restore + component.reset(fieldName); + expect(getValue()).toBe(418); + }); + + describe('should verify that getDirtyValues() returns correctly', () => { + let data; + + beforeEach(() => { + component.initializeData = new EventEmitter(); + fixture.detectChanges(); + component.ngOnInit(); + data = { + initialData: [ + { + name: 'rbd_qos_bps_limit', + value: 0, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_iops_limit', + value: 0, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_read_bps_limit', + value: 0, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_read_iops_limit', + value: 0, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_read_iops_burst', + value: 0, + source: RbdConfigurationSourceField.image + }, + { + name: 'rbd_qos_write_bps_burst', + value: undefined, + source: RbdConfigurationSourceField.global + }, + { + name: 'rbd_qos_write_iops_burst', + value: null, + source: RbdConfigurationSourceField.global + } + ], + sourceType: RbdConfigurationSourceField.image + }; + component.initializeData.emit(data); + }); + + it('should return an empty object', () => { + expect(component.getDirtyValues()).toEqual({}); + expect(component.getDirtyValues(true, RbdConfigurationSourceField.image)).toEqual({}); + }); + + it('should return dirty values', () => { + component.form.get('configuration.rbd_qos_write_bps_burst').markAsDirty(); + expect(component.getDirtyValues()).toEqual({ rbd_qos_write_bps_burst: 0 }); + + component.form.get('configuration.rbd_qos_write_iops_burst').markAsDirty(); + expect(component.getDirtyValues()).toEqual({ + rbd_qos_write_iops_burst: 0, + rbd_qos_write_bps_burst: 0 + }); + }); + + it('should also return all local values if they do not contain their initial values', () => { + // Change value for all options + data.initialData = data.initialData.map((o) => { + o.value = 22; + return o; + }); + + // Mark some dirty + ['rbd_qos_read_iops_limit', 'rbd_qos_write_bps_burst'].forEach((option) => { + component.form.get(`configuration.${option}`).markAsDirty(); + }); + + expect(component.getDirtyValues(true, RbdConfigurationSourceField.image)).toEqual({ + rbd_qos_read_iops_limit: 0, + rbd_qos_write_bps_burst: 0 + }); + }); + + it('should throw an error if used incorrectly', () => { + expect(() => component.getDirtyValues(true)).toThrowError( + /^ProgrammingError: If local values shall be included/ + ); + }); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.ts new file mode 100644 index 000000000000..072ab6fea35e --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.ts @@ -0,0 +1,152 @@ +import { Component, EventEmitter, Input, OnInit, Output } from '@angular/core'; +import { FormControl, Validators } from '@angular/forms'; + +import { CdFormGroup } from '../../../shared/forms/cd-form-group'; +import { + RbdConfigurationEntry, + RbdConfigurationSourceField, + RbdConfigurationType +} from '../../../shared/models/configuration'; +import { FormatterService } from '../../../shared/services/formatter.service'; +import { RbdConfigurationService } from '../../../shared/services/rbd-configuration.service'; + +@Component({ + selector: 'cd-rbd-configuration-form', + templateUrl: './rbd-configuration-form.component.html', + styleUrls: ['./rbd-configuration-form.component.scss'] +}) +export class RbdConfigurationFormComponent implements OnInit { + @Input() + form: CdFormGroup; + @Input() + initializeData: EventEmitter<{ + initialData: RbdConfigurationEntry[]; + sourceType: RbdConfigurationSourceField; + }>; + @Output() + changes = new EventEmitter(); + ngDataReady = new EventEmitter(); + initialData: RbdConfigurationEntry[]; + configurationType = RbdConfigurationType; + sectionVisibility: { [key: string]: boolean } = {}; + + constructor( + public formatterService: FormatterService, + public rbdConfigurationService: RbdConfigurationService + ) {} + + ngOnInit() { + const configFormGroup = this.createConfigurationFormGroup(); + this.form.addControl('configuration', configFormGroup); + + // Listen to changes and emit the values to the parent component + configFormGroup.valueChanges.subscribe(() => { + this.changes.emit(this.getDirtyValues.bind(this)); + }); + + if (this.initializeData) { + this.initializeData.subscribe((data) => { + this.initialData = data.initialData; + const dataType = data.sourceType; + + this.rbdConfigurationService.getWritableOptionFields().forEach((option) => { + const optionData = data.initialData.filter((entry) => entry.name === option.name).pop(); + if (optionData && optionData['source'] === dataType) { + this.form.get(`configuration.${option.name}`).setValue(optionData['value']); + } + }); + this.ngDataReady.emit(); + }); + } + + this.rbdConfigurationService + .getWritableSections() + .forEach((section) => (this.sectionVisibility[section.class] = false)); + } + + getDirtyValues(includeLocalValues = false, localFieldType?: RbdConfigurationSourceField) { + if (includeLocalValues && !localFieldType) { + const msg = + 'ProgrammingError: If local values shall be included, a proper localFieldType argument has to be provided, too'; + throw new Error(msg); + } + const result = {}; + + this.rbdConfigurationService.getWritableOptionFields().forEach((config) => { + const control = this.form.get('configuration').get(config.name); + const dirty = control.dirty; + + if (this.initialData && this.initialData[config.name] === control.value) { + return; // Skip controls with initial data loaded + } + + if (dirty || (includeLocalValues && control['source'] === localFieldType)) { + if (control.value === null) { + result[config.name] = control.value; + } else if (config.type === RbdConfigurationType.bps) { + result[config.name] = this.formatterService.toBytes(control.value); + } else if (config.type === RbdConfigurationType.milliseconds) { + result[config.name] = this.formatterService.toMilliseconds(control.value); + } else if (config.type === RbdConfigurationType.iops) { + result[config.name] = this.formatterService.toIops(control.value); + } else { + result[config.name] = control.value; + } + } + }); + + return result; + } + + /** + * Dynamically create form controls. + */ + private createConfigurationFormGroup() { + const configFormGroup = new CdFormGroup({}); + + this.rbdConfigurationService.getWritableOptionFields().forEach((c) => { + let control: FormControl; + if ( + c.type === RbdConfigurationType.milliseconds || + c.type === RbdConfigurationType.iops || + c.type === RbdConfigurationType.bps + ) { + control = new FormControl(0, Validators.min(0)); + } else { + throw new Error( + `Type ${c.type} is unknown, you may need to add it to RbdConfiguration class` + ); + } + configFormGroup.addControl(c.name, control); + }); + + return configFormGroup; + } + + /** + * Reset the value. The inherited value will be used instead. + */ + reset(optionName: string) { + const formControl = this.form.get('configuration').get(optionName); + if (formControl.disabled) { + formControl.setValue(formControl['previousValue'] || 0); + formControl.enable(); + if (!formControl['previousValue']) { + formControl.markAsPristine(); + } + } else { + formControl['previousValue'] = formControl.value; + formControl.setValue(null); + formControl.markAsDirty(); + formControl.disable(); + } + } + + isDisabled(optionName: string) { + return this.form.get('configuration').get(optionName).disabled; + } + + toggleSectionVisibility(className) { + this.sectionVisibility[className] = !this.sectionVisibility[className]; + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html new file mode 100644 index 000000000000..80d0b94731be --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html @@ -0,0 +1,25 @@ + + + + +
+ Global + Image + Pool +
+ + + +
+ {{ value | dimlessBinaryPerSecond }} + {{ value | milliseconds }} + {{ value | iops }} + {{ value }} +
+ diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.scss b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.scss new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.spec.ts new file mode 100644 index 000000000000..72b0114b37d0 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.spec.ts @@ -0,0 +1,67 @@ +import { SimpleChange } from '@angular/core'; +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { FormsModule } from '@angular/forms'; +import { RouterTestingModule } from '@angular/router/testing'; + +import { NgxDatatableModule } from '@swimlane/ngx-datatable'; +import { ChartsModule } from 'ng2-charts'; +import { AlertModule } from 'ngx-bootstrap/alert'; + +import { configureTestBed, i18nProviders } from '../../../../testing/unit-test-helper'; +import { ErrorPanelComponent } from '../../../shared/components/error-panel/error-panel.component'; +import { SparklineComponent } from '../../../shared/components/sparkline/sparkline.component'; +import { TableComponent } from '../../../shared/datatable/table/table.component'; +import { RbdConfigurationEntry } from '../../../shared/models/configuration'; +import { PipesModule } from '../../../shared/pipes/pipes.module'; +import { FormatterService } from '../../../shared/services/formatter.service'; +import { RbdConfigurationService } from '../../../shared/services/rbd-configuration.service'; +import { RbdConfigurationListComponent } from './rbd-configuration-list.component'; + +describe('RbdConfigurationListComponent', () => { + let component: RbdConfigurationListComponent; + let fixture: ComponentFixture; + + configureTestBed({ + imports: [ + FormsModule, + NgxDatatableModule, + RouterTestingModule, + AlertModule, + ChartsModule, + PipesModule + ], + declarations: [ + RbdConfigurationListComponent, + TableComponent, + ErrorPanelComponent, + SparklineComponent + ], + providers: [FormatterService, RbdConfigurationService, i18nProviders] + }); + + beforeEach(() => { + fixture = TestBed.createComponent(RbdConfigurationListComponent); + component = fixture.componentInstance; + component.data = []; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('filters options out which are not defined in RbdConfigurationService', () => { + const fakeOption = { name: 'foo', source: 0, value: '50' } as RbdConfigurationEntry; + const realOption = { + name: 'rbd_qos_read_iops_burst', + source: 0, + value: '50' + } as RbdConfigurationEntry; + + component.data = [fakeOption, realOption]; + component.ngOnChanges({ name: new SimpleChange(null, null, null) }); + + expect(component.data.length).toBe(1); + expect(component.data.pop()).toBe(realOption); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.ts new file mode 100644 index 000000000000..55389fd43a7e --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.ts @@ -0,0 +1,66 @@ +import { + Component, + Input, + OnChanges, + OnInit, + SimpleChanges, + TemplateRef, + ViewChild +} from '@angular/core'; + +import { I18n } from '@ngx-translate/i18n-polyfill'; +import { CdTableColumn } from '../../../shared/models/cd-table-column'; +import { + RbdConfigurationEntry, + RbdConfigurationSourceField, + RbdConfigurationType +} from '../../../shared/models/configuration'; +import { FormatterService } from '../../../shared/services/formatter.service'; +import { RbdConfigurationService } from '../../../shared/services/rbd-configuration.service'; + +@Component({ + selector: 'cd-rbd-configuration-table', + templateUrl: './rbd-configuration-list.component.html', + styleUrls: ['./rbd-configuration-list.component.scss'] +}) +export class RbdConfigurationListComponent implements OnInit, OnChanges { + @Input() + data: RbdConfigurationEntry[]; + poolConfigurationColumns: CdTableColumn[]; + @ViewChild('configurationSourceTpl') + configurationSourceTpl: TemplateRef; + @ViewChild('configurationValueTpl') + configurationValueTpl: TemplateRef; + + readonly sourceField = RbdConfigurationSourceField; + readonly typeField = RbdConfigurationType; + + constructor( + public formatterService: FormatterService, + private rbdConfigurationService: RbdConfigurationService, + private i18n: I18n + ) {} + + ngOnInit() { + this.poolConfigurationColumns = [ + { prop: 'displayName', name: this.i18n('Name') }, + { prop: 'description', name: this.i18n('Description') }, + { prop: 'name', name: this.i18n('Key') }, + { prop: 'source', name: this.i18n('Source'), cellTemplate: this.configurationSourceTpl }, + { prop: 'value', name: this.i18n('Value'), cellTemplate: this.configurationValueTpl } + ]; + } + + ngOnChanges(changes: SimpleChanges): void { + if (!this.data) { + return; + } + // Filter settings out which are not listed in RbdConfigurationService + this.data = this.data.filter((row) => + this.rbdConfigurationService + .getOptionFields() + .map((o) => o.name) + .includes(row.name) + ); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.html index 28546d0d0485..889cab1f9a4b 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.html @@ -121,4 +121,19 @@ [poolName]="selectedItem.pool_name" [rbdName]="selectedItem.name"> + + + + + + + Image + + Global + + diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.spec.ts index ac83e952cebe..44646595e812 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.spec.ts @@ -6,6 +6,7 @@ import { TooltipModule } from 'ngx-bootstrap/tooltip'; import { configureTestBed } from '../../../../testing/unit-test-helper'; import { SharedModule } from '../../../shared/shared.module'; +import { RbdConfigurationListComponent } from '../rbd-configuration-list/rbd-configuration-list.component'; import { RbdSnapshotListComponent } from '../rbd-snapshot-list/rbd-snapshot-list.component'; import { RbdDetailsComponent } from './rbd-details.component'; @@ -14,7 +15,7 @@ describe('RbdDetailsComponent', () => { let fixture: ComponentFixture; configureTestBed({ - declarations: [RbdDetailsComponent, RbdSnapshotListComponent], + declarations: [RbdDetailsComponent, RbdSnapshotListComponent, RbdConfigurationListComponent], imports: [SharedModule, TabsModule.forRoot(), TooltipModule.forRoot(), RouterTestingModule] }); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.ts index 702416b96d78..a579a1d315e6 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-details/rbd-details.component.ts @@ -1,6 +1,7 @@ -import { Component, Input, OnChanges } from '@angular/core'; +import { Component, Input, OnChanges, TemplateRef, ViewChild } from '@angular/core'; import { CdTableSelection } from '../../../shared/models/cd-table-selection'; +import { RbdFormModel } from '../rbd-form/rbd-form.model'; @Component({ selector: 'cd-rbd-details', @@ -10,7 +11,11 @@ import { CdTableSelection } from '../../../shared/models/cd-table-selection'; export class RbdDetailsComponent implements OnChanges { @Input() selection: CdTableSelection; - selectedItem: any; + selectedItem: RbdFormModel; + @Input() + images: any; + @ViewChild('poolConfigurationSourceTpl') + poolConfigurationSourceTpl: TemplateRef; constructor() {} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-clone-request.model.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-clone-request.model.ts index 826d4cc3fa90..0c18352d6574 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-clone-request.model.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-clone-request.model.ts @@ -1,3 +1,5 @@ +import { RbdConfigurationEntry } from '../../../shared/models/configuration'; + export class RbdFormCloneRequestModel { child_pool_name: string; child_image_name: string; @@ -6,4 +8,5 @@ export class RbdFormCloneRequestModel { stripe_unit: number; stripe_count: number; data_pool: string; + configuration?: RbdConfigurationEntry[]; } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-copy-request.model.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-copy-request.model.ts index 4553dc81c1fb..c1b290dca283 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-copy-request.model.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-copy-request.model.ts @@ -1,3 +1,5 @@ +import { RbdConfigurationEntry } from '../../../shared/models/configuration'; + export class RbdFormCopyRequestModel { dest_pool_name: string; dest_image_name: string; @@ -7,4 +9,5 @@ export class RbdFormCopyRequestModel { stripe_unit: number; stripe_count: number; data_pool: string; + configuration: RbdConfigurationEntry[]; } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-edit-request.model.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-edit-request.model.ts index 39495630a4c5..37997e22d7d5 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-edit-request.model.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form-edit-request.model.ts @@ -1,5 +1,8 @@ +import { RbdConfigurationEntry } from '../../../shared/models/configuration'; + export class RbdFormEditRequestModel { name: string; size: number; features: Array = []; + configuration: RbdConfigurationEntry[]; } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form.component.html index ec9729bfe293..5a0ef4ef0cd9 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/block/rbd-form/rbd-form.component.html @@ -7,7 +7,9 @@

- {mode, select, editing {Edit} cloning {Clone} copying {Copy} other {Add}} RBD + {mode, select, editing {Edit} cloning {Clone} copying {Copy} other {Add}} + RBD

@@ -211,82 +213,92 @@ i18n>Advanced...
-
+

Advanced

- -
- -
- +
+

Striping

+ + +
+ +
+ +
-
- -
-
@@ -295,7 +307,7 @@ - {mode, select, editing {Update} cloning {Clone} copying {Copy} other {Create}} RBD + {mode, select, editing {Update} cloning {Clone} copying {Copy} other {Create}} RBD
- -
- -
- - - - -
+
+ +
+ +
+ + + +
+
+ +
+ +
+
-
-
- - {editing, select, 1 {Edit} other {Create}} pool - - -
+
+
+ + {editing, select, 1 {Edit} other {Create}} pool + +
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.spec.ts index b672d371c3f7..eab7387b9963 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.spec.ts @@ -83,7 +83,11 @@ describe('PoolFormComponent', () => { return rule; }; - const testSubmit = (pool: any, taskName: string, poolServiceMethod: 'create' | 'update') => { + const expectValidSubmit = ( + pool: any, + taskName: string, + poolServiceMethod: 'create' | 'update' + ) => { spyOn(poolService, poolServiceMethod).and.stub(); const taskWrapper = TestBed.get(TaskWrapperService); spyOn(taskWrapper, 'wrapTaskAroundCall').and.callThrough(); @@ -840,7 +844,7 @@ describe('PoolFormComponent', () => { }); }; const testCreate = (pool) => { - testSubmit(pool, 'pool/create', 'create'); + expectValidSubmit(pool, 'pool/create', 'create'); }; beforeEach(() => { @@ -893,6 +897,27 @@ describe('PoolFormComponent', () => { flags: ['ec_overwrites'] }); }); + + it('with rbd qos settings', () => { + setMultipleValues({ + name: 'replicatedRbdQos', + poolType: 'replicated', + size: 2, + pgNum: 32 + }); + component.currentConfigurationValues = { + rbd_qos_bps_limit: 55 + }; + testCreate({ + pool: 'replicatedRbdQos', + pool_type: 'replicated', + size: 2, + pg_num: 32, + configuration: { + rbd_qos_bps_limit: 55 + } + }); + }); }); describe('replicated coded pool', () => { @@ -974,6 +999,7 @@ describe('PoolFormComponent', () => { pool.options.compression_required_ratio = 0.8; pool.flags_names = 'someFlag1,someFlag2'; pool.application_metadata = ['rbd', 'rgw']; + createCrushRule({ name: 'someRule' }); spyOn(poolService, 'get').and.callFake(() => of(pool)); }); @@ -1044,7 +1070,7 @@ describe('PoolFormComponent', () => { it(`always provides the application metadata array with submit even if it's empty`, () => { expect(form.get('mode').dirty).toBe(false); component.data.applications.selected = []; - testSubmit( + expectValidSubmit( { application_metadata: [], pool: 'somePoolName' @@ -1058,7 +1084,7 @@ describe('PoolFormComponent', () => { formHelper.setValue('minBlobSize', '').markAsDirty(); formHelper.setValue('maxBlobSize', '').markAsDirty(); formHelper.setValue('ratio', '').markAsDirty(); - testSubmit( + expectValidSubmit( { application_metadata: ['rbd', 'rgw'], compression_max_blob_size: 0, @@ -1073,7 +1099,7 @@ describe('PoolFormComponent', () => { it(`will unset mode not used anymore`, () => { formHelper.setValue('mode', 'none').markAsDirty(); - testSubmit( + expectValidSubmit( { application_metadata: ['rbd', 'rgw'], compression_mode: 'unset', @@ -1086,4 +1112,29 @@ describe('PoolFormComponent', () => { }); }); }); + + describe('test pool configuration component', () => { + it('is visible for replicated pools with rbd application', () => { + const poolType = component.form.get('poolType'); + poolType.markAsDirty(); + poolType.setValue('replicated'); + component.data.applications.selected = ['rbd']; + fixture.detectChanges(); + expect( + fixture.debugElement.query(By.css('cd-rbd-configuration-form')).nativeElement.parentElement + .hidden + ).toBe(false); + }); + + it('is invisible for erasure coded pools', () => { + const poolType = component.form.get('poolType'); + poolType.markAsDirty(); + poolType.setValue('erasure'); + fixture.detectChanges(); + expect( + fixture.debugElement.query(By.css('cd-rbd-configuration-form')).nativeElement.parentElement + .hidden + ).toBe(true); + }); + }); }); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.ts index 4a8424f350eb..7e2bf84106bd 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-form/pool-form.component.ts @@ -1,4 +1,4 @@ -import { Component, OnInit } from '@angular/core'; +import { Component, EventEmitter, OnInit } from '@angular/core'; import { FormControl, Validators } from '@angular/forms'; import { ActivatedRoute, Router } from '@angular/router'; @@ -12,6 +12,10 @@ import { PoolService } from '../../../shared/api/pool.service'; import { CriticalConfirmationModalComponent } from '../../../shared/components/critical-confirmation-modal/critical-confirmation-modal.component'; import { CdFormGroup } from '../../../shared/forms/cd-form-group'; import { CdValidators } from '../../../shared/forms/cd-validators'; +import { + RbdConfigurationEntry, + RbdConfigurationSourceField +} from '../../../shared/models/configuration'; import { CrushRule } from '../../../shared/models/crush-rule'; import { CrushStep } from '../../../shared/models/crush-step'; import { ErasureCodeProfile } from '../../../shared/models/erasure-code-profile'; @@ -53,6 +57,11 @@ export class PoolFormComponent implements OnInit { current = { rules: [] }; + initializeConfigData = new EventEmitter<{ + initialData: RbdConfigurationEntry[]; + sourceType: RbdConfigurationSourceField; + }>(); + currentConfigurationValues: { [configKey: string]: any } = {}; constructor( private dimlessBinaryPipe: DimlessBinaryPipe, @@ -177,6 +186,11 @@ export class PoolFormComponent implements OnInit { } private initEditFormData(pool: Pool) { + this.initializeConfigData.emit({ + initialData: pool.configuration, + sourceType: RbdConfigurationSourceField.pool + }); + const dataMap = { name: pool.pool_name, poolType: pool.type, @@ -569,10 +583,21 @@ export class PoolFormComponent implements OnInit { ]); } } + const apps = this.data.applications.selected; if (apps.length > 0 || this.editing) { pool['application_metadata'] = apps; } + + // Only collect configuration data for replicated pools, as QoS cannot be configured on EC + // pools. EC data pools inherit their settings from the corresponding replicated metadata pool. + if ( + this.form.get('poolType').value === 'replicated' && + !_.isEmpty(this.currentConfigurationValues) + ) { + pool['configuration'] = this.currentConfigurationValues; + } + this.triggerApiTask(pool); } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.spec.ts index 209bf60bdd49..117b7d26590c 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.spec.ts @@ -9,11 +9,12 @@ import { of } from 'rxjs'; import { configureTestBed, i18nProviders } from '../../../../testing/unit-test-helper'; import { PoolService } from '../../../shared/api/pool.service'; -import { DeletionModalComponent } from '../../../shared/components/deletion-modal/deletion-modal.component'; +import { CriticalConfirmationModalComponent } from '../../../shared/components/critical-confirmation-modal/critical-confirmation-modal.component'; import { ExecutingTask } from '../../../shared/models/executing-task'; import { SummaryService } from '../../../shared/services/summary.service'; import { TaskWrapperService } from '../../../shared/services/task-wrapper.service'; import { SharedModule } from '../../../shared/shared.module'; +import { RbdConfigurationListComponent } from '../../block/rbd-configuration-list/rbd-configuration-list.component'; import { PgCategoryService } from '../../shared/pg-category.service'; import { Pool } from '../pool'; import { PoolDetailsComponent } from '../pool-details/pool-details.component'; @@ -39,7 +40,7 @@ describe('PoolListComponent', () => { }; configureTestBed({ - declarations: [PoolListComponent, PoolDetailsComponent], + declarations: [PoolListComponent, PoolDetailsComponent, RbdConfigurationListComponent], imports: [ SharedModule, ToastModule.forRoot(), @@ -72,7 +73,7 @@ describe('PoolListComponent', () => { const callDeletion = () => { component.deletePoolModal(); - const deletion: DeletionModalComponent = component.modalRef.content; + const deletion: CriticalConfirmationModalComponent = component.modalRef.content; deletion.submitActionObservable(); }; diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.ts index a5545572e73d..fc1bbb0e5f89 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool-list/pool-list.component.ts @@ -34,6 +34,9 @@ export class PoolListComponent implements OnInit { @ViewChild('poolUsageTpl') poolUsageTpl: TemplateRef; + @ViewChild('poolConfigurationSourceTpl') + poolConfigurationSourceTpl: TemplateRef; + pools: Pool[] = []; columns: CdTableColumn[]; selection = new CdTableSelection(); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.module.ts index 1a789675b720..c13cd76290a0 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.module.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.module.ts @@ -6,9 +6,11 @@ import { RouterModule } from '@angular/router'; import { BsDropdownModule } from 'ngx-bootstrap/dropdown'; import { PopoverModule } from 'ngx-bootstrap/popover'; import { TabsModule } from 'ngx-bootstrap/tabs'; +import { TooltipModule } from 'ngx-bootstrap/tooltip'; import { ServicesModule } from '../../shared/services/services.module'; import { SharedModule } from '../../shared/shared.module'; +import { BlockModule } from '../block/block.module'; import { CephSharedModule } from '../shared/ceph-shared.module'; import { ErasureCodeProfileFormComponent } from './erasure-code-profile-form/erasure-code-profile-form.component'; import { PoolDetailsComponent } from './pool-details/pool-details.component'; @@ -25,7 +27,9 @@ import { PoolListComponent } from './pool-list/pool-list.component'; RouterModule, ReactiveFormsModule, BsDropdownModule, - ServicesModule + ServicesModule, + TooltipModule.forRoot(), + BlockModule ], exports: [PoolListComponent, PoolFormComponent], declarations: [ diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.ts index 3ff9d5e9a163..17be0f1d8e1a 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/pool/pool.ts @@ -67,6 +67,7 @@ export class Pool { wr?: PoolStat; }; cdIsBinary?: boolean; + configuration: { source: number; name: string; value: string }[]; constructor(name) { this.pool_name = name; diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.spec.ts index a2acdc687cee..20ff612d65d3 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.spec.ts @@ -1,7 +1,9 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { fakeAsync, TestBed, tick } from '@angular/core/testing'; -import { configureTestBed } from '../../../testing/unit-test-helper'; +import { configureTestBed, i18nProviders } from '../../../testing/unit-test-helper'; +import { RbdConfigurationSourceField } from '../models/configuration'; +import { RbdConfigurationService } from '../services/rbd-configuration.service'; import { PoolService } from './pool.service'; describe('PoolService', () => { @@ -10,7 +12,7 @@ describe('PoolService', () => { const apiPath = 'api/pool'; configureTestBed({ - providers: [PoolService], + providers: [PoolService, RbdConfigurationService, i18nProviders], imports: [HttpClientTestingModule] }); @@ -79,4 +81,43 @@ describe('PoolService', () => { tick(); expect(result).toEqual(['foo', 'bar']); })); + + it('should test injection of data from getConfiguration()', fakeAsync(() => { + const pool = 'foo'; + let value; + service.getConfiguration(pool).subscribe((next) => (value = next)); + const req = httpTesting.expectOne(`${apiPath}/${pool}/configuration`); + expect(req.request.method).toBe('GET'); + req.flush([ + { + name: 'rbd_qos_bps_limit', + value: '60', + source: RbdConfigurationSourceField.global + }, + { + name: 'rbd_qos_iops_limit', + value: '0', + source: RbdConfigurationSourceField.global + } + ]); + tick(); + expect(value).toEqual([ + { + description: 'The desired limit of IO bytes per second.', + displayName: 'BPS Limit', + name: 'rbd_qos_bps_limit', + source: RbdConfigurationSourceField.global, + type: 0, + value: '60' + }, + { + description: 'The desired limit of IO operations per second.', + displayName: 'IOPS Limit', + name: 'rbd_qos_iops_limit', + source: RbdConfigurationSourceField.global, + type: 1, + value: '0' + } + ]); + })); }); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.ts index 12aa43c9fab8..0b70dbda73a9 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/pool.service.ts @@ -2,9 +2,11 @@ import { HttpClient } from '@angular/common/http'; import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; +import { map } from 'rxjs/operators'; import { cdEncode } from '../decorators/cd-encode'; -import { PoolFormInfo } from '../models/pool-form-info'; +import { RbdConfigurationEntry } from '../models/configuration'; +import { RbdConfigurationService } from '../services/rbd-configuration.service'; import { ApiModule } from './api.module'; @cdEncode @@ -14,7 +16,7 @@ import { ApiModule } from './api.module'; export class PoolService { apiPath = 'api/pool'; - constructor(private http: HttpClient) {} + constructor(private http: HttpClient, private rbdConfigurationService: RbdConfigurationService) {} create(pool) { return this.http.post(this.apiPath, pool, { observe: 'response' }); @@ -44,8 +46,19 @@ export class PoolService { return this.http.get(`${this.apiPath}?stats=true`); } - getInfo(): Observable { - return this.http.get(`${this.apiPath}/_info`); + getConfiguration(poolName: string): Observable { + return this.http.get(`${this.apiPath}/${poolName}/configuration`).pipe( + // Add static data maintained in RbdConfigurationService + map((values) => + values.map((entry) => + Object.assign(entry, this.rbdConfigurationService.getOptionByName(entry.name)) + ) + ) + ); + } + + getInfo(pool_name?: string) { + return this.http.get(`${this.apiPath}/_info` + (pool_name ? `?pool_name=${pool_name}` : '')); } list(attrs = []) { diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.model.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.model.ts new file mode 100644 index 000000000000..af646d8ac61d --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.model.ts @@ -0,0 +1,29 @@ +import { RbdConfigurationEntry } from '../models/configuration'; + +export interface RbdPool { + pool_name: string; + status: number; + value: RbdImage[]; +} + +export interface RbdImage { + disk_usage: number; + stripe_unit: number; + name: string; + parent: any; + pool_name: string; + num_objs: number; + block_name_prefix: string; + snapshots: any[]; + obj_size: number; + data_pool: string; + total_disk_usage: number; + features: number; + configuration: RbdConfigurationEntry[]; + timestamp: string; + id: string; + features_name: string[]; + stripe_count: number; + order: number; + size: number; +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.spec.ts index 1fba5e58d25f..b09fec663a16 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.spec.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.spec.ts @@ -1,7 +1,8 @@ import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing'; import { TestBed } from '@angular/core/testing'; -import { configureTestBed } from '../../../testing/unit-test-helper'; +import { configureTestBed, i18nProviders } from '../../../testing/unit-test-helper'; +import { RbdConfigurationService } from '../services/rbd-configuration.service'; import { RbdService } from './rbd.service'; describe('RbdService', () => { @@ -9,7 +10,7 @@ describe('RbdService', () => { let httpTesting: HttpTestingController; configureTestBed({ - providers: [RbdService], + providers: [RbdService, RbdConfigurationService, i18nProviders], imports: [HttpClientTestingModule] }); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.ts index 02e1bcdc1522..3ccf6100254e 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rbd.service.ts @@ -1,15 +1,19 @@ import { HttpClient } from '@angular/common/http'; import { Injectable } from '@angular/core'; +import { map } from 'rxjs/operators'; + import { cdEncode, cdEncodeNot } from '../decorators/cd-encode'; +import { RbdConfigurationService } from '../services/rbd-configuration.service'; import { ApiModule } from './api.module'; +import { RbdPool } from './rbd.model'; @cdEncode @Injectable({ providedIn: ApiModule }) export class RbdService { - constructor(private http: HttpClient) {} + constructor(private http: HttpClient, private rbdConfigurationService: RbdConfigurationService) {} create(rbd) { return this.http.post('api/block/image', rbd, { observe: 'response' }); @@ -28,7 +32,22 @@ export class RbdService { } list() { - return this.http.get('api/block/image'); + return this.http.get('api/block/image').pipe( + map((pools) => + pools.map((pool) => { + pool.value.map((image) => { + if (!image.configuration) { + return image; + } + image.configuration.map((option) => + Object.assign(option, this.rbdConfigurationService.getOptionByName(option.name)) + ); + return image; + }); + return pool; + }) + ) + ); } copy(poolName, rbdName, rbd) { diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/sparkline/sparkline.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/sparkline/sparkline.component.ts index b289882237e3..906fb64d49ce 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/sparkline/sparkline.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/sparkline/sparkline.component.ts @@ -1,7 +1,7 @@ import { Component, ElementRef, OnChanges, OnInit, SimpleChanges, ViewChild } from '@angular/core'; import { Input } from '@angular/core'; -import { ChartTooltip } from '../../../shared/models/chart-tooltip'; +import { ChartTooltip } from '../../models/chart-tooltip'; import { DimlessBinaryPipe } from '../../pipes/dimless-binary.pipe'; @Component({ diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.spec.ts new file mode 100644 index 000000000000..858becc450c1 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.spec.ts @@ -0,0 +1,12 @@ +import { DimlessBinaryPerSecondDirective } from './dimless-binary-per-second.directive'; + +export class MockElementRef { + nativeElement: {}; +} + +describe('DimlessBinaryPerSecondDirective', () => { + it('should create an instance', () => { + const directive = new DimlessBinaryPerSecondDirective(new MockElementRef(), null, null, null); + expect(directive).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.ts new file mode 100644 index 000000000000..6355fd74cd57 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/dimless-binary-per-second.directive.ts @@ -0,0 +1,132 @@ +import { + Directive, + ElementRef, + EventEmitter, + HostListener, + Input, + OnInit, + Output +} from '@angular/core'; +import { NgControl } from '@angular/forms'; + +import * as _ from 'lodash'; + +import { DimlessBinaryPerSecondPipe } from '../pipes/dimless-binary-per-second.pipe'; +import { FormatterService } from '../services/formatter.service'; + +@Directive({ + selector: '[cdDimlessBinaryPerSecond]' +}) +export class DimlessBinaryPerSecondDirective implements OnInit { + @Output() + ngModelChange: EventEmitter = new EventEmitter(); + + /** + * Event emitter for letting this directive know that the data has (asynchronously) been loaded + * and the value needs to be adapted by this directive. + */ + @Input() + ngDataReady: EventEmitter; + + /** + * Minimum size in bytes. + * If user enter a value lower than , + * the model will automatically be update to . + * + * If is used, this value should be a power of . + * + * Example: + * Given minBytes=4096 (4KiB), if user type 1KiB, then model will be updated to 4KiB + */ + @Input() + minBytes: number; + + /** + * Maximum size in bytes. + * If user enter a value greater than , + * the model will automatically be update to . + * + * If is used, this value should be a power of . + * + * Example: + * Given maxBytes=3145728 (3MiB), if user type 4MiB, then model will be updated to 3MiB + */ + @Input() + maxBytes: number; + + /** + * Value will be rounded up the nearest power of + * + * Example: + * Given roundPower=2, if user type 7KiB, then model will be updated to 8KiB + * Given roundPower=2, if user type 5KiB, then model will be updated to 4KiB + */ + @Input() + roundPower: number; + + /** + * Default unit that should be used when user do not type a unit. + * By default, "MiB" will be used. + * + * Example: + * Given defaultUnit=null, if user type 7, then model will be updated to 7MiB + * Given defaultUnit=k, if user type 7, then model will be updated to 7KiB + */ + @Input() + defaultUnit: string; + + private el: HTMLInputElement; + + constructor( + private elementRef: ElementRef, + private control: NgControl, + private dimlessBinaryPerSecondPipe: DimlessBinaryPerSecondPipe, + private formatter: FormatterService + ) { + this.el = this.elementRef.nativeElement; + } + + ngOnInit() { + this.setValue(this.el.value); + if (this.ngDataReady) { + this.ngDataReady.subscribe(() => this.setValue(this.el.value)); + } + } + + setValue(value) { + if (/^[\d.]+$/.test(value)) { + value += this.defaultUnit || 'm'; + } + const size = this.formatter.toBytes(value, 0); + const roundedSize = this.round(size); + this.el.value = this.dimlessBinaryPerSecondPipe.transform(roundedSize); + if (size !== null) { + this.ngModelChange.emit(this.el.value); + this.control.control.setValue(this.el.value); + } else { + this.ngModelChange.emit(null); + this.control.control.setValue(null); + } + } + + round(size) { + if (size !== null && size !== 0) { + if (!_.isUndefined(this.minBytes) && size < this.minBytes) { + return this.minBytes; + } + if (!_.isUndefined(this.maxBytes) && size > this.maxBytes) { + return this.maxBytes; + } + if (!_.isUndefined(this.roundPower)) { + const power = Math.round(Math.log(size) / Math.log(this.roundPower)); + return Math.pow(this.roundPower, power); + } + } + return size; + } + + @HostListener('blur', ['$event.target.value']) + onBlur(value) { + this.setValue(value); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/directives.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/directives.module.ts index e2d9f7d90d0d..a521a6c0c058 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/directives.module.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/directives.module.ts @@ -2,7 +2,10 @@ import { NgModule } from '@angular/core'; import { AutofocusDirective } from './autofocus.directive'; import { Copy2ClipboardButtonDirective } from './copy2clipboard-button.directive'; +import { DimlessBinaryPerSecondDirective } from './dimless-binary-per-second.directive'; import { DimlessBinaryDirective } from './dimless-binary.directive'; +import { IopsDirective } from './iops.directive'; +import { MillisecondsDirective } from './milliseconds.directive'; import { PasswordButtonDirective } from './password-button.directive'; @NgModule({ @@ -11,13 +14,19 @@ import { PasswordButtonDirective } from './password-button.directive'; AutofocusDirective, Copy2ClipboardButtonDirective, DimlessBinaryDirective, - PasswordButtonDirective + DimlessBinaryPerSecondDirective, + PasswordButtonDirective, + MillisecondsDirective, + IopsDirective ], exports: [ AutofocusDirective, Copy2ClipboardButtonDirective, DimlessBinaryDirective, - PasswordButtonDirective + DimlessBinaryPerSecondDirective, + PasswordButtonDirective, + MillisecondsDirective, + IopsDirective ], providers: [] }) diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.spec.ts new file mode 100644 index 000000000000..9c1641dedc91 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.spec.ts @@ -0,0 +1,8 @@ +import { IopsDirective } from './iops.directive'; + +describe('IopsDirective', () => { + it('should create an instance', () => { + const directive = new IopsDirective(null, null); + expect(directive).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.ts new file mode 100644 index 000000000000..5d5d22dba87e --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/iops.directive.ts @@ -0,0 +1,31 @@ +import { Directive, EventEmitter, HostListener, Input, OnInit } from '@angular/core'; +import { NgControl } from '@angular/forms'; + +import { FormatterService } from '../services/formatter.service'; + +@Directive({ + selector: '[cdIops]' +}) +export class IopsDirective implements OnInit { + @Input() + ngDataReady: EventEmitter; + + constructor(private formatter: FormatterService, private ngControl: NgControl) {} + + setValue(value: string): void { + const iops = this.formatter.toIops(value); + this.ngControl.control.setValue(`${iops} IOPS`); + } + + ngOnInit(): void { + this.setValue(this.ngControl.value); + if (this.ngDataReady) { + this.ngDataReady.subscribe(() => this.setValue(this.ngControl.value)); + } + } + + @HostListener('blur', ['$event.target.value']) + onUpdate(value) { + this.setValue(value); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.spec.ts new file mode 100644 index 000000000000..50380205660f --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.spec.ts @@ -0,0 +1,8 @@ +import { MillisecondsDirective } from './milliseconds.directive'; + +describe('MillisecondsDirective', () => { + it('should create an instance', () => { + const directive = new MillisecondsDirective(null, null); + expect(directive).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.ts new file mode 100644 index 000000000000..4d84499bc8ae --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/directives/milliseconds.directive.ts @@ -0,0 +1,31 @@ +import { Directive, EventEmitter, HostListener, Input, OnInit } from '@angular/core'; +import { NgControl } from '@angular/forms'; + +import { FormatterService } from '../services/formatter.service'; + +@Directive({ + selector: '[cdMilliseconds]' +}) +export class MillisecondsDirective implements OnInit { + @Input() + ngDataReady: EventEmitter; + + constructor(private control: NgControl, private formatter: FormatterService) {} + + setValue(value: string): void { + const ms = this.formatter.toMilliseconds(value); + this.control.control.setValue(`${ms} ms`); + } + + ngOnInit(): void { + this.setValue(this.control.value); + if (this.ngDataReady) { + this.ngDataReady.subscribe(() => this.setValue(this.control.value)); + } + } + + @HostListener('blur', ['$event.target.value']) + onUpdate(value) { + this.setValue(value); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/models/configuration.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/models/configuration.ts new file mode 100644 index 000000000000..0a8e403d7ce2 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/models/configuration.ts @@ -0,0 +1,43 @@ +export enum RbdConfigurationSourceField { + global = 0, + pool = 1, + image = 2 +} + +export enum RbdConfigurationType { + bps, + iops, + milliseconds +} + +/** + * This configuration can also be set on a pool level. + */ +export interface RbdConfigurationEntry { + name: string; + source: RbdConfigurationSourceField; + value: any; + type?: RbdConfigurationType; // Non-external field. + description?: string; // Non-external field. + displayName?: string; // Non-external field. Nice name for the UI which is added in the UI. +} + +/** + * This object contains additional information injected into the elements retrieved by the service. + */ +export interface RbdConfigurationExtraField { + name: string; + displayName: string; + description: string; + type: RbdConfigurationType; + readOnly?: boolean; +} + +/** + * Represents a set of data to be used for editing or creating configuration options + */ +export interface RbdConfigurationSection { + heading: string; + class: string; + options: RbdConfigurationExtraField[]; +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/dimless-binary-per-second.pipe.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/dimless-binary-per-second.pipe.ts new file mode 100644 index 000000000000..bcd8f666c7e6 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/dimless-binary-per-second.pipe.ts @@ -0,0 +1,23 @@ +import { Pipe, PipeTransform } from '@angular/core'; +import { FormatterService } from '../services/formatter.service'; + +@Pipe({ + name: 'dimlessBinaryPerSecond' +}) +export class DimlessBinaryPerSecondPipe implements PipeTransform { + constructor(private formatter: FormatterService) {} + + transform(value: any, args?: any): any { + return this.formatter.format_number(value, 1024, [ + 'B/s', + 'kB/s', + 'MB/s', + 'GB/s', + 'TB/s', + 'PB/s', + 'EB/s', + 'ZB/s', + 'YB/s' + ]); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.spec.ts new file mode 100644 index 000000000000..dac353ddfdf4 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.spec.ts @@ -0,0 +1,8 @@ +import { IopsPipe } from './iops.pipe'; + +describe('IopsPipe', () => { + it('create an instance', () => { + const pipe = new IopsPipe(); + expect(pipe).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.ts new file mode 100644 index 000000000000..921e773af612 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/iops.pipe.ts @@ -0,0 +1,10 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ + name: 'iops' +}) +export class IopsPipe implements PipeTransform { + transform(value: any, args?: any): any { + return `${value} IOPS`; + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.spec.ts new file mode 100644 index 000000000000..cea4bb13faca --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.spec.ts @@ -0,0 +1,8 @@ +import { MillisecondsPipe } from './milliseconds.pipe'; + +describe('MillisecondsPipe', () => { + it('create an instance', () => { + const pipe = new MillisecondsPipe(); + expect(pipe).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.ts new file mode 100644 index 000000000000..c2e45ca33cb7 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/milliseconds.pipe.ts @@ -0,0 +1,10 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ + name: 'milliseconds' +}) +export class MillisecondsPipe implements PipeTransform { + transform(value: any, args?: any): any { + return `${value} ms`; + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts index c7870011592c..ac89776424ef 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts @@ -5,13 +5,16 @@ import { EmptyPipe } from '../empty.pipe'; import { CdDatePipe } from './cd-date.pipe'; import { CephReleaseNamePipe } from './ceph-release-name.pipe'; import { CephShortVersionPipe } from './ceph-short-version.pipe'; +import { DimlessBinaryPerSecondPipe } from './dimless-binary-per-second.pipe'; import { DimlessBinaryPipe } from './dimless-binary.pipe'; import { DimlessPipe } from './dimless.pipe'; import { EncodeUriPipe } from './encode-uri.pipe'; import { FilterPipe } from './filter.pipe'; import { HealthColorPipe } from './health-color.pipe'; +import { IopsPipe } from './iops.pipe'; import { ListPipe } from './list.pipe'; import { LogPriorityPipe } from './log-priority.pipe'; +import { MillisecondsPipe } from './milliseconds.pipe'; import { OrdinalPipe } from './ordinal.pipe'; import { RelativeDatePipe } from './relative-date.pipe'; import { RoundPipe } from './round.pipe'; @@ -20,6 +23,7 @@ import { RoundPipe } from './round.pipe'; imports: [CommonModule], declarations: [ DimlessBinaryPipe, + DimlessBinaryPerSecondPipe, HealthColorPipe, DimlessPipe, CephShortVersionPipe, @@ -32,10 +36,13 @@ import { RoundPipe } from './round.pipe'; EmptyPipe, EncodeUriPipe, RoundPipe, - OrdinalPipe + OrdinalPipe, + MillisecondsPipe, + IopsPipe ], exports: [ DimlessBinaryPipe, + DimlessBinaryPerSecondPipe, HealthColorPipe, DimlessPipe, CephShortVersionPipe, @@ -48,13 +55,16 @@ import { RoundPipe } from './round.pipe'; EmptyPipe, EncodeUriPipe, RoundPipe, - OrdinalPipe + OrdinalPipe, + MillisecondsPipe, + IopsPipe ], providers: [ DatePipe, CephShortVersionPipe, CephReleaseNamePipe, DimlessBinaryPipe, + DimlessBinaryPerSecondPipe, DimlessPipe, RelativeDatePipe, ListPipe, @@ -62,7 +72,9 @@ import { RoundPipe } from './round.pipe'; CdDatePipe, EmptyPipe, EncodeUriPipe, - OrdinalPipe + OrdinalPipe, + IopsPipe, + MillisecondsPipe ] }) export class PipesModule {} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/formatter.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/formatter.service.ts index bb80765d5fd4..51ac884150d0 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/formatter.service.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/formatter.service.ts @@ -32,15 +32,17 @@ export class FormatterService { /** * Convert the given value into bytes. * @param {string} value The value to be converted, e.g. 1024B, 10M, 300KiB or 1ZB. - * @returns Returns the given value in bytes without any appended unit or null in case - * of an error. + * @param error_value The value returned in case the regular expression did not match. Defaults to + * null. + * @returns Returns the given value in bytes without any unit appended or the defined error value + * in case xof an error. */ - toBytes(value: string): number | null { + toBytes(value: string, error_value = null): number | null { const base = 1024; const units = ['b', 'k', 'm', 'g', 't', 'p', 'e', 'z', 'y']; - const m = RegExp('^(\\d+(.\\d+)?) ?([' + units.join('') + '](b|ib)?)?$', 'i').exec(value); + const m = RegExp('^(\\d+(.\\d+)?) ?([' + units.join('') + ']?(b|ib|B/s)?)?$', 'i').exec(value); if (m === null) { - return null; + return error_value; } let bytes = parseFloat(m[1]); if (_.isString(m[3])) { @@ -48,4 +50,32 @@ export class FormatterService { } return Math.round(bytes); } + + /** + * Converts `x ms` to `x` (currently) or `0` if the conversion fails + */ + toMilliseconds(value: string): number { + const pattern = /^\s*(\d+)\s*(ms)?\s*$/i; + const testResult = pattern.exec(value); + + if (testResult !== null) { + return +testResult[1]; + } + + return 0; + } + + /** + * Converts `x IOPS` to `x` (currently) or `0` if the conversion fails + */ + toIops(value: string): number { + const pattern = /^\s*(\d+)\s*(IOPS)?\s*$/i; + const testResult = pattern.exec(value); + + if (testResult !== null) { + return +testResult[1]; + } + + return 0; + } } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.spec.ts new file mode 100644 index 000000000000..3b9c0437aaf9 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.spec.ts @@ -0,0 +1,45 @@ +import { TestBed } from '@angular/core/testing'; + +import { configureTestBed, i18nProviders } from '../../../testing/unit-test-helper'; +import { RbdConfigurationType } from '../models/configuration'; +import { RbdConfigurationService } from './rbd-configuration.service'; + +describe('RbdConfigurationService', () => { + let service: RbdConfigurationService; + + configureTestBed({ + providers: [RbdConfigurationService, i18nProviders] + }); + + beforeEach(() => { + service = TestBed.get(RbdConfigurationService); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); + + it('should filter config options', () => { + const result = service.getOptionByName('rbd_qos_write_iops_burst'); + expect(result).toEqual({ + name: 'rbd_qos_write_iops_burst', + displayName: 'Write IOPS Burst', + description: 'The desired burst limit of write operations.', + type: RbdConfigurationType.iops + }); + }); + + it('should return the display name', () => { + const displayName = service.getDisplayName('rbd_qos_write_iops_burst'); + expect(displayName).toBe('Write IOPS Burst'); + }); + + it('should return the description', () => { + const description = service.getDescription('rbd_qos_write_iops_burst'); + expect(description).toBe('The desired burst limit of write operations.'); + }); + + it('should have a class for each section', () => { + service.sections.forEach((section) => expect(section.class).toBeTruthy()); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.ts new file mode 100644 index 000000000000..cf56d64d87be --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/services/rbd-configuration.service.ts @@ -0,0 +1,147 @@ +import { Injectable } from '@angular/core'; + +import { I18n } from '@ngx-translate/i18n-polyfill'; + +import { + RbdConfigurationExtraField, + RbdConfigurationSection, + RbdConfigurationType +} from '../models/configuration'; +import { ServicesModule } from './services.module'; + +/** + * Define here which options should be made available under which section heading. + * The display name and description needs to be added manually as long as Ceph does not provide + * this information. + */ +@Injectable({ + providedIn: ServicesModule +}) +export class RbdConfigurationService { + readonly sections: RbdConfigurationSection[]; + + constructor(private i18n: I18n) { + this.sections = [ + { + heading: this.i18n('Quality of Service'), + class: 'quality-of-service', + options: [ + { + name: 'rbd_qos_bps_limit', + displayName: this.i18n('BPS Limit'), + description: this.i18n('The desired limit of IO bytes per second.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_iops_limit', + displayName: this.i18n('IOPS Limit'), + description: this.i18n('The desired limit of IO operations per second.'), + type: RbdConfigurationType.iops + }, + { + name: 'rbd_qos_read_bps_limit', + displayName: this.i18n('Read BPS Limit'), + description: this.i18n('The desired limit of read bytes per second.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_read_iops_limit', + displayName: this.i18n('Read IOPS Limit'), + description: this.i18n('The desired limit of read operations per second.'), + type: RbdConfigurationType.iops + }, + { + name: 'rbd_qos_write_bps_limit', + displayName: this.i18n('Write BPS Limit'), + description: this.i18n('The desired limit of write bytes per second.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_write_iops_limit', + displayName: this.i18n('Write IOPS Limit'), + description: this.i18n('The desired limit of write operations per second.'), + type: RbdConfigurationType.iops + }, + { + name: 'rbd_qos_bps_burst', + displayName: this.i18n('BPS Burst'), + description: this.i18n('The desired burst limit of IO bytes.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_iops_burst', + displayName: this.i18n('IOPS Burst'), + description: this.i18n('The desired burst limit of IO operations.'), + type: RbdConfigurationType.iops + }, + { + name: 'rbd_qos_read_bps_burst', + displayName: this.i18n('Read BPS Burst'), + description: this.i18n('The desired burst limit of read bytes.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_read_iops_burst', + displayName: this.i18n('Read IOPS Burst'), + description: this.i18n('The desired burst limit of read operations.'), + type: RbdConfigurationType.iops + }, + { + name: 'rbd_qos_write_bps_burst', + displayName: this.i18n('Write BPS Burst'), + description: this.i18n('The desired burst limit of write bytes.'), + type: RbdConfigurationType.bps + }, + { + name: 'rbd_qos_write_iops_burst', + displayName: this.i18n('Write IOPS Burst'), + description: this.i18n('The desired burst limit of write operations.'), + type: RbdConfigurationType.iops + } + ] as RbdConfigurationExtraField[] + } + ]; + } + + private static getOptionsFromSections(sections: RbdConfigurationSection[]) { + return sections.map((section) => section.options).reduce((a, b) => a.concat(b)); + } + + private filterConfigOptionsByName(configName: string) { + return RbdConfigurationService.getOptionsFromSections(this.sections).filter( + (option) => option.name === configName + ); + } + + private getOptionValueByName(configName: string, fieldName: string, defaultValue = '') { + const configOptions = this.filterConfigOptionsByName(configName); + return configOptions.length === 1 ? configOptions.pop()[fieldName] : defaultValue; + } + + getWritableSections() { + return this.sections.map((section) => { + section.options = section.options.filter((o) => !o.readOnly); + return section; + }); + } + + getOptionFields() { + return RbdConfigurationService.getOptionsFromSections(this.sections); + } + + getWritableOptionFields() { + return RbdConfigurationService.getOptionsFromSections(this.getWritableSections()); + } + + getOptionByName(optionName: string): RbdConfigurationExtraField { + return this.filterConfigOptionsByName(optionName).pop(); + } + + getDisplayName(configName: string): string { + return this.getOptionValueByName(configName, 'displayName'); + } + + getDescription(configName: string): string { + return this.getOptionValueByName(configName, 'description'); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/locale/messages.xlf b/src/pybind/mgr/dashboard/frontend/src/locale/messages.xlf index a6b883cc654e..2464e1c35d9c 100644 --- a/src/pybind/mgr/dashboard/frontend/src/locale/messages.xlf +++ b/src/pybind/mgr/dashboard/frontend/src/locale/messages.xlf @@ -60,6 +60,14 @@ app/core/navigation/navigation/navigation.component.html 78 + + app/ceph/block/rbd-details/rbd-details.component.html + 125 + + + app/ceph/pool/pool-details/pool-details.component.html + 22 + CRUSH map @@ -240,7 +248,7 @@ app/ceph/block/rbd-form/rbd-form.component.html - 303 + 315 app/ceph/cluster/configuration/configuration-form/configuration-form.component.html @@ -252,7 +260,7 @@ app/ceph/pool/pool-form/pool-form.component.html - 443 + 451 app/ceph/rgw/rgw-bucket-form/rgw-bucket-form.component.html @@ -493,19 +501,19 @@ app/ceph/block/rbd-form/rbd-form.component.html - 49 + 51 app/ceph/block/rbd-form/rbd-form.component.html - 91 + 93 app/ceph/block/rbd-form/rbd-form.component.html - 151 + 153 app/ceph/block/rbd-form/rbd-form.component.html - 175 + 177 app/ceph/cluster/osd/osd-recv-speed-modal/osd-recv-speed-modal.component.html @@ -848,7 +856,7 @@ app/ceph/block/rbd-form/rbd-form.component.html - 36 + 38 app/ceph/cluster/configuration/configuration-form/configuration-form.component.html @@ -994,23 +1002,23 @@ {VAR_SELECT, select, editing {Edit} cloning {Clone} copying {Copy} other {Add} } app/ceph/block/rbd-form/rbd-form.component.html - 10 + 11 {VAR_SELECT, select, cloning {Clone from} copying {Copy from} other {Parent} } app/ceph/block/rbd-form/rbd-form.component.html - 20 + 22 Loading... app/ceph/block/rbd-form/rbd-form.component.html - 79 + 81 app/ceph/block/rbd-form/rbd-form.component.html - 139 + 141 app/ceph/nfs/nfs-form/nfs-form.component.html @@ -1062,7 +1070,7 @@ app/ceph/pool/pool-form/pool-form.component.html - 341 + 342 app/ceph/rgw/rgw-bucket-form/rgw-bucket-form.component.html @@ -1072,37 +1080,37 @@ -- No rbd pools available -- app/ceph/block/rbd-form/rbd-form.component.html - 82 + 84 -- Select a pool -- app/ceph/block/rbd-form/rbd-form.component.html - 85 + 87 Use a dedicated data pool app/ceph/block/rbd-form/rbd-form.component.html - 105 + 107 Data pool app/ceph/block/rbd-form/rbd-form.component.html - 116 + 118 Dedicated pool that stores the object-data of the RBD. app/ceph/block/rbd-form/rbd-form.component.html - 120 + 122 -- No data pools available -- app/ceph/block/rbd-form/rbd-form.component.html - 142 + 144 app/ceph/nfs/nfs-form/nfs-form.component.html @@ -1112,7 +1120,7 @@ Size app/ceph/block/rbd-form/rbd-form.component.html - 160 + 162 app/ceph/block/rbd-details/rbd-details.component.html @@ -1122,19 +1130,19 @@ e.g., 10GiB app/ceph/block/rbd-form/rbd-form.component.html - 170 + 172 You have to increase the size. app/ceph/block/rbd-form/rbd-form.component.html - 178 + 180 Features app/ceph/block/rbd-form/rbd-form.component.html - 188 + 190 app/ceph/block/rbd-details/rbd-details.component.html @@ -1144,19 +1152,25 @@ Advanced... app/ceph/block/rbd-form/rbd-form.component.html - 211 + 213 Advanced app/ceph/block/rbd-form/rbd-form.component.html - 217 + 219 + + + Striping + + app/ceph/block/rbd-form/rbd-form.component.html + 222 Object size app/ceph/block/rbd-form/rbd-form.component.html - 224 + 229 app/ceph/block/rbd-details/rbd-details.component.html @@ -1166,49 +1180,55 @@ Stripe unit app/ceph/block/rbd-form/rbd-form.component.html - 241 + 246 -- Select stripe unit -- app/ceph/block/rbd-form/rbd-form.component.html - 252 + 257 This field is required because stripe count is defined! app/ceph/block/rbd-form/rbd-form.component.html - 258 + 263 Stripe unit is greater than object size. app/ceph/block/rbd-form/rbd-form.component.html - 261 + 266 Stripe count app/ceph/block/rbd-form/rbd-form.component.html - 270 + 275 This field is required because stripe unit is defined! app/ceph/block/rbd-form/rbd-form.component.html - 283 + 288 Stripe count must be greater than 0. app/ceph/block/rbd-form/rbd-form.component.html - 286 + 291 + + + RBD + + app/ceph/block/rbd-form/rbd-form.component.html + 310 {VAR_SELECT, select, editing {Update} cloning {Clone} copying {Copy} other {Create} } app/ceph/block/rbd-form/rbd-form.component.html - 298 + 310 Trash @@ -2368,19 +2388,19 @@ Applications app/ceph/pool/pool-form/pool-form.component.html - 290 + 291 Compression app/ceph/pool/pool-form/pool-form.component.html - 308 + 309 Mode app/ceph/pool/pool-form/pool-form.component.html - 314 + 315 app/ceph/block/mirroring/pool-edit-mode-modal/pool-edit-mode-modal.component.html @@ -2390,89 +2410,89 @@ Algorithm app/ceph/pool/pool-form/pool-form.component.html - 333 + 334 -- No erasure compression algorithm available -- app/ceph/pool/pool-form/pool-form.component.html - 344 + 345 Minimum blob size app/ceph/pool/pool-form/pool-form.component.html - 358 + 359 e.g., 128KiB app/ceph/pool/pool-form/pool-form.component.html - 367 + 368 Value should be greater than 0 app/ceph/pool/pool-form/pool-form.component.html - 372 + 373 app/ceph/pool/pool-form/pool-form.component.html - 397 + 398 Value should be greater than the maximum blob size app/ceph/pool/pool-form/pool-form.component.html - 375 + 376 Maximum blob size app/ceph/pool/pool-form/pool-form.component.html - 384 + 385 e.g., 512KiB app/ceph/pool/pool-form/pool-form.component.html - 392 + 393 Value should be greater than the minimum blob size app/ceph/pool/pool-form/pool-form.component.html - 400 + 401 Ratio app/ceph/pool/pool-form/pool-form.component.html - 409 + 410 Compression ratio app/ceph/pool/pool-form/pool-form.component.html - 420 + 421 Value should be between 0.0 and 1.0 app/ceph/pool/pool-form/pool-form.component.html - 423 + 424 pool app/ceph/pool/pool-form/pool-form.component.html - 438 + 446 {VAR_SELECT, select, 1 {Edit} other {Create} } app/ceph/pool/pool-form/pool-form.component.html - 438 + 446 Pools List @@ -3521,6 +3541,54 @@ app/ceph/performance-counter/table-performance-counter/table-performance-counter.component.html 12 + + Global + + app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html + 10 + + + app/ceph/block/rbd-details/rbd-details.component.html + 137 + + + Image + + app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html + 11 + + + app/ceph/block/rbd-details/rbd-details.component.html + 135 + + + Pool + + app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.html + 12 + + + app/ceph/block/rbd-details/rbd-details.component.html + 18 + + + RBD Configuration + + app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html + 2 + + + Remove the local configuration value. The parent configuration value will be inherited and used instead. + + app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html + 60 + + + The mininum value is 0 + + app/ceph/block/rbd-configuration-form/rbd-configuration-form.component.html + 73 + Attributes (OSD map) @@ -3790,12 +3858,6 @@ app/ceph/block/rbd-details/rbd-details.component.html 2 - - Pool - - app/ceph/block/rbd-details/rbd-details.component.html - 18 - Data Pool @@ -3866,6 +3928,18 @@ app/ceph/block/rbd-details/rbd-details.component.html 119 + + This setting overrides the global value + + app/ceph/block/rbd-details/rbd-details.component.html + 135 + + + This is the global value. No value for this option has been set for this image. + + app/ceph/block/rbd-details/rbd-details.component.html + 137 + RBD Snapshot @@ -4141,7 +4215,7 @@ Cache Tiers Details app/ceph/pool/pool-details/pool-details.component.html - 22 + 27 Ranks @@ -4245,29 +4319,6 @@ 1 - - Image - - src/app/ceph/block/iscsi/iscsi.component.ts - 1 - - - src/app/ceph/block/mirroring/image-list/image-list.component.ts - 1 - - - src/app/ceph/block/mirroring/image-list/image-list.component.ts - 1 - - - src/app/ceph/block/mirroring/image-list/image-list.component.ts - 1 - - - src/app/ceph/block/mirroring/pool-edit-mode-modal/pool-edit-mode-modal.component.ts - 1 - - Active/Optimized @@ -4428,6 +4479,24 @@ 1 + + Key + + src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.ts + 1 + + + + Value + + src/app/ceph/block/rbd-configuration-list/rbd-configuration-list.component.ts + 1 + + + src/app/ceph/performance-counter/table-performance-counter/table-performance-counter.component.ts + 1 + + Deep flatten @@ -5426,13 +5495,6 @@ 1 - - Value - - src/app/ceph/performance-counter/table-performance-counter/table-performance-counter.component.ts - 1 - - Cache Mode @@ -6165,6 +6227,181 @@ 1 + + Quality of Service + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + BPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of IO bytes per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + IOPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of IO operations per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Read BPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of read bytes per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Read IOPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of read operations per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Write BPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of write bytes per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Write IOPS Limit + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired limit of write operations per second. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + BPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of IO bytes. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + IOPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of IO operations. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Read BPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of read bytes. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Read IOPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of read operations. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Write BPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of write bytes. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + Write IOPS Burst + + src/app/shared/services/rbd-configuration.service.ts + 1 + + + + The desired burst limit of write operations. + + src/app/shared/services/rbd-configuration.service.ts + 1 + + Failed to diff --git a/src/pybind/mgr/dashboard/frontend/src/styles.scss b/src/pybind/mgr/dashboard/frontend/src/styles.scss index 147374c26324..dfa92f0775b4 100644 --- a/src/pybind/mgr/dashboard/frontend/src/styles.scss +++ b/src/pybind/mgr/dashboard/frontend/src/styles.scss @@ -358,3 +358,20 @@ uib-accordion .panel-title, .block-ui-wrapper { background: $color-transparent-black !important; } + +h3.page-header { + margin-left: 1em; + margin-top: 1em; + border-color: #f0f0f0; +} + +.tooltip-wide .tooltip-inner { + width: 400px; +} + +.tooltip-inner { + background-color: white; + border: 1px solid grey; + color: #333; + font-size: 1.1em; +} diff --git a/src/pybind/mgr/dashboard/services/rbd.py b/src/pybind/mgr/dashboard/services/rbd.py new file mode 100644 index 000000000000..bdc536209ad6 --- /dev/null +++ b/src/pybind/mgr/dashboard/services/rbd.py @@ -0,0 +1,105 @@ +# -*- coding: utf-8 -*- +from __future__ import absolute_import + +import rbd +from .. import mgr + + +class RbdConfiguration(object): + _rbd = rbd.RBD() + + def __init__(self, pool_name='', image_name='', pool_ioctx=None, image_ioctx=None): + # type: (str, str, object, object) -> None + assert bool(pool_name) != bool(pool_ioctx) # xor + self._pool_name = pool_name + self._image_name = image_name + self._pool_ioctx = pool_ioctx + self._image_ioctx = image_ioctx + + @staticmethod + def _ensure_prefix(option): + # type: (str) -> str + return option if option.startswith('conf_') else 'conf_' + option + + def list(self): + # type: () -> [dict] + def _list(ioctx): + if self._image_name: # image config + with rbd.Image(ioctx, self._image_name) as image: + result = image.config_list() + else: # pool config + result = self._rbd.config_list(ioctx) + return list(result) + + if self._pool_name: + ioctx = mgr.rados.open_ioctx(self._pool_name) + else: + ioctx = self._pool_ioctx + + return _list(ioctx) + + def get(self, option_name): + # type: (str) -> str + option_name = self._ensure_prefix(option_name) + with mgr.rados.open_ioctx(self._pool_name) as pool_ioctx: + if self._image_name: + with rbd.Image(pool_ioctx, self._image_name) as image: + return image.metadata_get(option_name) + return self._rbd.pool_metadata_get(pool_ioctx, option_name) + + def set(self, option_name, option_value): + # type: (str, str) -> None + + option_value = str(option_value) + option_name = self._ensure_prefix(option_name) + + pool_ioctx = self._pool_ioctx + if self._pool_name: # open ioctx + pool_ioctx = mgr.rados.open_ioctx(self._pool_name) + pool_ioctx.__enter__() + + image_ioctx = self._image_ioctx + if self._image_name: + image_ioctx = rbd.Image(pool_ioctx, self._image_name) + image_ioctx.__enter__() + + if image_ioctx: + image_ioctx.metadata_set(option_name, option_value) + else: + self._rbd.pool_metadata_set(pool_ioctx, option_name, option_value) + + if self._image_name: # Name provided, so we opened it and now have to close it + image_ioctx.__exit__(None, None, None) + if self._pool_name: + pool_ioctx.__exit__(None, None, None) + + def remove(self, option_name): + """ + Removes an option by name. Will not raise an error, if the option hasn't been found. + :type option_name str + """ + def _remove(ioctx): + try: + if self._image_name: + with rbd.Image(ioctx, self._image_name) as image: + image.metadata_remove(option_name) + else: + self._rbd.pool_metadata_remove(ioctx, option_name) + except KeyError: + pass + + option_name = self._ensure_prefix(option_name) + + if self._pool_name: + with mgr.rados.open_ioctx(self._pool_name) as pool_ioctx: + _remove(pool_ioctx) + else: + _remove(self._pool_ioctx) + + def set_configuration(self, configuration): + if configuration: + for option_name, option_value in configuration.items(): + if option_value is not None: + self.set(option_name, option_value) + else: + self.remove(option_name) diff --git a/src/pybind/mgr/dashboard/tools.py b/src/pybind/mgr/dashboard/tools.py index 4b8f1bfa0c20..7eb23e535b70 100644 --- a/src/pybind/mgr/dashboard/tools.py +++ b/src/pybind/mgr/dashboard/tools.py @@ -876,7 +876,10 @@ def get_request_body_params(request): if content_type in ['application/json', 'text/javascript']: if not hasattr(request, 'json'): raise cherrypy.HTTPError(400, 'Expected JSON body') - params.update(request.json.items()) + if isinstance(request.json, str): + params.update(json.loads(request.json)) + else: + params.update(request.json) return params