Chapter 4. Fulfilling Requests

4.1. Fulfilling a Request

After a request has been approved, Red Hat CloudForms then goes through the steps required to complete the request. The steps followed for a regular provision from a virtual machine to a virtual machine (not to a template) are found by navigating to Automate → Explorer, then listed under DOMAIN → Cloud|Infrastructure → VM → Provisioning → VMProvision_VM → Provision VM from Template (template). The value for each state shows where the instance resides in the Datastore accordion. The default set of execution steps is shown below. For more information on state machines, see Section 4.2.1.4, “State Machines”.

4.2. Default Execution Steps in States Instance

StepDescription

Customize Request

Apply customizations.

Acquire IP Address

Integrates with IPAM (IP Address Management) to get an IP Address.

Acquire MAC Address

Integrates with IPAM to get a MAC Address.

Register DNS

Integrates with IPAM to register with DNS.

Register CMDB

Integrates with CMDB (Configuration Management Database) to register with the CMDB.

Register AD

Integrates with IPAM to register with active directory.

PreProvision

Pre-provisioning steps.

Provision

Create the virtual machine or instance.

CheckProvisioned

Check that the new virtual machine or instance is in the VMDB.

PostProvision

Post-provisioning steps.

Register DHCP

Integrate with IPAM to register the IP address with DHCP Server.

Activate CMDB

Integrate with IPAM to activate the virtual machine or instance in the CMDB.

Email owner

Send email to owner that the virtual machine or instance has been provisioned.

4.2.1. Quotas

Quotas allow you to establish maximum usage thresholds for an user, group, or tenant for provisioned virtual machines or instances and are integrated into provisioning profiles. These maximums are checked after the approval but before the actual provision request is started. The quota is set for the tenant or group as a whole.

4.2.1.1. Applying User or Group Quotas

  1. Log in as a user with administrator or super administrator rights to the Red Hat CloudForms console.
  2. Navigate to Automate → Explorer.
  3. Copy the ManageIQ → System → CommonMethods → QuotaStateMachine → quota instance to a custom DOMAIN.

  4. From the accordion menu, click DOMAIN → System → CommonMethods → QuotaStateMachine → quota.

    Note

    By default, quotas are applied to tenants and do not require any change in Automate → Explorer.

  5. Click 1847 (Configuration), 1851 (Edit this instance). 6300

    1. Set the value for Quota Source Type to user or group.

      Important

      A user creating a provisioning request must have an email address saved in their profile, or provisioning may fail. See Creating a User in General Configuration for details on configuring users.

    2. Set the values for VM Warning Count, VM Maximum Count, Storage Warning Limit, Storage Maximum Limit, CPU Warning Count, CPU Maximum Count, Memory Warning Limit, or Memory Maximum Limit to be the maximums for a specific user or group.
  6. Click Save.

4.2.1.2. Using Tags for Owner and Group Quotas

Red Hat CloudForms provides tags for enforcing quotas for the owners of virtual machines or instances. Ownership of a virtual machine or instance can be set either during the provisioning process or by using the Configuration Set Ownership button. If a virtual machine or instance has an owner, the value is displayed in the Lifecycle section of the virtual machine or instance summary page.

Quota tags can be assigned directly to either a group or owner not to a configuration item. The table below shows the tags for use in quotas.

Category Display Name (Name)Use

Quota Max CPU (quota_max_cpu)

Sets the maximum number of CPUs summed over all virtual machines and instances owned by the group or user. Sample Values: 1, 2, 3, 4, 5, 10, 20, 30, 40, 50

Quota Max Memory (quota_max_memory)

Sets the maximum memory summed over all virtual machines and instances owned by the group or user. Sample Values: 1024, 2048, 4096, 8192, 10240, 20480, 40960, 81920 (in MB)

Quota Max Storage (quota_max_storage)

Sets the maximum storage summed over virtual machines and instances owned by the group or user. Sample Values: 10, 100, 1000, 20, 200, 40, 400 (in GB)

4.2.1.3. Applying a Tag to a User or User Group

  1. From the settings menu, select Configuration.
  2. Click the Access Control accordion, and select the user or group that you want to tag.
  3. Click 1941 (Policy), then click 1851 (Edit Tags).
  4. Select the appropriate customer tag to assign, then the value.
  5. Click Save.
Note

When quotas are applied by both automate instance and tagging, the tagged values will have higher precedence.

4.2.1.4. State Machines

The automate state machine processes an ordered list of states. It can ensure the successful completion of a step before the next step is run, permit steps to be retried, allow setting a maximum time to retry the state before exiting, and number of retries before exiting the state. Before each state is executed, the On_Entry method is executed and after the state ends the On_Exit or On_Error method is executed based on how the state ends.

The following components make up a Red Hat CloudForms automate state machine:

ComponentDescription

On_Entry

Method to run when entering the state. It enables you to execute an automate method to do some pre-processing before the state of the state machine is processed.

On_Exit

Method to run when exiting the state.

On_Error

Method to run if an error is encountered when running the state. It enables you to execute an automate method to do some final processing before the state machine finally exits (MIQ_ABORT) due to the error.

Default Value

Runs after the On_Entry method completes (The actual state being processed).

Max Retries

Maximum number of times to retry the state before exiting.

Max Time

Maximum time in seconds to retry the state before exiting.

In the diagram below, you can see how these components combine to create a state machine workflow.

Note

The retry logic, On_Entry and On_Error are distinct cases in the program flow.

2353

Code snippet demonstrating the state machine retry logic: 

# Get current provisioning status
task = $evm.root['service_template_provision_task']
task_status = task['status']
result = task.status

Then check the result to see how it should proceed:

case result
when 'error'
  $evm.root['ae_result'] = 'error'
.....
when 'retry'
  $evm.root['ae_result'] = 'retry'
  $evm.root['ae_retry_interval'] = '1.minute'
when 'ok'
  $evm.root['ae_result'] = 'ok'
end

When the result is "retry", it sets:
  $evm.root['ae_result'] = 'retry'
  $evm.root['ae_retry_interval'] = '1.minute'

The following image shows a simple state machine pertaining to approving a provision request. This instance can be found in Datastore → ManageIQ → Infrastructure → VM → Provisioning → StateMachines → ProvisioningRequestApproval → Default. 2354

  1. The attribute max_vms has a value of 1. State machine processing can use the attributes of the state machine instance to make logic decisions. In this case, the validate_request method, which is processed during the On_Entry portion of the ValidateRequest state, evaluates the max_vms attribute. If the number of virtual machines requested is less than the max_vms value, the request can be auto-approved.
  2. ValidateRequest is the first state to be executed.
  3. ApproveRequest is the next state to be executed.
Note

Grayed out items reflect values that are set in the class schema. These values can be overwritten on a per instance basis.

4.2.1.5. Customizing Provisioning States

The steps followed when provisioning a virtual machine or cloud instance are completed based on instances from the DOMAIN → Cloud|Infrastructure → VM → Provisioning → StateMachines → VMProvision_VM class. Depending on your environment you can remove, change, or add steps to the provisioning process. For example, if you are not integrating with IPAM or a CMDB, then you can remove those execution steps. 6281

4.2.1.6. Editing the Default State Instance

  1. Navigate to Automate → Explorer.

  2. From the accordion menu, click DOMAIN → Cloud → VM → Provisioning → StateMachines → VMProvision_VM.

    Note

    DOMAIN must be a user-defined Domain and not the locked ManageIQ Domain. If necessary, you can copy the class from the ManageIQ domain into a custom domain.

    This example uses the Cloud Namespace, but can also use the Infrastructure namespace.

  3. Click 1847 (Configuration), then 1851 (Edit this instance). 6281
  4. For each step that you want to remove, clear the entries in the Value, On Entry, On Exit, and On Error columns.
  5. Click Save.

4.2.1.7. Viewing the Status of a Provisioning Request

After a request has been approved, the various stages of fulfillment are executed. You can see the progress of the provisioning process by viewing its status.

  1. Navigate to Services → Requests. The list of requests is shown.
  2. Click on a specific request for more information. Once the provisioning begins, if the request was supposed to create more than one virtual machine or instance, a field will appear called Provisioned VMs. Click on the number that appears next to it for information on each of the individual provisions.

4.2.1.8. Viewing a Provisioned Virtual Machine or Instance

When a virtual machine or instance is created as a result of a provisioning request, its summary screen will show when it was provisioned in the Lifecycle area of the respective summary.

  1. From Services → Workloads, click the virtual machine or instance that you want to view. 2356

4.2.1.9. Viewing a Virtual Machine or Instance Summary

From Services → Workloads, click the virtual machine or instance that you want to view.