Embed Size (px)
DESCRIPTION
CloudForms 1.1 Cloud Engine User Guide en US
Citation preview
Lana Brindley Athene Chan Sarah ChuaDaniel Macpherson Shikha Nansi Julie Wu
CloudForms 1.1Cloud Engine User Guide
Using CloudForms Cloud Engine
CloudForms 1.1 Cloud Engine User Guide
Using CloudForms Cloud Engine
Lana BrindleyRed Hat Engineering Cont ent Serviceslbrindle@redhat .com
At hene ChanRed Hat Engineering Cont ent Servicesachan@redhat .com
Sarah ChuaRed Hat Engineering Cont ent Servicessachua@redhat .com
Daniel MacphersonRed Hat Engineering Cont ent Servicesdmacpher@redhat .com
Shikha NansiRed Hat Engineering Cont ent Servicessnansi@redhat .com
Julie WuRed Hat Engineering Cont ent Servicesjuwu@redhat .com
Legal NoticeCopyright 2012 Red Hat. The text of and illustrations in this document are licensed by Red Hat under aCreative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at . In accordance with CC-BY-SA, if you distribute this document or an adaptation of it,you must provide the URL for the original version. Red Hat, as the licensor of this document, waives theright to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted byapplicable law. Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, theInfinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and othercountries. Linux is the registered trademark of Linus Torvalds in the United States and other countries.Java is a registered trademark of Oracle and/or its aff iliates. XFS is a trademark of Silicon GraphicsInternational Corp. or its subsidiaries in the United States and/or other countries. MySQL is a registeredtrademark of MySQL AB in the United States, the European Union and other countries. All othertrademarks are the property of their respective owners. 1801 Varsity Drive Raleigh, NC 27606-2072 USAPhone: +1 919 754 3700 Phone: 888 733 4281 Fax: +1 919 754 3701
Keywords
AbstractA guide to using CloudForms Cloud Engine.
7778999
10
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
11111313131313131314
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1515
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17171717
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19191919192020212121232424252525262627282828293030
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Table of Contents
Preface1. Document Conventions
1.1. Typographic Conventions1.2. Pull-quote Conventions1.3. Notes and Warnings
2. Getting Help and Giving Feedback2.1. Do You Need Help?2.2. We Need Feedback!
Chapter 1. Introduction1.1. About CloudForms1.2. About CloudForms Cloud Engine1.3. Components
1.3.1. Conductor1.3.2. Deltacloud1.3.3. Image Factory1.3.4. Image Warehouse1.3.5. Audrey
1.4. Supported Instance Operating Systems
Chapter 2. First Time Login2.1. Logging into CloudForms Cloud Engine for the First T ime
Chapter 3. Views, Searching and Filtering3.1. Views3.2. Searching3.3. Filtering
Chapter 4 . Cloud Resources4.1. Cloud Resources4.2. Cloud Resource Providers
4.2.1. Cloud Resource Providers4.2.2. Supported Cloud Resource Providers4.2.3. Provider Connections
4.2.3.1. Setting Up a Cloud Resource Provider Connection4.2.3.2. Disable a Cloud Resource Provider Connection
4.2.4. Provider Accounts4.2.4.1. Setting Up a Cloud Resource Provider Account4.2.4.2. Adding an Audrey Configuration Server to a Resource Provider Account4.2.4.3. Editing Audrey Configuration Server Details4.2.4.4. Delete Audrey Configuration Server Details
4.3. Cloud Resource Profiles4.3.1. Cloud Resource Profiles4.3.2. Creating a New Cloud Resource Profile
4.4. Cloud Resource Clusters4.4.1. Cloud Resource Clusters4.4.2. Setting up a Cloud Resource Cluster
4.5. Clouds4.5.1. Clouds4.5.2. Creating a New Cloud4.5.3. Associating a Cloud with a Cloud Resource Provider Account
4.6. Cloud Resource Zones4.6.1. Cloud Resource Zones
CloudForms 1.1 Cloud Engine User Guide
6
30313131
333333353535353637383941414142
424242444546484949495051515153545556
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58585858585959606060616162636363
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4.6.2. Creating a Cloud Resource Zone4.6.3. Provider Selection Strategies
4.6.3.1. Creating a Provider Selection Strategy4.6.3.2. Penalty for Failure Strategy
Chapter 5. Component Outlines5.1. Component Outlines5.2. Creating a Component Outline5.3. Example Component Outlines
5.3.1. Red Hat Enterprise Linux 6.3 via URL5.3.2. Red Hat Enterprise Linux 5.8 via ISO5.3.3. Red Hat Enterprise Linux 6.3 with Audrey Agent5.3.4. Red Hat Enterprise Linux 6.3 with HTTP Web Server5.3.5. Red Hat Enterprise Linux 6.3 with vm-tools agent (VMware vSphere)5.3.6. Red Hat Enterprise Linux 6.3 with rhev-agent (RHEV)
5.4. Including Target-Specific Packages and Repositories for Component Outlines5.5. Exporting a Component Outline from System Engine
5.5.1. About CloudForms System Engine5.5.2. System Templates5.5.3. Exporting a System Template5.5.4. Importing a CloudForms System Engine Component Outline into CloudForms Cloud Engine
5.6. Images5.6.1. Images5.6.2. Building an Image from a Component Outline5.6.3. Pushing an Image to a Cloud Resource Provider5.6.4. Importing an Image from a Cloud Resource Provider5.6.5. Deleting an Image from CloudForms Cloud Engine
5.7. Using the Command Line Tool5.7.1. Command Line Tool (aeolus)5.7.2. Building an Image via Command Line5.7.3. Pushing an Image via Command Line5.7.4. Command Line Reference
5.7.4.1. Command Line Syntax5.7.4.2. List Options5.7.4.3. Build Options5.7.4.4. Push Options5.7.4.5. Import Options5.7.4.6. Delete Options
Chapter 6. Applications6.1. Applications6.2. Catalogs
6.2.1. Catalogs6.2.2. Creating a Catalog6.2.3. Editing a Catalog6.2.4. Deleting Catalogs
6.3. Application Blueprint6.3.1. Application Blueprint6.3.2. Creating an Application Blueprint from a Component Outline6.3.3. Creating an Application Blueprint from a File Import6.3.4. Example Application Blueprint file6.3.5. Edit an Application Blueprint6.3.6. Add an Application Blueprint to Additional Catalogs6.3.7. Deleting Application Blueprints
6.4. Applications and Instances
Preface
7
6366666768
696969697173
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
79798080
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
818181818182
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
838383848586
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87878787878888888888
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
909090919393939394
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
95959596
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6.4.1. Creating a New Application6.4.2. Deleting an Application6.4.3. Accessing an Instance6.4.4. Rebooting an Instance6.4.5. Stopping an Instance
Chapter 7. Runtime Configuration7.1. Runtime Configuration7.2. Adding Audrey Agent to all Component Outlines7.3. Adding Runtime Configuration to an Application Blueprint7.4. Launching Instances with Runtime Configuration7.5. Using Runtime Configuration with System Engine Registration
Chapter 8. Users8.1. Creating a User8.2. Edit an Existing User8.3. Delete an Existing User
Chapter 9. Users Groups9.1. Creating a User Group9.2. Editing a User Group9.3. Adding Users to a User Group9.4. Removing Users from a User Group9.5. Deleting a User Group
Chapter 10. Permissions10.1. Setting Global Permissions10.2. Setting Cloud Resource Provider Permissions10.3. Setting Cloud Resource Zone Permissions10.4. Setting Application Blueprint Permissions10.5. Setting Application Permissions
Chapter 11. Logging and Reporting11.1. Provider History
11.1.1. Accessing Provider History11.2. Audit History
11.2.1. Accessing Audit History11.2.2. Exporting Audit History
11.3. Instance History11.3.1. Accessing Instance History11.3.2. Exporting Instance History
11.4. Accessing Log Files
Chapter 12. Maintenance12.1. Disaster Recovery
12.1.1. Cloud Engine Backup Procedure12.1.2. Cloud Engine Restore Procedure
12.2. Image Warehouse Recovery12.2.1. Testing Image Warehouse12.2.2. Analyzing the Log12.2.3. Recovery from Insufficient Space12.2.4. Recovery from Database Failure
Chapter 13. Template Description Language (TDL) Schema13.1. arch13.2. command13.3. commands
CloudForms 1.1 Cloud Engine User Guide
8
969797989899
100100101102102103103104104105105106107107108109
110110110110111111111112112112113113113114114114115115115116
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
117. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13.4. description13.5. file13.6. files13.7. install13.8. iso13.9. key13.10. md5sum13.11. os13.12. name (os)13.13. name (template)13.14. package13.15. packages13.16. repositories13.17. repository13.18. signed13.19. rootpw13.20. sha1sum13.21. sha256sum13.22. template13.23. url (repository)13.24. url (os)13.25. version
Chapter 14 . Application Blueprint XML Schema14.1. assemblies14.2. assembly14.3. contents (executable)14.4. contents (file)14.5. deployable14.6. description (deployable)14.7. description (service)14.8. executable14.9. file14.10. files14.11. image14.12. parameter14.13. parameters14.14. reference14.15. return14.16. returns14.17. service14.18. services14.19. value
Revision History
Preface
9
CloudForms 1.1 Cloud Engine User Guide
10
Preface
1. Document ConventionsThis manual uses several conventions to highlight certain words and phrases and draw attention tospecific pieces of information.
In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. TheLiberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternativebut equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes theLiberation Fonts set by default.
1.1. Typographic ConventionsFour typographic conventions are used to call attention to specific words and phrases. Theseconventions, and the circumstances they apply to, are as follows.
Mono-spaced Bold
Used to highlight system input, including shell commands, file names and paths. Also used to highlightkeys and key combinations. For example:
To see the contents of the file my_next_bestselling_novel in your current workingdirectory, enter the cat my_next_bestselling_novel command at the shell promptand press Enter to execute the command.
The above includes a file name, a shell command and a key, all presented in mono-spaced bold and alldistinguishable thanks to context.
Key combinations can be distinguished from an individual key by the plus sign that connects each part ofa key combination. For example:
Press Enter to execute the command.
Press Ctrl+Alt+F2 to switch to a virtual terminal.
The first example highlights a particular key to press. The second example highlights a key combination:a set of three keys pressed simultaneously.
If source code is discussed, class names, methods, functions, variable names and returned valuesmentioned within a paragraph will be presented as above, in mono-spaced bold. For example:
File-related classes include filesystem for file systems, file for files, and dir fordirectories. Each class has its own associated set of permissions.
Proportional Bold
This denotes words or phrases encountered on a system, including application names; dialog box text;labeled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:
Choose System → Preferences → Mouse from the main menu bar to launch MousePreferences. In the Buttons tab, click the Left-handed mouse check box and clickClose to switch the primary mouse button from the left to the right (making the mousesuitable for use in the left hand).
To insert a special character into a gedit file, choose Applications → Accessories →
Chapter 1. Introduction
11
Character Map from the main menu bar. Next, choose Search → Find… from theCharacter Map menu bar, type the name of the character in the Search field and clickNext. The character you sought will be highlighted in the Character Table. Double-clickthis highlighted character to place it in the Text to copy field and then click the Copybutton. Now switch back to your document and choose Edit → Paste from the gedit menubar.
The above text includes application names; system-wide menu names and items; application-specificmenu names; and buttons and text found within a GUI interface, all presented in proportional bold and alldistinguishable by context.
Mono-spaced Bold Italic or Proportional Bold Italic
Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variabletext. Italics denotes text you do not input literally or displayed text that changes depending oncircumstance. For example:
To connect to a remote machine using ssh, type ssh [email protected] at a shellprompt. If the remote machine is example.com and your username on that machine isjohn, type ssh [email protected] .
The mount -o remount file-system command remounts the named file system. Forexample, to remount the /home file system, the command is mount -o remount /home.
To see the version of a currently installed package, use the rpm -q package command. Itwill return a result as follows: package-version-release.
Note the words in bold italics above — username, domain.name, file-system, package, version andrelease. Each word is a placeholder, either for text you enter when issuing a command or for textdisplayed by the system.
Aside from standard usage for presenting the title of a work, italics denotes the first use of a new andimportant term. For example:
Publican is a DocBook publishing system.
1.2. Pull-quote ConventionsTerminal output and source code listings are set off visually from the surrounding text.
Output sent to a terminal is set in mono-spaced roman and presented thus:
books Desktop documentation drafts mss photos stuff svnbooks_tests Desktop1 downloads images notes scripts svgs
Source-code listings are also set in mono-spaced roman but add syntax highlighting as follows:
CloudForms 1.1 Cloud Engine User Guide
12
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient{ public static void main(String args[]) throws Exception { InitialContext iniCtx = new InitialContext(); Object ref = iniCtx.lookup("EchoBean"); EchoHome home = (EchoHome) ref; Echo echo = home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello")); }}
1.3. Notes and WarningsFinally, we use three visual styles to draw attention to information that might otherwise be overlooked.
Note
Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note shouldhave no negative consequences, but you might miss out on a trick that makes your life easier.
Important
Important boxes detail things that are easily missed: configuration changes that only apply to thecurrent session, or services that need restarting before an update will apply. Ignoring a boxlabeled 'Important' will not cause data loss but may cause irritation and frustration.
Warning
Warnings should not be ignored. Ignoring warnings will most likely cause data loss.
2. Getting Help and Giving Feedback
2.1. Do You Need Help?If you experience difficulty with a procedure described in this documentation, visit the Red Hat CustomerPortal at http://access.redhat.com. Through the customer portal, you can:
search or browse through a knowledgebase of technical support articles about Red Hat products.
submit a support case to Red Hat Global Support Services (GSS).
access other product documentation.
Chapter 1. Introduction
13
Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software andtechnology. You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo.Click on the name of any mailing list to subscribe to that list or to access the list archives.
2.2. We Need Feedback!If you find a typographical error in this manual, or if you have thought of a way to make this manualbetter, we would love to hear from you! Please submit a report in Bugzilla: http://bugzilla.redhat.com/against the product CloudForms Cloud Engine.
When submitting a bug report, be sure to mention the manual's identifier: Documentation-User_Guide
If you have a suggestion for improving the documentation, try to be as specific as possible whendescribing it. If you have found an error, please include the section number and some of the surroundingtext so we can find it easily.
CloudForms 1.1 Cloud Engine User Guide
14
Chapter 1. Introduction
1.1. About CloudFormsRed Hat CloudForms is an on-premise hybrid cloud Infrastructure-as-a-Service (IaaS) product that letsyou create and manage private and public clouds. It provides self-service computing resources to usersin a managed, governed, and secure way.
CloudForms is focused on two distinct sets of capabilities related to IaaS:
1. Providing the tools to build and manage hybrid clouds.
2. Providing the tools and processes to build, manage and launch applications that run on hybridclouds.
It integrates with existing products and technologies, including physical servers and virtualizationplatforms from other vendors, to provide the easiest on-ramp to an on-premise cloud. Using CloudForms,you can migrate to multiple public cloud providers, including those running a software stack from adifferent vendor.
CloudForms delivers automated resource management, automated workflow and policies to manage adiverse set of business applications in hybrid cloud environments. It also allows organizations toleverage public clouds for pay-as-you-go utility computing without creating another silo or losing controlof IT security or governance.
You can manage applications and infrastructure together as one unit, rather than as separate silos,simplifying the task of ensuring continuous compliance. Thus, all the infrastructure and applications willstay in sync with established policies at all times.
CloudForms usage is a four-phase process.
Chapter 2. First Time Login
15
Figure 1.1. The four phases of the CloudForms system
Phase 1: Use CloudForms to create a standard operating environment as a master componentoutline.
Phase 2: Build component outlines on top of a master component outline and customize each systemto your desired specification. Organize component outline collections in application templates.
Phase 3: Deploy and manage applications in cloud environments and provide runtime configuration.
Phase 4: Provide your systems with patches, updates, and ensure continuous compliance with RedHat subscriptions policy.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
16
1.2. About CloudForms Cloud EngineCloudForms Cloud Engine is a management application for cloud resources. It provides the followingfunctions:
Tools to abstract and utilize resources from multiple public and private cloud resource providers.
Creation of components used for producing virtual machine instances on cloud resource providers.
Deployment and runtime configuration of virtual machine instances.
Definition of deployment quotas and permissions for users.
Report a bug
1.3. Components
1.3.1. ConductorConductor is the web-based management console to help users control multiple clouds usingCloudForms Cloud Engine components. This includes helping users to launch virtual machines on acloud, tracking the virtual machines through their lifecycle, and removing them when they are no longerneeded.
Report a bug
1.3.2. DeltacloudDeltacloud is an open-source API that abstracts the differences between cloud resource providers forresource management. Deltacloud is built as a service-based REST API, and is the single API to manageall cloud resources. Clients communicate over HTTP to the Deltacloud server, which interacts withspecific Cloud providers.
Report a bug
1.3.3. Image FactoryImage Factory is a cloud image builder. It is a daemon with a REST interface that builds images forvarious cloud resource providers using description language-based templates.
Report a bug
1.3.4 . Image WarehouseImage Warehouse (iwhd) manages images built with Image Factory and moves them to their associatedcloud resource providers. Its functions include:
RESTful based requests
Unlimited key/value metadata associated with each image
Simple queries on metadata
Replication across different storage technologies based on policies defined by the user anddynamically evaluated in the context of object/container metadata
Report a bug
1.3.5. AudreyAudrey is a set of tools for run-time configuration of cloud instances. Audrey communicates with these
Chapter 3. Views, Searching and Filtering
17
components:
Audrey Configuration ServerThis component acts as a proxy for CloudForms Cloud Engine to communicate with Audrey-enabled instances.
Audrey AgentThis component is installed on an instance to communicate with the Audrey ConfigurationServer. Users should include this component in an image template as an additional package toinstall in order to enable Audrey on an instance. The Audrey Agent communicates with theAudrey Configuration Server when the instance launches. This enables a CloudFormsCloud Engine user to perform further configuration using a customizable script.
Report a bug
1.4. Supported Instance Operating SystemsCloudForms Cloud Engine 1.1 provides full feature support for the following instance operatingsystems:
Table 1.1. Supported Instance Operating Systems
Operating System Versions
Red Hat Enterprise Linux 6 6.4, 6.3, 6.2
Red Hat Enterprise Linux 5 5.9, 5.8, 5.7
Important
CloudForms Cloud Engine has the ability to install other guest operating systems on virtualmachine instances but not all features are supported for these operating systems.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
18
Chapter 2. First Time Login
2.1. Logging into CloudForms Cloud Engine for the First TimeCloudForms Cloud Engine uses a web interface to control the application. Access to CloudFormsCloud Engine requires a username and password.
Figure 2.1. CloudForms Cloud Engine login screen
Important
The CloudForms Cloud Engine installation procedure creates a first time admin account withthe password password. Change this password immediately after installation.
Procedure 2.1. Logging into CloudForms Cloud Engine
1. Use your preferred internet browser to navigate to https://[CloudEngineHost]/conductor
Chapter 4. Cloud Resources
19
Important
An untrusted connection warning appears on your web browser when accessing CloudEngine for the first time. Accept the self-signed certificate and add the Cloud Engine URLas a security exception to override the settings. This procedure might differ depending onthe browser being used.Only do this if you are sure that the Cloud Engine URL is a trusted source.
Figure 2.2. Untrusted Connection Warning
2. Enter your username and password and click Login.
A successful login takes you to the CloudForms Cloud Engine Monitor Dashboard, which showscritical information about your cloud environments.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
20
Chapter 3. Views, Searching and Filtering
3.1. ViewsCloudForms Cloud Engine provides two types of views for users to interact with the Monitoring userinterface. Change between these views with the User Interface Switch located at the top of the page.
Pretty ViewThe Pretty View provides a high-level layout of pools. This view displays applications andinstances in a graphical layout. Change to the Pretty View at anytime using the UI switch.
Figure 3.1. Pretty View in the UI switch
Filter ViewThe Filter View provides features for finding and sorting resources in your cloud. This viewdisplays applications and instances in a tabled layout. Change to the Filter View at anytimeusing the UI switch.
Figure 3.2. Filter View in the UI switch
Report a bug
3.2. SearchingSearch for resources in CloudForms Cloud Engine using the search box in the top-right corner of eachFilter View. Type your search value into the box and press Enter. CloudForms Cloud Engine returns alist of resources based on your search criteria.
Figure 3.3. Search box in Filter View
Report a bug
3.3. FilteringFilter resources in CloudForms Cloud Engine using the filter selection box in the top-right corner ofeach tabled view. Click the filter box and select the filtering method for your view. CloudForms CloudEngine returns a list of resources based on your filtering method.
Chapter 4. Cloud Resources
21
Figure 3.4 . Filter selection box in Filter View
Report a bug
CloudForms 1.1 Cloud Engine User Guide
22
Chapter 4. Cloud Resources
4.1. Cloud ResourcesCloudForms Cloud Engine contains a set of administrative tools to manage cloud resources, such asvirtual machine hardware abstractions and storage.
Report a bug
4.2. Cloud Resource Providers
4 .2.1. Cloud Resource ProvidersA cloud resource provider is a specific public or private virtualization environment. Users abstractresources from cloud resource providers to create cloud resource profiles, which CloudForms CloudEngine uses to create virtual machine instances in a deployment. Examples of cloud resource providersinclude Amazon Elastic Compute Cloud (Amazon EC2), Rackspace, GoGrid, a private VMWare ESXenvironment or a private Red Hat Enterprise Virtualization environment.
Figure 4 .1. Managing cloud resources for deployments
CloudForms Cloud Engine manages multiple cloud resource provider definitions simultaneously andcommunicates to each cloud resource provider using a special application programming interface calledDeltacloud.
Report a bug
4 .2.2. Supported Cloud Resource Providers
Chapter 4. Cloud Resources
23
Table 4 .1. Supported cloud resource providers
Provider Type Supported Providers
Private cloud products Red Hat Enterprise Virtualization, VMWare vSphere
Public cloud providers Amazon EC2
Report a bug
4 .2.3. Provider Connections
4 .2.3.1. Sett ing Up a Cloud Resource Provider ConnectionCloud resource provider setup first requires a connection to a provider using the appropriate Deltaclouddriver.
Figure 4 .2. Cloud resource provider connections
Setup your cloud resource provider connection with the following procedure.
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click the Create New Cloud Resource Provider button.
4. Type a Cloud Resource Provider Name for this connection.
5. Type the Cloud Resource Provider URL for the appropriate Deltacloud API driver.
6. Choose a Cloud Resource Provider Type from the list of supported resource providers.
7. Type any additional headers for the Deltacloud driver in the X-Deltacloud-Provider field.
8. Click on the Save Cloud Resource Provider button to save your new cloud resourceprovider connection.
CloudForms 1.1 Cloud Engine User Guide
24
This creates the cloud resource provider connection. Use this connection when entering cloud resourceprovider account details.
Important
CloudForms Cloud Engine administrators have the ability to add cloud resource providers usingthe aeolus-configure command line tool. Consult Section 3.2. Configuring CloudForms CloudEngine of the CloudForms Installation Guide for information on aeolus-configure use.
Important
Private cloud providers, such as Red Hat Enterprise Virtualization and VMware vSphere, requireconfiguration file edits before they are added to CloudForms Cloud Engine . Consult Appendix A.Private Cloud Configuration of the CloudForms Installation Guide for more information.
Report a bug
4 .2.3.2. Disable a Cloud Resource Provider ConnectionThis procedure disables a cloud resource provider connection in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider to be disabled.
4. Click the provider slide switch to change the state of the provider from ON to OFF.
5. An alert box displays the following message:
Disable provider? All its instances will be stopped.
Click OK. The disabled provider screen appears.
This disables the cloud resource provider connection and CloudForms Cloud Engine stops all itsinstances.
Report a bug
4 .2.4 . Provider Accounts
4 .2.4 .1. Sett ing Up a Cloud Resource Provider AccountEach cloud resource provider hosts a set of accounts for users to manage their cloud resources.CloudForms Cloud Engine can control multiple accounts for a single cloud resource provider.
Chapter 4. Cloud Resources
25
Figure 4 .3. Cloud resource provider account creation
This procedure sets up CloudForms Cloud Engine to connect with your cloud resource provideraccount.
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider to add an account.
4. Click on Accounts.
5. Click the New Account button. The New Cloud Resource Provider Account screenappears.
6. Enter the Account Name of the account.
7. Enter account credentials for the resource provider.
CloudForms 1.1 Cloud Engine User Guide
26
Table 4 .2. Required authentication details for Amazon EC2
Authentication Field Description
Access key A 20-character Access Key ID created in your AmazonWeb Services Account under Security Credentials →Access Credentials → Access Keys.
Secret access key Secret Access Key associated with the Access Key ID.This Secret Access Key is found in your Amazon WebServices Account under Security Credentials →Access Credentials → Access Keys.
Account number Your 12-digit Amazon Web Services account ID numberin your Amazon Web Services Account under SecurityCredentials → Account Identifiers.
Key PEM-encoded private key upload. Obtain this private keyfrom your Amazon Web Services Account by creating anew under Security Credentials → AccessCredentials → X.509 certificates.
Certificate PEM-encoded certificate file upload. Obtain thiscertificate from your Amazon Web Services Accountunder Security Credentials → Access Credentials→ X.509 certificates.
Table 4 .3. Required authentication details for RHEV-M and VMWare vSphere
Authentication Field Description
Username User with administrative access to the Provider.
Password The password associated with the user.
8. Type the Priority for your Cloud Resource Provider.
This defines the weighted probability that CloudForms Cloud Engine utilizes a cloud resourceprovider over others. Acceptable values range from -100 to 100, with lower values contributing toa higher probability. For example, a set of three providers with an equal priority of 0 yields a 33.33per cent chance of selection. However, a set of three providers with priority values of -1, 0 and 1yields respective probabilities of 33.67 per cent, 33.33 per cent and 33 per cent.
9. Type the Quota for this account. The quota defines the limit of instances for this account.
10. Click the Save button to save your new resource provider account configuration.
CloudForms Cloud Engine saves the cloud resource provider account details. Associate this accountwith cloud resource zones in your CloudForms Cloud Engine environment.
Report a bug
4 .2.4 .2. Adding an Audrey Configuration Server to a Resource Provider AccountThis procedure adds Audrey configuration server authentication to a cloud resource provider account.This enables an instance with Audrey Agent to communicate with CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider.
4. Click on Accounts for your chosen cloud resource provider.
Chapter 4. Cloud Resources
27
5. Click the desired account link in the Account Name column. The cloud resource provider accountinformation displays.
6. Click the Add link for the Config Server option.
7. Enter the Server Endpoint (URL) for your configuration server.
8. Enter the Consumer Key for your configuration server.
9. Enter the Consumer Secret for your configuration server.
10. Click the Save button. CloudForms Cloud Engine tests the connection to the configurationserver and saves your details.
CloudForms Cloud Engine adds the configuration server authentication details to your chosen cloudresource provider account.
Report a bug
4 .2.4 .3. Edit ing Audrey Configuration Server DetailsThis procedure edits Audrey configuration server authentication for a cloud resource provider account.
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider.
4. Click on Accounts.
5. Click the desired account link in the Account Name column. The cloud resource provider accountinformation displays including Config Server details.
6. Click the Edit link for the Config Server option.
7. Modify the Audrey configuration server settings.
8. Click the Save button. CloudForms Cloud Engine tests the connection to the configurationserver and saves your details.
CloudForms Cloud Engine saves the modified configuration server authentication details for your cloudresource provider account.
Report a bug
4 .2.4 .4 . Delete Audrey Configuration Server DetailsThis procedure removes Audrey configuration server authentication from a cloud resource provideraccount.
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider.
4. Click on Accounts.
5. Click the desired account link in the Account Name column.
6. The cloud resource provider account information displays including Config Server details. Click theDelete link for the Config Server option.
7. An alert box displays:
Are you sure you want to delete this config server?
Click OK.
CloudForms 1.1 Cloud Engine User Guide
28
CloudForms Cloud Engine removes the configuration server authentication details from your cloudresource provider account.
Report a bug
4.3. Cloud Resource Profiles
4 .3.1. Cloud Resource ProfilesCloudForms Cloud Engine provides the ability to define cloud resource profiles for your deployments.
A cloud resource profile abstracts hardware configuration settings across multiple providers in the cloudand applies them to a virtual machine instance during deployment to a cloud resource provider. Eachcloud resource profile contains a minimum value set for memory, CPUs, storage and architecture.CloudForms Cloud Engine matches this valueset with the closest predefined profile from each provider.
Report a bug
4 .3.2. Creating a New Cloud Resource Profile
Figure 4 .4 . Cloud resource profile creation
This procedure creates a cloud resource profile in CloudForms Cloud Engine . CloudForms CloudEngine matches this cloud resource profile against profiles from your resource providers, whichdetermines the optimal environments for application deployments.
1. Click on the Administer tab.
Chapter 4. Cloud Resources
29
2. Click on Content .
3. Click on Hardware .
4. Click the New Cloud Resource Profile button.
5. Type the Name of the cloud resource profile.
6. Type the amount of Memory for the cloud resource profile.
7. Type the number of CPUs for the cloud resource profile.
8. Type the Storage size in gigabytes.
9. Select the type of system Architecture for the profile. Choose from 32-bit (i386) or 64-bit(x86_64 ).
10. Click the Check Matches button to show profiles from cloud resource providers that match yourdesired configuration.
11. Click the Save button to save your new cloud resource profiles configuration.
CloudForms Cloud Engine creates a new cloud resource profile. This profile defines abstractedhardware specifications for instances in an application deployment.
Note
Some private cloud resources providers might not match cloud resource profiles if a user entersstorage data. Leave the Storage field blank in these cases.
Report a bug
4.4. Cloud Resource Clusters
4 .4 .1. Cloud Resource ClustersA cloud resource cluster is a provider-specific method of grouping cloud resources. Cloud resourceclusters contain either cloud resource providers, such as Amazon EC2 or Red Hat EnterpriseVirtualization, or their specific availability zones or datacenters, such as Amazon EC2 regions or datacenters in a Red Hat Enterprise Virtualization environment. CloudForms Cloud Engine uses cloudresource clusters to launch deployments into a specific provider or datacenter. If a cloud resourcecluster contains more than one mapping, CloudForms Cloud Engine selects the mapping based onprovider account priority. This provides a CloudForms Cloud Engine administrator with the ability togroup cloud resources from several provider accounts and provider-specific groups under a single cloudresource cluster.
CloudForms Cloud Engine contains locations for two different sets of Cloud Resource Clusterinformation. Please note the difference between the two locations.
Each provider account under Cloud Resource Providers shows a set of Provider Realms,which displays information on all available (clusters or availability zones) for a specific provider.
Under Content, Cloud Resource Clusters shows the user-defined mappings from the availableclusters.
CloudForms Cloud Engine users select the appropriate Cloud Resource Cluster section based uponthis distinction.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
30
4 .4 .2. Sett ing up a Cloud Resource Cluster
Important
To launch in a specific cluster, ensure to define only the cluster mapping and not the providermapping.
Figure 4 .5. Cloud resource cluster creation
This procedure creates a cloud resource cluster in CloudForms Cloud Engine and maps it to a specificcloud resource provider.
1. Create a cloud resource cluster:
a. Click on the Administer tab.
b. Click on Content .
c. Click on Cloud Resource Clusters.
d. Click the New Cloud Resource Clusters button.
e. Provide your cluster with a valid Name.
f. Provide your cluster with an optional Description.
g. Click the Save button to save your new cloud resource cluster.
2. Map a cloud resource cluster:
a. Option 1: Click Add mapping to cloud resource provider to map your cloudresource cluster to a cloud resource provider. Select a cloud resource provider and Save.
b. Option 2: Click Add mapping to cloud resource cluster to map your cloudresource cluster to a list of predefined clusters from your cloud resource providers. Select acluster and click Save.
3. To delete a mapping or several mappings, select each mapping using the checkboxes on the leftand click Delete.
Chapter 4. Cloud Resources
31
CloudForms Cloud Engine creates a cloud resource cluster that contains one or more mappings.
Report a bug
4.5. Clouds
4 .5.1. CloudsCloudForms Cloud Engine provides the ability to define clouds to group your cloud resource zones.
Figure 4 .6. Cloud resource zones organized into clouds
A cloud streamlines the setup of a multiple cloud resource zones to connect with a common set of cloudresource provider accounts. A cloud contains multiple cloud resource zones but each cloud resourcezone belongs to one cloud only. Clouds are associated with multiple cloud resource provider accounts,and cloud resource provider accounts deliver resources to multiple clouds. An administrator chooses asingle cloud, instead of having to choose several provider accounts, during cloud resource zonecreation. A cloud has an instance quota to limit provider resources delivered to cloud resource zones.
Report a bug
4 .5.2. Creating a New Cloud
CloudForms 1.1 Cloud Engine User Guide
32
Figure 4 .7. Cloud creation
This procedure creates a new cloud in CloudForms Cloud Engine . A cloud organizes your cloudresource zones into groups that assign resources from chosen cloud resource providers.
1. Click on the Administer tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click the New Cloud button.
4. Specify a valid Cloud Name.
5. Specify the Maximum Running Instances. Leave this field blank for unlimited instances.
6. Click the Save button to save your new cloud.
CloudForms creates a new cloud.
Report a bug
4 .5.3. Associating a Cloud with a Cloud Resource Provider AccountThis procedure adds an account to a cloud in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click on the name of your chosen cloud.
4. Click on Accounts. The list of cloud resource provider accounts associated with this clouddisplays in a tabled format.
5. Click the Add Account button. A list of unassociated cloud resource provider accounts displaysin a tabled format.
6. Select the checkboxes for all cloud resource provider accounts to associate with your chosencloud.
7. Click the Add Account button to add your selected cloud resource provider accounts.
Report a bug
Chapter 5. Component Outlines
33
4.6. Cloud Resource Zones
4 .6.1. Cloud Resource ZonesCloudForms Cloud Engine provides the ability to define cloud resource zones to group yourdeployments.
A cloud resource zone is a logical container for application deployments. CloudForms Cloud Enginelaunches a deployment to a zone only if the zone's cloud contains sufficient cloud provider resources tosatisfy a deployment's cloud resource profile. CloudForms also enforces a quota for each zone to definethe maximum number of instances generated from application deployments.
Report a bug
4 .6.2. Creating a Cloud Resource Zone
Figure 4 .8. Cloud resource zone creation
This procedure creates a new cloud resource zone in CloudForms Cloud Engine . This cloud resourcezone contains your application deployments.
1. Click on the Administer application tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click the New Cloud Resource Zone button for a chosen cloud.
4. Specify a valid Name for the resource zone.
5. Change the Cloud from the drop-down selector if necessary.
6. Specify the Quota of maximum instances in the resource zone. Click unlimited for unlimitedinstances.
7. Check the Cloud Resource Zone enabled? checkbox to set the resource zone to an activestate.
8. Click the Save button to save the new cloud resource zone.
CloudForms 1.1 Cloud Engine User Guide
34
CloudForms Cloud Engine creates a new cloud resource zone in your chosen cloud.
The creation of a cloud resource zone provides a CloudForms user with a means to organize andlaunch deployments.
Report a bug
4 .6.3. Provider Selection Strategies
4 .6.3.1. Creating a Provider Selection StrategyCloudForms Cloud Engine uses provider selection strategies to decide how to select an appropriateprovider for launching applications into a cloud resource zone. This procedure shows how to setupprovider selection strategies.
1. Click on the Administer application tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click the Edit button for a chosen cloud resource zone.
4. Click the Cloud Resource Provider Selection button. The Cloud ResourceProvider Selection Strategies page displays. This includes a list of AvailableCloud Resource Provider Accounts assigned to the parent cloud and a list of AvailableStrategies for the cloud resource zone.
5. Enable or disable any number of Available Strategies for the cloud resource zone usingthe on/off switches on the left. CloudForms Cloud Engine saves these selections automatically.
This applies a set of strategies to the cloud resource zone.
Report a bug
4 .6.3.2. Penalty for Failure StrategyThe Penalty for Failure strategy determines which cloud resource provider accounts have failedover a certain period of time and avoids them for future deployment of applications. This procedureshows how to setup the Penalty for Failure strategy.
1. Click the Administer application tab.
2. Click the Clouds. This displays a list of your clouds.
3. Click the Edit button for a chosen cloud resource zone.
4. Click the Cloud Resource Provider Selection button. The Cloud ResourceProvider Selection Strategies page displays.
5. Enable the Penalty for Failure strategy using the on/off switch on the left.
6. A Configure button appears for the newly enabled Penalty for Failure strategy. Click theConfigure button.
7. The Edit Penalty for Failure Strategy page appears. Enter your desired values forthe following options.
Percentage penalty for each failureAdds a penalty to the provider account. This helps determine the provider account withthe highest chance of success. For example, CloudForms Cloud Engine will choose aprovider account with a 10 per cent fail rate over a provider account with a 30 per centfail rate.
Time period over which the failures are aggregated (in minutes)
Chapter 5. Component Outlines
35
The time period to gauge past failures. For example, entering 240 includes all failureswithin the last 240 minute period.
The number of failures before the Cloud Resource Provider Account should not beused
The maximum number of failures for a provider account before CloudForms CloudEngine disregards it.
8. Click the Save button to save your strategy.
This applies the Penalty for Failure strategy to the cloud resource zone.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
36
Chapter 5. Component Outlines
5.1. Component OutlinesCloudForms Cloud Engine builds images from a component outline file. A component outline isconfiguration file with settings that correspond to a list of packages and system architecture for a virtualmachine. CloudForms Cloud Engine builds a component outline into an image, which a CloudFormsCloud Engine user deploys as virtual machine instances.
A component outline uses Template Description Language (TDL) to represent a system. TDL is an XML-based language to create component outlines for CloudForms. TDL files define aspects of a virtualmachine instance including operating system, installation settings, packages, and files.
Report a bug
5.2. Creating a Component OutlineThis task manually creates a new component outline file.
1. Open a text editor and create a new file.
2. Start a component outline with XML declaration and an open template tag:
<?xml version="1.0" encoding="UTF-8"?><template>
3. Provide the component outline with a name and an optional description:
<name>MyImage</name><description>My Custom Image</description>
4. Define os elements:
<os> <name>RHEL-6</name> <version>2</version> <arch>x86_64</arch> <install type="iso"> <url>http://www.example.com/isos/RHEL_6.2_x86_64.iso</url> <md5sum>3b85ec9ab2984b91070128be6aae25eb</md5sum> </install> <rootpw>p@55w0rd!</rootpw></os>
Note
Ensue to select an appropriate name value and version value. For more information onall values, refer to Example Component Outlines or Chapter 13.
5. Define custom repositories for additional packages:
Chapter 5. Component Outlines
37
<repositories> <repository name="MyRepo"> <url>http://www.example.com/repo/</url> <signed>false</signed> </repository> ...</repositories>
Note
Ensue to use a fully-qualified domain name for the url instead of localhost whenreferring to any repositories hosted on the CloudForms Cloud Engine host. Using localhost refers to the guest image and not to the Cloud Engine host.
6. Define additional packages:
<packages> <package name="httpd"/> <package name="custom-app"> <repository>MyRepo</repository> </package> ...</packages>
Note
The httpd package is installed from the main installation media while the custom-apppackage is installed from the MyRepo repository specified in repositories
7. Define files to save post-installation:
<files> <file name="/dir/filename" type="raw">** Content for your file ** </file> ...</files>
8. Define commands to execute post-installation:
<commands> <command name="HTTP Server On" type="raw">chkconfig httpd on </command> <command name="Copy File" type="raw">cp /dir/filename /dir/filecopy </command> ...</commands>
9. Close the component outline with a closing template tag:
CloudForms 1.1 Cloud Engine User Guide
38
</template>
10. Save the component outline file.
A new component outline is created. Import this component outline to CloudForms Cloud Engine tocreate images for your instances.
Report a bug
5.3. Example Component Outlines
5.3.1. Red Hat Enterprise Linux 6.3 via URL
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL6-3</name> <description>A Red Hat Enterprise Linux 6.3 image</description> <os> <name>RHEL-6</name> <version>3</version> <arch>x86_64</arch> <install type='url'> <url>http://example.org/rhel-6-x86_64</url> </install> <rootpw>p@55w0rd!</rootpw> </os></template>
Report a bug
5.3.2. Red Hat Enterprise Linux 5.8 via ISO
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL5</name> <description>A Red Hat Enterprise Linux 5.8 image</description> <os> <name>RHEL-5</name> <version>U8</version> <arch>x86_64</arch> <install type='iso'> <iso>http://example.org/rhel-5.8-x86_64.iso</iso> </install> <rootpw>p@55w0rd!</rootpw> </os></template>
Report a bug
5.3.3. Red Hat Enterprise Linux 6.3 with Audrey Agent
Chapter 5. Component Outlines
39
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL6-3</name> <description>A Red Hat Enterprise Linux 6.3 image</description> <os> <name>RHEL-6</name> <version>3</version> <arch>x86_64</arch> <install type='url'> <url>http://example.org/rhel-6-x86_64</url> </install> <rootpw>p@55w0rd!</rootpw> </os> <packages> <package name='aeolus-audrey-agent'/> </packages> <repository name='aeolusrepo'> <url> http://repos.example.org/repos/aeolus/ conductor/latest-release/RHEL-6.3/x86_64/ </url> <signed>False</signed> </repository> <commands> <command name="RHEL6.3 updates" type="raw">yum update -y</command> </commands></template>
Note
The command section of this component outline instructs the virtual machine to update uponbooting.
Report a bug
5.3.4 . Red Hat Enterprise Linux 6.3 with HTTP Web Server
CloudForms 1.1 Cloud Engine User Guide
40
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL6Web</name> <description>A RHEL 6.3 image with a web server</description> <os> <name>RHEL-6</name> <version>3</version> <arch>x86_64</arch> <install type='url'> <url>http://example.org/rhel-6-x86_64</url> </install> <rootpw>p@55w0rd!</rootpw> </os> <packages> <package name="httpd"/> </packages> <files> <file name="/var/www/html/index.html" type="raw"><![CDATA[<html> <head> <title>Welcome!</title> </head> <body> <p>Welcome to my webserver!</p> </body></html> ]]></file> </files> <commands> <command name="HTTP Server On" type ="raw">chkconfig httpd on</command> </commands></template>
Note
The command section of this component outline instructs the HTTP Web Server to start at boot.
Report a bug
5.3.5. Red Hat Enterprise Linux 6.3 with vm-tools agent (VMware vSphere)
Chapter 5. Component Outlines
41
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL6-3</name> <description>A Red Hat Enterprise Linux 6.3 image</description> <os> <name>RHEL-6</name> <version>3</version> <arch>x86_64</arch> <install type='url'> <url>http://example.org/rhel-6-x86_64</url> </install> <rootpw>p@55w0rd!</rootpw> </os> <packages> <package name='open-vm-tools'/> </packages> <repository name='vm-toolsrepo'> <url>http://repos.example.org/repos/</url> <signed>False</signed> </repository></template>
Note
This template installs vm-tools agent . Install this package to have VMware vSphere supportmore functions.
Report a bug
5.3.6. Red Hat Enterprise Linux 6.3 with rhev-agent (RHEV)
<?xml version="1.0" encoding="UTF-8"?><template> <name>RHEL6-3</name> <description>A Red Hat Enterprise Linux 6.3 image</description> <os> <name>RHEL-6</name> <version>3</version> <arch>x86_64</arch> <install type='url'> <url>http://example.org/rhel-6-x86_64</url> </install> <rootpw>p@55w0rd!</rootpw> </os> <packages> <package name='rhev-agent'/> </packages> <repository name='rhev-agentrepo'> <url>http://repos.example.org/repos/</url> <signed>False</signed> </repository></template>
CloudForms 1.1 Cloud Engine User Guide
42
Note
This template installs rhev-agent . Install this package to have Red Hat Enterprise Virtualizationsupport more functions.
Report a bug
5.4. Including Target-Specific Packages and Repositories forComponent OutlinesSome images might require certain packages and repositories based upon a target criteria. CloudFormCloud Engine provides the ability to automatically include this content into component outlines withoutrequiring constant inclusion within each individual component outline.
The /etc/imagefactory/target_content.xml file defines the content to include in target-specific images. If this file does not exist, create it.
The target_content.xml file is a standard XML document containing a root template_includeselement and several include sub-elements. Each include sub-element defines a target criteria andcontent for inclusion. This content definition uses the standard TDL packages and repositorieselements.
<template_includes> <include target='...' os='...' version='...' arch='...'> <packages> ... </packages> <repositories> ... </repositories> </include> <include target='...' os='...' version='...' arch='...'> <packages> ... </packages> <repositories> ... </repositories> </include></template_includes>
The include element contains several attributes to use as criteria.
Chapter 5. Component Outlines
43
Table 5.1. Attributes for target-specific criteria
Element Description
target The target provider for the image. Use ec2, rhevm and vsphere to choose atarget image type. Use all for all images.
os The operating system for the image. Aligns with the TDL os element in componentoutlines.
version The version for the operating system. Aligns with the TDL version element incomponent outlines.
arch The architecture for the operating system. Aligns with the TDL arch element incomponent outlines.
CloudForms Cloud Engine chooses the target-specific inclusion that closest matches the defined TDLelements in the following order of priority: target (highest), os, version and arch (lowest). If lowerpriority attributes are not defined, CloudForms Cloud Engine ignores this attribute and matches basedupon higher priority attributes. For example, if the arch is omitted, the criteria matches to target, osand version.
Important
All include elements require the target at minimum. Ensure each include contains a target.
CloudForms 1.1 Cloud Engine User Guide
44
Example 5.1. Sample target_content.xml file
The following target_content.xml extract defines packages to include that are specific to variouscombinations of Red Hat Enterprise Linux 5 and 6 targeted to Amazon EC2 and Red Hat EnterpriseVirtualization providers.
<template_includes> <include target='ec2' os='RHEL-6'> <packages> <package name='my-rhel6-package-for-ec2'/> </packages> </include> <include target='rhevm' os='RHEL-6'> <packages> <package name='my-rhel6-package-for-rhevm'/> </packages> </include> <include target='ec2' os='RHEL-5'> <packages> <package name='my-rhel5-package-for-ec2'/> </packages> </include> <include target='rhevm' os='RHEL-5'> <packages> <package name='my-rhel5-package-for-rhevm'/> </packages> </include> </template_includes>
Note the omitted version and arch attributes. This creates a broader target specification criteria forthe packages.
Report a bug
5.5. Exporting a Component Outline from System Engine
5.5.1. About CloudForms System EngineCloudForms System Engine is an Infrastructure-as-a-Service (IaaS) application that provides tools toupdate systems within hybrid clouds. System Engine can be used to configure new systems,subscribe to updates, and maintain installations in distributed environments.
Report a bug
5.5.2. System TemplatesA system template defines the subscribed products and installed packages for a system in CloudFormsSystem Engine .
Once CloudForms System Engine creates and exports a system template, a user imports it intoCloudForms Cloud Engine as a component outline. CloudForms Cloud Engine uses this componentoutline to create images with the same subscribed products and packages.
Report a bug
Chapter 5. Component Outlines
45
5.5.3. Exporting a System TemplateThis procedure exports a system template from CloudForms System Engine as a new TemplateDescription Language (TDL) component outline. CloudForms Cloud Engine uses this componentoutline to generate images for deployment to resource providers.
Warning
Adding certain packages in CloudForms System Engine templates can upgrade the kernel onEC2 images, which can cause boot failure and render the image useless. Red Hat does notsupport upgrading the kernel of EC2 instances outside of Red Hat Update Infrastructure .
Procedure 5.1. Exporting a System Template
1. Click Content → System Templates.
2. A list of system templates is displayed under the System Templates menu on the right. Select thesystem template you wish to export.
3. Click the Download button at the bottom of the menu.
4. Select the environment you want to download your template from.
5. Click the Download button.
6. Save the system template into your local machine.
A system template is exported to your local machine.
Note
Debug Certificates are automatically generated for system template downloads if they do notalready exist in the organization for which they are being downloaded.
Report a bug
5.5.4 . Importing a CloudForms System Engine Component Outline into CloudForms CloudEngineCloudForms System Engine component outlines function the same as standard TDL componentoutlines. Refer to the next section for instructions on building TDL component outlines into CloudFormsCloud Engine images.
Report a bug
5.6. Images
5.6.1. ImagesA CloudForms Cloud Engine user builds a TDL file into an image, which contains a series of provider-specific target images. These target images are pushed and stored with their respective cloud resourceproviders.
Images
CloudForms 1.1 Cloud Engine User Guide
46
An image is a virtual machine base built from a Template Description Language (TDL) file.CloudForms Cloud Engine deploys images as virtual machine instances on Cloud ResourceProviders.
Figure 5.1. The CloudForms Cloud Engine process for building and pushing images
An image in CloudForms Cloud Engine contains the following parts:
BuildCloudForms Cloud Engine records each image created from a template as an individual build.Each build includes individual images for specific providers. This means CloudForms CloudEngine generates images for multiple providers based upon a single template.
Target ImageA target image is an image built for a specific cloud resource provider type. For example,CloudForms Cloud Engine has the ability to create target images for both Amazon EC2 andRed Hat Enterprise Virtualization Manager as part of a single build. These target images arepushed to their respective cloud resource providers for deployment.
Chapter 5. Component Outlines
47
Provider ImageA provider image is an image pushed and stored on a cloud resource provider. CloudFormsCloud Engine uses the chosen provider image to deploy virtual machine instances.
Report a bug
5.6.2. Building an Image from a Component OutlineThe following procedure demonstrates how to load a TDL component outline and build it into an imagefor a specific cloud resource provider.
1. Initial steps:
a. Ensure CloudForms can access your TDL file either from your client machine or from a URL.
b. Click on the Administer tab.
c. Click on Clouds. This displays a list of your clouds.
d. Click on New Image for a chosen cloud.
2. Option 1: Import the component outline from a file upload:
Figure 5.2. Upload a component outline from a file
a. Type a Name for your image.
b. Click Browse and select your component outline.
c. Select the Edit this file before saving checkbox to edit the component outlinebefore saving it to the database.
3. Option 2: Import the component outline From URL:
CloudForms 1.1 Cloud Engine User Guide
48
Figure 5.3. Upload a component outline from a URL
a. Type a Name for your image.
b. Type the Component Outline URL for your component outline.
c. Select the Edit this file before saving checkbox to edit the component outlinebefore saving it to the database.
4. Edit the component outline:
a. Edit the imported Template Description Language (TDL) XML in the textbox provided.
b. Click the Save and Continue to complete the component outline import.
5. Verifying the image
a. CloudForms Cloud Engine verifies a valid image from your component outline.
b. Click Save Component Outline to save the component outline and create an image.
c. The Image Properties screen displays. Click the Build for each target image you wishto build or click Build All to build all target images.
CloudForms Cloud Engine loads your component outline and builds it into an image.
Report a bug
5.6.3. Pushing an Image to a Cloud Resource Provider
Chapter 5. Component Outlines
49
Figure 5.4 . Click the Push button to push an image to a cloud resource provider
This procedure pushes an image to a cloud resource provider.
1. Click on the Administer tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click on Images. A list of images stored in CloudForms Cloud Engine displays.
4. Click the Name of an image. The image detail screen displays.
5. Click the Push button to push a target image to its cloud resource provider.
6. Wait for CloudForms Cloud Engine to complete the image push.
CloudForms Cloud Engine pushes your target image to your cloud resource provider.
Note
CloudForms Cloud Engine uses snapshots of Amazon Machine Images when pushing imagesto EC2 cloud resource providers. CloudForms Cloud Engine does not support image uploads toEC2 cloud resource providers.
Report a bug
5.6.4 . Importing an Image from a Cloud Resource ProviderThis procedure imports an image from a cloud resource provider.
1. Click on the Administer tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click on name of cloud. A list of images stored in CloudForms Cloud Engine displays.
4. Click on Images. This displays a list of images for your chosen cloud.
5. Click the Import Image button.
CloudForms 1.1 Cloud Engine User Guide
50
6. Choose a Cloud Resource Provider Account from the drop-down selector.
7. Enter the Cloud Resource Provider's Image ID from your cloud resource provider.
8. Enter a valid Image Name.
9. Click Continue to import the component outline.
CloudForms Cloud Engine imports your image from your cloud resource provider.
Note
Each cloud in the Clouds section contains an Import Image shortcut.
Note
Imported images from cloud resource providers require Audrey Agent to work with AeolusConfiguration Server. Runtime configuration is available only on instances with the Audrey Agent.
Chapter 5. Component Outlines
51
Important
The Component Outline ID refers to the image or template ID for your cloud resourceproviders.Amazon EC2 providers require the format ami-xxxxxxx for component outline identification. Findthese ami-xxxxxxx values in your Amazon Web Services (AWS) Management Console.Red Hat Enterprise Virtualization providers require a template UUID for the image. Access a list ofthese UUIDs via the Red Hat Enterprise Virtualization Manager's REST API as per the followingsteps.
1. Ensure you have the proper SSL certification imported on your client. To obtain a certificatefrom Red Hat Enterprise Virtualization Manager, follow the instructions in Section 2.1.TLS/SSL Certification of the Red Hat Enterprise Virtualization 3.0 REST API Guide. Importthe certificate using the following command:
# certutil -d sql:$HOME/.pki/nssdb -A -t TC -n "Red Hat Enterprise Virtualization Manager" -i [CERT-FILE]
2. View a list of template UUIDs using the following command on your Red Hat EnterpriseVirtualization Manager's REST API:
# curl https://[RHEVM-HOST]/api/templates --user [USER]@[DOMAIN]:[PASSWORD]
To search for template with a specific name, use the following command:
# curl https://[RHEVM-HOST]/api/templates?search=name%3D[TEMPLATE-NAME] --user [USER]@[DOMAIN]:[PASSWORD]
The API returns an XML representation of each template and its UUID:
<templates> <template id="[UUID]" href="/api/templates/[UUID]"> <name>Template_01</name> ... </template> <template id="[UUID]" href="/api/templates/[UUID]"> <name>Template_02</name> ... </template> ... </templates>
Use this UUID as the Component Outline ID for CloudForms Cloud Engine imports.
Report a bug
5.6.5. Deleting an Image from CloudForms Cloud EngineThe following procedure demonstrates how to delete an image from CloudForms Cloud Engine .
1. Initial steps:
a. Click on the Administer tab.
b. Click on Clouds.
CloudForms 1.1 Cloud Engine User Guide
52
c. Click on Images.
d. Click on the image template name you want to delete.
2. Option 1: Delete a target image and all associated provider image records:
a. Click on Delete next to the Cloud Provider type name.
Note
While all associated image records are deleted, the image template is not deleted,and is available for reuse.
3. Option 2: Delete a single provider image record:
a. Click on the X mark next to the provider image for deletion.
4. Option 3: Delete an image template and all associated image records:
a. Click on the red Delete .
Warning
All associated image records, including the image template will be deleted.
b. Click on OK when prompted
Important
All three delete options only delete image records from the client's side. If you want to deleteimage records from both the client and provider's side, go to the provider's management console,and use the Component Outline UUID to search and delete the image records.
Report a bug
5.7. Using the Command Line Tool
5.7.1. Command Line Tool (aeolus)CloudForms Cloud Engine uses a command-line interface application (aeolus) as a basis for buildingand pushing to cloud resource providers.
Report a bug
5.7.2. Building an Image via Command LineThis task uses the aeolus command line tool to build a Template Descriptor Language (TDL) file intoan image for a cloud resource provider.
1. Ensure the TDL file is stored in a location aeolus can access on your CloudForms CloudEngine host.
2. Run the following command:
# aeolus image build --target [TARGET] --template [FILENAME]
Chapter 5. Component Outlines
53
The following output displays for building an Amazon EC2 image:
# aeolus image build --target ec2 --template ec2-template.xmlTarget Image Target Status ------------------------------------ ------ ---------749799f5-5096-4ce4-8c96-7da8365e7f80 ec2 COMPLETED
Image Build------------------------------------ ------------------------------------a01199a4-9bd0-46ae-9665-df07034a9357 f9e1ceec-8073-4299-8ab8-26f3d3e9ff10
#
CloudForms Cloud Engine creates a new image from the template. This image contains a build,which includes target images for specific cloud resource provider types.
aeolus builds the TDL file and pushes the resulting image to the cloud resource provider.
Report a bug
5.7.3. Pushing an Image via Command LineThis task uses the aeolus command line tool to push a built image to the cloud resource provider.
1. Run the following command:
# aeolus image push --account [ACCOUNT] --image [IMAGE-UUID]
The following output displays for a push to an Amazon EC2 account:
# aeolus image push --account ec2 --image a01199a4-9bd0-46ae-9665-df07034a9357ID Provider ------------------------------------ -------------1154c01e-c05d-45eb-9563-aac4e03b0688 ec2-us-east-1
Account Status Image ------- ------ ------------------------------------ec2 New a01199a4-9bd0-46ae-9665-df07034a9357 #
CloudForms Cloud Engine starts the process to push all target images associated with thechosen image to their respective providers.
2. To view the progress of the push, run the following command:
# tail -f /var/log/imagefactory.log /var/log/iwhd.log
This command outputs a continuous update of the logs associated with image building andpushing. The push will finish with the following line:
2011-11-24 15:18:20,769 DEBUG imgfac.ImageWarehouse.ImageWarehouse pid(1226) Message: Setting metadata ({'latest_unpushed': None}) for http://localhost:9090/images/caeabf4b-8b7f-404f-b06b-b4b4607d9445
CloudForms 1.1 Cloud Engine User Guide
54
Press CTRL-C to return to the command prompt.
aeolus pushes the built image to the cloud resource provider.
Report a bug
5.7.4 . Command Line Reference
5.7.4 .1. Command Line SyntaxUse the following syntax to run aeolus functions:
# aeolus [ACTION-TYPE] [COMMAND] [GENERAL-OPTIONS] [COMMAND-OPTIONS]
The following table outlines the action type for aeolus.
Table 5.2. aeolus action type
Command Description
image Actions related to image builds, pushes, and imports.
The following table outlines the commands for aeolus image.
Table 5.3. aeolus commands
Command Description
list List resources such as images, image targets, cloudresource providers, resource provider accounts.
build Build an image from a TDL file.
push Push a built image to a cloud resource provider.
import Import an image from a cloud resource provider.
delete Delete a built image.
Report a bug
5.7.4 .2. List OptionsUse the following options with the list command.
List options
-i, - - imagesRetrieve a list of all images.
-E, --environment ENVIRONMENTLimit image list to environment.
-b, - -builds IMAGEIDRetrieve a list of all builds for an image. Requires the UUID of an image.
Chapter 5. Component Outlines
55
-t , - - targetimages BUILDIDRetrieve a list of all target images for a build. Requires the UUID of a build.
-P, --providerimages TARGETIMAGERetrieve a list of all provider images for a target image. Requires the UUID of a target image.
-g, - -targetsRetrieve a list of all cloud resource provider types.
-p, - -providersRetrieve a list of cloud resource provider connections in CloudForms Cloud Engine .
-a, - -accountsRetrieve a list of cloud resource provider accounts in CloudForms Cloud Engine .
-c, - -environmentsRetrieve a list of clouds in CloudForms Cloud Engine .
CloudForms 1.1 Cloud Engine User Guide
56
Example 5.2. Examples for list command
List images:
# aeolus image list --images
List builds:
# aeolus image list --builds 29f75966-52b7-11e1-8b34-001a4a400e1c
List target images:
# aeolus image list --targetimages 5537e55a-8e7b-4030-b4e8-8e062a5c99e8
List provider images:
# aeolus image list --providerimages 5c0c27db-161b-4421-8dfb-2f551b74f296
List provider types:
# aeolus image list --targets
List cloud resource providers:
# aeolus image list --providers
List cloud resource provider accounts:
# aeolus image list --accounts
List clouds:
# aeolus image list --environments
Report a bug
5.7.4 .3. Build OptionsUse the following options with the build command.
Build options
-e, --template FILEBuild an image from a TDL file. Requires a the local location of a TDL file.
-z, - -no-validationDisable TDL validation of template file.
-T, - -target TARGET1,TARGET2Disable TDL validation of template file.
Chapter 5. Component Outlines
57
-E, --environment ENVIRONMENTBuild for specific cloud.
Example 5.3. Examples for build command
Build image for a cloud resource provider:
# aeolus image build --target ec2 --template mytemplate.xml --environment default
Build image for multiple cloud resource providers:
# aeolus image build --target ec2,rhevm --template mytemplate.xml --environment default
Report a bug
5.7.4 .4 . Push OptionsUse the following options with the push command.
Push options
-I, - - image IMAGEIDUse base image for the push. Requires the UUID of an image.
-B, --build BUILDIDUse build for the push. Requires the UUID of a build.
-t , - - targetimages TARGETIDUse target image from a build. Requires the UUID of a target image.
-A, --account NAME1,NAME2Name of cloud resource provider accounts to use for pushing target images. Ensure a targetimage exists for each account.
CloudForms 1.1 Cloud Engine User Guide
58
Example 5.4 . Examples for push command
Push target image to an account:
# aeolus image push --account myaccount --targetimage 5c0c27db-161b-4421-8dfb-2f551b74f296
Push target images from a build to accounts:
# aeolus image push --account myaccount --build 5537e55a-8e7b-4030-b4e8-8e062a5c99e8
Push target images from an image to accounts:
# aeolus image push --account myaccount --image 29f75966-52b7-11e1-8b34-001a4a400e1c
Report a bug
5.7.4 .5. Import OptionsUse the following options with the import command.
Import options
-d, -- id IDThe ID for a given object.
Table 5.4 . IDs for Import to CloudForms Cloud Engine
Provider ID Type Example
Amazon EC2 Amazon MachineImage (AMI) ID
ami-79af0410
Red Hat EnterpriseVirtualization
Template UUID 99408929-82cf-4dc7-a532-9d998063fa95
VMware vSphere Template UUID 99408929-82cf-4dc7-a532-9d998063fa95
-r, - -description DESCRIPTIONThe XML description for an object.
-A, --account NAME1,NAME2Names of the cloud resource provider accounts to use for imports.
-E, --environment ENVIRONMENTName of the clouds to use for imports.
Chapter 6. Applications
59
Example 5.5. Examples for import command
Import image from a provider:
# aeolus image import --account my-ec2 --environment default --id ami-8d0cdce4 --description '<image><name>myAMI</name></image>'
Report a bug
5.7.4 .6. Delete OptionsUse the following options with the delete command.
Delete options
-I, - - image IMAGEIDDelete an image and all associated builds.
-B, --build BUILDIDDelete a single build and all associated target images.
-m, --targetimage TARGETIDDelete a single target image from a build and all associated cloud resource provider images.
-D, --providerimage PROVIDERIMAGEIDDelete a single image on a cloud resource provider.
Example 5.6. Examples for delete command
Delete image:
# aeolus image delete --image 29f75966-52b7-11e1-8b34-001a4a400e1c
Delete build:
# aeolus image delete --build 5537e55a-8e7b-4030-b4e8-8e062a5c99e8
Delete target image:
# aeolus image delete --targetimage 5c0c27db-161b-4421-8dfb-2f551b74f296
Delete provider image:
# aeolus image delete --providerimage 9085b2d3-5edd-4d8d-8344-095d5b5bb00e
Report a bug
CloudForms 1.1 Cloud Engine User Guide
60
Chapter 6. Applications
61
Chapter 6. Applications
6.1. ApplicationsAn application is the result of a CloudForms process. An application is an instance, or set of instances,launched on a cloud resource provider. CloudForms imports an application blueprint identifying the builtcomponent outline and desired hardware profile, and launches the application into a chosen cluster.CloudForms selects a resource provider from the chosen cluster that best fits a cloud resource profile'srequirements. CloudForms then launches the application's instances into the cloud resource provider.
This chapter examines the process of creating application deployments. This process includes thefollowing stages:
1. Create a catalog for application blueprints.
2. Assign images to application blueprints to define instances in an application.
3. Create an application from an application blueprint and deploy it to a cloud resource provider.
Report a bug
6.2. Catalogs
6.2.1. CatalogsCloudForms Cloud Engine creates catalogs to group your application blueprints. A catalog is acollection of application blueprints. These blueprints define the deployment configuration of a set ofsystems in an application. CloudForms administrators define a series of application blueprints, eachcontaining a reference to a component outline. These blueprints simplify the process of launching anapplication to a cloud resource provider.
Report a bug
6.2.2. Creating a CatalogThis procedure creates a new catalog with CloudForms Cloud Engine . Catalogs contain applicationblueprints.
Figure 6.1. New catalog creation
CloudForms 1.1 Cloud Engine User Guide
62
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Click the New Catalog button.
4. Specify a valid Name for the catalog.
5. Choose a Cloud Resource Zone for the catalog.
6. Click the Save button to save your new catalog.
CloudForms creates a new catalog to store catalog entries.
Report a bug
6.2.3. Edit ing a CatalogThis procedure edits a catalog's details.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Click on the Name link of a catalog to edit.
4. Click on the Edit button.
5. Modify the catalog details.
6. Click the Save button to save the catalog changes.
CloudForms Cloud Engine saves changes to the chosen catalog.
Report a bug
6.2.4 . Deleting CatalogsThis procedure deletes a single catalog or multiple catalogs.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Option 1: Single delete
a. Click on the Name link of a catalog to delete.
b. Click on the Delete button. An alert box displays:
Are you sure you want to proceed?
Click OK.
4. Option 2: Multiple delete
a. Click the checkboxes of all catalogs to delete.
b. Click the Delete button. An alert box displays:
Are you sure you want to proceed?
Click OK.
CloudForms Cloud Engine deletes your chosen catalogs.
Chapter 6. Applications
63
Report a bug
6.3. Application Blueprint
6.3.1. Application BlueprintCloudForms Cloud Engine uses application blueprints to define the instances in an application. Anapplication blueprint makes a reference to a component outline and a cloud resource profile, or multiplesets of both, to define each instance. CloudForms Cloud Engine also builds blueprints either from asingle image or from an XML file import.
CloudForms Cloud Engine provides the ability to edit application blueprints to include additionalcomponent outlines or create multiple instances in a deployment.
Report a bug
6.3.2. Creating an Application Blueprint from a Component OutlineThis procedure adds a new application blueprint from a component outline.
Figure 6.2. Application blueprint creation from a component outline
1. Click on the Administer tab.
2. Click on Clouds. This displays a list of your clouds.
3. Click on Images. A list of your images displays in a tabled format.
4. Click on the Name of a image in the table. Information about the image displays in a new screen.
5. Click the New Application Blueprint from Image button.
6. The Create Application Blueprint screen appears. Provide the application blueprint witha Name and select Default Cloud Resource Profile for the instance.
CloudForms 1.1 Cloud Engine User Guide
64
Important
If you intend to launch the application right away after step 8, make sure the ApplicationBlueprint Name , which is also the default Application Name , is within the character limit.The total characters of the Application Name and the Image Name combined should notexceed 50 characters, otherwise an error will occur when creating applications.
7. Choose the Catalog to post the application blueprint. Mark the checkboxes to specify one ormore catalogs for the blueprint.
8. Click the Save button to save your application blueprint to the chosen catalogs.
CloudForms creates a new application blueprint based upon an image and saves the blueprint in yourchosen catalogs. This blueprint refers to the chosen images to form an instance in a deployment. Thisblueprint also refers to the chosen cloud resource profile to define the logical hardware specifications ofyour instance.
Report a bug
6.3.3. Creating an Application Blueprint from a File ImportThis procedure adds a new application blueprint using an XML file to define the application.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Choose a catalog to add the blueprint. Click on its Name link.
4. Click the New Application Blueprint button.
5. Choose either to Upload a file or load the blueprint From URL.
6. Specify a valid Name for the application blueprint.
7. Provide a Description for the application blueprint.
8. If Upload is selected:a. Click Browse and select the application blueprint filename.
9. If From URL is selected:a. Specify the URL for the application blueprint's file.
10. Select the Edit XML file after save checkbox to edit your blueprint after pressing Save .
11. Click the Save button to save your new application blueprint.
CloudForms Cloud Engine creates a new application blueprint in the catalog. This blueprint containsreferences to a component outline, or set of component outlines, to form instances in an application.This blueprint also contains references to cloud resource profiles to define the logical hardwarespecifications of your instances.
Report a bug
6.3.4 . Example Application Blueprint file
Chapter 6. Applications
65
<deployable name="My Application Blueprint"> <description>This is an example Application Blueprint file</description> <assemblies> <assembly name="samplehost" hwp="hwp1"> <image id="609a6eee-5ec5-4b13-8486-7491d091f8dc" /> </assembly> <services> <service name="httpd"> <executable> <contents><![CDATA[#!/bin/bashservice httpd start ]]></contents> </executable> <files> <file> <contents filename="/var/www/html/index.html"><![CDATA[<html> <head> <title>Welcome!</title> </head> <body> <p>Welcome to my webserver!</p> </body></html> ]]></contents> </file> </files> </service> </services> </assemblies></deployable>
Note
This application blueprint uses runtime configuration. Make sure your CloudForms Cloud Engineserver is configured with Audrey.
Report a bug
6.3.5. Edit an Application BlueprintThis procedure edits an application blueprint's details.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Choose a catalog with blueprints to edit. Click on the Name link.
4. Click on the Name link of an application blueprint to edit.
5. Click on the Edit button.
6. Modify the application blueprint details.
7. Click the Save button to save the application blueprint changes.
CloudForms saves changes to the chosen application blueprint.
CloudForms 1.1 Cloud Engine User Guide
66
Report a bug
6.3.6. Add an Application Blueprint to Additional CatalogsThis procedure adds an application blueprint to a new catalog.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Choose a catalog with blueprints. Click on the Name link.
4. Click on the Name link of an application blueprint.
5. Scroll to the Catalogs section. This section indicates the catalogs that currently contain theapplication blueprint.
6. Choose a catalog to enable access from the drop-down menu and click the Add +button.
CloudForms Cloud Engine adds the application blueprint to a new catalog.
Report a bug
6.3.7. Deleting Application BlueprintsThis procedure deletes a single application blueprint or multiple application blueprints.
1. Click on the Administer tab.
2. Click on Content . This displays a list of your catalogs.
3. Choose a catalog with blueprints to delete. Click on its Name link.
4. Option 1: Single delete
a. Click on the Name link of an application blueprint to delete.
b. Click on the Delete button. An alert box displays:
Are you sure you want to delete?
Click OK.
5. Option 2: Multiple delete
a. Click the checkboxes of all application blueprints to delete.
b. Click the Remove button in the Application Blueprints section. An alert box displays:
Are you sure you want to delete?
Click OK.
CloudForms deletes your chosen application blueprints.
Report a bug
6.4. Applications and Instances
6.4 .1. Creating a New ApplicationThis procedure creates a new application in CloudForms Cloud Engine . Applications launch instancesinto cloud resource providers.
Chapter 6. Applications
67
1. Open CloudForms Cloud Engine .
2. Click on the Monitor application tab.
3. Choose a cloud resource zone for application creation and click its name.
4. Click the New Application button. The application creation screen appears.
Figure 6.3. Application creation screen
5. Specify a valid Application Name.
Important
Limit the Application Name , so that the total characters of the Application Name and theImage Name combined should not exceed 50 characters, otherwise an error will occurwhen creating applications.
6. Choose a Application Blueprint from the drop-down selector.
7. Choose a valid Cloud Resource Cluster for the application.
8. Click the Next button. The deployment launch confirmation screen appears.
CloudForms 1.1 Cloud Engine User Guide
68
Figure 6.4 . Application launch confirmation screen
9. Review the application details. If an error occurs during instance launch, the deployment processterminates and CloudForms Cloud Engine displays an appropriate error message. To ignoreinstance errors and proceed with the deployment process until completion, choose Ignoreinstance errors during launch.
10. Click the Launch button to launch the application.
Figure 6.5. A launched application containing a single instance
CloudForms creates an application and launches its instances into your chosen cluster.
Chapter 7. Runtime Configuration
69
Note
CloudForms only creates applications in enabled cloud resource zones. The applicationdeployment fails if the chosen zone is disabled.
Important
CloudForms Cloud Engine stores information on running instances, such as references to basecomponent outlines. As a recommendation, do not delete any component outlines that runninginstances have used.
Report a bug
6.4 .2. Deleting an ApplicationThis procedure deletes an application or multiple applications.
1. Open CloudForms Cloud Engine .
2. Click on the Monitor application tab.
3. Choose a cloud resource zone for application creation and click its name.
4. Option 1: Single delete
a. Click on the Name link of an application to delete.
b. Click on the Delete button. An alert box displays:
Are you sure you want to delete this application?
Click OK.
5. Option 2: Multiple delete
a. Ensure you are using the tabled view. If not, click the tabled view button.
b. Click the checkboxes of all applications to delete.
c. Click the Delete Selected button. An alert box displays:
Are you sure you want to proceed with deletion?
Click OK.
CloudForms deletes chosen applications and their instances from cloud resource providers.
Report a bug
6.4 .3. Accessing an InstanceAn instance is a running virtual machine, started by a user or an administrator, on a cloud resourceprovider.
A user accesses an instance through secure shell (SSH) using the rootpw from the instance's originalcomponent outline.
CloudForms 1.1 Cloud Engine User Guide
70
Important
Ensure port 22 (SSH) on your resource provider is open for in-bound communication.
Users have access to EC2 instances using SSH certificates, which are obtained via CloudForms CloudEngine . The following task shows how to obtain the SSH certificate and configure access to a chosenEC2 instance.
This procedure provides the user with access to a CloudForms EC2 instance.
1. Obtain the EC2 instance's SSH key:
a. Click on the Monitor tab.
b. The Monitor dashboard displays a list of cloud resource zones. Click the name of a cloudresource zone.
c. A list of applications in the chosen cloud resource zone displays. Click the name of anapplication.
d. A list of instances in the chosen application displays. Each EC2 instance contains aDownload key link to its SSH key. Click the Download key link for a chosen instance.
e. Save the SSH key to a location on your hard disk.
2. Securing your SSH key:
a. SSH certificates require user-only read access before use. Run the following command:
$ chmod 400 [certificate]
3. Accessing your EC2 instance via SSH:
a. Run the following command:
$ ssh -i [certificate] [hostname]
The user gains access to the CloudForms-created EC2 instance.
Report a bug
6.4 .4 . Rebooting an InstanceThis procedure provides the user with steps required to reboot an instance from the user interface.
Note
Red Hat Enterprise Virtualization does not support this function of rebooting an instance from thegraphical user interface. VMware vSphere supports this function providing that the vm-tools agent is installed.
1. Click on the Monitor tab.
2. The Monitor dashboard displays a list of cloud resource zones. Click the name of a cloudresource zone.
3. A list of applications in the chosen cloud resource zone displays. Click the name of an application.
4. A list of instances in the chosen application displays. Each instance contains a Restart button.Press the Restart button for a chosen instance. A status message indicating a successfully
Chapter 7. Runtime Configuration
71
Press the Restart button for a chosen instance. A status message indicating a successfullyqueued restart appears.
CloudForms reboots the chosen instance.
Report a bug
6.4 .5. Stopping an InstanceThis procedure provides steps required to stop an instance or multiple instances with the user interface.
1. Click on the Monitor tab.
2. The Monitor dashboard displays a list of cloud resource zones. Click the name of a cloudresource zone.
3. A list of applications in the chosen cloud resource zone displays. Click the name of an application.
4. A list of instances in the chosen application displays. Switch to the filtered view.
5. Select one or multiple instances to stop using the checkboxes.
6. Click the Stop selected instances button.
7. CloudForms Cloud Engine changes the state of each chosen instance to stopped.
CloudForms Cloud Engine stops each chosen instance.
Important
An instance cannot be started again once stopped.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
72
Chapter 7. Runtime Configuration
7.1. Runtime ConfigurationThese steps show how to access the runtime configuration for an Audrey-enabled instance.
1. Click on the Monitor tab.
2. Click the name of an application in a cloud resource zone.
3. Choose the Tabled View icon and select the Name of an instance. The instance informationscreen displays. The second section shows the Runtime Configuration for your instance.
Report a bug
7.2. Adding Audrey Agent to all Component OutlinesThe following task adds Audrey Agent to all future component outlines.
1. Add the following XML to your Imagefactory's target configuration file(/etc/imagefactory/target_content.xml):
<template_includes> <include target='all' os='all' version='all' arch='all'> <packages> <package name='aeolus-audrey-agent'/> </packages> </include></template_includes>
2. Build and push your component outlines.
All future component outlines contain Audrey Agent.
Report a bug
7.3. Adding Runtime Configuration to an Application Blueprint
Important
All instances using runtime configuration require Audrey Agent installed as a package. Ensureimages used for instances contain the audrey-agent package included in the image'scomponent outline. for information on adding packages to a component outline, read 5.3.1 AddingPackages to System Templates in the CloudForms 1.1 System Engine User Guide.
This procedure adds runtime configuration parameters to an application blueprint.
1. Open an application blueprint:
a. Click on the Administer tab.
b. Click on Content . This displays a list of your catalogs.
c. Choose a catalog with blueprints to edit. Click on the Name link.
d. Click on the Name link of an application blueprint to edit.
Chapter 7. Runtime Configuration
73
e. Click on the Edit XML button.
2. Add runtime configuration elements to the application blueprint:
a. Include one or more services for each instance (signified with an assembly element).
<deployable name="Application"> <description>An example Application</description> <assemblies> <assembly name="instance-1" hwp="hwp1"> <image id="beedb0f9-ca05-46a1-bcbb-704887752d8e"/> <services> <service name="my-service"> <executable url="http://www.example.com/script.sh"/> <files> <file url="http://www.example.com/config.rb"/> </files> <parameters> <parameter name="param-1"> <value type="scalar">default_text</value> </parameter> <parameter name="param-2"> <reference assembly="instance-2" parameter="hostname"/> </parameter> </parameters> </service> ... </services> <returns> <return name="hostname"/> </returns> </assembly> <assembly name="instance-2" hwp="hwp1"> ... <returns> <return name="hostname"/> </returns> </assembly> </assemblies></deployable>
In this example, instance-1 contains a service called my-service. This servicecontains an executable, files and parameters.
The executable element refers to the script that runs when the instance boots. In theexample, the script is script.sh. A service only has one script.
The files element refers to additional configuration files for the service. The examplerefers to a single file called config.rb. The files element accepts one or more file elements.
The parameters element refers to the parameters for the service. The examplecontains two parameter elements:
param-1 is a user-defined parameter with a default value of default_text.
param-2 contains a reference to the hostname return value from instance-2. This reference acts as a service dependency from one instanceservice to another.
Parameters are used in the executable script as variables that take on the followingformat:
CloudForms 1.1 Cloud Engine User Guide
74
AUDREY_VAR_[service]_[parameter]
For example:
AUDREY_VAR_my-service_param-1
CloudForms Cloud Engine replaces variables that match this format with their values.
b. Define the return values (returns) for the service's executable script.
<deployable name="Application"> <description>An example application</description> <assemblies> <assembly name="instance-1" hwp="hwp1"> <image id="beedb0f9-ca05-46a1-bcbb-704887752d8e"/> <services> ... </services> <returns> <return name="hostname"/> </returns> </assembly> ... </assemblies></deployable>
This example contains a single return value called hostname. The application blueprintuses return value for other service parameters in other instances. Audrey uses inputfrom the Facter Ruby library as a basis for these return values.
3. Save the application blueprint:
a. Click on the Save button to save your changes.
CloudForms Cloud Engine saves the new runtime configuration information to the chosen applicationblueprint.
Report a bug
7.4. Launching Instances with Runtime ConfigurationCloudForms Cloud Engine provides users with runtime configuration options when launching anapplication. After selecting an application blueprint, CloudForms Cloud Engine displays a list ofparameter fields and references defined in the application blueprint. Select a service from the left paneland type the desired configuration values in its parameter fields.
Chapter 7. Runtime Configuration
75
Figure 7.1. User-defined runtime configuration parameters
The example above uses the following extract from an application blueprint to define the http service.
CloudForms 1.1 Cloud Engine User Guide
76
<deployable name="Wordpress Multi-Instance Deployable"> ... <assemblies> <assembly name="apache" hwp="hwp1"> <image id="beedb0f9-ca05-46a1-bcbb-704887752d8e"/> <services> <service name="http"> <executable url="http://www.example.com/wordpress-http.sh"/> <parameters> <parameter name="wp_name" type="scalar"> <value>MyWordpressSite</value> </parameter> <parameter name="wp_user" type="scalar"> <value>wordpress</value> </parameter> <parameter name="wp_pw" type="scalar"> <value>wordpress</value> </parameter> <parameter name="mysql_ip" type="scalar"> <reference assembly="mysql" parameter="ipaddress"/> </parameter> <parameter name="mysql_hostname" type="scalar"> <reference assembly="mysql" parameter="hostname"/> </parameter> <parameter name="mysql_dbup" type="scalar"> <reference assembly="mysql" parameter="dbup"/> </parameter> </parameters> </service> </services> <returns> <return name="hostname"/> <return name="ipaddress"/> </returns> </assembly> ... </assemblies></deployable>
Click Finalize to continue with the Application launch.
Report a bug
7.5. Using Runtime Configuration with System Engine RegistrationA user registers an Audrey-enabled instance with CloudForms System Engine using runtimeconfiguration. The following task shows how to register an instance with CloudForms System Engineusing a runtime configuration script embedded within an application blueprint.
1. Load the following application blueprint into CloudForms Cloud Engine :
Chapter 7. Runtime Configuration
77
<?xml version="1.0" encoding="UTF-8"?><deployable name="My Deployment"> <description>This is a sample deployment that registers and subscribes to content hosted by katello.</description> <assemblies> <assembly name="[NAME]" hwp="[PROFILE]"> <image id="[UUID]"/> <services> <service name="GPG_KEY_IMPORT"> <executable> <contents><![CDATA[#!/bin/bash
rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-releaseecho ${AUDREY_VAR_GPG_KEY_IMPORT_IMPORT_BETA_KEY:=False}if [[ $AUDREY_VAR_GPG_KEY_IMPORT_IMPORT_BETA_KEY == [Tt][Rr][Uu][Ee] ]]; then rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-betafi
]]> </contents> </executable> <parameters> <parameter name="IMPORT_BETA_KEY"> <value type="scalar">True</value> </parameter> </parameters> </service> <service name="RHEL_PRODUCT_CERT"> <executable> <contents><![CDATA[#!/usr/bin/pythonimport osimport sysimport subprocessimport shutil
def is_ec2_deployment(): '''Returns boolean True of False to indicate whether the current system is an ec2 image'''
# FIXME - make sure 'wget' is installed, or use 'curl' cmd = 'curl --silent http://169.254.169.254/latest/dynamic/instance-identity/document' return subprocess.call(cmd.split()) == 0
os.chdir('/var/audrey/tooling/user/RHEL_PRODUCT_CERT')
# If running as an ec2 deployment, and no product cert is defined ... create oneif is_ec2_deployment() and not os.path.isfile('/etc/pki/product/69.pem') and os.path.isfile('69.pem'): if not os.path.isdir('/etc/pki/product'): os.mkdir('/etc/pki/product') shutil.copy('69.pem', '/etc/pki/product/69.pem')]]> </contents> </executable> <files> <file> <contents filename="69.pem"><
MIIGDTCCA/WgAwIBAgIJALDxRLt/tUszMA0GCSqGSIb3DQEBBQUAMIGuMQswCQYDVQQGEwJVUzEXMBUGA1UECAwOTm9ydGggQ2Fyb2xpbmExFjAUBgNVBAoMDVJlZCBIYXQsIEluYy4xGDAWBgNVBAsMD1JlZCBIYXQgTmV0d29yazEuMCwGA1UEAwwlUmVkIEhhdCBFbnRpdGxlbWVudCBQcm9kdWN0IEF1dGhvcml0eTEkMCIGCSqGSIb3DQEJARYVY2Etc3VwcG9ydEByZWRoYXQuY29tMB4XDTExMTEwODE1NDYyNFoXDTMxMTEwMzE1NDYyNFowRDFCMEAGA1UEAww5UmVkIEhhdCBQcm9kdWN0IElEIFsyMGM3MWU4Ni1iZjA4LTRlZjYtYTAxYS1lYzQ0MDRkNzIyODZdMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAxj9J04z+Ezdyx1U33kFftLv0ntNS1BSeuhoZLDhs18yksepG7hXXtHh2CMFfLZmTjAyL9i1XsxykQpVQdXTGpUF33C2qBQHB5glYs9+d781x8p8m8zFxbPcW82TIJXbgW3ErVh8vk5qCbG1cCAAHb+DWMq0EAyy1bl/JgAghYNGBRvKJObTdCrdpYh02KUqBLkSPZHvo6DUJFN37MXDpVeQq9VtqRjpKLLwuEfXb0Y7I5xEOrR3kYbOaBAWVt3mYZ1t0L/KfY2jVOdU5WFyyB9PhbMdLi1xE801j+GJrwcLaxmqvj4UaICRzcPATP86zVM1BBQa+lilkRQes5HyjZzZDiGYudnXhbqmLo/n0cuXoQBVVjhzRTMx71Eiiahmiw+U1vGqkHhQNxb13HtN1lcAhUCDrxxeMvrAjYdWpYlpIyW3NssPWt1YUHidMBSAJ4KctIf91dyE93aStlxwC/QnyFsZOmcEsBzVCnz9GmWMl1/6XzBS1yDUqByklx0TLH+z/sK9A+O2rZAy1mByCYwVxvbOZhnqGxAuToIS+A81v5hCjsCiOScVB+cil30YBu0cH85RZ0ILNkHdKdrLLWW4wjphK2nBn2g2i3+ztf+nQED2pQqZ/rhuW79jcyCZl9kXqe1wOdF0Cwah4N6/3LzIXEEKyEJxNqQwtNc2IVE8CAwEAAaOBljCBkzAJBgNVHRMEAjAAMDAGCysGAQQBkggJAUUBBCEMH1JlZCBIYXQgRW50ZXJwcmlzZSBMaW51eCBTZXJ2ZXIwFAYLKwYBBAGSCAkBRQIEBQwDNi4yMBcGCysGAQQBkggJAUUDBAgMBng4Nl82NDAlBgsrBgEEAZIICQFFBAQWDBRyaGVsLTYscmhlbC02LXNlcnZlcjANBgkqhkiG9w0BAQUFAAOCAgEAsS+51Nhm3vTPqU75GJwNWFTOh/S7Imf2h569t2C6MsOE2z2a5Q9bs20PmcfjSH5pTjRxbniegZKMAydlM8Oip3VOEulgBqbERMb2NmYLWFugN2emMPZ8Y+c4ZkxzxNrHG68858PLw/Hw3x7ceyVnSzVhG24CESgeIhyLzHmqnsM2TVx3gnIaKgpfNio6+g8TQ3Zdn0Y3aWVF4046e8sBniCqWaGWXq/cG6+KSQkADvxQXqBLIf/BG7zXnjeg7CwfDItWdca1fJBLh3WZTAdcd90Jhn5IUqwPWf6nupuyAFcxLcMHvn+7/x6sbUz7sdNJfUx/WnU52OqsuM/03wqnb449m8INeGCoa7yZdSQlcnH6UWLeKnrnhk/81Rrv265Q044dxzUA+aMJPn0ZFXIj76ot5agNeCEtZyKWptOR7to6gQutD4It8siqR2L2TK8eNcFxJVFSuenMjScoppJoWsK6OXGdxJA2PLpSSm0vJtFrLdjt3NnoMXHTi7HmldC1HLMLGEg/QNDdesdZcLBEAI2X5TrH/24IpBKtT+y/lImchb9INSsFJa29SSCrTFKLOc8aGvlb4nidHhRgFOzOfT34E8euLKc0d3pznxL/W8M/JsLF7abe3pijcvY0wGp9LHit2qeCJMWWdv6OKZMK8DbQo0gvmAQZGuMI459xDTA=-----END CERTIFICATE----- ]]> </contents> </file> </files> </service> <service name="KATELLO_REGISTER"> <executable> <contents><![CDATA[#!/usr/bin/python
import osimport sysimport reimport subprocessimport shutilfrom ConfigParser import ConfigParserfrom string import Template
def s_format(s, dct): if hasattr(s, 'format'): return s.format(**dct) else: # convert python-2.6 format to something 2.4 can handle return Template(re.sub(r'{([^}]+)}', '$\\1', s)).substitute(dct)
def run(cmd):
Chapter 8. Users
79
if isinstance(cmd, str): cmd = cmd.split() p_open = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) (stdout, stderr) = p_open.communicate() if p_open.returncode != 0: print "Error: command failed (%s) - %s" % (p_open.returncode, stdout) sys.exit(p_open.returncode) return stdout
def subscription_manager_version(): sm_rpm_ver = run('rpm -q --queryformat %{VERSION} subscription-manager') sm_ver_maj, sm_ver_min, sm_ver_rest = sm_rpm_ver.split(".", 2) return int(sm_ver_maj), int(sm_ver_min)
def audrey_var(name, default=None): return os.environ.get("AUDREY_VAR_KATELLO_REGISTER_%s" % name, default)
def setup_releasever(): fp = open("/etc/yum/vars/releasever", "r+") fp.write(audrey_var("RELEASEVER")) fp.close()
def register_katello_command(): org = audrey_var("KATELLO_ORG") activation_key = audrey_var("ACTIVATION_KEY", "").strip() auto_subscribe = audrey_var("AUTO_SUBSCRIBE", "false").lower() == "true" username = audrey_var("KATELLO_USER") password = audrey_var("KATELLO_PASS") kat_env = audrey_var("KATELLO_ENV") sm_ver_maj, sm_ver_min = subscription_manager_version()
cmd = "subscription-manager register --force" cmd += " --org=%s" % org
if sm_ver_maj <= 0: if sm_ver_min <= 96: if auto_subscribe: cmd += " --username=%s --password=%s" % (username, password) cmd += " --autosubscribe" elif activation_key != "" and sm_ver_min >= 95: cmd += " --activationkey=%s" % activation_key else: pass # determine and print error condition to stdout else: if auto_subscribe: cmd += " --username=%s --password=%s" % (username, password) cmd += " --env=%s" % kat_env cmd += " --autosubscribe" elif activation_key != "": cmd += " --activationkey=%s" % activation_key else: pass # determine and print error condition to stdout return cmd
CloudForms 1.1 Cloud Engine User Guide
80
# If requested, customize the yum $releaseverif not audrey_var("RELEASEVER", "Default").lower() in ["", "default"]: setup_releasever()
# FIXME - Installing using yum on a system with no enabled repos will remove# product cert. Until bug#806457 is fixed, install using the 'rpm' command.# cmd = "yum -y install %s" % cert_rpmcert_rpm = s_format("http://{AUDREY_VAR_KATELLO_REGISTER_KATELLO_HOST}/pub/candlepin-cert-consumer-{AUDREY_VAR_KATELLO_REGISTER_KATELLO_HOST}-1.0-1.noarch.rpm", os.environ)cmd = "rpm -ivh %s" % cert_rpmrun(cmd)
cmd = register_katello_command()print run(cmd)]]> </contents> </executable> <parameters> <parameter name="KATELLO_HOST"> <value type="scalar"></value> </parameter> <parameter name="KATELLO_PORT"> <value type="scalar"></value> </parameter> <parameter name="KATELLO_ORG"> <value type="scalar"></value> </parameter> <parameter name="KATELLO_ENV"> <value type="scalar"></value> </parameter> <parameter name="KATELLO_USER"> <value type="scalar"></value> </parameter> <parameter name="KATELLO_PASS"> <value type="password"></value> </parameter> <parameter name="RELEASEVER"> <value type="scalar">Default</value> </parameter> <parameter name="AUTO_SUBSCRIBE"> <value type="scalar">True</value> </parameter> <parameter name="ACTIVATION_KEY"> <value type="scalar">None</value> </parameter> </parameters> </service> </services> </assembly> </assemblies></deployable>
Ensure to replace the emphasized strings in the example with your desired values.
Chapter 9. Users Groups
81
Note
This example application blueprint is also available on your Audrey ConfigurationServer at:https://[CONFIGSERVER]/examples
Important
Ensure that images used in this example have Audrey Agent installed.
2. Launch an application using this blueprint. The runtime configuration parameters screen showsthe following fields that require your CloudForms System Engine details:
Table 7.1. User-defined runtime parameters for CloudForms System Engineregistration
Parameter Description
IMPORT_BETA_KEY Sets whether to import the Red Hat Enterprise Linux Beta GPGkey. Requires a Boolean value: true or false.
KATELLO_HOST The hostname or IP address for the CloudForms SystemEngine host.
KATELLO_PORT The port used to access the CloudForms System Enginehost.
KATELLO_ORG The chosen organization on the CloudForms System Enginehost for registration.
KATELLO_ENV The chosen environment on the CloudForms System Enginehost for registration.
KATELLO_USER The user for accessing the CloudForms System Engine host.
KATELLO_PASS The password for accessing the CloudForms System Enginehost.
AUTO_SUBSCRIBE Set auto-subscription status for registration. Requires aBoolean value: true or false.
ACTIVATION_KEY The activation key for your registration. Use None for noactivation key. Use None if AUTO_SUBSCRIBE equals true
3. Click Finalize to continue with the Application launch.
The application launches and registers with CloudForms System Engine using the suppliedparameters.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
82
Chapter 8. Users
8.1. Creating a User
Figure 8.1. New user creation
These steps show how to create a new user in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Users.
3. Click the Add User button.
Figure 8.2. New User Button
The New User screen appears.
4. Type the user's First name.
5. Type the user's Last name.
6. Type the user's E-mail address.
7. Type a username for the new user in the Choose a username field.
8. Type a password for the new user in the Choose a password field.
9. Retype the password for the new user into the Confirm password field.
10. Type the Maximum Running Instances a user can have running simultaneously. Leave thisfield blank for unlimited.
Chapter 10. Permissions
83
11. Select whether the User Status is Active or Inactive. This setting determines whether theuser's access is active.
12. Click Save User to save your new user.
Report a bug
8.2. Edit an Existing UserThese steps show how to edit details of an existing user in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Users.
3. Click on the User ID of the required user.
4. Information about that particular user appears in the Details View. Click the Edit button to edit theuser's details.
5. Modify the required details.
6. Click the Save User button to save your changes.
Report a bug
8.3. Delete an Existing UserThese steps show how to delete an existing user in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Users.
3. Click each checkbox to the left of each user you want to delete.
4. Click the Delete Selected command button.
5. An alert box appears:
Are you sure you want to proceed with deletion?
Click OK.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
84
Chapter 9. Users Groups
9.1. Creating a User GroupThese steps show how to create a new user group in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on User Groups.
3. Click the Add User Group button.
The New User Group screen appears.
4. Select a user group Type. Choose Local to create a local user group within the CloudFormsCloud Engine database.
5. Type the user group Name.
6. Type a description for the user group.
7. Click Save User Group to save your new user group.
Report a bug
9.2. Editing a User GroupThese steps show how to edit a user group in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on User Groups.
3. Click the Name of a user group to edit.
The Edit User Group screen appears.
4. Modify your chosen user group property fields.
5. Click the Save User Group button to save your user group properties.
Report a bug
9.3. Adding Users to a User GroupThese steps show how to add users to a user group in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on User Groups.
3. Click the Name of a user group to add users.
A new screen shows the Properties, Members and Permissions for the user group. Scrollto the Members section.
4. Click the Add Members button.
5. Use the check box to select which users belong to the user group.
6. Click the Add Members button to save your selection.
Report a bug
9.4. Removing Users from a User Group
Chapter 10. Permissions
85
These steps show how to remove users from a user group in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on User Groups.
3. Click the Name of a user group to remove users.
A new screen shows the Properties, Members and Permissions for the user group. Scrollto the Members section.
4. Use the check box to select which users to remove from the user group.
5. Click the Remove button. The following message appears:
Are you sure you want to proceed?
Click the OK button.
Report a bug
9.5. Deleting a User GroupThese steps show how to delete a new user group in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on User Groups.
3. Use the check box to select the user groups to remove.
4. Click the Delete Selected button. The following message appears:
Are you sure you want to proceed?
Click the OK button.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
86
Chapter 10. Permissions
10.1. Setting Global Permissions
Figure 10.1. Global permissions
This procedure shows how to provide global role grants to each user or user group in CloudFormsCloud Engine .
1. Click on the Administer tab.
2. Click on Global Role Grants.
3. Click on the Grant Access button. The provider access selection screen appears.
4. Choose a Role from the drop-down menu for each user and user group.
5. Click Grant Access to save your permissions.
CloudForms sets additional global role grants for each user or user group.
Report a bug
10.2. Setting Cloud Resource Provider Permissions
Chapter 11. Logging and Reporting
87
Figure 10.2. Cloud resource provider permissions
These steps show how to provide user and user groups and roles with access to cloud resourceproviders in CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Providers dashboard displays.
3. Click a Cloud Resource Provider Name to select a provider.
4. Click on Role Assignments. The current list of user and user groups and roles with access tothe chosen provider displays.
5. Click on the Grant Access button. The provider access selection screen appears.
6. Choose a Role from the drop-down menu for each user and user group.
7. Click Grant Access to save your permissions.
Report a bug
10.3. Setting Cloud Resource Zone Permissions
CloudForms 1.1 Cloud Engine User Guide
88
Figure 10.3. Cloud resource zone permissions
These steps show how to provide user and user groups and roles with access to cloud resource zonesin CloudForms Cloud Engine .
1. Click on the Monitor tab.
2. Click the name of a cloud resource zone.
3. Click on Role Assignments. The current list of user and user groups and roles with accessdisplays.
4. Click on the Grant Access button. The zone access selection screen appears.
5. Choose a Role from the drop-down menu for each user and user group.
6. Click Grant Access to save your permissions.
Report a bug
10.4. Setting Application Blueprint Permissions
Figure 10.4 . Application blueprint permissions
These steps show how to provide user and user groups and roles with access to Application Blueprintsin CloudForms Cloud Engine .
1. Click on the Administer tab.
2. Click on Content .
Chapter 11. Logging and Reporting
89
2. Click on Content .
3. Click on the Name of a catalog. A list of the catalog's application blueprints displays.
4. Click on the Name of an application blueprint. The application blueprint's properties displays.
5. Scroll to the Role Assignments section.
6. Click on the Grant Access button. The application blueprint access selection screen appears.
7. Choose a Role from the drop-down menu for each user and user group.
8. Click Grant Access to save your permissions.
Report a bug
10.5. Setting Application Permissions
Figure 10.5. Application permissions
These steps show how to provide user and user groups and roles with access to an application inCloudForms Cloud Engine .
1. Click on the Monitor tab.
2. Click the name of cloud resource zone.
3. Click the name of an application in the cloud resource zone.
4. Click on Role Assignments. The current list of user and user groups and roles with accessdisplays.
5. Click on the Grant Access button. The application access selection screen appears.
6. Choose a Role from the drop-down menu for each user and user group.
7. Click Grant Access to save your permissions.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
90
Chapter 11. Logging and Reporting
11.1. Provider History
11.1.1. Accessing Provider HistoryThe following procedure shows how to filter and display reports for cloud resource providers.
1. Click on the Administer tab.
2. Click on Cloud Resource Providers. The Cloud Resource Provider dashboard appears.
3. Use the From and To date selection fields to specify a date range.
4. Click the Apply Filter button.
The dashboard displays a record for the date range specified of currently running, pending anderroneous instances, plus historical data for previously running and erroneous instances. A graph ofrunning instances, both current and historical, appears in the lower half of the page.
Report a bug
11.2. Audit History
11.2.1. Accessing Audit HistoryThese steps show how to view the history for multiple instances.
1. Click on the Monitor Tab.
2. Click on Logs.
3. Select applicable filters, or leave it as default.
Filter options include:
Viewing filtersRefine log search results by applying Viewing filters. Viewing options include: EventTypes, States, Pools, Providers, and Users.
Date filterRefine log search results to a certain time frame with the Date filter.
Ordered By filterSelect the order you want the logs to be displayed by with the Ordered by filter.
4. Click on Apply filters.
Note
The number next to Apply filters shows how many instances have matched your searchpreference.
Report a bug
Chapter 12. Maintenance
91
11.2.2. Exporting Audit HistoryThese steps show how to export audit history as a CSV file.
1. Click on the Monitor Tab.
2. Click on Logs.
3. Click the Export logs button.
4. Your browser asks for a location to save the CSV file. Choose a location and save.
Report a bug
11.3. Instance History
11.3.1. Accessing Instance HistoryCloudForms Cloud Engine contains functions for generating event reports for instances and a seriesof logs to track functions for individual components.
These steps show how to view the history for an instance.
1. Click on the Monitor tab.
2. Click the name of an application in a cloud resource zone.
3. Choose the Tabled View icon and select the Name of an instance. The instance informationscreen displays. The third section shows the History for your instance.
Report a bug
11.3.2. Exporting Instance HistoryThese steps show how to export instance history as a CSV file.
1. Click on the Monitor tab.
2. Click the name of cloud resource zone.
3. Click the name of an application in the cloud resource zone.
4. Choose the Tabled View icon.
5. Click the Export events button.
6. Your browser asks for a location to save the CSV file. Choose a location and save.
Report a bug
11.4. Accessing Log FilesCloudForms Cloud Engine provides a log file for each of its components. Table 11.1, “CloudFormsCloud Engine Log Files” lists the location of all log files and their function.
CloudForms 1.1 Cloud Engine User Guide
92
Table 11.1. CloudForms Cloud Engine Log Files
Location Log File Description
/var/log aeolus.log General log messages for CloudFormsCloud Engine .
imagefactory.log
Imagefactory log file. Contains history of allinteractions related to building images forcloud resource providers.
iwhd.log Image Warehouse log file. Contains historyof all interactions related to image storageand management on cloud resourceproviders.
/var/log/aeolus-conductor
rails.log Log for all Ruby-based interactions withCloudForms Cloud Engine .
dbomatic.log Log for status update transactions.
thin.log Ruby webserver log for CloudForms CloudEngine .
/var/log/deltacloud-core
*.log Log files for Deltacloud API interactions.
/var/log/mongodb/ mongodb.log Log file for Image Warehouse databaseinteractions.
/var/log/aeolus-conductor/
aeolus_upgrade.log
Log file for CloudForms Cloud Engineupgrades.
Report a bug
Chapter 12. Maintenance
93
Chapter 12. Maintenance
12.1. Disaster Recovery
12.1.1. Cloud Engine Backup ProcedureThis example uses the /backup directory as our target directory to hold backup archives. Execute thefollowing commands as the root system account.
1. Prepare your backup location:
# mkdir /backup# chgrp postgres /backup# chmod g+w /backup# cd /backup
2. Stop all CloudForms Cloud Engine services.
# aeolus-services stop
3. Back up the Cloud Engine PostgreSQL and MongoDB databases with their respective tools.
Note
As an optional method of backup, perform the following commands while database servicesare offline:
# tar --selinux -czvf mongo_data.tar.gz /var/lib/mongodb# tar --selinux -czvf pgsql_data.tar.gz /var/lib/pgsql/data/
This method archives the all PostgreSQL and MongoDB databases. This type of backuprequires a complete shutdown of all services and it is recommended to perform this backupmainly during maintenance periods.
Back up PostgreSQL databases
The database name for Cloud Engine is conductor. Execute pg_dump to create onlinedatabase backups. This process can take minutes to finish depending on database sizes.
# service postgresql start# su postgres -c "pg_dump -Fc conductor > /backup/conductor.dump"# service postgresql stop
Note
For more info about PostgreSQL backups consult pg_dump manual page or visithttp://www.postgresql.org/docs/8.4/static/backup.html.
Back up MongoDB database
Use online tools to backup the iwhd database (MongoDB) while the database is running. Execute
CloudForms 1.1 Cloud Engine User Guide
94
the following command in the backup directory:
# service mongod start# mongodump --host localhost --out mongo_dump# service mongod stop
This tool should create a /backup/mongo_dump/repo directory with several JSON files.
Note
For more information consult mongodump man page or visithttp://www.mongodb.org/display/DOCS/Backups.
4. Back up the Cloud Engine configuration files.
tar --selinux -czvf ce-backup.tar.gz /etc/aeolus-conductor /etc/aeolus-configure /etc/imagefactory /etc/iwhd /etc/fstab /usr/share/aeolus-conductor/config/{database.yml,environments/development.rb,oauth.json,environments/production.rb,settings.yml,environments/test.rb}
5. Back up the Cloud Engine image files.
tar --selinux -czvf ce-images-backup.tar.gz /var/lib/iwhd
6. Check the backup process. The process creates the following archive files and a directory:
# lsce-backup.tar.gz ce-images-backup.tar.gz conductor.dump mongo_dump
Cloud Engine is now backed up. Please restart your Cloud Engine instance.
# aeolus-services start
Report a bug
12.1.2. Cloud Engine Restore ProcedureThe following process describes a full Cloud Engine restore. This process deletes all data from acurrent Cloud Engine instance. Ensure you are restoring to the correct instance. All commands areexecuted as root in the directory with archives created during the backup process.
1. Reinstall CloudForms Cloud Engine and components
# yum aeolus-all
2. Run the configuration script.
# aeolus-configure
3. Stop all CloudForms Cloud Engine services.
# aeolus-services stop
4. Change to the backup directory.
Chapter 13. Template Description Language (TDL) Schema
95
# cd /backup
5. Restore the system files. Double-check that the files extract on the correct host. Restore allsystem files with following commands executed from the backup directory:
# tar --selinux -xvf ce-backup.tar -C / --exclude etc/fstab
Note
The /etc/fstab is not restored due to the possibility of new file system mounts on arestored system. If using a Red Hat Enterprise Virtualization provider, restore the mount tothe provider's export domain manually using the information in the /etc/fstab backup.
6. Drop the existing Cloud Engine PostgreSQL database.
# service postgresql start# su postgres -c "dropdb conductor"
Note
There is a possibility of the following error appearing during database drop:
database xxx is being accessed by other users
Ensure all processes are stopped.
7. Restore the image files.
# tar --selinux -xvf ce-images-backup.tar -C /
8. Restore Cloud Engine PostgreSQL databases with the following commands:
# su postgres -c "pg_restore -C -d postgres /backup/conductor.dump"
Note
For more info about PostgreSQL backups consult pg_dump manual page or visithttp://www.postgresql.org/docs/8.4/static/backup.html.
9. Ensure MongoDB is running and delete the old data:
# service mongod start# echo 'db.dropDatabase();' | mongo repo
10. Execute the following command in the directory with backup archives.
# mongorestore --host localhost /backup/mongo_dump/repo
CloudForms 1.1 Cloud Engine User Guide
96
Note
For more information consult mongorestore man page or visithttp://www.mongodb.org/display/DOCS/Backups.
11. Restart all CloudForms Cloud Engine processes:
# aeolus-services start
Report a bug
12.2. Image Warehouse Recovery
12.2.1. Testing Image WarehouseImage Warehouse troubleshooting starts with access to the REST API. To test the active state of ImageWarehouse, run the following command on the CloudForms Cloud Engine host:
# curl http://localhost:9090/
A properly functioning Image Warehouse returns an XML representation with this command.
Report a bug
12.2.2. Analyzing the LogThe default location of the Image Warehouse Log is /var/log/iwhd.log.
The log format includes two messages for each API operation. The first message is logged when theAPI receives a request. The second message is logged when the API completes the request. A userreading the log correlates the two messages by the IP address and port number of the client. Thefollowing example corresponds to the curl command above:
Dec 06 15:33:43 iwhd[3363]: 192.168.128.11.37750 "GET /" -Dec 06 15:33:43 iwhd[3363]: 192.168.128.11.37750 200 302
For additional troubleshooting, add the -v argument to IWHD_ARGS in /etc/sysconfig/iwhd andrestart the Image Warehouse daemon (iwhd). Note the verbose log contains a large amount ofinformation and is generally used only to debug Image Warehouse.
Report a bug
12.2.3. Recovery from Insufficient SpaceIf Image Warehouse returns an error 500 on both PUT and POST requests, the most common cause isinsufficient space due to the accumulation of temporary data. This is the case in particular forconfigurations with Red Hat Enterprise Virtualization Manager or oVirt clouds. Once the root cause of thefailing registrations is resolved, remove the accumulated templates manually.
Attributes and metadata are kept in MongoDB database. Its location is set by the configuration ofmongod. The default is /var/lib/mongodb.
Bulk data is either stored in the cloud under management, where it is a subject to the controls of the
Chapter 13. Template Description Language (TDL) Schema
97
cloud, or in a filesystem-like type of backend, such as fs or fs-rhev-m .
Registration operations require additional temporary space to succeed. Small control files arecreated in /tmp.
Registration in Red Hat Enterprise Virtualization Manager requires space in the cluster. An image isuploaded to the export domain, which is seen as an NFS-mounted directory. The location of thisdirectory is set outside of iwhd, usually by Conductor. System crashes can cause incomplete imagesto accumulate there. Their file names start with iwhd.
Once a template is uploaded, it has to be imported, according to the Red Hat Enterprise VirtualizationManager terminology. This process can fail and leave an incomplete template visible to RHEV-M. Thesafest way to remove this template is from the UI of Red Hat Enterprise Virtualization Manager.
Remove only temporary files and templates that are excessively old. Exercise caution when removing alltemporary files in a busy cloud environment.
Report a bug
12.2.4 . Recovery from Database FailureIf CloudForms Cloud Engine fails to load after a host reboot, check the MongoDB service's status.
# service mongod status
MongoDB is a database service that stores attributes and metadata for Image Warehouse. In the eventof an improper system shut down, MongoDB can fail to start on boot due to the presence of a databaselockfile. Systems affected include the following information in the mongo log(/var/log/mongodb/mongodb.log)
old lock file: /var/lib/mongodb/mongod.lock. probably means unclean shutdownrecommend removing file and running --repairsee: http://dochub.mongodb.org/core/repair for more information
If MongoDB refuses to start on reboot, remove the database lock using the following command:
# rm -f /var/lib/mongodb/mongod.lock# mongod --repair
Reboot the host and access CloudForms Cloud Engine via the web interface.
Report a bug
CloudForms 1.1 Cloud Engine User Guide
98
Chapter 13. Template Description Language (TDL) Schema
13.1. archThe arch element provides information about the type of CPU architecture of the instance. Possiblereturn values for Linux operating systems include 32-bit (i386) and 64-bit (x86_64 ).
The arch is a required element.
Parent Elements
os.
Child Elements
None.
Example 13.1. An example of the arch element.
<template> ... <os> ... <arch>x86_64</> ... </os> ...</template>
Report a bug
13.2. commandThe command element provides commands to run post-installation. The command can be of two types: raw or base64 .
Parent Elements
commands.
Child Elements
None.
Chapter 13. Template Description Language (TDL) Schema
99
Example 13.2. An example of the command element
</template> ... <commands> <command name="Create SSH config file for root" type="raw">touch /root/.ssh/config</command> </commands> ...</template>
Report a bug
13.3. commandsThe commands element acts as a collection of commands for execution at the end of image creation.
Parent Elements
template.
Child Elements
command.
Example 13.3. An example of the commands element
<template> ... <commands> <command name="Create SSH config file for root" type="raw">touch /root/.ssh/config</command> </commands> ...</template>
Report a bug
13.4. descriptionThe description element tag provides a short description of the template. It contains a string value. Itis an optional element.
Parent Elements
template.
Child Elements
None.
CloudForms 1.1 Cloud Engine User Guide
100
Example 13.4 . An example of the description element
<template> ... <description>A description of the image</description> ...</template>
Report a bug
13.5. fileThe file element tag adds content to the image in a file at the specified path. file can be of twotypes: raw and base64.
Parent Elements
files.
Child Elements
None.
Example 13.5. An example of the file element
<template> ... <files> <file name="/root/.ssh/config" type="raw"><![CDATA[Host ExampleUser myuserPort 1313HostName example.com ]]></file> </files> ...</template>
Report a bug
13.6. filesThe files element tag lists user-defined files to add to the image.
Parent Elements
template.
Child Elements
file.
Chapter 13. Template Description Language (TDL) Schema
101
Example 13.6. An example of the files element
<template> ... <files> <file name="/root/.ssh/config" type="raw"><![CDATA[Host ExampleUser myuserPort 1313HostName example.com ]]></file> </files> ...</template>
Report a bug
13.7. installThe install element refers to the installation source, which is either iso or url. When type="iso",the os is installed from an ISO image of the required operating system. When type="url", the os isinstalled from a repository url.
The install element is a required element.
Parent Elements
os.
Child Elements
url, iso, md5sum , sha1sum , and sha256.
Example 13.7. An example of the install element
<template> ... <os> <install type="url"> <url>http://download.fedoraproject.org/pub/fedora/linux/releases/16/Fedora/x86_64/os/</url> </install> ... </os></template>
Report a bug
13.8. iso
CloudForms 1.1 Cloud Engine User Guide
102
The iso element is required for providing the ISO image location of the installation media. This elementis required if when install type="iso".
Parent Elements
install.
Child Elements
None.
Example 13.8. An example of the iso element
<template> ... <os> ... <install type='iso'> <iso>http://download.fedoraproject.org/pub/fedora/linux/ releases/15/Fedora/x86_64/iso/Fedora-15-x86_64-DVD.iso</iso> </install> ... </os></template>
Report a bug
13.9. keyThe key element represents the product key for Windows installation media.
Parent Elements
os.
Child Elements
None.
Example 13.9. An example of the key element
<template> ... <os> ... <key>12345-67890-ABCDE-FGHIJ-KLMNO</key> ... </os></template>
Report a bug
Chapter 13. Template Description Language (TDL) Schema
103
13.10. md5sumThe md5sum element is used for the install element when type="iso". md5sum is a method usedto check the integrity and authenticity of ISO files using a MD5 digital fingerprint. It is an optional element.
Parent Elements
install.
Child Elements
None.
Example 13.10. An example of the md5sum element
<template> ... <os> ... <install type='iso'> <iso>http://download.fedoraproject.org/pub/fedora/linux/releases/15/Fedora/x86_64/iso/Fedora-15-x86_64-DVD.iso</iso> <md5sum>47f4cc0b788002e8b264881beb4ec08b</md5sum> </install> ... </os> ...</template>
Report a bug
13.11. osThe os element acts as a parent element for operating system values in a template. It contains multiplemandatory parameters.
Parent Elements
template.
Child Elements
name, version, arch, install, rootpw, and key.
CloudForms 1.1 Cloud Engine User Guide
104
Example 13.11. An example of the os element
<template> ... <os> <name>RHEL-6</name> <version>2</version> <arch>x86_64</arch> ... </os></template>
Report a bug
13.12. name (os)The name element is required for the os element. The name element is the operating system's name. Itcontains a string value.
Table 13.1. Name Listings
Operating System Name
Fedora 15 Fedora
Fedora 16 Fedora
Red Hat Enterprise Linux 5.6 RHEL-5
Red Hat Enterprise Linux 5.7 RHEL-5
Red Hat Enterprise Linux 5.8 RHEL-5
Red Hat Enterprise Linux 5.9 RHEL-5
Red Hat Enterprise Linux 6.1 RHEL-6
Red Hat Enterprise Linux 6.2 RHEL-6
Red Hat Enterprise Linux 6.3 RHEL-6
Red Hat Enterprise Linux 6.4 RHEL-6
Parent Elements
os.
Child Elements
None.
Chapter 13. Template Description Language (TDL) Schema
105
Example 13.12. An example of the os name element
<template> ... <os> <name>RHEL-6</name> ... </os></template>
Report a bug
13.13. name (template)The name element is the template's name. It contains a string value.
Parent Elements
template.
Child Elements
None.
Example 13.13. An example of the template element
<template> ... <name>Example_Template</name> ...</template>
Report a bug
13.14. packageThe package element tag provides the information about the programs that are organized as sets ofpackages. Each package has its own set of names for types, which helps to prevent name conflicts. Atop level type is accessible outside the package that declares it only if the type is declared public.Thenaming structure for packages is hierarchical. Members of a package are class and interface types ,which are declared in compilation units of the package, and subpackages, which may contain compilationunits and subpackages of their own.
Parent Elements
packages.
Child Elements
None.
CloudForms 1.1 Cloud Engine User Guide
106
Example 13.14 . An example of the package element
<template> ... <packages> <package name='aeolus-audrey-agent'></package> </packages> ...</template>
Report a bug
13.15. packagesThe packages element tag is used to indicate the package to which the compilation unit belongs.Packages that are stored in a file system have certain constraints on the organization of theircompilation units to allow a simple implementation to find classes easily. A compilation unit automaticallyhas access to all types declared in its package and also automatically imports all of the public typesdeclared in the predefined package.
Parent Elements
template.
Child Elements
package.
Example 13.15. An example of the packages element
<template> ... <packages> <package name="httpd"/> ... </packages></template>
Report a bug
13.16. repositoriesThe repositories element acts as a collection of additional repositories.
Parent Elements
template.
Child Elements
Chapter 13. Template Description Language (TDL) Schema
107
repository.
Example 13.16. An example of the description element
<template> ... <repositories> <repository name="Additional Repository"> <url>http://www.example.com/repositories/x86_64/</url> </repository> </repositories> ...</template>
Report a bug
13.17. repositoryThe repository element tag provides the destination information of source repository from additionalpackages. It contains a string value.
Parent Elements
repositories.
Child Elements
signed and url.
Example 13.17. An example of the description element
<template> ... <repositories> <repository name="Additional Repository"> <url>http://www.example.com/repositories/x86_64/[-1245128208]/url> </repository> </repositories> ...</template>
Report a bug
13.18. signedThe signed is used when installing from RPM packages. Each package is signed with a GPG key orsignature. It contains a Boolean value to indicate CloudForms' use for GPG signatures for repositoryverification.
Parent Elements
CloudForms 1.1 Cloud Engine User Guide
108
repository.
Child Elements
None.
Example 13.18. An example of the signed element
<template> ... <repositories> <repository name="Additional Repository"[-207143004] <url>http://www.example.com/repositories/x86_64/</url> <signed>true</signed> </repository> </repositories> ...</template>
Report a bug
13.19. rootpwThe rootpw element is required for the os installation. The rootpw sets the root or administrationpassword.
Parent Elements
os.
Child Elements
None.
Example 13.19. An example of the rootpw element
<template> ... <os> ... <rootpw>p@55w0rd!</rootpw> ... </os></template>
Report a bug
13.20. sha1sumThe sha1sum element is used for the install element when type="iso". sha1sum is a methodused to check the integrity and authenticity of ISO files using a SHA-1 digital fingerprint. It is an optional
Chapter 13. Template Description Language (TDL) Schema
109
element.
Parent Elements
install.
Child Elements
None.
Example 13.20. An example of the sha1sum element
<template> ... <os> ... <install type='iso'> <iso>http://download.fedoraproject.org/pub/fedora/linux/ releases/15/Fedora/x86_64/iso/Fedora-15-x86_64-DVD.iso</iso> <sha1sum>da39a3ee5e6b4b0d3255bfef95601890afd80709</sha1sum> </install> ... </os> ...</template>
Report a bug
13.21. sha256sumThe sha256sum element is used for the install element when type="iso". sha256sum is amethod used to check the integrity and authenticity of ISO files using a 256-bit SHA-2 digital fingerprint. Itis an optional element.
Parent Elements
install.
Child Elements
None.
CloudForms 1.1 Cloud Engine User Guide
110
Example 13.21. An example of the sha256sum element
<template> ... <os> ... <install type='iso'> <iso>http://download.fedoraproject.org/pub/fedora/linux/ releases/15/Fedora/x86_64/iso/Fedora-15-x86_64-DVD.iso</iso> <sha256sum> b23a1dbe9d29b9f545e56dcf334b4cb7a65f63e8df615dbe9bfbf57e5bcfb581 </sha256sum> </install> ... </os> ...</template>
Report a bug
13.22. templateThe template element is the base XML element for your template file. It contains several sub-elementsthat refer to your system installation.
Parent Elements
None.
Child Elements
name, description, os, packages, files, commands, and repositories.
Example 13.22. An example of the template element
<template> <name>Example_Template</name> <description>An example of a template</description> <os> ... </os></template>
Report a bug
13.23. url (repository)The url element tag provides the URL of the repository. This element requires a fully qualified domainname or consistent IP address accessible from the guest image. It contains a string value.
Chapter 14. Application Blueprint XML Schema
111
Parent Elements
repository.
Child Elements
None.
Example 13.23. An example of the url element
<template> ... <repositories> <repository name="Additional Repository"> <url>http://www.example.com/repositories/x86_64/</url> </repository> </repositories> ...</template>
Report a bug
13.24. url (os)The url element is required for providing the URL location of installation media. This element isrequired if when install type="url".
Parent Elements
install.
Child Elements
None.
Example 13.24 . An example of the url element
<template> ... <os> ... <install type='url'> <url>http://download.fedoraproject.org/pub/fedora/ linux/releases/14/Fedora/x86_64/os/</url> </install> </os> ...</template>
Report a bug
CloudForms 1.1 Cloud Engine User Guide
112
13.25. versionThe version element is required for the os installation. The version element identifies the versionnumber for the chosen operating system. It contains a string value.
Table 13.2. Version Listing
Operating System Name Version
Fedora 15 Fedora 15
Fedora 16 Fedora 16
Red Hat Enterprise Linux 5.6 RHEL-5 U6
Red Hat Enterprise Linux 5.7 RHEL-5 U7
Red Hat Enterprise Linux 5.8 RHEL-5 U8
Red Hat Enterprise Linux 5.9 RHEL-5 U9
Red Hat Enterprise Linux 6.1 RHEL-6 1
Red Hat Enterprise Linux 6.2 RHEL-6 2
Red Hat Enterprise Linux 6.3 RHEL-6 3
Red Hat Enterprise Linux 6.4 RHEL-6 4
Parent Elements
os.
Child Elements
None.
Example 13.25. An example of the version element
<template> ... <os> <name>Fedora</name> <version>16</version> ... </os></template>
Report a bug
Chapter 14. Application Blueprint XML Schema
113
Chapter 14. Application Blueprint XML Schema
14.1. assembliesThe assemblies element is a container for the instances in an application. An application can containmore than one instance, which a CloudForms Cloud Engine user achieves using multiple assemblyelements with the assemblies element. This element is a required element.
Parent Elements
deployable.
Child Elements
assembly.
Report a bug
14.2. assemblyThe assembly element defines an instance in an application. A CloudForms Cloud Engine user canuse multiple assembly elements to create multiple instances in an application deployment.
Table 14 .1. Attributes for the assembly element
Attribute Data Type Description
name string The name of the instance.
hwp enumerated A reference to the cloud resource profile for the instance.
Parent Elements
assemblies.
Child Elements
image, returns, services.
Report a bug
14.3. contents (executable)The contents refers to the content of an executable script if no URL is specified in the executableelement.
Parent Elements
executable.
Child Elements
None.
CloudForms 1.1 Cloud Engine User Guide
114
Report a bug
14.4. contents (file)The contents refers to the content of a configuration file if no URL is specified in the file element.
Parent Elements
executable.
Child Elements
None.
Report a bug
14.5. deployableThe deployable element is a base container for your application blueprint and represents theapplication for deployment. This element is a required element.
Table 14 .2. Attributes for the deployable element
Attribute Data Type Description
id string The application blueprint's id.
name string The application blueprint's name.
version enumerated The application blueprint's version. The default value is 1.0.
Parent Elements
None.
Child Elements
description, assemblies.
Report a bug
14.6. description (deployable)The description element is a plain text description of the application.
Parent Elements
deployable.
Child Elements
None.
Report a bug
Chapter 14. Application Blueprint XML Schema
115
14.7. description (service)The description element is a plain text description of a service.
Parent Elements
service.
Child Elements
None.
Report a bug
14.8. executableThe executable refers to a script that launches upon an instance's post-boot. When the instance islaunched, the Audrey executes the script for each service definition. The executable script isresponsible for understanding how to interpret the optional parameters and configuration files.
Table 14 .3. Attributes for the element
Attribute Data Type Description
url URL The location and name of the executable script.
Parent Elements
service.
Child Elements
content.
Report a bug
14.9. fileThe file refers to an individual configuration file, which executable scripts can use.
Table 14 .4 . Attributes for the element
Attribute Data Type Description
url URL The location and name of the configuration file.
Parent Elements
files.
Child Elements
contents.
CloudForms 1.1 Cloud Engine User Guide
116
Report a bug
14.10. filesThe files element is a container for configuration files in a application service.
Parent Elements
service.
Child Elements
file.
Report a bug
14.11. imageThe image element is a reference to a built image in your CloudForms Cloud Engine environment.
Table 14 .5. Attributes for the image element
Attribute Data Type Description
id UUID A reference to an image's identification value.
build UUID A reference to a build's identification value.
Parent Elements
assembly.
Child Elements
None.
Report a bug
14.12. parameterThe parameter element represents a single runtime parameter for an application service.
Table 14 .6. Attributes for the parameter element
Attribute Data Type Description
name string The name of the parameter.
type One of scalar or password.
Indicates the type of parameter field, either a scalar value or a hidden password field.
Parent Elements
parameters.
Revision History
117
Child Elements
value, reference.
Report a bug
14.13. parametersThe parameters element is a container for parameters in a application service.
Parent Elements
service.
Child Elements
parameter.
Report a bug
14.14. referenceThe reference element accepts a return parameter from another assembly. This creates adependency from one instance service to another.
Table 14 .7. Attributes for the reference element
Attribute Data Type Description
assembly string The name of the assembly with the desired return parameter.
parameter
string The name of the return parameter.
Parent Elements
parameter.
Child Elements
None.
Report a bug
14.15. returnThe return element is a single parameter value that an application service provides. Other assembliesutilize these return parameters for use in their own executable scripts.
The return element uses variables from the Facter Ruby library. For more information, read the full
specification of Facter variables on the Facter Documentation website .[1]
CloudForms 1.1 Cloud Engine User Guide
118
Table 14 .8. Attributes for the return element
Attribute Data Type Description
name string The name of the return parameter.
Parent Elements
returns.
Child Elements
None.
Report a bug
14.16. returnsThe returns element is a container for return parameters from application service.
Parent Elements
assembly.
Child Elements
return.
Report a bug
14.17. serviceThe service element configures a runtime service on your application. An application can containmultiple services each using a service container element. Audrey runs a service using an executablescript, an optional list of configuration files, and an optional list of parameters.
Table 14 .9. Attributes for the element
Attribute Data Type Description
name string The name for the service.
Parent Elements
services.
Child Elements
description, executable, files, parameters.
Report a bug
14.18. services
Revision History
119
The services element is a container for runtime services for the application.
Parent Elements
assembly.
Child Elements
service.
Report a bug
14.19. valueThe value element indicates the default value of a parameter.
Parent Elements
parameter.
Child Elements
None.
Report a bug
Facter Do cumentatio n - http ://d o cs.p up p etlab s.co m/facter/[1]
CloudForms 1.1 Cloud Engine User Guide
120
Revision HistoryRevision 0-93 Tue 19 Feb 2013 Dan Macpherson
Updating documentation for RHEL 6.4 support
Revision 0-92 Wed 13 Feb 2013 Dan MacphersonUpdating documentation for RHEL 6.4 supportMinor fixes
Revision 0-91 Fri 4 Jan 2013 Julie WuMinor typos.
Revision 0-90 Thu 3 Jan 2013 Julie WuChanged System Engine to Cloud Engine in the restore procedure.
Revision 0-88 Fri 16 Nov 2012 Dan MacphersonBeta respin.
Revision 0-87 Mon 12 Nov 2012 Dan MacphersonSnapshot for translation.
Revision 0-86 Thu 08 Nov 2012 Dan MacphersonMinor fix.
Revision 0-85 Thu 08 Nov 2012 Dan MacphersonImplemented Docs QE feedback.
Revision 0-84 Wed 07 Nov 2012 Dan MacphersonImplemented minor corrections.
Revision 0-83 Mon 05 Nov 2012 Dan MacphersonSnapshot for 1.1 Release Candidate.
Revision 0-82 Fri 02 Nov 2012 Dan MacphersonRevising intructions for Cloud Resource Providers to match UI changes.
Revision 0-81 Fri 02 Nov 2012 Dan MacphersonRemoving support for RHEL 6.1 images.
Revision 0-80 Thu 01 Nov 2012 Dan MacphersonFix to Bugzilla product and component.
Revision 0-79 Tue Oct 30 2012 Julie WuRemoved reboot/reset note from 6.4.4Added vm tools agent note in 6.4.4Added more example component outlines
Revision 0-78 Mon Oct 29 2012 Dan MacphersonBZ#818573 - RHEV API ports fixed
Revision History
121
BZ#867928 - Added note regarding retaining LDAP Fluff config when adding a new providerBZ#820228 - Typo fixesBZ#870084 - Add note for stopping build and push processesBZ#799020 - Correction to tar command for backing up config filesBZ#843807 - Added correct description of Priority
Revision 0-77 Fri Oct 19 2012 Dan MacphersonMinor fix to Application Blueprint example
Revision 0-76 Fri Oct 19 2012 Dan MacphersonRevised screenshots after UI change
Revision 0-74 Thu Oct 18 2012 Dan MacphersonBZ#799020 - Revision of Disaster Recovery Plan with juwu
Revision 0-73 Tues Oct 16 2012 Dan MacphersonPackage refresh
Revision 0-72 Tues Oct 16 2012 Dan MacphersonBZ#795901 - Modification to reflect UI changeBZ#818573 - Document obtaining SSL cert for RHEVBZ#856379 - Fixed typosBZ#856380 - Expanded Views sectionBZ#856390 - Fixed typoBZ#856391 - Modification to reflect UI changeBZ#859506 - Document behavior of Ignore Instance errors during launch buttonBZ#862323 - Added some extra information on services dependencies
Revision 0-71 Fri Oct 12 2012 Julie WuFixed Chapter9 typos
Revision 0-70 Thu Oct 11 2012 Julie WuBZ#856390 fixed typos and tags
Revision 0-69 Mon Oct 08 2012 Dan MacphersonRevisions for first draft
Revision 0-68 Wed Oct 03 2012 Dan MacphersonRevised task structure
Revision 0-67 Wed Oct 03 2012 Julie WuAdded Topic: Example Application Blueprint file [11651]
Revision 0-66 Wed Sept 19 2012 Julie WuAdded example in[9594][9595][9605][11541][11540][9609][9614][9628][9617][9619][9620][9621][9622][9624][9625][9626][9627][9623][9630][9631][9597][9599][9612][9607][9610][9611]
Revision 0-65 Wed Sept 19 2012 Daniel MacphersonAdded Provider Selection Strategy documentation
CloudForms 1.1 Cloud Engine User Guide
122
Revision 0-64 Mon Sept 17 2012 Julie WuUpdated [9729] [11524]Edited [9603], added Audrey exampleAdded [11540][11541]Edited [9748][9747]
Revision 0-63 Fri Sept 14 2012 Daniel MacphersonEarly preview documentation for CloudForms 1.1
Revision 0-62 Mon Sep 10 2012 Julie WuMerged several topics togetherRemoved section layer in Runtime chapter
Revision 0-61 Mon Sept 10 2012 Daniel MacphersonInitial build for CloudForms 1.1
Revision 0-60 Fri Sep 07 2012 Julie WuEdited not in [9647]#819674 Added an important note in [9651]
Revision 0-59 Thu Sep 06 2012 Julie WuCreated Topic [11398]Deleting an image from the Cloud Resource Provider#854674 Fixed typos in [9953] [9663]#854674 Replaced RHEV-M with Red Hat Enterprise Virtualization Manager [9964]#854674 Edited [9964]Edited [9965] title#819674 Added an important note in [9647]
Revision 0-58 Wed Sep 05 2012 Julie WuRestored [9747][9748][9749][9744] and removed [9966]Merged [9927][9733]Merged [9751][9931]Merged [9933][9671]Merged [9934][9673]Moved image from [9753] to [9653]Moved image and important note from [9756] to [9674]Edited [9756] topic titleEdited [9755] topic titleMoved image from [9754] to [9666]Removed [9935]In [9666], added Task Summary
Revision 0-57 Tue Sep 04 2012 Julie WuMerged [9747][9748][9749][9744] into Components [9966]
Revision 0-56 Thu Aug 30 2012 Julie Wu#808208 wrote a new procedure for deleting an image from GUI
Revision 0-55 Wed Aug 29 2012 Julie WuEdited Topic titles
Revision History
123
Merged [9766][9768][9767] into [9943]
Revision 0-54 Tue Aug 27 2012 Julie WuUpdated OS version in: Instance Operating Systems [9923]#850507Added full stop in:First T ime Login [9927]#847165
Revision 0-53 Fri Jul 6 2012 Daniel MacphersonMinor fix for 1.0.1 release
Revision 0-52 Tue Jun 19 2012 Daniel MacphersonMinor revision for 1.0.1 release
Revision 0-50 Tue Apr 13 2012 Daniel MacphersonFinal runtime script for System Engine registration
Revision 0-4 6 Tue Apr 10 2012 Daniel MacphersonDropping FINAL documentation to translation
Revision 0-4 5 Thu Apr 5 2012 Daniel MacphersonFinal minor revisions
Revision 0-4 4 Mon Apr 2 2012 Daniel MacphersonBZ#805601 - Correction to typo in import CLI options
Revision 0-4 2 Fri Mar 30 2012 Daniel MacphersonBZ#807851 - Added new task for System Engine registration with runtime configuration
Revision 0-4 0 Thu Mar 29 2012 Daniel MacphersonRevisions to Aeolus CLI instructionsBZ#805596 - Revised Aeolus CLI build instructionsBZ#805601 - Revised Aeolus CLI import instructions
Revision 0-39 Wed Mar 28 2012 Daniel MacphersonBZ#805609 - Corrections to Create Application Blueprint processBZ#805612 - Changed Accessing Instances in an Application process to be EC2-specificBZ#805555 - Added note that cites Installation Guide for process to create providers via aeolus-configureBZ#805559 - Added note to remove storage details for some cloud resource profilesBZ#805563 - Minor revisions to Pushing an Image sectionBZ#805578 - Revisions to Importing a Component Outline from a Cloud Resource Provider sectionBZ#805590 - Revision to Importing a Component Outline import note in regard to AudreyBZ#805553 - Minor revisions to IntroductionBZ#805777 - Added rootpw element to the example templates
Revision 0-38 Mon Mar 19 2012 Daniel MacphersonRevising as per advice from translation team.
Revision 0-37 Mon Mar 19 2012 Daniel MacphersonTag correction for GUI element.
CloudForms 1.1 Cloud Engine User Guide
124
Revision 0-34 Mon Mar 5 2012 Daniel MacphersonImplemented suggestions from translation team.
Revision 0-21 Fri Feb 10 2012 Daniel MacphersonImplemented Documentation QE feedback.
Revision 0-17 Wed Feb 8 2012 Daniel MacphersonBZ#785043 - Improved cloud resource provider account creation instructions and removed redundantstep.
Revision 0-16 Wed Feb 8 2012 Daniel MacphersonRevised documentation based upon changes to UI labels and branding.Fixes to documentation based upon QE.
Revision 0-15 Tue Jan 31 2012 Daniel MacphersonBZ#717997 - Added note on use of localhost for repository URL in TDLBZ#719972 - Added more detail on version element in TDL. Added RHEL 5 TDL example.
Revision 0-14 Mon Jan 30 2012 Daniel MacphersonBZ#781594 - Added note regarding instances built from imported images not containing Audrey Agent.
Revision 0-10 Fri Jan 12 2012 Daniel MacphersonBZ#746306, BZ#747645, BZ#767382 - Improved Cloud Resource Cluster concept and task. Addedadmonition regarding priority for providers over clusters.
Revision 0-3 Tue Dec 09 2011 Daniel MacphersonBuilding book for technical review
Revision 0-2 Tue Dec 01 2011 Shikha NansiPublishing on doc-stage
Revision 0-1 Tue Dec 01 2011 Shikha NansiInitial creation of book by publican
Revision History
125
