storage/object: Add support for Ceph RGW Object Store (apache#8389)

This feature adds support for Ceph's RADOS Gateway (RGW) support for the
Object Store feature of CloudStack.

The RGW of Ceph is Amazon S3 compliant and is therefor an easy and straigforward
implementation of basic S3 features.

Existing Ceph environments can have the RGW added as an additional feature to a
cluster already providing RBD (Block Device) to a CloudStack environment.

Introduce the BucketTO to pass to the drivers. This replaces just passing the bucket's name.

Some upcoming drivers require more information then just the bucket name to perform their actions,
for example they require the access and secret key which belong to the account of this bucket.

This is leftover code from a long time ago and this validation test has nu influence
on the end result on how a URL will be used afterwards.

We should support hosts pointing to an IPv6(-only) address out of the box.

For the code it does not matter if it's IPv4 or IPv6. This is the admin's choice.

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>
Co-authored-by: Rohit Yadav <rohit.yadav@shapeblue.com>

Author: 2 people

engine/schema/src/main/java/com/cloud/storage/BucketVO.java

@@ -97,17 +97,23 @@ public class BucketVO implements Bucket {
     String uuid;
 
     public BucketVO() {
+        this.uuid = UUID.randomUUID().toString();
+    }
+
+    public BucketVO(String name) {
+        this.uuid = UUID.randomUUID().toString();
+        this.name = name;
+        this.state = State.Allocated;
     }
 
     public BucketVO(long accountId, long domainId, long objectStoreId, String name, Integer quota, boolean versioning,
-                    boolean encryption, boolean objectLock, String policy)
-    {
+                    boolean encryption, boolean objectLock, String policy) {
         this.accountId = accountId;
         this.domainId = domainId;
         this.objectStoreId = objectStoreId;
         this.name = name;
-        state = State.Allocated;
-        uuid = UUID.randomUUID().toString();
+        this.state = State.Allocated;
+        this.uuid = UUID.randomUUID().toString();
         this.quota = quota;
         this.versioning = versioning;
         this.encryption = encryption;

plugins/storage/object/ceph/src/main/java/org/apache/cloudstack/storage/datastore/driver/CephObjectStoreDriverImpl.java

@@ -19,25 +19,26 @@
 package org.apache.cloudstack.storage.datastore.driver;
 
 import com.amazonaws.AmazonServiceException;
+import com.amazonaws.SdkClientException;
+import com.amazonaws.services.s3.model.BucketCrossOriginConfiguration;
+import com.amazonaws.services.s3.model.CORSRule;
+
 import com.amazonaws.auth.AWSStaticCredentialsProvider;
 import com.amazonaws.auth.BasicAWSCredentials;
 import com.amazonaws.client.builder.AwsClientBuilder;
-import com.amazonaws.SdkClientException;
 import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.AmazonS3ClientBuilder;
-import com.amazonaws.services.s3.model.AccessControlList;
 import com.amazonaws.services.s3.model.AmazonS3Exception;
-import com.amazonaws.services.s3.model.BucketCrossOriginConfiguration;
+import com.amazonaws.services.s3.model.AccessControlList;
 import com.amazonaws.services.s3.model.BucketPolicy;
 import com.amazonaws.services.s3.model.BucketVersioningConfiguration;
-import com.amazonaws.services.s3.model.CORSRule;
 import com.amazonaws.services.s3.model.DeleteBucketPolicyRequest;
-import com.amazonaws.services.s3.model.GetBucketPolicyRequest;
 import com.amazonaws.services.s3.model.SetBucketPolicyRequest;
+import com.amazonaws.services.s3.model.GetBucketPolicyRequest;
 import com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest;
-
 import com.cloud.agent.api.to.BucketTO;
 import com.cloud.agent.api.to.DataStoreTO;
+import org.apache.cloudstack.storage.object.Bucket;
 import com.cloud.storage.BucketVO;
 import com.cloud.storage.dao.BucketDao;
 import com.cloud.user.Account;
@@ -56,6 +57,7 @@
 import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
 import org.apache.cloudstack.framework.async.AsyncCompletionCallback;
 import org.apache.cloudstack.storage.command.CommandResult;
+import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
 import org.apache.cloudstack.storage.datastore.db.ObjectStoreDao;
 import org.apache.cloudstack.storage.datastore.db.ObjectStoreDetailsDao;
 import org.apache.cloudstack.storage.datastore.db.ObjectStoreVO;
@@ -68,7 +70,12 @@
 import org.twonote.rgwadmin4j.RgwAdmin;
 import org.twonote.rgwadmin4j.RgwAdminBuilder;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
 public class CephObjectStoreDriverImpl extends BaseObjectStoreDriverImpl {
+    private static final Logger s_logger = LogManager.getLogger(CephObjectStoreDriverImpl.class);
+
     @Inject
     AccountDao _accountDao;
 
@@ -312,11 +319,7 @@ public boolean setBucketVersioning(BucketTO bucket, long storeId) {
             SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest =
                     new SetBucketVersioningConfigurationRequest(bucket.getName(), configuration);
 
-            client.setBucketVersioningConfiguration(setBucketVersioningConfigurationRequest);
             return true;
-        } catch (AmazonS3Exception e) {
-            throw new CloudRuntimeException(e);
-        }
     }
 
     @Override

plugins/storage/object/ceph/src/main/java/org/apache/cloudstack/storage/datastore/lifecycle/CephObjectStoreLifeCycleImpl.java

@@ -38,7 +38,8 @@
 import java.util.Map;
 
 public class CephObjectStoreLifeCycleImpl implements ObjectStoreLifeCycle {
-    protected Logger logger = LogManager.getLogger(getClass());
+
+    private static final Logger s_logger = LogManager.getLogger(CephObjectStoreLifeCycleImpl.class);
 
     @Inject
     ObjectStoreHelper objectStoreHelper;
@@ -71,7 +72,7 @@ public DataStore initialize(Map<String, Object> dsInfos) {
         objectStoreParameters.put("accesskey", accessKey);
         objectStoreParameters.put("secretkey", secretKey);
 
-        logger.info("Attempting to connect to Ceph RGW at " + url + " with access key " + accessKey);
+        s_logger.info("Attempting to connect to Ceph RGW at " + url + " with access key " + accessKey);
 
         RgwAdmin rgwAdmin = new RgwAdminBuilder()
                 .accessKey(accessKey)
@@ -80,10 +81,10 @@ public DataStore initialize(Map<String, Object> dsInfos) {
                 .build();
         try {
             List<String> buckets = rgwAdmin.listBucket();
-            logger.debug("Found " + buckets + " buckets at Ceph RGW: " + url);
-            logger.info("Successfully connected to Ceph RGW: " + url);
+            s_logger.debug("Found " + buckets + " buckets at Ceph RGW: " + url);
+            s_logger.info("Successfully connected to Ceph RGW: " + url);
         } catch (Exception e) {
-            logger.debug("Error while initializing Ceph RGW Object Store: " + e.getMessage());
+            s_logger.debug("Error while initializing Ceph RGW Object Store: " + e.getMessage());
             throw new RuntimeException("Error while initializing Ceph RGW Object Store. Invalid credentials or URL");
         }
 

plugins/storage/object/ceph/src/test/java/org/apache/cloudstack/storage/datastore/driver/CephObjectStoreDriverImplTest.java

@@ -44,6 +44,8 @@
 import static org.mockito.Mockito.anyString;
 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 @RunWith(MockitoJUnitRunner.class)
@@ -67,12 +69,12 @@ public class CephObjectStoreDriverImplTest {
     @Mock
     BucketDao bucketDao;
     @Mock
-    Bucket bucket;
-    @Mock
     AccountVO account;
     @Mock
     AccountDetailsDao accountDetailsDao;
 
+    Bucket bucket;
+
     @Before
     public void setUp() {
         MockitoAnnotations.initMocks(this);
@@ -81,31 +83,31 @@ public void setUp() {
         cephObjectStoreDriverImpl._accountDao = accountDao;
         cephObjectStoreDriverImpl._bucketDao = bucketDao;
         cephObjectStoreDriverImpl._accountDetailsDao = accountDetailsDao;
+        bucket = new BucketVO();
+        bucket.setName("test-bucket");
         when(objectStoreVO.getUrl()).thenReturn("http://localhost:8000");
         when(objectStoreDao.findById(any())).thenReturn(objectStoreVO);
     }
 
     @Test
     public void testCreateBucket() throws Exception {
-        when(bucket.getName()).thenReturn("test-bucket");
-        when(bucket.getObjectStoreId()).thenReturn(1L);
-        when(bucket.getAccountId()).thenReturn(1L);
-        when(rgwClient.getBucketAcl(anyString())).thenReturn(null);
+        doReturn(rgwClient).when(cephObjectStoreDriverImpl).getS3Client(anyLong(), anyLong());
         when(accountDetailsDao.findDetail(anyLong(),anyString())).
                 thenReturn(new AccountDetailVO(1L, "abc","def"));
-        when(bucketDao.findById(anyLong())).thenReturn(new BucketVO());
-        doReturn(rgwClient).when(cephObjectStoreDriverImpl).getS3Client(anyLong(), anyLong());
+        when(bucketDao.findById(anyLong())).thenReturn(new BucketVO(bucket.getName()));
         Bucket bucketRet = cephObjectStoreDriverImpl.createBucket(bucket, false);
         assertEquals(bucketRet.getName(), bucket.getName());
+        verify(rgwClient, times(1)).getBucketAcl(anyString());
+        verify(rgwClient, times(1)).createBucket(anyString());
     }
 
     @Test
     public void testDeleteBucket() throws Exception {
         String bucketName = "test-bucket";
         BucketTO bucket = new BucketTO(bucketName);
         doReturn(rgwAdmin).when(cephObjectStoreDriverImpl).getRgwAdminClient(anyLong());
-        doNothing().when(rgwAdmin).removeBucket(anyString());
         boolean success = cephObjectStoreDriverImpl.deleteBucket(bucket, 1L);
         assertTrue(success);
+        verify(rgwAdmin, times(1)).removeBucket(anyString());
     }
 }

server/src/main/java/org/apache/cloudstack/storage/object/BucketApiServiceImpl.java

@@ -137,14 +137,14 @@ public Bucket createBucket(CreateBucketCmd cmd) {
         ObjectStoreVO objectStoreVO = _objectStoreDao.findById(cmd.getObjectStoragePoolId());
         ObjectStoreEntity objectStore = (ObjectStoreEntity)_dataStoreMgr.getDataStore(objectStoreVO.getId(), DataStoreRole.Object);
         BucketVO bucket = _bucketDao.findById(cmd.getEntityId());
-        BucketTO bucketTO = null;
+        BucketTO bucketTO = new BucketTO(bucket);
         boolean objectLock = false;
         boolean bucketCreated = false;
         if(cmd.isObjectLocking()) {
             objectLock = true;
         }
         try {
-            objectStore.createBucket(bucket, objectLock);
+            bucketTO = new BucketTO(objectStore.createBucket(bucket, objectLock));
             bucketCreated = true;
 
             bucket = _bucketDao.findById(cmd.getEntityId());

utils/src/main/java/com/cloud/utils/UriUtils.java

@@ -23,8 +23,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
-import java.net.Inet6Address;
 import java.net.InetAddress;
+import java.net.Inet6Address;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URLEncoder;

utils/src/test/java/com/cloud/utils/UriUtilsTest.java

@@ -281,8 +281,5 @@ public void validateUrl() {
 
         Pair<String, Integer> url2 = UriUtils.validateUrl("https://www.apache.org");
         Assert.assertEquals(url2.first(), "www.apache.org");
-
-        Pair<String, Integer> url3 = UriUtils.validateUrl("https://ipv6.google.com");
-        Assert.assertEquals(url3.first(), "ipv6.google.com");
     }
 }