book

Mastering CloudForms Automation

by Peter McGowan

September 2016

Intermediate to advanced

432 pages

8h 40m

English

O'Reilly Media, Inc.

Read now

Unlock full access

A Brief Word on TerminologyWho Should Read This Book?Why I Wrote This BookVersions and ReleasesNavigating This BookPart I, Working with CloudForms AutomatePart II, Provisioning Virtual MachinesPart III, Working with ServicesPart IV, RetirementPart V, IntegrationPart VI, MiscellaneousOnline ResourcesOfficial DocumentationCode RepositoriesForumsBlogsConventions Used in This BookUsing Code ExamplesSafari® Books OnlineHow to Contact UsAcknowledgments
What Is CloudForms?ProvidersCloud ProvidersInfrastructure ProvidersConfiguration Management ProvidersContainer ProvidersMixing and Matching ProvidersThe Capabilities of CloudFormsInsightControlAutomateIntegrateThe CloudForms ApplianceRuby and RailsProjects, Products, and Some HistoryManageIQ (the Project)Red Hat CloudForms (the Product)CloudForms Management Engine (the Appliance)SummaryFurther Reading
The Automate ExplorerThe Automate DatastoreDomainsDomain PriorityImporting/Exporting DomainsCopying Objects Between DomainsImporting Old Format ExportsNamespacesClassesSchemasAdding or Editing a SchemaRelationshipsInstancesMethodsSummaryFurther Reading
Creating the EnvironmentAdding a New DomainAdding a NamespaceAdding a ClassEditing the SchemaHello, World!Adding a New InstanceAdding a New MethodRunning the InstanceExit Status CodesSummary
Preparing the SchemaThe InstanceThe MethodRunning the InstanceSummary
Custom AttributesCreating the Service DialogCreating the Instance and MethodThe CodeCreating the /System Entry PointRunning Automation Scripts from a ButtonCreating the Button GroupCreating the ButtonRunning the InstanceSummaryFurther Reading
A Little Rails Knowledge (Goes a Long Way)Plain Old RubyModel-View-ControllerActive Record AssociationsRails Helper Methods (.find_by_*)Service ModelsService Model Object PropertiesAttributesVirtual ColumnsAssociationsMethodsDistributed RubySummaryFurther Reading
$evm.log$evm.root$evm.object, $evm.current, and $evm.parent$evm.vmdbSingle-Argument FormTwo-Argument Form$evm.executeExamples$evm.instantiateSummaryFurther Reading
TaskSolutionrelocate_vmsend_emailMain CodeSummaryFurther Reading

Creating Tags and CategoriesAssigning and Removing TagsTesting Whether an Object Is TaggedRetrieving an Object’s TagsSearching for Specifically Tagged ObjectsPractical ExampleGetting the List of Tag CategoriesGetting the List of Tags in a CategoryFinding a Tag’s Name, Given Its DescriptionFinding a Specific Tag (MiqAeServiceClassification) ObjectDeleting a Tag CategorySummaryFurther Reading
InspectMeobject_walkerBlack or Whitelisting Associationsobject_walker_readerRails ConsoleRails dbSummaryFurther Reading
Buttons and SimulationRESTful APIControl Policy ActionsAlertsService Dialog Dynamic ElementsFinding Out How Our Method Has Been CalledSummaryFurther Reading
The Need for ApprovalRequest and Task ObjectsApprovalObject Class AncestryContextObject ContentsDumping the Object ContentsComparing the ObjectsSummaryFurther Reading
Building a State MachineState Machine Schema Field ColumnsState Machine ExampleState VariablesSetting State ResultState RetriesGetting the State Machine NameGetting the Current Step in the State MachineGetting the on_entry, on_exit, on_error Status StateState Machine Enhancements in CloudForms 4.0Error RecoverySkipping StatesJumping to a Specific StateNested State MachinesSaving Variables Between State RetriesSummaryFurther Reading
MessagesSpecifying Our Own MessagesAssertionsCollectionsSummary
Event Processing Component PartsThe Event Stream ObjectThe Event SwitchboardEvent HandlersCatching and Handling External EventsEvent CatchingEvent ProcessingCreating and Processing Internal EventsEvent-Initiated Control Policy ProcessingEvent-Initiated Alert ProcessingEvent-Initiated Automation Request WorkflowsStep 1: The request_created EventStep 2: The request_approved EventStep 3: The request_starting EventStep 4: Automation Task ProcessingExtending Automate Event HandlingAdding a New Automation Instance to /System/Event/EmsEvent/SummaryNext Steps
The Provisioning ProcessGroup-Specific Considerations, and Common ProcessingSummary
LocationSchemaCustomizing the ProfileProfile Processing in DetailThe Provisioning DialogVM Name (Pass 1)ApprovalQuotaVM Name (Pass 2)VM Provisioning State MachineSummaryFurther Reading
Approval WorkflowRequest Created EventMethodsRequest Pending EventOverriding the DefaultsTemplate TaggingVM Provisioning–Related EmailSummaryFurther Reading
Quotas in Cloudforms 4.0Quota SourceQuota WorkflowSummaryFurther Reading
Request Object (miq_provision_request)Task Object (miq_provision)Adding Network AdaptersCorrelation with the Provisioning DialogAdding Our Own Options: The ws_values HashSummary
State Machine SchemaFilling in the BlanksSummary
ScenarioTaskMethodologyStep 1: Extend the State MachineStep 2: Disable Auto-Power-OnStep 3: Create Our New Instances and MethodsStep 4: Add Our New Instances to the Copied State MachineStep 5: Provision a Virtual MachineSummaryFurther Reading
VM Name-Related Provisioning OptionsInputs to the Naming ProcessOutputs from the Naming ProcessName ProcessingProvisioning a Single VM or InstanceProvisioning Multiple VMs or Instances in a Single RequestCustomizing the Naming ProcessSummaryFurther Reading
Placement MethodsMethod DescriptionCustomising PlacementUsing Alternative Placement MethodsSummaryFurther Reading
Tabs and Input FieldsDialog YAMLSelection of VM Provisioning DialogGroup-Specific DialogsExample: Expanding the DialogSummaryFurther Reading
Object OverviewThe Provision Request ObjectRequest ContextTask ContextThe Provision Task ObjectThe Source ObjectThe Destination ObjectSummary
Making the CallArgument ListversiontemplateFieldsvmFieldsrequestertagsadditionalValues (aka ws_values)emsCustomAttributesmiqCustomAttributesSetting Placement OptionsSummaryFurther Reading
Hosts and Content HostsThe Satellite 6 Host EntryNon-CloudForms PreparationCreating the Host Groups in Satellite 6Creating the Activation Keys in Satellite 6Adding an SSH Key to the VMware TemplateInstalling and Configuring Ansible on the CloudForms ApplianceModifying the CloudForms Provisioning WorkflowRegisterSatelliteActivateSatelliteTesting the Integration: Provisioning a New VMSummaryFurther Reading
Dialog ElementsDynamic ElementsPopulating the Dynamic FieldsRead-Only and Protected ElementsProgrammatically Populating a Read-Only Text BoxElement ValidationUsing the Input from One Element in Another Element’s Dynamic MethodExampleSummaryFurther Reading
Class and InstancesPassing Service Dialog Options to the Child and Grandchild TasksAccessing the Service Dialog OptionsConfigureChildDialogSummaryVM Naming for Services
CatalogItemInitializationService Dialog Element Naming ConventionCatalogBundleInitializationSummaryFurther Reading
Triggering EventsApprovalCustomizing ApprovalQuotaEmailSummary
The Service DialogFinding the Correct Element NamesCreating the Service DialogCreating the Service Catalog ItemCreate a CatalogCreating the Catalog ItemOrdering the Catalog ItemSummaryFurther Reading
Creating the Service Dialog for the BundlePreparing the Service Catalog ItemsCreating the Service Catalog BundleOrdering the Catalog BundleSummaryFurther Reading
Object StructureService Template Provision TaskService Template Provisioning RequestChild miq_request_taskGrandchild miq_request_taskSummary
Initial RequestProfile LookupRequest Processing and ApprovalService Template Provisioning TasksVM Provisioning TaskService State Machine CheckProvisionedVM State Machine CheckProvisionedVirtual Machine Provision CompleteService Provision CompleteSummary
Organizing Our ServicesCreating an Empty ServiceAdding VMs and Services to Existing ServicesAdding the ButtonSummary
Reconfigure Entry PointService DesignAdding a Configuration Management ProviderAutomate Datastore ComponentsCreating the Namespaces and State MachinesEmail ClassesPoliciesModifying the VM Provision WorkflowService DialogElementsInstances and MethodsDynamic DialogsConfiguration-Related MethodsTestingSummary
Test Virtual Machine Provisioning FirstRe-create the Service Item if the Template ChangesCustom State MachinesSummary
Initiating RetirementRetirement-Related Attributes and MethodsVM Retirement State MachineStartRetirementPreRetirement/CheckPreRetirementRemoveFromProvider/CheckRemovedFromProviderFinishRetirementDeleteFromVMDBSummaryFurther Reading
Defining a Service Retirement Entry PointInitiating RetirementRetirement-Related Attributes and MethodsService Retirement State MachineStartRetirementRetireService/CheckServiceRetiredFinishRetirementDeleteServiceFromVMDBSummary
API Entry PointReturning Results to the CallerAuthentication and auto_approveZone Implicationsrun_via_apiSummaryFurther Reading
Implementing a Custom Approval WorkflowNamespaceGroup ProfileState MachineEmail ClassesPoliciesAutomationRequest_createdAutomationRequest_pendingTestingSummary
Calling a SOAP API Using the Savon GemCalling an OpenStack API Using the fog GemReading from a MySQL Database Using the MySQL GemSummaryFurther Reading
Nondistributed Automation OperationsDistributed Automation OperationsTracing Queueing/Dequeueing OperationsDetailed Queue AnalysisMonitoring the Queue During an Automation OperationTroubleshootingSummary
Case 1: Calling from a ButtonCase 2: Calling from the RESTful APICase 3: Calling from a Relationship or Automate Datastore URICase 4: Passing Arguments via the ws_values Hash During a VM ProvisionPassing Arguments When Calling a Method in the Same ClassSummary
Updating the ApplianceThe ManageIQ Coding Style and Standards GuideDefensive ProgrammingCatch ExceptionsUse an External IDEVersion ControlUse Configuration DomainsSummary

Overview

Learn how to work with the Automate feature of CloudForms, the powerful Red Hat cloud management platform that lets you administer your virtual infrastructure, including hybrid public and private clouds. This practical hands-on introduction shows you how to increase your operational efficiency by automating day-to-day tasks that now require manual input. Throughout the book, author Peter McGowan provides a combination of theoretical information and practical coding examples to help you learn the Automate object model. With this CloudForms feature, you can create auto-scalable cloud applications, eliminate manual decisions and operations when provisioning virtual machines and cloud instances, and manage your complete virtual machine lifecycle.