This documentation will go through the steps required to create a simple Service (also known as Service Catalog List or Catalog List) which will take a user input of instance name and service name to deploy an instance.
- A basic understanding of the ManageIQ environment.
- A basic understanding of OpenStack
- ManageIQ installed and configured with OpenStack added as a provider
- An OpenStack environment which will deploy the instance
- The VM image, flavor, network that will be used to deploy the instance
Concepts Used in this Documentation
A service (also known as Service Catalog List or Catalog List) is an item that can be requested by the user to the admin. Think of service as a task that can be called by a user whose underlying work will be configured by the user.
A service consists of: Service Catalog and a Provisioning Catalog
A service catalog consists of a group of dialogs
Made up of fully customizable tabs, items, and values for use with Service provisioning.
Create a simple Service
As mentioned above in the Overview, we will create a simple Service to take the user inputs service name and instance name.
On your ManageIQ interface, go to Automation->Automate->Customization. You will see the following screen:
Click on Service Dialogs, and click on the Configuration button (The Cog wheel) and select add a new dialog. You will see the following screen:
We are going to create a Service Dialog now
The Dialog name and the Description are written and selected as per the user requirement. In this Documentation, since we are using OpenStack and using a Cirros image, we will make it ‘Cirros User Dialog’ for the Dialog’s Name and ‘This is my Cirros Dialog’ for Dialog’s Description
A Service Dialog consists of essentially 3 components:
- An element, like Text Box, Text Area, Check Box, Dropdown
- A section which consists of multiple elements
- And finally, a tab which consists of multiple sections
In our use-case, we will be needing two elements (one for the instance name input and one for the service name), one section and one tab.
Drag and drop two text boxes, one for service name and one for instance name.
Hover your mouse over the text boxes to get an Edit option, which is represented with a pencil icon. Click on that.
In our Dialog, we have Label and Name in the Field Information tab.
Label, which will be the name displayed for the user and Name, which is the element name.
In our case,
- Label will be Service Name
- Name will be service_name
- NOTE: The element name that is mentioned is not user-specific. You have to find out the name of the element by going to Automation->Automate->Customization->Provisioning Dialog and going through the Dialogs to find out the respective element name.
- In our example, the element names are service_name which is used for service name and vm_name for instance name.
- We also have to change Value Type in the Options tab to String
Accordingly, give a name to the Tab and Section settings as well by hovering over them and selecting the Edit option (pencil icon)
Accordingly, make changes to the other element as well (Label = Instance name, Name = vm_name, Value Type = String)
Your final screen should look something like this:
Go to Services->Catalog->Catalog and click on the Configuration button (The Cog wheel) and select add a new dialog.
This is our Service Catalog
You should see this screen:
Name and Descriptionwill be according to your requirement.
We will be using Cirros Catalog for Name and Cirros Catalog Description for the Description
We now need to create a Service which will combine our service catalog and out provisioning catalog.
Go to Services->Catalog->Catalog Items and click on the Configuration button (The Cog wheel) and select add a new dialog. You should see this screen:
On selecting OpenStack, you’ll see this:
- Name and Description is as per user requirement
- Check the Display in Catalog option
- Catalog will be the Catalog we created (Cirros Catalog)
- Dialog will be the Dialog we created (Cirros Dialog)
- Go to the Request Info tab and select the appropriate VM configuration
- Note: This documentation assumes that you have an understanding of the VM creation
- After clicking on Add, you should see a screen like this:
- Click on the Cirros instance Catalog Item.
- You should see a screen like this
- Choose and Image of your liking and upload it.
- Your service catalog item has now been created.
Accessing the service
Log onto the self-service portal (https://:8443/self_service)
Click on Service Catalog, where you will find your service:
You are now able to request and order services now.
An explanation of what we’ve done
First we created a dialog item, after which we created a service dialog and then finally a service item which was now used in our self-service portal to create a VM instance.