From d9efaed62e7082ad1a61233515b05b7c15bdc28b Mon Sep 17 00:00:00 2001 From: avanthakkar Date: Thu, 30 Mar 2023 22:48:52 +0530 Subject: [PATCH] mgr/dashboard: add support for editing RGW zonegroup Fixes: https://tracker.ceph.com/issues/59239 Signed-off-by: Avan Thakkar Co-authored-by: Aashish Sharma --- src/pybind/mgr/dashboard/controllers/rgw.py | 15 ++ .../rgw-multisite-details.component.html | 7 +- .../rgw-multisite-details.component.scss | 4 + .../rgw-multisite-details.component.ts | 6 +- ...gw-multisite-zonegroup-form.component.html | 99 +++++++- ...multisite-zonegroup-form.component.spec.ts | 65 ++++++ .../rgw-multisite-zonegroup-form.component.ts | 217 +++++++++++++++--- .../app/shared/api/rgw-zonegroup.service.ts | 27 +++ src/pybind/mgr/dashboard/openapi.yaml | 64 ++++++ .../mgr/dashboard/services/rgw_client.py | 164 ++++++++++++- 10 files changed, 633 insertions(+), 35 deletions(-) diff --git a/src/pybind/mgr/dashboard/controllers/rgw.py b/src/pybind/mgr/dashboard/controllers/rgw.py index def764eceaa08..d061dc579fa7e 100644 --- a/src/pybind/mgr/dashboard/controllers/rgw.py +++ b/src/pybind/mgr/dashboard/controllers/rgw.py @@ -814,6 +814,21 @@ class RgwZonegroup(RESTController): except NoRgwDaemonsException as e: raise DashboardException(e, http_status_code=404, component='rgw') + @allow_empty_body + # pylint: disable=W0613,W0102 + def set(self, zonegroup_name: str, realm_name: str, new_zonegroup_name: str, default: str = '', + master: str = '', zonegroup_endpoints: List[str] = [], add_zones: List[str] = [], + remove_zones: List[str] = [], placement_targets: List[Dict[str, str]] = [], + daemon_name=None): + try: + instance = RgwClient.admin_instance() + result = instance.edit_zonegroup(realm_name, zonegroup_name, new_zonegroup_name, + default, master, zonegroup_endpoints, add_zones, + remove_zones, placement_targets) + return result + except NoRgwDaemonsException as e: + raise DashboardException(e, http_status_code=404, component='rgw') + @APIRouter('/rgw/zone', Scope.RGW) class RgwZone(RESTController): diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.html index 3dcb290c64141..12ae56a2d0742 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.html @@ -34,17 +34,18 @@ *ngIf="node.data.is_default"> default - master
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.scss b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.scss index 423c078066afb..537b53a519ccf 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.scss +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.scss @@ -7,3 +7,7 @@ .align-inline-btns { margin-left: 5em; } + +.btn:disabled { + pointer-events: none; +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.ts index 0a8e598f6e73b..a0edcd95b49aa 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-details/rgw-multisite-details.component.ts @@ -76,6 +76,7 @@ export class RgwMultisiteDetailsComponent implements OnDestroy, OnInit { defaultZoneId = ''; multisiteInfo: object[] = []; defaultsInfo: string[] = []; + title: string = 'Edit'; constructor( private modalService: ModalService, @@ -291,18 +292,21 @@ export class RgwMultisiteDetailsComponent implements OnDestroy, OnInit { } getDisable() { + let isMasterZone = true; if (this.defaultRealmId === '') { return this.messages.noDefaultRealm; } else { - let isMasterZone = true; this.zonegroups.forEach((zgp: any) => { if (_.isEmpty(zgp.master_zone)) { isMasterZone = false; } }); if (!isMasterZone) { + this.title = + 'Please create a master zone for each existing zonegroup to enable this feature'; return this.messages.noMasterZone; } else { + this.title = 'Edit'; return false; } } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.html index adcadde8775ee..b3848052b5b0d 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.html @@ -52,7 +52,10 @@ type="checkbox">
+ i18n>Default + + Zonegroup doesn't belong to the default realm. +
+ + Multiple master zonegroups can't be configured. If you want to create a new zonegroup and make it the master zonegroup, you must delete the default zonegroup. +
@@ -89,6 +95,97 @@ i18n>Please enter a valid IP address. +
+ +
+ +
+ Cannot remove master zone. +
+
+
+ Placement targets + +
+
+
+ {{ (index + 1) | ordinal }} + × +
+ +
+ +
+ +
+ + + This field is required. + +
+
+ + +
+ +
+ +
+
+ + +
+ +
+ +
+
+
+
+
+ + +
{ let component: RgwMultisiteZonegroupFormComponent; let fixture: ComponentFixture; + let rgwZonegroupService: RgwZonegroupService; beforeEach(async () => { await TestBed.configureTestingModule({ @@ -35,4 +42,62 @@ describe('RgwMultisiteZonegroupFormComponent', () => { it('should create', () => { expect(component).toBeTruthy(); }); + + describe('submit form', () => { + let notificationService: NotificationService; + + beforeEach(() => { + spyOn(TestBed.inject(Router), 'navigate').and.stub(); + notificationService = TestBed.inject(NotificationService); + spyOn(notificationService, 'show'); + rgwZonegroupService = TestBed.inject(RgwZonegroupService); + }); + + it('should validate name', () => { + component.action = 'create'; + component.createForm(); + const control = component.multisiteZonegroupForm.get('zonegroupName'); + expect(_.isFunction(control.validator)).toBeTruthy(); + }); + + it('should not validate name', () => { + component.action = 'edit'; + component.createForm(); + const control = component.multisiteZonegroupForm.get('zonegroupName'); + expect(control.asyncValidator).toBeNull(); + }); + + it('tests create success notification', () => { + spyOn(rgwZonegroupService, 'create').and.returnValue(observableOf([])); + component.action = 'create'; + component.multisiteZonegroupForm.markAsDirty(); + component.multisiteZonegroupForm._get('zonegroupName').setValue('zg-1'); + component.multisiteZonegroupForm + ._get('zonegroup_endpoints') + .setValue('http://192.1.1.1:8004'); + component.submit(); + expect(notificationService.show).toHaveBeenCalledWith( + NotificationType.success, + "Zonegroup: 'zg-1' created successfully" + ); + }); + + it('tests update success notification', () => { + spyOn(rgwZonegroupService, 'update').and.returnValue(observableOf([])); + component.action = 'edit'; + component.info = { + data: { name: 'zg-1', zones: ['z1'] } + }; + component.multisiteZonegroupForm._get('zonegroupName').setValue('zg-1'); + component.multisiteZonegroupForm + ._get('zonegroup_endpoints') + .setValue('http://192.1.1.1:8004,http://192.12.12.12:8004'); + component.multisiteZonegroupForm.markAsDirty(); + component.submit(); + expect(notificationService.show).toHaveBeenCalledWith( + NotificationType.success, + "Zonegroup: 'zg-1' updated successfully" + ); + }); + }); }); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.ts index c36c636ce305b..2172a301e2cad 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/rgw/rgw-multisite-zonegroup-form/rgw-multisite-zonegroup-form.component.ts @@ -1,5 +1,5 @@ import { Component, OnInit } from '@angular/core'; -import { FormControl, Validators } from '@angular/forms'; +import { FormArray, FormBuilder, FormControl, NgForm, Validators } from '@angular/forms'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import _ from 'lodash'; import { RgwZonegroupService } from '~/app/shared/api/rgw-zonegroup.service'; @@ -8,7 +8,9 @@ import { NotificationType } from '~/app/shared/enum/notification-type.enum'; import { CdFormGroup } from '~/app/shared/forms/cd-form-group'; import { CdValidators } from '~/app/shared/forms/cd-validators'; import { NotificationService } from '~/app/shared/services/notification.service'; -import { RgwRealm, RgwZonegroup } from '../models/rgw-multisite'; +import { RgwRealm, RgwZone, RgwZonegroup } from '../models/rgw-multisite'; +import { Icons } from '~/app/shared/enum/icons.enum'; +import { SelectOption } from '~/app/shared/components/select/select-option.model'; @Component({ selector: 'cd-rgw-multisite-zonegroup-form', @@ -20,23 +22,39 @@ export class RgwMultisiteZonegroupFormComponent implements OnInit { readonly ipv4Rgx = /^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/i; readonly ipv6Rgx = /^(?:[a-f0-9]{1,4}:){7}[a-f0-9]{1,4}$/i; action: string; + icons = Icons; multisiteZonegroupForm: CdFormGroup; editing = false; resource: string; realm: RgwRealm; zonegroup: RgwZonegroup; + info: any; defaultsInfo: string[] = []; multisiteInfo: object[] = []; realmList: RgwRealm[] = []; zonegroupList: RgwZonegroup[] = []; zonegroupNames: string[]; isMaster = false; + placementTargets: FormArray; + newZonegroupName: string; + zonegroupZoneNames: string[]; + labelsOption: Array = []; + zoneList: RgwZone[] = []; + allZoneNames: string[]; + zgZoneNames: string[]; + zgZoneIds: string[]; + removedZones: string[]; + isRemoveMasterZone = false; + addedZones: string[]; + disableDefault = false; + disableMaster = false; constructor( public activeModal: NgbActiveModal, public actionLabels: ActionLabelsI18n, public rgwZonegroupService: RgwZonegroupService, - public notificationService: NotificationService + public notificationService: NotificationService, + private formBuilder: FormBuilder ) { this.action = this.editing ? this.actionLabels.EDIT + this.resource @@ -51,7 +69,11 @@ export class RgwMultisiteZonegroupFormComponent implements OnInit { validators: [ Validators.required, CdValidators.custom('uniqueName', (zonegroupName: string) => { - return this.zonegroupNames && this.zonegroupNames.indexOf(zonegroupName) !== -1; + return ( + this.action === 'create' && + this.zonegroupNames && + this.zonegroupNames.indexOf(zonegroupName) !== -1 + ); }) ] }), @@ -79,11 +101,17 @@ export class RgwMultisiteZonegroupFormComponent implements OnInit { } }), Validators.required - ]) + ]), + placementTargets: this.formBuilder.array([]) }); } ngOnInit(): void { + _.forEach(this.multisiteZonegroupForm.get('placementTargets'), (placementTarget) => { + const fg = this.addPlacementTarget(); + fg.patchValue(placementTarget); + }); + this.placementTargets = this.multisiteZonegroupForm.get('placementTargets') as FormArray; this.realmList = this.multisiteInfo[0] !== undefined && this.multisiteInfo[0].hasOwnProperty('realms') ? this.multisiteInfo[0]['realms'] @@ -93,49 +121,150 @@ export class RgwMultisiteZonegroupFormComponent implements OnInit { ? this.multisiteInfo[1]['zonegroups'] : []; this.zonegroupList.forEach((zgp: any) => { - if ( - zgp.is_master === true && - !_.isEmpty(zgp.realm_id) && - zgp.realm_id === this.defaultsInfo['defaultRealmName'] - ) { + if (zgp.is_master === true && !_.isEmpty(zgp.realm_id)) { this.isMaster = true; + this.disableMaster = true; } }); if (!this.isMaster) { this.multisiteZonegroupForm.get('master_zonegroup').setValue(true); this.multisiteZonegroupForm.get('master_zonegroup').disable(); } + this.zoneList = + this.multisiteInfo[2] !== undefined && this.multisiteInfo[2].hasOwnProperty('zones') + ? this.multisiteInfo[2]['zones'] + : []; this.zonegroupNames = this.zonegroupList.map((zonegroup) => { return zonegroup['name']; }); + this.allZoneNames = this.zoneList.map((zone: RgwZone) => { + return zone['name']; + }); if (this.action === 'create' && this.defaultsInfo['defaultRealmName'] !== null) { this.multisiteZonegroupForm .get('selectedRealm') .setValue(this.defaultsInfo['defaultRealmName']); + if (this.disableMaster) { + this.multisiteZonegroupForm.get('master_zonegroup').disable(); + } + } + if (this.action === 'edit') { + this.multisiteZonegroupForm.get('zonegroupName').setValue(this.info.data.name); + this.multisiteZonegroupForm.get('selectedRealm').setValue(this.info.data.parent); + this.multisiteZonegroupForm.get('default_zonegroup').setValue(this.info.data.is_default); + this.multisiteZonegroupForm.get('master_zonegroup').setValue(this.info.data.is_master); + this.multisiteZonegroupForm.get('zonegroup_endpoints').setValue(this.info.data.endpoints); + + if (this.info.data.is_default) { + this.multisiteZonegroupForm.get('default_zonegroup').disable(); + } + if ( + !this.info.data.is_default && + this.multisiteZonegroupForm.getValue('selectedRealm') !== + this.defaultsInfo['defaultRealmName'] + ) { + this.multisiteZonegroupForm.get('default_zonegroup').disable(); + this.disableDefault = true; + } + if (this.info.data.is_master || this.disableMaster) { + this.multisiteZonegroupForm.get('master_zonegroup').disable(); + } + + this.zonegroupZoneNames = this.info.data.zones.map((zone: { [x: string]: any }) => { + return zone['name']; + }); + this.zgZoneNames = this.info.data.zones.map((zone: { [x: string]: any }) => { + return zone['name']; + }); + this.zgZoneIds = this.info.data.zones.map((zone: { [x: string]: any }) => { + return zone['id']; + }); + const uniqueZones = new Set(this.allZoneNames); + this.labelsOption = Array.from(uniqueZones).map((zone) => { + return { enabled: true, name: zone, selected: false, description: null }; + }); + + this.info.data.placement_targets.forEach((target: object) => { + const fg = this.addPlacementTarget(); + let data = { + placement_id: target['name'], + tags: target['tags'].join(','), + storage_class: + typeof target['storage_classes'] === 'string' + ? target['storage_classes'] + : target['storage_classes'].join(',') + }; + fg.patchValue(data); + }); } } submit() { - const values = this.multisiteZonegroupForm.value; - this.realm = new RgwRealm(); - this.realm.name = values['selectedRealm']; - this.zonegroup = new RgwZonegroup(); - this.zonegroup.name = values['zonegroupName']; - this.zonegroup.endpoints = this.checkUrlArray(values['zonegroup_endpoints']); - this.rgwZonegroupService - .create(this.realm, this.zonegroup, values['default_zonegroup'], values['master_zonegroup']) - .subscribe( - () => { - this.notificationService.show( - NotificationType.success, - $localize`Zonegroup: '${values['zonegroupName']}' created successfully` - ); - this.activeModal.close(); - }, - () => { - this.multisiteZonegroupForm.setErrors({ cdSubmitButton: true }); - } + const values = this.multisiteZonegroupForm.getRawValue(); + if (this.action === 'create') { + this.realm = new RgwRealm(); + this.realm.name = values['selectedRealm']; + this.zonegroup = new RgwZonegroup(); + this.zonegroup.name = values['zonegroupName']; + this.zonegroup.endpoints = this.checkUrlArray(values['zonegroup_endpoints']); + this.rgwZonegroupService + .create(this.realm, this.zonegroup, values['default_zonegroup'], values['master_zonegroup']) + .subscribe( + () => { + this.notificationService.show( + NotificationType.success, + $localize`Zonegroup: '${values['zonegroupName']}' created successfully` + ); + this.activeModal.close(); + }, + () => { + this.multisiteZonegroupForm.setErrors({ cdSubmitButton: true }); + } + ); + } else if (this.action === 'edit') { + this.removedZones = _.difference(this.zgZoneNames, this.zonegroupZoneNames); + const masterZoneName = this.info.data.zones.filter( + (zone: any) => zone.id === this.info.data.master_zone ); + this.isRemoveMasterZone = this.removedZones.includes(masterZoneName[0].name); + if (this.isRemoveMasterZone) { + this.multisiteZonegroupForm.setErrors({ cdSubmitButton: true }); + return; + } + this.addedZones = _.difference(this.zonegroupZoneNames, this.zgZoneNames); + this.realm = new RgwRealm(); + this.realm.name = values['selectedRealm']; + this.zonegroup = new RgwZonegroup(); + this.zonegroup.name = this.info.data.name; + this.newZonegroupName = values['zonegroupName']; + this.zonegroup.endpoints = + values['zonegroup_endpoints'] === this.info.data.endpoints + ? values['zonegroup_endpoints'] + : this.checkUrlArray(values['zonegroup_endpoints']); + this.zonegroup.placement_targets = values['placementTargets']; + this.rgwZonegroupService + .update( + this.realm, + this.zonegroup, + this.newZonegroupName, + values['default_zonegroup'], + values['master_zonegroup'], + this.removedZones, + this.addedZones + ) + .subscribe( + () => { + this.notificationService.show( + NotificationType.success, + $localize`Zonegroup: '${values['zonegroupName']}' updated successfully` + ); + this.activeModal.close(); + }, + () => { + this.multisiteZonegroupForm.setErrors({ cdSubmitButton: true }); + } + ); + } } checkUrlArray(endpoints: string) { @@ -147,4 +276,34 @@ export class RgwMultisiteZonegroupFormComponent implements OnInit { } return endpointsArray; } + + addPlacementTarget() { + this.placementTargets = this.multisiteZonegroupForm.get('placementTargets') as FormArray; + const fg = new CdFormGroup({ + placement_id: new FormControl('', { + validators: [Validators.required] + }), + tags: new FormControl(''), + storage_class: new FormControl([]) + }); + this.placementTargets.push(fg); + return fg; + } + + trackByFn(index: number) { + return index; + } + + removePlacementTarget(index: number) { + this.placementTargets = this.multisiteZonegroupForm.get('placementTargets') as FormArray; + this.placementTargets.removeAt(index); + } + + showError(index: number, control: string, formDir: NgForm, x: string) { + return (this.multisiteZonegroupForm.controls.placementTargets).controls[index].showError( + control, + formDir, + x + ); + } } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-zonegroup.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-zonegroup.service.ts index c8bec73383747..bb54606c2fef0 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-zonegroup.service.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/rgw-zonegroup.service.ts @@ -26,6 +26,31 @@ export class RgwZonegroupService { }); } + update( + realm: RgwRealm, + zonegroup: RgwZonegroup, + newZonegroupName: string, + defaultZonegroup: boolean, + master: boolean, + removedZones: string[], + addedZones: string[] + ) { + return this.rgwDaemonService.request((requestBody: any) => { + requestBody = { + zonegroup_name: zonegroup.name, + realm_name: realm.name, + new_zonegroup_name: newZonegroupName, + default: defaultZonegroup, + master: master, + zonegroup_endpoints: zonegroup.endpoints, + placement_targets: zonegroup.placement_targets, + remove_zones: removedZones, + add_zones: addedZones + }; + return this.http.put(`${this.url}/${zonegroup.name}`, requestBody); + }); + } + list(): Observable { return this.rgwDaemonService.request(() => { return this.http.get(`${this.url}`); @@ -66,6 +91,8 @@ export class RgwZonegroupService { nodes['type'] = 'zonegroup'; nodes['endpoints'] = zonegroup.endpoints; nodes['master_zone'] = zonegroup.master_zone; + nodes['zones'] = zonegroup.zones; + nodes['placement_targets'] = zonegroup.placement_targets; return nodes; } } diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml index dfb30d3a309b1..df4159e7ea17a 100644 --- a/src/pybind/mgr/dashboard/openapi.yaml +++ b/src/pybind/mgr/dashboard/openapi.yaml @@ -9455,6 +9455,70 @@ paths: - jwt: [] tags: - RgwZonegroup + put: + parameters: + - in: path + name: zonegroup_name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + add_zones: + default: [] + type: string + daemon_name: + type: string + default: + default: '' + type: string + master: + default: '' + type: string + new_zonegroup_name: + type: string + placement_targets: + default: [] + type: string + realm_name: + type: string + remove_zones: + default: [] + type: string + zonegroup_endpoints: + default: [] + type: string + required: + - realm_name + - new_zonegroup_name + type: object + responses: + '200': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Resource updated. + '202': + content: + application/vnd.ceph.api.v1.0+json: + type: object + description: Operation is still executing. Please check the task queue. + '400': + description: Operation exception. Please check the response body for details. + '401': + description: Unauthenticated access. Please login first. + '403': + description: Unauthorized access. Please check your permissions. + '500': + description: Unexpected error. Please check the response body for the stack + trace. + security: + - jwt: [] + tags: + - RgwZonegroup /api/role: get: parameters: [] diff --git a/src/pybind/mgr/dashboard/services/rgw_client.py b/src/pybind/mgr/dashboard/services/rgw_client.py index 09719af20acfd..fe432f079c3ca 100644 --- a/src/pybind/mgr/dashboard/services/rgw_client.py +++ b/src/pybind/mgr/dashboard/services/rgw_client.py @@ -667,7 +667,7 @@ class RgwClient(RestClient): exit_code, _, err = mgr.send_rgwadmin_command(rgw_update_period_cmd) if exit_code > 0: raise DashboardException(e=err, msg='Unable to update period', - http_status_code=400, component='rgw') + http_status_code=500, component='rgw') except SubprocessError as error: raise DashboardException(error, http_status_code=500, component='rgw') @@ -721,6 +721,168 @@ class RgwClient(RestClient): raise DashboardException(error, http_status_code=500, component='rgw') return out + def modify_zonegroup(self, realm_name: str, zonegroup_name: str, default: str, master: str, + endpoints: List[str]): + if realm_name: + rgw_zonegroup_modify_cmd = ['zonegroup', 'modify', + '--rgw-realm', realm_name, + '--rgw-zonegroup', zonegroup_name] + if endpoints: + if len(endpoints) > 1: + endpoint = ','.join(str(e) for e in endpoints) + else: + endpoint = endpoints[0] + rgw_zonegroup_modify_cmd.append('--endpoints') + rgw_zonegroup_modify_cmd.append(endpoint) + if master and str_to_bool(master): + rgw_zonegroup_modify_cmd.append('--master') + if default and str_to_bool(default): + rgw_zonegroup_modify_cmd.append('--default') + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_zonegroup_modify_cmd) + if exit_code > 0: + raise DashboardException(e=err, msg='Unable to modify zonegroup {}'.format(zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + + def add_or_remove_zone(self, zonegroup_name: str, zone_name: str, action: str): + if action == 'add': + rgw_zonegroup_add_zone_cmd = ['zonegroup', 'add', '--rgw-zonegroup', + zonegroup_name, '--rgw-zone', zone_name] + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_zonegroup_add_zone_cmd) + if exit_code > 0: + raise DashboardException(e=err, msg='Unable to add zone {} to zonegroup {}'.format(zone_name, zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + if action == 'remove': + rgw_zonegroup_rm_zone_cmd = ['zonegroup', 'remove', + '--rgw-zonegroup', zonegroup_name, '--rgw-zone', zone_name] + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_zonegroup_rm_zone_cmd) + if exit_code > 0: + raise DashboardException(e=err, msg='Unable to remove zone {} from zonegroup {}'.format(zone_name, zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + + def get_placement_targets_by_zonegroup(self, zonegroup_name: str): + rgw_get_placement_cmd = ['zonegroup', 'placement', + 'list', '--rgw-zonegroup', zonegroup_name] + try: + exit_code, out, err = mgr.send_rgwadmin_command(rgw_get_placement_cmd) + if exit_code > 0: + raise DashboardException(e=err, msg='Unable to get placement targets', + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + return out + + def add_placement_targets(self, zonegroup_name: str, placement_targets: List[Dict]): + rgw_add_placement_cmd = ['zonegroup', 'placement', 'add'] + for placement_target in placement_targets: + cmd_add_placement_options = ['--rgw-zonegroup', zonegroup_name, + '--placement-id', placement_target['placement_id']] + if placement_target['tags']: + cmd_add_placement_options += ['--tags', placement_target['tags']] + rgw_add_placement_cmd += cmd_add_placement_options + storage_classes = placement_target['storage_class'].split(",") if placement_target['storage_class'] else [] # noqa E501 #pylint: disable=line-too-long + if storage_classes: + for sc in storage_classes: + cmd_add_placement_options = ['--storage-class', sc] + try: + exit_code, _, err = mgr.send_rgwadmin_command( + rgw_add_placement_cmd + cmd_add_placement_options) + if exit_code > 0: + raise DashboardException(e=err, + msg='Unable to add placement target {} to zonegroup {}'.format(placement_target['placement_id'], zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + return + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_add_placement_cmd) + if exit_code > 0: + raise DashboardException(e=err, + msg='Unable to add placement target {} to zonegroup {}'.format(placement_target['placement_id'], zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + + def modify_placement_targets(self, zonegroup_name: str, placement_targets: List[Dict]): + rgw_add_placement_cmd = ['zonegroup', 'placement', 'modify'] + for placement_target in placement_targets: + cmd_add_placement_options = ['--rgw-zonegroup', zonegroup_name, + '--placement-id', placement_target['placement_id']] + if placement_target['tags']: + cmd_add_placement_options += ['--tags', placement_target['tags']] + rgw_add_placement_cmd += cmd_add_placement_options + storage_classes = placement_target['storage_class'].split(",") if placement_target['storage_class'] else [] # noqa E501 #pylint: disable=line-too-long + if storage_classes: + for sc in storage_classes: + cmd_add_placement_options = [] + cmd_add_placement_options = ['--storage-class', sc] + try: + exit_code, _, err = mgr.send_rgwadmin_command( + rgw_add_placement_cmd + cmd_add_placement_options) + if exit_code > 0: + raise DashboardException(e=err, + msg='Unable to add placement target {} to zonegroup {}'.format(placement_target['placement_id'], zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + else: + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_add_placement_cmd) + if exit_code > 0: + raise DashboardException(e=err, + msg='Unable to add placement target {} to zonegroup {}'.format(placement_target['placement_id'], zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + + # pylint: disable=W0102 + def edit_zonegroup(self, realm_name: str, zonegroup_name: str, new_zonegroup_name: str, + default: str = '', master: str = '', endpoints: List[str] = [], + add_zones: List[str] = [], remove_zones: List[str] = [], + placement_targets: List[Dict[str, str]] = []): + rgw_zonegroup_edit_cmd = [] + if new_zonegroup_name != zonegroup_name: + rgw_zonegroup_edit_cmd = ['zonegroup', 'rename', '--rgw-zonegroup', zonegroup_name, + '--zonegroup-new-name', new_zonegroup_name] + try: + exit_code, _, err = mgr.send_rgwadmin_command(rgw_zonegroup_edit_cmd, False) + if exit_code > 0: + raise DashboardException(e=err, msg='Unable to rename zonegroup to {}'.format(new_zonegroup_name), # noqa E501 #pylint: disable=line-too-long + http_status_code=500, component='rgw') + except SubprocessError as error: + raise DashboardException(error, http_status_code=500, component='rgw') + self.update_period() + self.modify_zonegroup(realm_name, new_zonegroup_name, default, master, endpoints) + if add_zones: + for zone_name in add_zones: + self.add_or_remove_zone(new_zonegroup_name, zone_name, 'add') + if remove_zones: + for zone_name in remove_zones: + self.add_or_remove_zone(new_zonegroup_name, zone_name, 'remove') + existing_placement_targets = self.get_placement_targets_by_zonegroup(new_zonegroup_name) + existing_placement_targets_ids = [pt['key'] for pt in existing_placement_targets] + if placement_targets: + for pt in placement_targets: + if pt['placement_id'] in existing_placement_targets_ids: + self.modify_placement_targets(new_zonegroup_name, placement_targets) + else: + self.add_placement_targets(new_zonegroup_name, placement_targets) + def list_zonegroups(self): rgw_zonegroup_list = {} rgw_zonegroup_list_cmd = ['zonegroup', 'list'] -- 2.47.3