smengcl commented on a change in pull request #2059: URL: https://github.com/apache/ozone/pull/2059#discussion_r605932848
########## File path: hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/request/s3/tenant/OMTenantCreateRequest.java ########## @@ -0,0 +1,300 @@ +/* + * 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.hadoop.ozone.om.request.s3.tenant; + +import com.google.common.base.Optional; +import org.apache.hadoop.hdds.utils.db.cache.CacheKey; +import org.apache.hadoop.hdds.utils.db.cache.CacheValue; +import org.apache.hadoop.ozone.OmUtils; +import org.apache.hadoop.ozone.OzoneConsts; +import org.apache.hadoop.ozone.audit.OMAction; +import org.apache.hadoop.ozone.om.OMMetadataManager; +import org.apache.hadoop.ozone.om.OzoneManager; +import org.apache.hadoop.ozone.om.exceptions.OMException; +import org.apache.hadoop.ozone.om.helpers.OmDBTenantInfo; +import org.apache.hadoop.ozone.om.helpers.OmVolumeArgs; +import org.apache.hadoop.ozone.om.multitenant.Tenant; +import org.apache.hadoop.ozone.om.ratis.utils.OzoneManagerDoubleBufferHelper; +import org.apache.hadoop.ozone.om.request.util.OmResponseUtil; +import org.apache.hadoop.ozone.om.request.volume.OMVolumeRequest; +import org.apache.hadoop.ozone.om.response.OMClientResponse; +import org.apache.hadoop.ozone.om.response.s3.tenant.OMTenantCreateResponse; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.CreateTenantRequest; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.CreateTenantResponse; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.CreateVolumeRequest; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse; +import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.VolumeInfo; +import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer; +import org.apache.hadoop.ozone.security.acl.OzoneObj; +import org.apache.hadoop.ozone.storage.proto.OzoneManagerStorageProtos.PersistedUserVolumeInfo; +import org.apache.hadoop.util.Time; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; + +import static org.apache.hadoop.ozone.om.lock.OzoneManagerLock.Resource.USER_LOCK; +import static org.apache.hadoop.ozone.om.lock.OzoneManagerLock.Resource.VOLUME_LOCK; + +/* + Ratis execution flow for OMTenantCreate + +- preExecute (perform checks and init) + - Check tenant name validity (again) + - If name is invalid, throw exception to client; else continue +- validateAndUpdateCache (update DB) + - Grab VOLUME_LOCK write lock + - Check volume existence + - If tenant already exists, throw exception to client; else continue + - Check tenant existence by checking tenantStateTable keys + - If tenant already exists, throw exception to client; else continue + - tenantStateTable: New entry + - Key: tenant name. e.g. finance + - Value: new OmDBTenantInfo for the tenant + - tenantName: finance + - bucketNamespaceName: finance + - accountNamespaceName: finance + - userPolicyGroupName: finance-users + - bucketPolicyGroupName: finance-buckets + - tenantPolicyTable: Generate default policies for the new tenant + - K: finance-Users, V: finance-users-default + - K: finance-Buckets, V: finance-buckets-default + - Grab USER_LOCK write lock + - Create volume finance (See OMVolumeCreateRequest) + - Release VOLUME_LOCK write lock + - Release USER_LOCK write lock + - Queue Ranger policy sync that pushes default policies: + OMMultiTenantManager#createTenant + */ + +/** + * Handles OMTenantCreate request. + */ +public class OMTenantCreateRequest extends OMVolumeRequest { + private static final Logger LOG = + LoggerFactory.getLogger(OMTenantCreateRequest.class); + + public OMTenantCreateRequest(OMRequest omRequest) { + super(omRequest); + } + + @Override + public OMRequest preExecute(OzoneManager ozoneManager) throws IOException { + final CreateTenantRequest request = getOmRequest().getCreateTenantRequest(); + final String tenantName = request.getTenantName(); + + // Check tenantName validity + if (tenantName.contains(OzoneConsts.TENANT_NAME_USER_NAME_DELIMITER)) { + throw new OMException("Invalid tenant name " + tenantName + + ". Tenant name should not contain delimiter.", + OMException.ResultCodes.INVALID_VOLUME_NAME); + } + + // getUserName returns: + // - Kerberos principal when Kerberos security is enabled + // - User's login name when security is not enabled + // - AWS_ACCESS_KEY_ID if the original request comes from S3 Gateway. + // Not Applicable to TenantCreateRequest. + final String owner = getOmRequest().getUserInfo().getUserName(); + final String volumeName = tenantName; // TODO: Configurable + final VolumeInfo volumeInfo = VolumeInfo.newBuilder() + .setVolume(volumeName) + .setAdminName(owner) + .setOwnerName(owner) + .build(); + // Verify volume name + OmUtils.validateVolumeName(volumeInfo.getVolume()); + + // Generate volume modification time + long initialTime = Time.now(); + final VolumeInfo updatedVolumeInfo = volumeInfo.toBuilder() + .setCreationTime(initialTime) + .setModificationTime(initialTime) + .build(); + + final OMRequest.Builder omRequestBuilder = getOmRequest().toBuilder() + .setCreateTenantRequest( + CreateTenantRequest.newBuilder().setTenantName(tenantName)) + .setCreateVolumeRequest( + CreateVolumeRequest.newBuilder().setVolumeInfo(updatedVolumeInfo)) + .setUserInfo(getUserInfo()) + .setCmdType(getOmRequest().getCmdType()) + .setClientId(getOmRequest().getClientId()); + + if (getOmRequest().hasTraceID()) { + omRequestBuilder.setTraceID(getOmRequest().getTraceID()); + } + + return omRequestBuilder.build(); + } + + @Override + public OMClientResponse validateAndUpdateCache( + OzoneManager ozoneManager, long transactionLogIndex, + OzoneManagerDoubleBufferHelper ozoneManagerDoubleBufferHelper) { + + OMClientResponse omClientResponse = null; + OMResponse.Builder omResponse = OmResponseUtil.getOMResponseBuilder( + getOmRequest()); + OmVolumeArgs omVolumeArgs; + boolean acquiredVolumeLock = false, acquiredUserLock = false; + Tenant tenant = null; + final String owner = getOmRequest().getUserInfo().getUserName(); + LOG.info("owner: {}", owner); // TODO: owner should be access_key_id + Map<String, String> auditMap = new HashMap<>(); + OMMetadataManager omMetadataManager = ozoneManager.getMetadataManager(); + CreateTenantRequest request = getOmRequest().getCreateTenantRequest(); + final String tenantName = request.getTenantName(); + final VolumeInfo volumeInfo = + getOmRequest().getCreateVolumeRequest().getVolumeInfo(); + final String volumeName = volumeInfo.getVolume(); + final String dbVolumeKey = omMetadataManager.getVolumeKey(volumeName); + IOException exception = null; + try { + // Check ACL: requires volume create permission. TODO: tenant create perm? + if (ozoneManager.getAclsEnabled()) { + checkAcls(ozoneManager, OzoneObj.ResourceType.VOLUME, + OzoneObj.StoreType.OZONE, IAccessAuthorizer.ACLType.CREATE, + tenantName, null, null); + } + + acquiredVolumeLock = omMetadataManager.getLock().acquireWriteLock( + VOLUME_LOCK, volumeName); + // Check volume existence + if (omMetadataManager.getVolumeTable().isExist(volumeName)) { + LOG.debug("volume: {} already exists", volumeName); + throw new OMException("Volume already exists", + OMException.ResultCodes.VOLUME_ALREADY_EXISTS); + } + // Check tenant existence in tenantStateTable + if (omMetadataManager.getTenantStateTable().isExist(tenantName)) { + LOG.debug("tenant: {} already exists", tenantName); + throw new OMException("Tenant already exists", + OMException.ResultCodes.TENANT_ALREADY_EXISTS); + } + + // Add to tenantStateTable. Redundant assignment for clarity + final String bucketNamespaceName = tenantName; + final String accountNamespaceName = tenantName; + final String userPolicyGroupName = + tenantName + OzoneConsts.DEFAULT_TENANT_USER_POLICY_SUFFIX; + final String bucketPolicyGroupName = + tenantName + OzoneConsts.DEFAULT_TENANT_BUCKET_POLICY_SUFFIX; + final OmDBTenantInfo omDBTenantInfo = new OmDBTenantInfo( + tenantName, bucketNamespaceName, accountNamespaceName, + userPolicyGroupName, bucketPolicyGroupName); + omMetadataManager.getTenantStateTable().addCacheEntry( + new CacheKey<>(tenantName), + new CacheValue<>(Optional.of(omDBTenantInfo), transactionLogIndex)); + + // Call OMMultiTenantManager +// tenant = ozoneManager.getMultiTenantManager().createTenant(tenantName); Review comment: @prashantpogde -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
