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.

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.00%. Comparing base (864751d) to head (f2a0120).

❗ There is a different number of reports uploaded between BASE (864751d) and HEAD (f2a0120). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (864751d) HEAD (f2a0120)

unittests 1 0

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #9748       +/-   ##
============================================
- Coverage     16.15%   4.00%   -12.16%     
============================================
  Files          5666     396     -5270     
  Lines        497960   32527   -465433     
  Branches      60241    5760    -54481     
============================================
- Hits          80459    1302    -79157     
+ Misses       408499   31075   -377424     
+ Partials       9002     150     -8852

Flag	Coverage Δ
uitests	`4.00% <ø> (-0.01%)`	⬇️
unittests	`?`

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.

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

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.

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.

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!

...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

plugins/storage/object/cloudian/add_cloudian_hyperstore.png

plugins/storage/object/cloudian/README.md

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 · 2025-02-17T02:09:37Z

Hi @DaanHoogland @rohityadavcloud - Any update on when this PR is likely to be merged?

abh1sar · 2025-02-17T09:19:52Z

Hi @tpodowd ,
Please sync with the latest code and test bucket creation. The quota field in create bucket api has been made mandatory since #10017 to support Object Storage Limits per Account/Project and Domain.
Happy to discuss further if needed.

tpodowd · 2025-02-18T02:20:20Z

Hi @abh1sar, ok. I will allocate some time to look at this in the coming days. As I mentioned before, we don't have a bucket level quota setting. We do have a User level QoS setting. I think the only thing that I can do currently is to set the User (that owns the bucket) QoS settings to the limit specified in the create bucket request. An example might be as below:

Bucket B1 created for User A with a quota of 5GB.
Plugin adjusts the HyperStore user A's quota to 5GB
Bucket B2 created for User A with a quota of 5GB.
Plugin keeps HyperStore user A's quota at 5GB (updates CS DB quotas for B1,B2 to 5GB to match)
Bucket B3 created for User A with a quota of 3GB.
Plugin reduces HyperStore user A's quota to 3GB (updates CS DB quotas for B1,B2,B3 to 3GB to match)
Bucket B2's quota is adjusted to 10GB
Plugin expands HyperStore user A's quota to 10GB (updates CS DB quotas for B1,B2,B3 to 10GB to match)

When any adjustment happens to the user's quota, all of the HyperStore buckets owned by that account need to get their quota settings updated in the DB to correctly represent the latest user's quota setting.

This is currently all we can do I think. If we document it, it should not be too hard to understand for the admin.

Does this sounds ok? I think plugin wise, the plugin currently does not update information about different bucket(s) when processing a request for a certain bucket, so I will need to figure out how best to do that. I do think it is easier for the administrator to understand the implementation and understand what the quota is set to though if it is done this way.

DaanHoogland · 2025-02-18T08:10:06Z

@blueorangutan package

blueorangutan · 2025-02-18T08:12: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 · 2025-02-18T08:14:22Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12496

DaanHoogland · 2025-02-18T08:35:59Z

@tpodowd , it seems there is some dependency error on debian:

09:14:14 [ERROR] [ERROR] Some problems were encountered while processing the POMs:
09:14:14 [FATAL] Non-resolvable parent POM for org.apache.cloudstack:cloud-plugin-storage-object-cloudian:4.20.0.0-SNAPSHOT: Could not find artifact org.apache.cloudstack:cloudstack-plugins:pom:4.20.0.0-SNAPSHOT and 'parent.relativePath' points at wrong local POM @ line 24, column 13

and in the github action:

Error: ] Some problems were encountered while processing the POMs:
[FATAL] Non-resolvable parent POM for org.apache.cloudstack:cloud-plugin-storage-object-cloudian:4.20.0.0-SNAPSHOT: The following artifacts could not be resolved: org.apache.cloudstack:cloudstack-plugins:pom:4.20.0.0-SNAPSHOT (absent): Could not find artifact org.apache.cloudstack:cloudstack-plugins:pom:4.20.0.0-SNAPSHOT and 'parent.relativePath' points at wrong local POM @ line 24, column 13

I must say I can not find it (yet)

shwstppr · 2025-02-18T10:17:15Z

plugins/storage/object/cloudian/pom.xml

+    <parent>
+        <groupId>org.apache.cloudstack</groupId>
+        <artifactId>cloudstack-plugins</artifactId>
+        <version>4.20.0.0-SNAPSHOT</version>


Suggested change

<version>4.20.0.0-SNAPSHOT</version>

<version>4.21.0.0-SNAPSHOT</version>

tpodowd · 2025-02-19T02:07:20Z

Hi @DaanHoogland - please ignore this PR for the moment. I'm going to look at the plugin again with the new information that @abh1sar has provided regarding the quota being required. I'll fix the build issue before I push anything to the branch.

@abh1sar - can you check my reply above also regarding how I think we might handle this? Thanks @shwstppr for pointing out the issue with the pom versions.

tpodowd · 2025-02-19T06:16:07Z

I got my local build working again and confirmed that indeed we cannot add buckets currently as quota is now a requirement and create bucket fails with:

Failed to create bucket with name: testbucket com.cloud.utils.exception.CloudRuntimeException: This bucket does not support quotas.

This is because the Cloudian plugin as written does not implement bucket quota and fails the request. I need to figure out an approach for this. I guess there are two approaches:

The plugin ignores the quota and creates the bucket regardless.
We implement the user quota that I mentioned in an earlier comment.

I am guessing that option 1 is not really an option and I need to implement option 2? Let me know if I am wrong about that.

abh1sar · 2025-02-19T08:41:20Z

Hi @abh1sar, ok. I will allocate some time to look at this in the coming days. As I mentioned before, we don't have a bucket level quota setting. We do have a User level QoS setting. I think the only thing that I can do currently is to set the User (that owns the bucket) QoS settings to the limit specified in the create bucket request. An example might be as below:

Bucket B1 created for User A with a quota of 5GB.

Plugin adjusts the HyperStore user A's quota to 5GB

Bucket B2 created for User A with a quota of 5GB.

Plugin keeps HyperStore user A's quota at 5GB (updates CS DB quotas for B1,B2 to 5GB to match)

Bucket B3 created for User A with a quota of 3GB.

Plugin reduces HyperStore user A's quota to 3GB (updates CS DB quotas for B1,B2,B3 to 3GB to match)

Bucket B2's quota is adjusted to 10GB

Plugin expands HyperStore user A's quota to 10GB (updates CS DB quotas for B1,B2,B3 to 10GB to match)

When any adjustment happens to the user's quota, all of the HyperStore buckets owned by that account need to get their quota settings updated in the DB to correctly represent the latest user's quota setting.

This is currently all we can do I think. If we document it, it should not be too hard to understand for the admin.

Does this sounds ok? I think plugin wise, the plugin currently does not update information about different bucket(s) when processing a request for a certain bucket, so I will need to figure out how best to do that. I do think it is easier for the administrator to understand the implementation and understand what the quota is set to though if it is done this way.

Hi @tpodowd
There could be another approach : if the user has 3 buckets of size 5GB, 10GB and 3GB, we keep the quota in CS DB as 5, 10 and 3 respectively. On the plugin side we can set the total user quota to be the sum of all quotas i.e. 18GB. So, the plugin needs to increase, decrease user quota whenever a bucket is created/ destroyed or quota is changed. This will also
need to be documented, that a bucket from the same user can feed space from another bucket of the same user (Although we defined bucket quota as 5, 10 and 3, the actually usage could be 6, 6 and 6.)

Another thing could be, if you are ok with Cloudian not supporting Object Storage Limits, you can document that and make the quota field non-mandatory for Cloudian.

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

plugins/storage/object/cloudian/add_cloudian_hyperstore.png Outdated Show resolved Hide resolved

plugins/storage/object/cloudian/README.md Outdated Show resolved Hide resolved

Delete the add_cloudian_hyperstore.png file,

f239762

Merge branch 'apache:main' into add_cloudian_object_storage

f2a0120

apache deleted a comment from blueorangutan Feb 18, 2025

shwstppr reviewed Feb 18, 2025

View reviewed changes

DaanHoogland marked this pull request as draft February 19, 2025 10:30

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

codecov bot commented Sep 30, 2024 •

edited

Loading

rohityadavcloud commented Oct 1, 2024

tpodowd commented Oct 1, 2024

tpodowd commented Oct 2, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 6, 2024

DaanHoogland commented Oct 7, 2024

tpodowd commented Oct 11, 2024

tpodowd commented Oct 18, 2024

JoaoJandre commented Oct 18, 2024

tpodowd commented Oct 21, 2024

JoaoJandre left a comment

DaanHoogland left a comment

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

tpodowd commented Feb 17, 2025

abh1sar commented Feb 17, 2025

tpodowd commented Feb 18, 2025

DaanHoogland commented Feb 18, 2025

blueorangutan commented Feb 18, 2025

blueorangutan commented Feb 18, 2025

DaanHoogland commented Feb 18, 2025

shwstppr Feb 18, 2025

tpodowd commented Feb 19, 2025

tpodowd commented Feb 19, 2025

abh1sar commented Feb 19, 2025

	<version>4.20.0.0-SNAPSHOT</version>
	<version>4.21.0.0-SNAPSHOT</version>

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?

codecov bot commented Sep 30, 2024 • edited Loading

Codecov Report

rohityadavcloud commented Oct 1, 2024

tpodowd commented Oct 1, 2024

tpodowd commented Oct 2, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 4, 2024

tpodowd commented Oct 6, 2024

DaanHoogland commented Oct 7, 2024

tpodowd commented Oct 11, 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

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

abh1sar commented Nov 5, 2024

tpodowd commented Nov 5, 2024

tpodowd commented Feb 17, 2025

abh1sar commented Feb 17, 2025

tpodowd commented Feb 18, 2025

DaanHoogland commented Feb 18, 2025

blueorangutan commented Feb 18, 2025

blueorangutan commented Feb 18, 2025

DaanHoogland commented Feb 18, 2025

shwstppr Feb 18, 2025

Choose a reason for hiding this comment

tpodowd commented Feb 19, 2025

tpodowd commented Feb 19, 2025

abh1sar commented Feb 19, 2025

codecov bot commented Sep 30, 2024 •

edited

Loading