Add Cloudian HyperStore Object Storage #9748

tpodowd · 2024-09-30T11:41:55Z

Description

This PR Adds A New Object Storage Provider Plugin for Cloudian HyperStore

Allow the CloudStack administrator to connect to Cloudian HyperStore object storage.
Once connected, CloudStack Accounts can create buckets that are managed by and belong to their own Account.
IAM Credentials are available for each bucket such that Accounts can use the buckets either from 3rd party S3 applications or from the CloudStack Bucket Browser UI Feature.
The plugin supports all the current CloudStack bucket operations such as Object Lock, Versioning, Encryption and policy settings.
The plugin currently does not support setting a bucket quota as HyperStore does not currently support that functionality.
Bucket usage is supported.

More Details:

See plugins/storage/object/cloudian/README.md for details

UI Changes - Add Object Storage for Cloudian HyperStore:

Cloudian HyperStore Object Storage requires more fields than Minio, Ceph and Simulator so when the Cloudian HyperStore provider is selected, the GUI adjusts and offers the extra fields that the provider requires.

Other Bug fixes and improvements as part of this fix I kept in separate commits.

Use a password input field type for object store secret key entry
Fix to avoid pre-pending a second '/' to the object name in the Bucket Browser Feature.
Fix issue where usage may not be collected if another object store is down.
Various fixes and enhancements to CloudianClient

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Unit Testing
Testing against the Cloudian HyperStore system. Tested bad configurations and credentials, system down.
Monitored log entries and sniffed network connections.
Tested the various UI compontents such as Add Object Storage, Edit and Delete Object Storage. Adding buckets with various Accounts and Projects, editing bucket configurations, verifying configurations were set using different S3 exploration tools.
Tested the bucket browser UI component against HyperStore.

How did you try to break this feature and the system with this change?

As this change altered CloudianClient which is shared code with the other cloudian infrastructure plugin, I also re-tested that plugin after these changes.
I also lightly tested with Minio.
This plugin feature shouldn't break other areas of the system.

- Added API to return the version of the HyperStore service - Added API to manage user Root credentials - Added API to return usage information for buckets owned by a group Fixes: - Only disable https certificate validation if using https - Don't log the admin password on error - Update to always throw exception on error instead of sometimes returning empty data. - Fixed empty list cases for list users and list groups - Use an easier to understand exception message for SSL errors - Updated test cases

If there are multiple object stores configured and one of the stores is down or has some other issue returning bucket usage, it can cause usage collection to be skipped on other object stores.

- Previous Behaviour: if uploadDirectory was empty, it was set to '/'. When the object is uploaded the API adds another '/' between the endpoint url and the object name, so an object called 'abc.txt' would be uploaded as '/abc.txt'. The bucket listing is done using a delimiter of '/' which returns the common prefix '/' of the '/abc.txt' object and the object itself is not listed at the top level. - New Behaviour: The object is uploaded as 'abc.txt' if uploadDirectory is empty as would be expected.

- Allow the CloudStack administrator to connect to Cloudian HyperStore object storage. - Once connected, CloudStack Accounts can create buckets that are managed by and belong to their own Account. - IAM Credentials are available for each bucket such that Accounts can use the buckets either from 3rd party S3 applications or from the CloudStack Bucket Browser UI Feature. - The plugin supports all the current CloudStack bucket operations such as Object Lock, Versioning, Encryption and policy settings. - The plugin currently does not support setting a bucket quota as HyperStore does not currently support that functionality. - Bucket usage is supported. More Details: - See plugins/storage/object/cloudian/README.md for details UI Changes - Add Object Storage for Cloudian HyperStore: - Cloudian HyperStore Object Storage requires more fields than Minio, Ceph and Simulator so when the Cloudian HyperStore provider is selected, the GUI adjusts and offers the extra fields that the provider requires.

DaanHoogland · 2024-09-30T14:17:03Z

@blueorangutan package

blueorangutan · 2024-09-30T14:18:04Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2024-09-30T14:25:14Z

Codecov Report

Attention: Patch coverage is 74.67700% with 196 lines in your changes missing coverage. Please review.

Project coverage is 15.88%. Comparing base (2fa1761) to head (f239762).
Report is 28 commits behind head on main.

Files with missing lines	Patch %	Lines
...river/CloudianHyperStoreObjectStoreDriverImpl.java	76.84%	90 Missing and 7 partials ⚠️
...che/cloudstack/cloudian/client/CloudianClient.java	73.84%	28 Missing and 6 partials ⚠️
...le/CloudianHyperStoreObjectStoreLifeCycleImpl.java	58.06%	24 Missing and 2 partials ⚠️
...der/CloudianHyperStoreObjectStoreProviderImpl.java	40.00%	15 Missing ⚠️
...storage/datastore/util/CloudianHyperStoreUtil.java	83.01%	6 Missing and 3 partials ⚠️
...loudstack/storage/object/BucketApiServiceImpl.java	0.00%	8 Missing ⚠️
...cloudstack/cloudian/client/CloudianCredential.java	82.05%	6 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9748      +/-   ##
============================================
+ Coverage     15.78%   15.88%   +0.09%     
- Complexity    12550    12661     +111     
============================================
  Files          5625     5633       +8     
  Lines        491972   492995    +1023     
  Branches      60019    61256    +1237     
============================================
+ Hits          77663    78296     +633     
- Misses       405850   406208     +358     
- Partials       8459     8491      +32

Flag	Coverage Δ
uitests	`4.04% <ø> (+<0.01%)`	⬆️
unittests	`16.70% <74.67%> (+0.10%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

blueorangutan · 2024-09-30T15:20:30Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11244

rohityadavcloud · 2024-10-01T07:19:37Z

Thanks for the PR @tpodowd since we don't have the cloudian system to test against, we'll help with regression testing.

@blueorangutan test

blueorangutan · 2024-10-01T07:20:11Z

@rohityadavcloud a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

tpodowd · 2024-10-01T08:50:21Z

Hi @rohityadavcloud - I updated the PR to fix the README.md lint issue and also added a bit more unit test coverage in the main driver code.

You mentioned the following:

since we don't have the cloudian system to test against, we'll help with regression testing.

Thanks, let me know what information you need and I'll do my best to get back to you.

blueorangutan · 2024-10-01T23:40:21Z

[SF] Trillian test result (tid-11583)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 56540 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9748-t11583-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

tpodowd · 2024-10-02T08:24:07Z

Hi @DaanHoogland - I think I have got the pre-commit stuff nailed now. I ran pre-commit locally and it fixed the end of files for me. Then I reviewed that and pushed commit 40c0366

tpodowd · 2024-10-04T11:57:53Z

Sorry. I was reviewing the beautiful code coverage report and reviewing code I had not tested when I noticed a bad typo that means CloudianClient won't timeout. I have a fix locally and have added unit tests. I am doing a full build and a bit more testing and then I'll push another commit.

- The timeout parameter was using the port so instead of timing out in 10 seconds, it was using 19443 seconds. - Added tests to use real connections instead of mocking and added line tests to try catch other issues. - Noticed that HyperStore and AWS IAM services use return different errorcodes. This will be fixed in HyperStore so handle both errorcodes.

tpodowd · 2024-10-04T13:21:56Z

Ok. Hopefully that is it. I have pre-commit hooked in now also so I know that is clean. Code coverage should be a little better again also.

DaanHoogland · 2024-10-04T15:32:36Z

@blueorangutan package

blueorangutan · 2024-10-04T15:34:03Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-10-04T16:40:47Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11283

tpodowd · 2024-10-06T23:46:31Z

Hi @DaanHoogland / @rohityadavcloud - There seems to be an error in one of the checks. I'm not sure that it is related to my changes though. Let me know if I need to do anything about it. Thanks!

DaanHoogland · 2024-10-07T13:40:43Z

Hi @DaanHoogland / @rohityadavcloud - There seems to be an error in one of the checks. I'm not sure that it is related to my changes though. Let me know if I need to do anything about it. Thanks!

rerunning, let's see. It doesn't seem related to me either.

- The Store details are maintained outside of the plugin so it is best to save them using their original key names.

tpodowd · 2024-10-11T03:27:53Z

I realised that I should not change the key names that the Object Store Details use as they may be read/updated outside of the plugin. Thanks!

DaanHoogland · 2024-10-14T08:13:09Z

@blueorangutan package

blueorangutan · 2024-10-14T08:14:03Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-10-14T09:13:57Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11332

...ntegrations/cloudian/src/main/java/org/apache/cloudstack/cloudian/client/CloudianClient.java

.../org/apache/cloudstack/storage/datastore/driver/CloudianHyperStoreObjectStoreDriverImpl.java

...udian/src/main/java/org/apache/cloudstack/storage/datastore/util/CloudianHyperStoreUtil.java

- error out of getUserBucketUsages() if bucket param is set but userid is not - added unit tests for the same. - split some copy/paste code into a new function - added unit tests for new function which required moving the test to the right package to test a protected function. - use the base class logger - misc tidy ups.

tpodowd · 2024-10-18T07:05:45Z

Hi @JoaoJandre - I have pushed another commit to address your review comments. Thanks for your time and let me know if you have any other concerns or questions.

JoaoJandre · 2024-10-18T11:44:01Z

Hi @JoaoJandre - I have pushed another commit to address your review comments. Thanks for your time and let me know if you have any other concerns or questions.

@tpodowd I did my best with no knowledge of Cloudian 😄 . In any case, overall it looks good to me. There is only one thing (#9748 (comment)) left that I think should be addressed.

- created new deleteIAMCredential() function.

tpodowd · 2024-10-21T03:01:30Z

@tpodowd I did my best with no knowledge of Cloudian 😄 . In any case, overall it looks good to me. There is only one thing (#9748 (comment)) left that I think should be addressed.

Hi @JoaoJandre - No worries. Thank you so much again for your time on this. I have addressed your last comment and have pushed an update.

JoaoJandre

LGTM, did not test it.

DaanHoogland

clgtm, one organisational issue though

DaanHoogland · 2024-10-28T15:01:35Z

plugins/storage/object/cloudian/add_cloudian_hyperstore.png

why would we need this image in the production source? seems more for the documentation.

DaanHoogland · 2024-10-28T15:02:46Z

plugins/storage/object/cloudian/README.md

should this be added to a PR for https://github.com/apache/cloudstack-documentation?

Hi @DaanHoogland. I can certainly move the the png out. Is the README file ok (once I remove the png reference from it)? I was trying to leave a little developer documentation on the plugin. I think we need user documentation separately as you say and the png can go there I guess.

fine, but keep in mind the docs are better viewed than any readme in the code (unless it is really in the code)

Ok. Thanks. I updated the README and deleted the png file.

abh1sar · 2024-11-05T05:31:24Z

Hi @tpodowd,
I understand Cloudian doesn't support per bucket Quota.
Does it support per user quota? Is there a way to configure it from within CloudStack?

cc @rohityadavcloud @sureshanaparti

tpodowd · 2024-11-05T07:51:42Z

Hi @abh1sar - Thanks for your comment/question.

I understand Cloudian doesn't support per bucket Quota.

Yes, Cloudian HyperStore does not currently support a bucket storage quota.

Does it support per user quota?

Yes, Cloudian HyperStore does support per user quota. We have a warning level and a hard limit for storage bytes and we also have some other related settings.

Is there a way to configure it from within CloudStack?

Unfortunately not. There are some issues here:

Although the CloudStack APIs for Object Storage allow setting a quota on a bucket, there is no API framework provided to the plugins to set something on the CloudStack Account level.
On HyperStore, setting a quota on an Account/User is usually something that an administrator would do as it is related to QoS settings (ie protecting the system, rather than protecting the user). I guess a user concerned about potential storage costs might also want to impose a limit on themselves. But, if the administrator for example set the QoS limit to one thing, then the user should not be able to raise it higher or disable it for themselves.

Currently, the administrator would have to login to the HyperStore system and either:

Select the HyperStore group (representing the CloudStack Domain) and set a QoS limit that applies to all users in that group.
Select the HyperStore user (representing the CloudStack Account) and set a QoS limit that only applies to that particular user.

abh1sar · 2024-11-05T08:12:06Z

Thanks @tpodowd for your response.
If we had to implement the functionality to set Account level Quota in cloudstack, how do you think that could be done?
Does the HyperStore plugin has API to do something like that?
I am asking because I am working on a PR which adds resource limits to Object Storage space usage.

tpodowd · 2024-11-05T08:59:37Z

Hi @abh1sar. The current plugin does not have any API support itself for setting Account level QoS (as it only implements the provided plugin APIs). The HyperStore Admin API itself does support setting QoS for a user though so that could be made available to CloudStack if it was implemented in CloudianClient (which is easy enough). If I know more about what you are doing, I guess I can also chip in.

FYI. I have another PR pending this one also which adds the ability to edit the Object Store details.
https://github.com/tpodowd/cloudstack/tree/edit_object_storage

tpodowd added 5 commits September 30, 2024 10:44

Fix issue where usage may not be collected if an object store is down.

c9e6462

If there are multiple object stores configured and one of the stores is down or has some other issue returning bucket usage, it can cause usage collection to be skipped on other object stores.

Use a password input field type for object store secret key entry

528bead

boring-cyborg bot added component:build component:storage component:UI labels Sep 30, 2024

Fix lint issue in README.md and add more unit tests.

ef6fe4d

DaanHoogland added the has-3rdparty-components label Oct 2, 2024

Fix "end-of-file-fixer" errors at the end of 3 files

40c0366

Use original GUI store details key names

33c7a07

- The Store details are maintained outside of the plugin so it is best to save them using their original key names.

JoaoJandre reviewed Oct 17, 2024

View reviewed changes

Fix policy typo where an extra space crept in.

b24f307

Update based on review to replace duplicated code with a function

4a4ad66

- created new deleteIAMCredential() function.

JoaoJandre approved these changes Oct 21, 2024

View reviewed changes

DaanHoogland reviewed Oct 28, 2024

View reviewed changes

Delete the add_cloudian_hyperstore.png file,

f239762

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Cloudian HyperStore Object Storage #9748

Add Cloudian HyperStore Object Storage #9748

tpodowd commented Sep 30, 2024

DaanHoogland commented Sep 30, 2024

blueorangutan commented Sep 30, 2024

codecov bot commented Sep 30, 2024 •

edited

Loading

blueorangutan commented Sep 30, 2024

rohityadavcloud commented Oct 1, 2024

blueorangutan commented Oct 1, 2024

tpodowd commented Oct 1, 2024

blueorangutan commented Oct 1, 2024

tpodowd commented Oct 2, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 4, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

tpodowd commented Oct 6, 2024

DaanHoogland commented Oct 7, 2024

tpodowd commented Oct 11, 2024

DaanHoogland commented Oct 14, 2024

blueorangutan commented Oct 14, 2024

blueorangutan commented Oct 14, 2024

tpodowd commented Oct 18, 2024

JoaoJandre commented Oct 18, 2024

tpodowd commented Oct 21, 2024

JoaoJandre left a comment

DaanHoogland left a comment

DaanHoogland Oct 28, 2024

DaanHoogland Oct 28, 2024

tpodowd Oct 29, 2024

DaanHoogland Oct 29, 2024

tpodowd Oct 30, 2024

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

Add Cloudian HyperStore Object Storage #9748

Are you sure you want to change the base?

Add Cloudian HyperStore Object Storage #9748

Conversation

tpodowd commented Sep 30, 2024

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

DaanHoogland commented Sep 30, 2024

blueorangutan commented Sep 30, 2024

codecov bot commented Sep 30, 2024 • edited Loading

Codecov Report

blueorangutan commented Sep 30, 2024

rohityadavcloud commented Oct 1, 2024

blueorangutan commented Oct 1, 2024

tpodowd commented Oct 1, 2024

blueorangutan commented Oct 1, 2024

tpodowd commented Oct 2, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 4, 2024

DaanHoogland commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

blueorangutan commented Oct 4, 2024

tpodowd commented Oct 6, 2024

DaanHoogland commented Oct 7, 2024

tpodowd commented Oct 11, 2024

DaanHoogland commented Oct 14, 2024

blueorangutan commented Oct 14, 2024

blueorangutan commented Oct 14, 2024

tpodowd commented Oct 18, 2024

JoaoJandre commented Oct 18, 2024

tpodowd commented Oct 21, 2024

JoaoJandre left a comment

Choose a reason for hiding this comment

DaanHoogland left a comment

Choose a reason for hiding this comment

DaanHoogland Oct 28, 2024

Choose a reason for hiding this comment

DaanHoogland Oct 28, 2024

Choose a reason for hiding this comment

tpodowd Oct 29, 2024

Choose a reason for hiding this comment

DaanHoogland Oct 29, 2024

Choose a reason for hiding this comment

tpodowd Oct 30, 2024

Choose a reason for hiding this comment

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

codecov bot commented Sep 30, 2024 •

edited

Loading