Examples with Metadata com.woorea.openstack.keystone.model.Metadata used on opensource projects

Example 1 with Metadata

use of com.woorea.openstack.keystone.model.Metadata in project so by onap.

the class MsoKeystoneUtils method queryTenant.

/**
 * Query for a tenant by ID in the given cloud. If the tenant exists, return an MsoTenant object. If not, return
 * null.
 * <p>
 * For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized
 * identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be
 * needed to access the correct region.
 * <p>
 *
 * @param tenantId The Openstack ID of the tenant to query
 * @param cloudSiteId The cloud identifier (may be a region) in which to query the tenant.
 * @return the tenant properties of the queried tenant, or null if not found
 * @throws MsoOpenstackException Thrown if the Openstack API call returns an exception
 */
public MsoTenant queryTenant(String tenantId, String cloudSiteId) throws MsoException {
    // Obtain the cloud site information where we will query the tenant
    CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(() -> new MsoCloudSiteNotFound(cloudSiteId));
    Keystone keystoneAdminClient = getKeystoneAdminClient(cloudSite);
    // Check if the tenant exists and return its Tenant Id
    try {
        Tenant tenant = findTenantById(keystoneAdminClient, tenantId);
        if (tenant == null) {
            return null;
        }
        Map<String, String> metadata = new HashMap<>();
        if (cloudSite.getIdentityService().getTenantMetadata()) {
            OpenStackRequest<Metadata> request = keystoneAdminClient.tenants().showMetadata(tenant.getId());
            Metadata tenantMetadata = executeAndRecordOpenstackRequest(request);
            if (tenantMetadata != null) {
                metadata = tenantMetadata.getMetadata();
            }
        }
        return new MsoTenant(tenant.getId(), tenant.getName(), metadata);
    } catch (OpenStackBaseException e) {
        // Convert Keystone OpenStackResponseException to MsoOpenstackException
        throw keystoneErrorToMsoException(e, "QueryTenant");
    } catch (RuntimeException e) {
        // Catch-all
        throw runtimeExceptionToMsoException(e, "QueryTenant");
    }
}

Example 2 with Metadata

use of com.woorea.openstack.keystone.model.Metadata in project so by onap.

the class MsoKeystoneUtils method queryTenantByName.

/**
 * Query for a tenant with the specified name in the given cloud. If the tenant exists, return an MsoTenant object.
 * If not, return null. This query is useful if the client knows it has the tenant name, skipping an initial lookup
 * by ID that would always fail.
 * <p>
 * For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized
 * identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be
 * needed to access the correct region.
 * <p>
 *
 * @param tenantName The name of the tenant to query
 * @param cloudSiteId The cloud identifier (may be a region) in which to query the tenant.
 * @return the tenant properties of the queried tenant, or null if not found
 * @throws MsoOpenstackException Thrown if the Openstack API call returns an exception
 */
public MsoTenant queryTenantByName(String tenantName, String cloudSiteId) throws MsoException {
    // Obtain the cloud site information where we will query the tenant
    CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(() -> new MsoCloudSiteNotFound(cloudSiteId));
    Keystone keystoneAdminClient = getKeystoneAdminClient(cloudSite);
    try {
        Tenant tenant = findTenantByName(keystoneAdminClient, tenantName);
        if (tenant == null) {
            return null;
        }
        Map<String, String> metadata = new HashMap<>();
        if (cloudSite.getIdentityService().getTenantMetadata()) {
            OpenStackRequest<Metadata> request = keystoneAdminClient.tenants().showMetadata(tenant.getId());
            Metadata tenantMetadata = executeAndRecordOpenstackRequest(request);
            if (tenantMetadata != null) {
                metadata = tenantMetadata.getMetadata();
            }
        }
        return new MsoTenant(tenant.getId(), tenant.getName(), metadata);
    } catch (OpenStackBaseException e) {
        // Convert Keystone OpenStackResponseException to MsoOpenstackException
        throw keystoneErrorToMsoException(e, "QueryTenantName");
    } catch (RuntimeException e) {
        // Catch-all
        throw runtimeExceptionToMsoException(e, "QueryTenantName");
    }
}

Example 3 with Metadata

use of com.woorea.openstack.keystone.model.Metadata in project so by onap.

the class MsoKeystoneUtils method createTenant.

/**
 * Create a tenant with the specified name in the given cloud. If the tenant already exists, an Exception will be
 * thrown. The MSO User will also be added to the "member" list of the new tenant to perform subsequent Nova/Heat
 * commands in the tenant. If the MSO User association fails, the entire transaction will be rolled back.
 * <p>
 * For the AIC Cloud (DCP/LCP): it is not clear that cloudId is needed, as all admin requests go to the centralized
 * identity service in DCP. However, if some artifact must exist in each local LCP instance as well, then it will be
 * needed to access the correct region.
 * <p>
 *
 * @param tenantName The tenant name to create
 * @param cloudSiteId The cloud identifier (may be a region) in which to create the tenant.
 * @return the tenant ID of the newly created tenant
 * @throws MsoTenantAlreadyExists Thrown if the requested tenant already exists
 * @throws MsoOpenstackException Thrown if the Openstack API call returns an exception
 */
public String createTenant(String tenantName, String cloudSiteId, Map<String, String> metadata, boolean backout) throws MsoException {
    // Obtain the cloud site information where we will create the tenant
    Optional<CloudSite> cloudSiteOpt = cloudConfig.getCloudSite(cloudSiteId);
    if (!cloudSiteOpt.isPresent()) {
        LOGGER.error("{} MSOCloudSite {} not found {} ", MessageEnum.RA_CREATE_TENANT_ERR, cloudSiteId, ErrorCode.DataError.getValue());
        throw new MsoCloudSiteNotFound(cloudSiteId);
    }
    Keystone keystoneAdminClient = getKeystoneAdminClient(cloudSiteOpt.get());
    Tenant tenant = null;
    try {
        // Check if the tenant already exists
        tenant = findTenantByName(keystoneAdminClient, tenantName);
        if (tenant != null) {
            // Tenant already exists. Throw an exception
            LOGGER.error("{} Tenant name {} already exists on Cloud site id {}, {}", MessageEnum.RA_TENANT_ALREADY_EXIST, tenantName, cloudSiteId, ErrorCode.DataError.getValue());
            throw new MsoTenantAlreadyExists(tenantName, cloudSiteId);
        }
        // Does not exist, create a new one
        tenant = new Tenant();
        tenant.setName(tenantName);
        tenant.setDescription("SDN Tenant (via MSO)");
        tenant.setEnabled(true);
        OpenStackRequest<Tenant> request = keystoneAdminClient.tenants().create(tenant);
        tenant = executeAndRecordOpenstackRequest(request);
    } catch (OpenStackBaseException e) {
        // Convert Keystone OpenStackResponseException to MsoOpenstackException
        throw keystoneErrorToMsoException(e, "CreateTenant");
    } catch (RuntimeException e) {
        // Catch-all
        throw runtimeExceptionToMsoException(e, "CreateTenant");
    }
    // apply tenant metadata if supported by the cloud site
    try {
        CloudIdentity cloudIdentity = cloudSiteOpt.get().getIdentityService();
        User msoUser = findUserByNameOrId(keystoneAdminClient, cloudIdentity.getMsoId());
        Role memberRole = findRoleByNameOrId(keystoneAdminClient, cloudIdentity.getMemberRole());
        if (msoUser != null && memberRole != null) {
            OpenStackRequest<Void> request = keystoneAdminClient.tenants().addUser(tenant.getId(), msoUser.getId(), memberRole.getId());
            executeAndRecordOpenstackRequest(request);
        }
        if (cloudIdentity.getTenantMetadata() && metadata != null && !metadata.isEmpty()) {
            Metadata tenantMetadata = new Metadata();
            tenantMetadata.setMetadata(metadata);
            OpenStackRequest<Metadata> metaRequest = keystoneAdminClient.tenants().createOrUpdateMetadata(tenant.getId(), tenantMetadata);
            executeAndRecordOpenstackRequest(metaRequest);
        }
    } catch (Exception e) {
        // so roll back the tenant.
        if (!backout) {
            LOGGER.warn("{} Create Tenant errored, Tenant deletion suppressed {} ", MessageEnum.RA_CREATE_TENANT_ERR, ErrorCode.DataError.getValue());
        } else {
            try {
                OpenStackRequest<Void> request = keystoneAdminClient.tenants().delete(tenant.getId());
                executeAndRecordOpenstackRequest(request);
            } catch (Exception e2) {
                // Just log this one. We will report the original exception.
                LOGGER.error("{} Nested exception rolling back tenant {} ", MessageEnum.RA_CREATE_TENANT_ERR, ErrorCode.DataError.getValue(), e2);
            }
        }
        // Propagate the original exception on user/role/tenant mapping
        if (e instanceof OpenStackBaseException) {
            // Convert Keystone Exception to MsoOpenstackException
            throw keystoneErrorToMsoException((OpenStackBaseException) e, "CreateTenantUser");
        } else {
            MsoAdapterException me = new MsoAdapterException(e.getMessage(), e);
            me.addContext("CreateTenantUser");
            throw me;
        }
    }
    return tenant.getId();
}