Bug 795901

Summary: Document Differences of Cloud Resource Cluster in UI
Product: [Retired] CloudForms Cloud Engine Reporter: james labocki <jlabocki>
Component: Docs User GuideAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact: ecs-bugs
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 1.0.0CC: akarol, cpelland, deltacloud-maint, dgao, dmacpher, lbrindle, snansi, ssachdev, sseago, sshveta
Target Milestone: beta6   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
CloudForms Cloud Engine contains locations for two different sets of Cloud Resource Cluster information. This might cause confusion about the different types of Cloud Resource Clusters. Please note the difference between the two locations: * Under Cloud Resource Providers, Cloud Resource Cluster shows all available clusters for a provider. * Under Content, Cloud Resource Clusters shows the user-defined mappings from the available clusters. CloudForms Cloud Engine users select the appropriate Cloud Resource Cluster section based upon this distinction.
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-12-10 21:53:16 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Attachments:
Description Flags
Screenshot of Cloud Resource Clusters section under Cloud Resource Providers
none
Provider realms
none
Provider Realms added none

Description james labocki 2012-02-21 18:56:17 UTC
Description of problem:
In Cloud Engine, under 'Content Resource Providers' there is a 'Cloud Resource Clusters'. Under 'Content' there is also a 'Cloud Resource Clusters' that shows a different set of items. This is confusing and it would be ideal if we used different terms. In the short term, it is important to thoroughly document the differences between these two.

the one under cloud providers are what dealta cloud sees
the ones under content are what the use makes to map to delta cloud

Comment 1 Dan Macpherson 2012-02-22 03:50:53 UTC
I think the best way to document the difference between the two is to call one "pre-defined"/"provider-defined" (under "Cloud Resource Providers" and the other as "user-defined" (under "Content").

Any additional thoughts?

Comment 2 wes hayutin 2012-02-24 04:06:40 UTC
no no no..

typically referred to as front end and back end clusters or realms..

Cloud Resource Clusters' under Cloud Resource Providers shows ALL the available clusters for a provider

Cloud Resource Clusters' under content shows what the user has mapped for their use from the available clusters..

confusing yes
crappy use of language .. yes..

I suspect this is already documented, if not please contact dev for specifics.

Comment 3 Dan Macpherson 2012-03-12 01:06:11 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
CloudForms Cloud Engine contains locations for two different sets of Cloud Resource Cluster information. This might cause confusion about the different types of Cloud Resource Clusters.

Please note the difference between the two locations:

* Under Cloud Resource Providers, Cloud Resource Cluster shows all available clusters for a provider. 

* Under Content, Cloud Resource Clusters shows the user-defined mappings from the available clusters.

CloudForms Cloud Engine users select the appropriate Cloud Resource Cluster section based upon this distinction.

Comment 4 Scott Seago 2012-03-12 05:28:34 UTC
Didn't we agree to change the language of the "back end/provider" clusters to "Provider Realms"?

If I'm remembering this correctly, under Content you'll see Cloud Resource Clusters and under Cloud Resource Providers you'll see Provider Realm. We wanted to use different terms to make the distinction clearer. A  Provider realm is a list of provider-specific entities that generally specifies a notion of "locale", but the meaning is different per-provider. We use the term 'realm' because that's the Deltacloud term for it, and everything to the providers goes via the Deltacloud API. For RHEV these are clusters, for ec2 they're availability zones.

On the other hand, the Cloud Resource Cluster is a "front end" concept, defined by a Cloud Engine admin that allows the admin to map a Cluster to _either_ one or more Cloud Resource Providers _or_ one or more Provider Realms. In both cases this allows the admin to give the user a way to more directly influence where an application will be launched. The difference is that mapping to a Provider (or providers) results in the instances being launched in one of the mapped providers without any further realm-scoping at the deltacloud level. By mapping to one or more provider realms, not only are the instances launched in one of the providers represented by the chosen realm, but they're launched in that particular realm.

For example, if the Cloud Resource Cluster is mapped to a single RHEV provider (datacenter), then the application will be launched in that datacenter without specifying a particular cluster (the default cluster will be used). If it's mapped to a RHEV realm (cluster), then the application will launch not only on that provider (datacenter) but in the specific provider realm (RHEV cluster) specified.

Comment 5 Dan Macpherson 2012-03-12 06:19:43 UTC
Created attachment 569281 [details]
Screenshot of Cloud Resource Clusters section under Cloud Resource Providers

Comment 6 Dan Macpherson 2012-03-12 06:48:48 UTC
> Didn't we agree to change the language of the "back end/provider" clusters to
> "Provider Realms"?

AFAIR, there was the name change from "Realm" to "Cloud Resource Cluster" across all of Conductor, but I hadn't heard of any changes of the back-end "Cloud Resource Clusters" to "Provider Realms".

Having said that, I totally agree there should be some distinctive naming between the two. 

> If I'm remembering this correctly, under Content you'll see Cloud Resource
> Clusters and under Cloud Resource Providers you'll see Provider Realm.

I've checked my build of Cloud Engine (0.8.0-41.el6) and it still says "Cloud Resource Clusters" under "Cloud Resource Providers" (see attachment). Is this correct or should it be "Provider Realm"?



It would be great to call the back-end clusters/realms something distinctive from the front-end/user-defined clusters/realms, which is something I'll document in greater details for the 1.1 guides. However, for 1.0's release notes, does the text in "Technical Notes" suit as a basic description of the difference between the back-end and front-end concepts?

Comment 7 Lana Brindley 2012-03-27 23:10:45 UTC
Doc update will occur for 1.1. Release note to occur for 1.0.

LKB

Comment 8 Shikha 2012-04-12 05:20:51 UTC
Rel note added in CloudForms Cloud Engine section.

Comment 9 Lana Brindley 2012-06-12 03:21:33 UTC
Back to assigned for doc update.

LKB

Comment 10 Dan Macpherson 2012-09-06 04:17:48 UTC
Added Docs Text to 1.1 docs

Comment 11 Shveta 2012-10-15 23:36:19 UTC
Referring to 

http://documentation-devel.engineering.redhat.com/docs/en-US/CloudForms/1.1/html-single/Cloud_Engine_User_Guide/index.html#sect-Cloud_Resource_Clusters


Section 4.4.1. Cloud Resource Clusters

CloudForms Cloud Engine contains locations for two different sets of Cloud Resource Cluster information. Please note the difference between the two locations.

    Under Cloud Resource Providers, Cloud Resource Cluster shows all available clusters for a provider.

    Under Content, Cloud Resource Clusters shows the user-defined mappings from the available clusters. 

CloudForms Cloud Engine users select the appropriate Cloud Resource Cluster section based upon this distinction. 
=======================================================

Under Cloud Resource Provider , Cloud Resource cluster is renamed to Provider Realms . Please change that.

Comment 12 Shveta 2012-10-15 23:37:09 UTC
Created attachment 627788 [details]
Provider realms

Comment 15 Lana Brindley 2012-11-19 02:45:29 UTC
This documentation has now been dropped to translation ahead of publication. For any further issues, please open a new a bug.

LKB

Comment 16 Lana Brindley 2012-12-10 21:53:16 UTC
This document is now publicly available on access.redhat.com. For any further issues, please raise a new bug.

LKB