-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New API "checkVolume" to check and repair any leaks or issues reported by qemu-img check #8577
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
2a5ca85
Introduced a new API checkVolumeAndRepair that allows users or admins…
harikrishna-patnala af4c422
some fixes
harikrishna-patnala a365b45
Added unit tests
harikrishna-patnala f52c819
addressed review comments
harikrishna-patnala 08d3c06
add repair volume while granting access
harikrishna-patnala 3b5514d
Changed repair parameter to accept both leaks/all
harikrishna-patnala ef1bbdd
Introduced new global setting volume.check.and.repair.before.use to d…
harikrishna-patnala 369e567
Added volume check and repair changes only during VM start and volume…
harikrishna-patnala 6402882
Refactored the names to look similar across the code
harikrishna-patnala 8e4017d
Some code fixes
harikrishna-patnala a5d3999
remove unused code
harikrishna-patnala a109da1
Renamed repair values
harikrishna-patnala d6495c4
Fixed unit tests
harikrishna-patnala 6ff875f
changed version
harikrishna-patnala a143e82
Address review comments
harikrishna-patnala 3dc2dd9
Code refactored
harikrishna-patnala c805940
used volume name in logs
harikrishna-patnala cac4418
Changed the API to Async and the setting scope to storage pool
harikrishna-patnala 0b88d52
Fixed exit value handling with check volume command
harikrishna-patnala 1596d14
Fixed storage scope to the setting
harikrishna-patnala fb1026b
Fix volume format issues
harikrishna-patnala 2dfeece
Refactored the log messages
harikrishna-patnala 30fa612
Fix formatting
harikrishna-patnala File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
api/src/main/java/org/apache/cloudstack/api/command/user/volume/CheckAndRepairVolumeCmd.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| package org.apache.cloudstack.api.command.user.volume; | ||
|
|
||
| import com.cloud.event.EventTypes; | ||
| import com.cloud.exception.InvalidParameterValueException; | ||
| import org.apache.cloudstack.acl.RoleType; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiCommandResourceType; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.BaseAsyncCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ResponseObject.ResponseView; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.VolumeResponse; | ||
| import org.apache.cloudstack.context.CallContext; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import com.cloud.exception.ResourceAllocationException; | ||
| import com.cloud.storage.Volume; | ||
| import com.cloud.user.Account; | ||
| import com.cloud.utils.Pair; | ||
| import com.cloud.utils.StringUtils; | ||
|
|
||
| import java.util.Arrays; | ||
|
|
||
| @APICommand(name = "checkVolume", description = "Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only", responseObject = VolumeResponse.class, entityType = {Volume.class}, | ||
| since = "4.19.1", | ||
| authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User}) | ||
| public class CheckAndRepairVolumeCmd extends BaseAsyncCmd { | ||
| public static final Logger s_logger = Logger.getLogger(CheckAndRepairVolumeCmd.class.getName()); | ||
sureshanaparti marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private static final String s_name = "checkandrepairvolumeresponse"; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| //////////////// API parameters ///////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the volume") | ||
| private Long id; | ||
|
|
||
| @Parameter(name = ApiConstants.REPAIR, type = CommandType.STRING, required = false, description = "parameter to repair the volume, leaks or all are the possible values") | ||
| private String repair; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////////// Accessors /////////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| public enum RepairValues { | ||
| LEAKS, ALL | ||
| } | ||
|
|
||
| public Long getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public String getRepair() { | ||
| if (org.apache.commons.lang3.StringUtils.isNotEmpty(repair)) { | ||
JoaoJandre marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| RepairValues repairType = Enum.valueOf(RepairValues.class, repair.toUpperCase()); | ||
| if (repairType == null) { | ||
| throw new InvalidParameterValueException(String.format("Repair parameter can only take the following values: %s" + Arrays.toString(RepairValues.values()))); | ||
| } | ||
| return repair.toLowerCase(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////// API Implementation/////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| @Override | ||
| public String getCommandName() { | ||
| return s_name; | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| Volume volume = _entityMgr.findById(Volume.class, getId()); | ||
| if (volume != null) { | ||
| return volume.getAccountId(); | ||
| } | ||
|
|
||
| return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are tracked | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventType() { | ||
| return EventTypes.EVENT_VOLUME_CHECK; | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventDescription() { | ||
| return String.format("check and repair operation on volume: %s", this._uuidMgr.getUuid(Volume.class, getId())); | ||
| } | ||
|
|
||
| @Override | ||
| public Long getApiResourceId() { | ||
| return id; | ||
| } | ||
|
|
||
| @Override | ||
| public ApiCommandResourceType getApiResourceType() { | ||
| return ApiCommandResourceType.Volume; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() throws ResourceAllocationException { | ||
| CallContext.current().setEventDetails("Volume Id: " + getId()); | ||
| Pair<String, String> result = _volumeService.checkAndRepairVolume(this); | ||
| Volume volume = _responseGenerator.findVolumeById(getId()); | ||
| if (result != null) { | ||
| VolumeResponse response = _responseGenerator.createVolumeResponse(ResponseView.Full, volume); | ||
| response.setVolumeCheckResult(StringUtils.parseJsonToMap(result.first())); | ||
| if (getRepair() != null) { | ||
| response.setVolumeRepairResult(StringUtils.parseJsonToMap(result.second())); | ||
| } | ||
| response.setResponseName(getCommandName()); | ||
| setResponseObject(response); | ||
| } else { | ||
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to check volume and repair"); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
core/src/main/java/com/cloud/agent/api/storage/CheckAndRepairVolumeAnswer.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| // | ||
|
|
||
| package com.cloud.agent.api.storage; | ||
|
|
||
| import com.cloud.agent.api.Answer; | ||
|
|
||
| public class CheckAndRepairVolumeAnswer extends Answer { | ||
| private String volumeCheckExecutionResult; | ||
| private String volumeRepairExecutionResult; | ||
|
|
||
| protected CheckAndRepairVolumeAnswer() { | ||
| super(); | ||
| } | ||
|
|
||
| public CheckAndRepairVolumeAnswer(CheckAndRepairVolumeCommand cmd, boolean result, String details, String volumeCheckExecutionResult, String volumeRepairedExecutionResult) { | ||
| super(cmd, result, details); | ||
| this.volumeCheckExecutionResult = volumeCheckExecutionResult; | ||
| this.volumeRepairExecutionResult = volumeRepairedExecutionResult; | ||
| } | ||
|
|
||
| public CheckAndRepairVolumeAnswer(CheckAndRepairVolumeCommand cmd, boolean result, String details) { | ||
| super(cmd, result, details); | ||
| } | ||
|
|
||
| public String getVolumeCheckExecutionResult() { | ||
| return volumeCheckExecutionResult; | ||
| } | ||
|
|
||
| public String getVolumeRepairExecutionResult() { | ||
| return volumeRepairExecutionResult; | ||
| } | ||
|
|
||
| public void setVolumeCheckExecutionResult(String volumeCheckExecutionResult) { | ||
| this.volumeCheckExecutionResult = volumeCheckExecutionResult; | ||
| } | ||
|
|
||
| public void setVolumeRepairExecutionResult(String volumeRepairExecutionResult) { | ||
| this.volumeRepairExecutionResult = volumeRepairExecutionResult; | ||
| } | ||
| } |
77 changes: 77 additions & 0 deletions
77
core/src/main/java/com/cloud/agent/api/storage/CheckAndRepairVolumeCommand.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| // | ||
|
|
||
| package com.cloud.agent.api.storage; | ||
|
|
||
| import com.cloud.agent.api.Command; | ||
| import com.cloud.agent.api.LogLevel; | ||
| import com.cloud.agent.api.to.StorageFilerTO; | ||
|
|
||
| import java.util.Arrays; | ||
|
|
||
| public class CheckAndRepairVolumeCommand extends Command { | ||
| private String path; | ||
| private StorageFilerTO pool; | ||
| private String repair; | ||
| @LogLevel(LogLevel.Log4jLevel.Off) | ||
| private byte[] passphrase; | ||
| private String encryptFormat; | ||
|
|
||
| public CheckAndRepairVolumeCommand(String path, StorageFilerTO pool, String repair, byte[] passphrase, String encryptFormat) { | ||
| this.path = path; | ||
| this.pool = pool; | ||
| this.repair = repair; | ||
| this.passphrase = passphrase; | ||
| this.encryptFormat = encryptFormat; | ||
| } | ||
|
|
||
| public String getPath() { | ||
| return path; | ||
| } | ||
|
|
||
| public String getPoolUuid() { | ||
| return pool.getUuid(); | ||
| } | ||
|
|
||
| public StorageFilerTO getPool() { | ||
| return pool; | ||
| } | ||
|
|
||
| public String getRepair() { | ||
| return repair; | ||
| } | ||
|
|
||
| public String getEncryptFormat() { return encryptFormat; } | ||
|
|
||
| public byte[] getPassphrase() { return passphrase; } | ||
|
|
||
| public void clearPassphrase() { | ||
| if (this.passphrase != null) { | ||
| Arrays.fill(this.passphrase, (byte) 0); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public boolean executeInSequence() { | ||
| return false; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.